OpenJDK / jdk / jdk
changeset 25148:1026dc322690
8046446: Fix doclint warnings in javax.swing.text.html package
Reviewed-by: pchelko
Contributed-by: Andrei Eremeev <andrei.eremeev@oracle.com>
line wrap: on
line diff
--- a/jdk/src/share/classes/javax/swing/text/html/BlockView.java Thu Jun 19 16:54:59 2014 +0400 +++ b/jdk/src/share/classes/javax/swing/text/html/BlockView.java Thu Jun 19 16:57:14 2014 +0400 @@ -417,6 +417,11 @@ cssHeight = (CSS.LengthValue) attr.getAttribute(CSS.Attribute.HEIGHT); } + /** + * Convenient method to get the StyleSheet. + * + * @return the StyleSheet + */ protected StyleSheet getStyleSheet() { HTMLDocument doc = (HTMLDocument) getDocument(); return doc.getStyleSheet();
--- a/jdk/src/share/classes/javax/swing/text/html/CSS.java Thu Jun 19 16:54:59 2014 +0400 +++ b/jdk/src/share/classes/javax/swing/text/html/CSS.java Thu Jun 19 16:57:14 2014 +0400 @@ -175,144 +175,285 @@ private boolean inherited; + /** + * CSS attribute "background". + */ public static final Attribute BACKGROUND = new Attribute("background", null, false); + /** + * CSS attribute "background-attachment". + */ public static final Attribute BACKGROUND_ATTACHMENT = new Attribute("background-attachment", "scroll", false); + /** + * CSS attribute "background-color". + */ public static final Attribute BACKGROUND_COLOR = new Attribute("background-color", "transparent", false); + /** + * CSS attribute "background-image". + */ public static final Attribute BACKGROUND_IMAGE = new Attribute("background-image", "none", false); + /** + * CSS attribute "background-position". + */ public static final Attribute BACKGROUND_POSITION = new Attribute("background-position", null, false); + /** + * CSS attribute "background-repeat". + */ public static final Attribute BACKGROUND_REPEAT = new Attribute("background-repeat", "repeat", false); + /** + * CSS attribute "border". + */ public static final Attribute BORDER = new Attribute("border", null, false); + /** + * CSS attribute "border-bottom". + */ public static final Attribute BORDER_BOTTOM = new Attribute("border-bottom", null, false); + /** + * CSS attribute "border-bottom-color". + */ public static final Attribute BORDER_BOTTOM_COLOR = new Attribute("border-bottom-color", null, false); + /** + * CSS attribute "border-bottom-style". + */ public static final Attribute BORDER_BOTTOM_STYLE = new Attribute("border-bottom-style", "none", false); + /** + * CSS attribute "border-bottom-width". + */ public static final Attribute BORDER_BOTTOM_WIDTH = new Attribute("border-bottom-width", "medium", false); + /** + * CSS attribute "border-color". + */ public static final Attribute BORDER_COLOR = new Attribute("border-color", null, false); + /** + * CSS attribute "border-left". + */ public static final Attribute BORDER_LEFT = new Attribute("border-left", null, false); + /** + * CSS attribute "margin-right". + */ public static final Attribute BORDER_LEFT_COLOR = new Attribute("border-left-color", null, false); + /** + * CSS attribute "border-left-style". + */ public static final Attribute BORDER_LEFT_STYLE = new Attribute("border-left-style", "none", false); + /** + * CSS attribute "border-left-width". + */ public static final Attribute BORDER_LEFT_WIDTH = new Attribute("border-left-width", "medium", false); + /** + * CSS attribute "border-right". + */ public static final Attribute BORDER_RIGHT = new Attribute("border-right", null, false); + /** + * CSS attribute "border-right-color". + */ public static final Attribute BORDER_RIGHT_COLOR = new Attribute("border-right-color", null, false); + /** + * CSS attribute "border-right-style". + */ public static final Attribute BORDER_RIGHT_STYLE = new Attribute("border-right-style", "none", false); + /** + * CSS attribute "border-right-width". + */ public static final Attribute BORDER_RIGHT_WIDTH = new Attribute("border-right-width", "medium", false); + /** + * CSS attribute "border-style". + */ public static final Attribute BORDER_STYLE = new Attribute("border-style", "none", false); + /** + * CSS attribute "border-top". + */ public static final Attribute BORDER_TOP = new Attribute("border-top", null, false); + /** + * CSS attribute "border-top-color". + */ public static final Attribute BORDER_TOP_COLOR = new Attribute("border-top-color", null, false); + /** + * CSS attribute "border-top-style". + */ public static final Attribute BORDER_TOP_STYLE = new Attribute("border-top-style", "none", false); + /** + * CSS attribute "border-top-width". + */ public static final Attribute BORDER_TOP_WIDTH = new Attribute("border-top-width", "medium", false); + /** + * CSS attribute "border-width". + */ public static final Attribute BORDER_WIDTH = new Attribute("border-width", "medium", false); + /** + * CSS attribute "clear". + */ public static final Attribute CLEAR = new Attribute("clear", "none", false); + /** + * CSS attribute "color". + */ public static final Attribute COLOR = new Attribute("color", "black", true); + /** + * CSS attribute "display". + */ public static final Attribute DISPLAY = new Attribute("display", "block", false); + /** + * CSS attribute "float". + */ public static final Attribute FLOAT = new Attribute("float", "none", false); + /** + * CSS attribute "font". + */ public static final Attribute FONT = new Attribute("font", null, true); + /** + * CSS attribute "font-family". + */ public static final Attribute FONT_FAMILY = new Attribute("font-family", null, true); + /** + * CSS attribute "font-size". + */ public static final Attribute FONT_SIZE = new Attribute("font-size", "medium", true); + /** + * CSS attribute "font-style". + */ public static final Attribute FONT_STYLE = new Attribute("font-style", "normal", true); + /** + * CSS attribute "font-variant". + */ public static final Attribute FONT_VARIANT = new Attribute("font-variant", "normal", true); + /** + * CSS attribute "font-weight". + */ public static final Attribute FONT_WEIGHT = new Attribute("font-weight", "normal", true); + /** + * CSS attribute "height". + */ public static final Attribute HEIGHT = new Attribute("height", "auto", false); + /** + * CSS attribute "letter-spacing". + */ public static final Attribute LETTER_SPACING = new Attribute("letter-spacing", "normal", true); + /** + * CSS attribute "line-height". + */ public static final Attribute LINE_HEIGHT = new Attribute("line-height", "normal", true); + /** + * CSS attribute "list-style". + */ public static final Attribute LIST_STYLE = new Attribute("list-style", null, true); + /** + * CSS attribute "list-style-image". + */ public static final Attribute LIST_STYLE_IMAGE = new Attribute("list-style-image", "none", true); + /** + * CSS attribute "list-style-position". + */ public static final Attribute LIST_STYLE_POSITION = new Attribute("list-style-position", "outside", true); + /** + * CSS attribute "list-style-type". + */ public static final Attribute LIST_STYLE_TYPE = new Attribute("list-style-type", "disc", true); + /** + * CSS attribute "margin". + */ public static final Attribute MARGIN = new Attribute("margin", null, false); + /** + * CSS attribute "margin-bottom". + */ public static final Attribute MARGIN_BOTTOM = new Attribute("margin-bottom", "0", false); + /** + * CSS attribute "margin-left". + */ public static final Attribute MARGIN_LEFT = new Attribute("margin-left", "0", false); + /** + * CSS attribute "margin-right". + */ public static final Attribute MARGIN_RIGHT = new Attribute("margin-right", "0", false); @@ -338,45 +479,87 @@ Integer.toString(Integer.MIN_VALUE), false); + /** + * CSS attribute "margin-top". + */ public static final Attribute MARGIN_TOP = new Attribute("margin-top", "0", false); + /** + * CSS attribute "padding". + */ public static final Attribute PADDING = new Attribute("padding", null, false); + /** + * CSS attribute "padding-bottom". + */ public static final Attribute PADDING_BOTTOM = new Attribute("padding-bottom", "0", false); + /** + * CSS attribute "padding-left". + */ public static final Attribute PADDING_LEFT = new Attribute("padding-left", "0", false); + /** + * CSS attribute "padding-right". + */ public static final Attribute PADDING_RIGHT = new Attribute("padding-right", "0", false); + /** + * CSS attribute "padding-top". + */ public static final Attribute PADDING_TOP = new Attribute("padding-top", "0", false); + /** + * CSS attribute "text-align". + */ public static final Attribute TEXT_ALIGN = new Attribute("text-align", null, true); + /** + * CSS attribute "text-decoration". + */ public static final Attribute TEXT_DECORATION = new Attribute("text-decoration", "none", true); + /** + * CSS attribute "text-indent". + */ public static final Attribute TEXT_INDENT = new Attribute("text-indent", "0", true); + /** + * CSS attribute "text-transform". + */ public static final Attribute TEXT_TRANSFORM = new Attribute("text-transform", "none", true); + /** + * CSS attribute "vertical-align". + */ public static final Attribute VERTICAL_ALIGN = new Attribute("vertical-align", "baseline", false); + /** + * CSS attribute "word-spacing". + */ public static final Attribute WORD_SPACING = new Attribute("word-spacing", "normal", true); + /** + * CSS attribute "white-space". + */ public static final Attribute WHITE_SPACE = new Attribute("white-space", "normal", true); + /** + * CSS attribute "width". + */ public static final Attribute WIDTH = new Attribute("width", "auto", false); @@ -480,6 +663,9 @@ }; } + /** + * Constructs a CSS object. + */ public CSS() { baseFontSize = baseFontSizeIndex + 1; // setup the css conversion table
--- a/jdk/src/share/classes/javax/swing/text/html/FormSubmitEvent.java Thu Jun 19 16:54:59 2014 +0400 +++ b/jdk/src/share/classes/javax/swing/text/html/FormSubmitEvent.java Thu Jun 19 16:57:14 2014 +0400 @@ -40,19 +40,30 @@ /** * Represents an HTML form method type. * <UL> - * <LI><code>GET</code> corresponds to the GET form method</LI> - * <LI><code>POST</code> corresponds to the POST from method</LI> + * <LI>{@code GET} corresponds to the GET form method</LI> + * <LI>{@code POST} corresponds to the POST from method</LI> * </UL> * @since 1.5 */ - public enum MethodType { GET, POST }; + public enum MethodType { + + /** + * {@code GET} corresponds to the GET form method + */ + GET, + + /** + * {@code POST} corresponds to the POST from method + */ + POST + } /** * Creates a new object representing an html form submit event. * * @param source the object responsible for the event * @param type the event type - * @param actionURL the form action URL + * @param targetURL the form action URL * @param sourceElement the element that corresponds to the source * of the event * @param targetFrame the Frame to display the document in
--- a/jdk/src/share/classes/javax/swing/text/html/HTML.java Thu Jun 19 16:54:59 2014 +0400 +++ b/jdk/src/share/classes/javax/swing/text/html/HTML.java Thu Jun 19 16:57:14 2014 +0400 @@ -156,79 +156,369 @@ // --- Tag Names ----------------------------------- + /** + * Tag <a> + */ public static final Tag A = new Tag("a"); + + /** + * Tag <address> + */ public static final Tag ADDRESS = new Tag("address"); + /** + * Tag <applet> + */ public static final Tag APPLET = new Tag("applet"); + + /** + * Tag <area> + */ public static final Tag AREA = new Tag("area"); + + /** + * Tag <b> + */ public static final Tag B = new Tag("b"); + + /** + * Tag <base> + */ public static final Tag BASE = new Tag("base"); + + /** + * Tag <basefont> + */ public static final Tag BASEFONT = new Tag("basefont"); + + /** + * Tag <big> + */ public static final Tag BIG = new Tag("big"); + + /** + * Tag <blockquote> + */ public static final Tag BLOCKQUOTE = new Tag("blockquote", true, true); + + /** + * Tag <body> + */ public static final Tag BODY = new Tag("body", true, true); + + /** + * Tag <br> + */ public static final Tag BR = new Tag("br", true, false); + + /** + * Tag <caption> + */ public static final Tag CAPTION = new Tag("caption"); + + /** + * Tag <center> + */ public static final Tag CENTER = new Tag("center", true, false); + + /** + * Tag <cite> + */ public static final Tag CITE = new Tag("cite"); + + /** + * Tag <code> + */ public static final Tag CODE = new Tag("code"); + + /** + * Tag <dd> + */ public static final Tag DD = new Tag("dd", true, true); + + /** + * Tag <dfn> + */ public static final Tag DFN = new Tag("dfn"); + + /** + * Tag <dir> + */ public static final Tag DIR = new Tag("dir", true, true); + + /** + * Tag <div> + */ public static final Tag DIV = new Tag("div", true, true); + + /** + * Tag <dl> + */ public static final Tag DL = new Tag("dl", true, true); + + /** + * Tag <dt> + */ public static final Tag DT = new Tag("dt", true, true); + + /** + * Tag <em> + */ public static final Tag EM = new Tag("em"); + + /** + * Tag <font> + */ public static final Tag FONT = new Tag("font"); + + /** + * Tag <form> + */ public static final Tag FORM = new Tag("form", true, false); + + /** + * Tag <frame> + */ public static final Tag FRAME = new Tag("frame"); + + /** + * Tag <frameset> + */ public static final Tag FRAMESET = new Tag("frameset"); + + /** + * Tag <h1> + */ public static final Tag H1 = new Tag("h1", true, true); + + /** + * Tag <h2> + */ public static final Tag H2 = new Tag("h2", true, true); + + /** + * Tag <h3> + */ public static final Tag H3 = new Tag("h3", true, true); + + /** + * Tag <h4> + */ public static final Tag H4 = new Tag("h4", true, true); + + /** + * Tag <h5> + */ public static final Tag H5 = new Tag("h5", true, true); + + /** + * Tag <h6> + */ public static final Tag H6 = new Tag("h6", true, true); + + /** + * Tag <head> + */ public static final Tag HEAD = new Tag("head", true, true); + + /** + * Tag <hr> + */ public static final Tag HR = new Tag("hr", true, false); + + /** + * Tag <html> + */ public static final Tag HTML = new Tag("html", true, false); + + /** + * Tag <i> + */ public static final Tag I = new Tag("i"); + + /** + * Tag <img> + */ public static final Tag IMG = new Tag("img"); + + /** + * Tag <input> + */ public static final Tag INPUT = new Tag("input"); + + /** + * Tag <isindex> + */ public static final Tag ISINDEX = new Tag("isindex", true, false); + + /** + * Tag <kbd> + */ public static final Tag KBD = new Tag("kbd"); + + /** + * Tag <li> + */ public static final Tag LI = new Tag("li", true, true); + + /** + * Tag <link> + */ public static final Tag LINK = new Tag("link"); + + /** + * Tag <map> + */ public static final Tag MAP = new Tag("map"); + + /** + * Tag <menu> + */ public static final Tag MENU = new Tag("menu", true, true); + + /** + * Tag <meta> + */ public static final Tag META = new Tag("meta"); /*public*/ static final Tag NOBR = new Tag("nobr"); + + /** + * Tag <noframes> + */ public static final Tag NOFRAMES = new Tag("noframes", true, true); + + /** + * Tag <object> + */ public static final Tag OBJECT = new Tag("object"); + + /** + * Tag <ol> + */ public static final Tag OL = new Tag("ol", true, true); + + /** + * Tag <option> + */ public static final Tag OPTION = new Tag("option"); + + /** + * Tag <p> + */ public static final Tag P = new Tag("p", true, true); + + /** + * Tag <param> + */ public static final Tag PARAM = new Tag("param"); + + /** + * Tag <pre> + */ public static final Tag PRE = new Tag("pre", true, true); + + /** + * Tag <samp> + */ public static final Tag SAMP = new Tag("samp"); + + /** + * Tag <script> + */ public static final Tag SCRIPT = new Tag("script"); + + /** + * Tag <select> + */ public static final Tag SELECT = new Tag("select"); + + /** + * Tag <small> + */ public static final Tag SMALL = new Tag("small"); + + /** + * Tag <span> + */ public static final Tag SPAN = new Tag("span"); + + /** + * Tag <strike> + */ public static final Tag STRIKE = new Tag("strike"); + + /** + * Tag <s> + */ public static final Tag S = new Tag("s"); + + /** + * Tag <strong> + */ public static final Tag STRONG = new Tag("strong"); + + /** + * Tag <style> + */ public static final Tag STYLE = new Tag("style"); + + /** + * Tag <sub> + */ public static final Tag SUB = new Tag("sub"); + + /** + * Tag <sup> + */ public static final Tag SUP = new Tag("sup"); + + /** + * Tag <table> + */ public static final Tag TABLE = new Tag("table", false, true); + + /** + * Tag <td> + */ public static final Tag TD = new Tag("td", true, true); + + /** + * Tag <textarea> + */ public static final Tag TEXTAREA = new Tag("textarea"); + + /** + * Tag <th> + */ public static final Tag TH = new Tag("th", true, true); + + /** + * Tag <title> + */ public static final Tag TITLE = new Tag("title", true, true); + + /** + * Tag <tr> + */ public static final Tag TR = new Tag("tr", false, true); + + /** + * Tag <tt> + */ public static final Tag TT = new Tag("tt"); + + /** + * Tag <u> + */ public static final Tag U = new Tag("u"); + + /** + * Tag <ul> + */ public static final Tag UL = new Tag("ul", true, true); + + /** + * Tag <var> + */ public static final Tag VAR = new Tag("var"); /** @@ -281,6 +571,9 @@ } } + /** + * Class represents unknown HTML tag. + */ // There is no unique instance of UnknownTag, so we allow it to be // Serializable. @SuppressWarnings("serial") // Same-version serialization only @@ -365,85 +658,405 @@ private String name; + + /** + * Attribute "size" + */ public static final Attribute SIZE = new Attribute("size"); + + /** + * Attribute "color" + */ public static final Attribute COLOR = new Attribute("color"); + + /** + * Attribute "clear" + */ public static final Attribute CLEAR = new Attribute("clear"); + + /** + * Attribute "background" + */ public static final Attribute BACKGROUND = new Attribute("background"); + + /** + * Attribute "bgcolor" + */ public static final Attribute BGCOLOR = new Attribute("bgcolor"); + + /** + * Attribute "text" + */ public static final Attribute TEXT = new Attribute("text"); + + /** + * Attribute "link" + */ public static final Attribute LINK = new Attribute("link"); + + /** + * Attribute "vlink" + */ public static final Attribute VLINK = new Attribute("vlink"); + + /** + * Attribute "alink" + */ public static final Attribute ALINK = new Attribute("alink"); + + /** + * Attribute "width" + */ public static final Attribute WIDTH = new Attribute("width"); + + /** + * Attribute "height" + */ public static final Attribute HEIGHT = new Attribute("height"); + + /** + * Attribute "align" + */ public static final Attribute ALIGN = new Attribute("align"); + + /** + * Attribute "name" + */ public static final Attribute NAME = new Attribute("name"); + + /** + * Attribute "href" + */ public static final Attribute HREF = new Attribute("href"); + + /** + * Attribute "rel" + */ public static final Attribute REL = new Attribute("rel"); + + /** + * Attribute "rev" + */ public static final Attribute REV = new Attribute("rev"); + + /** + * Attribute "title" + */ public static final Attribute TITLE = new Attribute("title"); + + /** + * Attribute "target" + */ public static final Attribute TARGET = new Attribute("target"); + + /** + * Attribute "shape" + */ public static final Attribute SHAPE = new Attribute("shape"); + + /** + * Attribute "coords" + */ public static final Attribute COORDS = new Attribute("coords"); + + /** + * Attribute "ismap" + */ public static final Attribute ISMAP = new Attribute("ismap"); + + /** + * Attribute "nohref" + */ public static final Attribute NOHREF = new Attribute("nohref"); + + /** + * Attribute "alt" + */ public static final Attribute ALT = new Attribute("alt"); + + /** + * Attribute "id" + */ public static final Attribute ID = new Attribute("id"); + + /** + * Attribute "src" + */ public static final Attribute SRC = new Attribute("src"); + + /** + * Attribute "hspace" + */ public static final Attribute HSPACE = new Attribute("hspace"); + + /** + * Attribute "vspace" + */ public static final Attribute VSPACE = new Attribute("vspace"); + + /** + * Attribute "usemap" + */ public static final Attribute USEMAP = new Attribute("usemap"); + + /** + * Attribute "lowsrc" + */ public static final Attribute LOWSRC = new Attribute("lowsrc"); + + /** + * Attribute "codebase" + */ public static final Attribute CODEBASE = new Attribute("codebase"); + + /** + * Attribute "code" + */ public static final Attribute CODE = new Attribute("code"); + + /** + * Attribute "archive" + */ public static final Attribute ARCHIVE = new Attribute("archive"); + + /** + * Attribute "value" + */ public static final Attribute VALUE = new Attribute("value"); + + /** + * Attribute "valuetype" + */ public static final Attribute VALUETYPE = new Attribute("valuetype"); + + /** + * Attribute "type" + */ public static final Attribute TYPE = new Attribute("type"); + + /** + * Attribute "class" + */ public static final Attribute CLASS = new Attribute("class"); + + /** + * Attribute "style" + */ public static final Attribute STYLE = new Attribute("style"); + + /** + * Attribute "lang" + */ public static final Attribute LANG = new Attribute("lang"); + + /** + * Attribute "face" + */ public static final Attribute FACE = new Attribute("face"); + + /** + * Attribute "dir" + */ public static final Attribute DIR = new Attribute("dir"); + + /** + * Attribute "declare" + */ public static final Attribute DECLARE = new Attribute("declare"); + + /** + * Attribute "classid" + */ public static final Attribute CLASSID = new Attribute("classid"); + + /** + * Attribute "data" + */ public static final Attribute DATA = new Attribute("data"); + + /** + * Attribute "codetype" + */ public static final Attribute CODETYPE = new Attribute("codetype"); + + /** + * Attribute "standby" + */ public static final Attribute STANDBY = new Attribute("standby"); + + /** + * Attribute "border" + */ public static final Attribute BORDER = new Attribute("border"); + + /** + * Attribute "shapes" + */ public static final Attribute SHAPES = new Attribute("shapes"); + + /** + * Attribute "noshade" + */ public static final Attribute NOSHADE = new Attribute("noshade"); + + /** + * Attribute "compact" + */ public static final Attribute COMPACT = new Attribute("compact"); + + /** + * Attribute "start" + */ public static final Attribute START = new Attribute("start"); + + /** + * Attribute "action" + */ public static final Attribute ACTION = new Attribute("action"); + + /** + * Attribute "method" + */ public static final Attribute METHOD = new Attribute("method"); + + /** + * Attribute "enctype" + */ public static final Attribute ENCTYPE = new Attribute("enctype"); + + /** + * Attribute "checked" + */ public static final Attribute CHECKED = new Attribute("checked"); + + /** + * Attribute "maxlength" + */ public static final Attribute MAXLENGTH = new Attribute("maxlength"); + + /** + * Attribute "multiple" + */ public static final Attribute MULTIPLE = new Attribute("multiple"); + + /** + * Attribute "selected" + */ public static final Attribute SELECTED = new Attribute("selected"); + + /** + * Attribute "rows" + */ public static final Attribute ROWS = new Attribute("rows"); + + /** + * Attribute "cols" + */ public static final Attribute COLS = new Attribute("cols"); + + /** + * Attribute "dummy" + */ public static final Attribute DUMMY = new Attribute("dummy"); + + /** + * Attribute "cellspacing" + */ public static final Attribute CELLSPACING = new Attribute("cellspacing"); + + /** + * Attribute "cellpadding" + */ public static final Attribute CELLPADDING = new Attribute("cellpadding"); + + /** + * Attribute "valign" + */ public static final Attribute VALIGN = new Attribute("valign"); + + /** + * Attribute "halign" + */ public static final Attribute HALIGN = new Attribute("halign"); + + /** + * Attribute "nowrap" + */ public static final Attribute NOWRAP = new Attribute("nowrap"); + + /** + * Attribute "rowspan" + */ public static final Attribute ROWSPAN = new Attribute("rowspan"); + + /** + * Attribute "colspan" + */ public static final Attribute COLSPAN = new Attribute("colspan"); + + /** + * Attribute "prompt" + */ public static final Attribute PROMPT = new Attribute("prompt"); + + /** + * Attribute "http-equiv" + */ public static final Attribute HTTPEQUIV = new Attribute("http-equiv"); + + /** + * Attribute "content" + */ public static final Attribute CONTENT = new Attribute("content"); + + /** + * Attribute "language" + */ public static final Attribute LANGUAGE = new Attribute("language"); + + /** + * Attribute "version" + */ public static final Attribute VERSION = new Attribute("version"); + + /** + * Attribute "n" + */ public static final Attribute N = new Attribute("n"); + + /** + * Attribute "frameborder" + */ public static final Attribute FRAMEBORDER = new Attribute("frameborder"); + + /** + * Attribute "marginwidth" + */ public static final Attribute MARGINWIDTH = new Attribute("marginwidth"); + + /** + * Attribute "marginheight" + */ public static final Attribute MARGINHEIGHT = new Attribute("marginheight"); + + /** + * Attribute "scrolling" + */ public static final Attribute SCROLLING = new Attribute("scrolling"); + + /** + * Attribute "noresize" + */ public static final Attribute NORESIZE = new Attribute("noresize"); + + /** + * Attribute "endtag" + */ public static final Attribute ENDTAG = new Attribute("endtag"); + + /** + * Attribute "comment" + */ public static final Attribute COMMENT = new Attribute("comment"); static final Attribute MEDIA = new Attribute("media"); @@ -645,9 +1258,10 @@ return value; } - // This is used in cases where the value for the attribute has not - // been specified. - // + /** + * {@code NULL_ATTRIBUTE_VALUE} used in cases where the value for the attribute has not + * been specified. + */ public static final String NULL_ATTRIBUTE_VALUE = "#DEFAULT"; // size determined similar to size of tagHashtable
--- a/jdk/src/share/classes/javax/swing/text/html/HTMLDocument.java Thu Jun 19 16:54:59 2014 +0400 +++ b/jdk/src/share/classes/javax/swing/text/html/HTMLDocument.java Thu Jun 19 16:57:14 2014 +0400 @@ -2888,6 +2888,9 @@ } + /** + * Action assigned by default to handle the Isindex task of the reader. + */ public class IsindexAction extends TagAction { public void start(HTML.Tag t, MutableAttributeSet a) { @@ -3128,7 +3131,9 @@ } } - + /** + * Action assigned by default to handle the Pre block task of the reader. + */ public class PreAction extends BlockAction { public void start(HTML.Tag t, MutableAttributeSet attr) {
--- a/jdk/src/share/classes/javax/swing/text/html/HTMLEditorKit.java Thu Jun 19 16:54:59 2014 +0400 +++ b/jdk/src/share/classes/javax/swing/text/html/HTMLEditorKit.java Thu Jun 19 16:57:14 2014 +0400 @@ -238,7 +238,7 @@ * be thrown. When inserting into a non-empty document all tags outside * of the body (head, title) will be dropped. * - * @param in the stream to read from + * @param in the stream to read from * @param doc the destination for the insertion * @param pos the location in the document to place the * content @@ -269,14 +269,18 @@ /** * Inserts HTML into an existing document. * - * @param doc the document to insert into - * @param offset the offset to insert HTML at - * @param popDepth the number of ElementSpec.EndTagTypes to generate before - * inserting + * @param doc the document to insert into + * @param offset the offset to insert HTML at + * @param popDepth the number of ElementSpec.EndTagTypes to generate + * before inserting + * @param html the HTML string * @param pushDepth the number of ElementSpec.StartTagTypes with a direction - * of ElementSpec.JoinNextDirection that should be generated - * before inserting, but after the end tags have been generated + * of ElementSpec.JoinNextDirection that should be generated + * before inserting, but after the end tags have been generated * @param insertTag the first tag to start inserting into document + * + * @throws BadLocationException if {@code offset} is invalid + * @throws IOException on I/O error * @exception RuntimeException (will eventually be a BadLocationException) * if pos is invalid */ @@ -302,13 +306,13 @@ * Write content from a document to the given stream * in a format appropriate for this kind of content handler. * - * @param out the stream to write to - * @param doc the source for the write - * @param pos the location in the document to fetch the + * @param out the stream to write to + * @param doc the source for the write + * @param pos the location in the document to fetch the * content - * @param len the amount to write out + * @param len the amount to write out * @exception IOException on any I/O error - * @exception BadLocationException if pos represents an invalid + * @exception BadLocationException if {@code pos} represents an invalid * location within the document */ public void write(Writer out, Document doc, int pos, int len) @@ -369,6 +373,8 @@ * specified is shared by all HTMLEditorKit instances. * This should be reimplemented to provide a finer granularity * if desired. + * + * @param s a StyleSheet */ public void setStyleSheet(StyleSheet s) { if (s == null) { @@ -383,6 +389,8 @@ * HTML elements. By default the resource specified by * DEFAULT_CSS gets loaded, and is shared by all HTMLEditorKit * instances. + * + * @return the StyleSheet */ public StyleSheet getStyleSheet() { AppContext appContext = AppContext.getAppContext(); @@ -412,7 +420,7 @@ * to function when used in an applet. * * @param name the name of the resource, relative to the - * HTMLEditorKit class + * HTMLEditorKit class * @return a stream representing the resource */ static InputStream getResourceAsStream(final String name) { @@ -506,6 +514,8 @@ /** * Sets the default cursor. * + * @param cursor a cursor + * * @since 1.3 */ public void setDefaultCursor(Cursor cursor) { @@ -515,6 +525,8 @@ /** * Returns the default cursor. * + * @return the cursor + * * @since 1.3 */ public Cursor getDefaultCursor() { @@ -524,6 +536,8 @@ /** * Sets the cursor to use over links. * + * @param cursor a cursor + * * @since 1.3 */ public void setLinkCursor(Cursor cursor) { @@ -532,6 +546,9 @@ /** * Returns the cursor to use over hyper links. + * + * @return the cursor + * * @since 1.3 */ public Cursor getLinkCursor() { @@ -557,6 +574,8 @@ * automatically or only <code>FormSubmitEvent</code> is fired. * By default it is set to true. * + * @param isAuto if {@code true}, html form submission is processed automatically. + * * @see #isAutoFormSubmission() * @see FormSubmitEvent * @since 1.5 @@ -586,6 +605,8 @@ * to avoid the overhead of loading the default parser if * it's not used. The default parser is the HotJava parser * using an HTML 3.2 DTD. + * + * @return the parser */ protected Parser getParser() { if (defaultParser == null) { @@ -972,6 +993,9 @@ * with the results of the parse. This method should * be implemented to be thread-safe. * + * @param r a reader + * @param cb a parser callback + * @param ignoreCharSet if {@code true} charset is ignoring * @throws IOException if an I/O exception occurs */ public abstract void parse(Reader r, ParserCallback cb, boolean ignoreCharSet) throws IOException; @@ -1000,26 +1024,78 @@ */ public static final Object IMPLIED = "_implied_"; - + /** + * The last method called on the reader. It allows + * any pending changes to be flushed into the document. + * Since this is currently loading synchronously, the entire + * set of changes are pushed in at this point. + * + * @throws BadLocationException if the given position does not + * represent a valid location in the associated document. + */ public void flush() throws BadLocationException { } + /** + * Called by the parser to indicate a block of text was + * encountered. + * + * @param data a data + * @param pos a position + */ public void handleText(char[] data, int pos) { } + /** + * Called by the parser to indicate a block of comment was + * encountered. + * + * @param data a data + * @param pos a position + */ public void handleComment(char[] data, int pos) { } + /** + * Callback from the parser. Route to the appropriate + * handler for the tag. + * + * @param t an HTML tag + * @param a a set of attributes + * @param pos a position + */ public void handleStartTag(HTML.Tag t, MutableAttributeSet a, int pos) { } + /** + * Callback from the parser. Route to the appropriate + * handler for the tag. + * + * @param t an HTML tag + * @param pos a position + */ public void handleEndTag(HTML.Tag t, int pos) { } + /** + * Callback from the parser. Route to the appropriate + * handler for the tag. + * + * @param t an HTML tag + * @param a a set of attributes + * @param pos a position + */ public void handleSimpleTag(HTML.Tag t, MutableAttributeSet a, int pos) { } - public void handleError(String errorMsg, int pos){ + /** + * Callback from the parser. Route to the appropriate + * handler for the error. + * + * @param errorMsg a error message + * @param pos a position + */ + public void handleError(String errorMsg, int pos) { } /** @@ -1489,6 +1565,12 @@ */ @SuppressWarnings("serial") // Superclass is not serializable across versions public static abstract class HTMLTextAction extends StyledTextAction { + + /** + * Creates a new HTMLTextAction from a string action name. + * + * @param name the name of the action + */ public HTMLTextAction(String name) { super(name); } @@ -1575,6 +1657,12 @@ /** * Returns the deepest element at <code>offset</code> matching * <code>tag</code>. + * + * @param doc an instance of HTMLDocument + * @param offset the specified offset >= 0 + * @param tag an instance of HTML.Tag + * + * @return the deepest element */ protected Element findElementMatchingTag(HTMLDocument doc, int offset, HTML.Tag tag) { @@ -1611,11 +1699,30 @@ */ @SuppressWarnings("serial") // Superclass is not serializable across versions public static class InsertHTMLTextAction extends HTMLTextAction { + + /** + * Creates a new InsertHTMLTextAction. + * + * @param name a name of the action + * @param html an HTML string + * @param parentTag a parent tag + * @param addTag the first tag to start inserting into document + */ public InsertHTMLTextAction(String name, String html, HTML.Tag parentTag, HTML.Tag addTag) { this(name, html, parentTag, addTag, null, null); } + /** + * Creates a new InsertHTMLTextAction. + * + * @param name a name of the action + * @param html an HTML string + * @param parentTag a parent tag + * @param addTag the first tag to start inserting into document + * @param alternateParentTag an alternative parent tag + * @param alternateAddTag an alternative tag + */ public InsertHTMLTextAction(String name, String html, HTML.Tag parentTag, HTML.Tag addTag, @@ -1644,6 +1751,17 @@ /** * A cover for HTMLEditorKit.insertHTML. If an exception it * thrown it is wrapped in a RuntimeException and thrown. + * + * @param editor an instance of JEditorPane + * @param doc the document to insert into + * @param offset the offset to insert HTML at + * @param html an HTML string + * @param popDepth the number of ElementSpec.EndTagTypes to generate + * before inserting + * @param pushDepth the number of ElementSpec.StartTagTypes with a direction + * of ElementSpec.JoinNextDirection that should be generated + * before inserting, but after the end tags have been generated + * @param addTag the first tag to start inserting into document */ protected void insertHTML(JEditorPane editor, HTMLDocument doc, int offset, String html, int popDepth, @@ -1663,7 +1781,17 @@ * This is invoked when inserting at a boundary. It determines * the number of pops, and then the number of pushes that need * to be performed, and then invokes insertHTML. + * + * @param editor an instance of JEditorPane + * @param doc an instance of HTMLDocument + * @param offset an offset to start from + * @param insertElement an instance of Element + * @param html an HTML string + * @param parentTag a parent tag + * @param addTag the first tag to start inserting into document + * * @since 1.3 + * */ protected void insertAtBoundary(JEditorPane editor, HTMLDocument doc, int offset, Element insertElement, @@ -1678,6 +1806,14 @@ * the number of pops, and then the number of pushes that need * to be performed, and then invokes insertHTML. * @deprecated As of Java 2 platform v1.3, use insertAtBoundary + * + * @param editor an instance of JEditorPane + * @param doc an instance of HTMLDocument + * @param offset an offset to start from + * @param insertElement an instance of Element + * @param html an HTML string + * @param parentTag a parent tag + * @param addTag the first tag to start inserting into document */ @Deprecated protected void insertAtBoundry(JEditorPane editor, HTMLDocument doc, @@ -2050,7 +2186,7 @@ * @param offs0 the starting model offset ≥ 0 * @param offs1 the ending model offset ≥ offs1 * @param bounds the bounding box of the view, which is not - * necessarily the region to paint. + * necessarily the region to paint. * @param c the editor * @param view View painting for * @return region in which drawing occurred
--- a/jdk/src/share/classes/javax/swing/text/html/HTMLWriter.java Thu Jun 19 16:54:59 2014 +0400 +++ b/jdk/src/share/classes/javax/swing/text/html/HTMLWriter.java Thu Jun 19 16:57:14 2014 +0400 @@ -361,8 +361,10 @@ * Writes out a start tag for the element. * Ignores all synthesized elements. * - * @param elem an Element - * @exception IOException on any I/O error + * @param elem an Element + * @throws IOException on any I/O error + * @throws BadLocationException if pos represents an invalid + * location within the document. */ protected void startTag(Element elem) throws IOException, BadLocationException { @@ -667,9 +669,12 @@ /** - * Returns true if the element is a + * Returns {@code true} if the element is a * synthesized element. Currently we are only testing * for the p-implied tag. + * + * @param elem an element + * @return {@code true} if the element is a synthesized element. */ protected boolean synthesizedElement(Element elem) { if (matchNameAttribute(elem.getAttributes(), HTML.Tag.IMPLIED)) { @@ -682,6 +687,10 @@ /** * Returns true if the StyleConstants.NameAttribute is * equal to the tag that is passed in as a parameter. + * + * @param attr a set of attributes + * @param tag an HTML tag + * @return {@code true} if the StyleConstants.NameAttribute is equal to the tag that is passed in as a parameter. */ protected boolean matchNameAttribute(AttributeSet attr, HTML.Tag tag) { Object o = attr.getAttribute(StyleConstants.NameAttribute); @@ -700,6 +709,7 @@ * so that when appropriate the corresponding end tags can be * written out. * + * @param attr a set of attributes * @exception IOException on any I/O error */ protected void writeEmbeddedTags(AttributeSet attr) throws IOException { @@ -754,6 +764,7 @@ * then the tag is removed from the vector and a corresponding * end tag is written out. * + * @param attr a set of attributes * @exception IOException on any I/O error */ protected void closeOutUnwantedEmbeddedTags(AttributeSet attr) throws IOException {
--- a/jdk/src/share/classes/javax/swing/text/html/ImageView.java Thu Jun 19 16:54:59 2014 +0400 +++ b/jdk/src/share/classes/javax/swing/text/html/ImageView.java Thu Jun 19 16:57:14 2014 +0400 @@ -141,9 +141,11 @@ } /** - * Returns the text to display if the image can't be loaded. This is + * Returns the text to display if the image cannot be loaded. This is * obtained from the Elements attribute set with the attribute name * <code>HTML.Attribute.ALT</code>. + * + * @return the test to display if the image cannot be loaded. */ public String getAltText() { return (String)getElement().getAttributes().getAttribute @@ -153,6 +155,8 @@ /** * Return a URL for the image source, * or null if it could not be determined. + * + * @return the URL for the image source, or null if it could not be determined. */ public URL getImageURL() { String src = (String)getElement().getAttributes(). @@ -171,7 +175,9 @@ } /** - * Returns the icon to use if the image couldn't be found. + * Returns the icon to use if the image could not be found. + * + * @return the icon to use if the image could not be found. */ public Icon getNoImageIcon() { return (Icon) UIManager.getLookAndFeelDefaults().get(MISSING_IMAGE); @@ -179,6 +185,8 @@ /** * Returns the icon to use while in the process of loading the image. + * + * @return the icon to use while in the process of loading the image. */ public Icon getLoadingImageIcon() { return (Icon) UIManager.getLookAndFeelDefaults().get(PENDING_IMAGE); @@ -186,6 +194,8 @@ /** * Returns the image to render. + * + * @return the image to render. */ public Image getImage() { sync(); @@ -205,9 +215,12 @@ /** * Sets how the image is loaded. If <code>newValue</code> is true, - * the image we be loaded when first asked for, otherwise it will + * the image will be loaded when first asked for, otherwise it will * be loaded asynchronously. The default is to not load synchronously, * that is to load the image asynchronously. + * + * @param newValue if {@code true} the image will be loaded when first asked for, + * otherwise it will be asynchronously. */ public void setLoadsSynchronously(boolean newValue) { synchronized(this) { @@ -221,14 +234,18 @@ } /** - * Returns true if the image should be loaded when first asked for. + * Returns {@code true} if the image should be loaded when first asked for. + * + * @return {@code true} if the image should be loaded when first asked for. */ public boolean getLoadsSynchronously() { return ((state & SYNC_LOAD_FLAG) != 0); } /** - * Convenience method to get the StyleSheet. + * Convenient method to get the StyleSheet. + * + * @return the StyleSheet */ protected StyleSheet getStyleSheet() { HTMLDocument doc = (HTMLDocument) getDocument(); @@ -613,7 +630,7 @@ } /** - * Convenience method for getting an integer attribute from the elements + * Convenient method for getting an integer attribute from the elements * AttributeSet. */ private int getIntAttr(HTML.Attribute name, int deflt) {
--- a/jdk/src/share/classes/javax/swing/text/html/InlineView.java Thu Jun 19 16:54:59 2014 +0400 +++ b/jdk/src/share/classes/javax/swing/text/html/InlineView.java Thu Jun 19 16:57:14 2014 +0400 @@ -214,7 +214,11 @@ } } - + /** + * Convenient method to get the StyleSheet. + * + * @return the StyleSheet + */ protected StyleSheet getStyleSheet() { HTMLDocument doc = (HTMLDocument) getDocument(); return doc.getStyleSheet();
--- a/jdk/src/share/classes/javax/swing/text/html/MinimalHTMLWriter.java Thu Jun 19 16:54:59 2014 +0400 +++ b/jdk/src/share/classes/javax/swing/text/html/MinimalHTMLWriter.java Thu Jun 19 16:57:14 2014 +0400 @@ -195,6 +195,7 @@ * Writes out a start tag appropriately * indented. Also increments the indent level. * + * @param tag a start tag * @exception IOException on any I/O error */ protected void writeStartTag(String tag) throws IOException { @@ -209,6 +210,7 @@ * Writes out an end tag appropriately * indented. Also decrements the indent level. * + * @param endTag an end tag * @exception IOException on any I/O error */ protected void writeEndTag(String endTag) throws IOException { @@ -284,7 +286,9 @@ * branch elements or leaf elements. This method specially handles * leaf elements that are text. * - * @exception IOException on any I/O error + * @throws IOException on any I/O error + * @throws BadLocationException if we are in an invalid + * location within the document. */ protected void writeBody() throws IOException, BadLocationException { ElementIterator it = getElementIterator(); @@ -354,6 +358,7 @@ * <p> tag and sets its value to be the name of the * style. * + * @param elem an element * @exception IOException on any I/O error */ protected void writeStartParagraph(Element elem) throws IOException { @@ -371,6 +376,7 @@ * Responsible for writing out other non-text leaf * elements. * + * @param elem an element * @exception IOException on any I/O error */ protected void writeLeaf(Element elem) throws IOException { @@ -392,7 +398,8 @@ * In certain cases it could be a URL, in others it could * be read from a stream. * - * @param elem element of type StyleConstants.IconElementName + * @param elem an element of type StyleConstants.IconElementName + * @throws IOException if I/O error occured. */ protected void writeImage(Element elem) throws IOException { } @@ -402,6 +409,9 @@ * Responsible for handling Component Elements; * deliberately unimplemented. * How this method is implemented is a matter of policy. + * + * @param elem an element of type StyleConstants.ComponentElementName + * @throws IOException if I/O error occured. */ protected void writeComponent(Element elem) throws IOException { } @@ -410,6 +420,8 @@ /** * Returns true if the element is a text element. * + * @param elem an element + * @return {@code true} if the element is a text element. */ protected boolean isText(Element elem) { return (elem.getName() == AbstractDocument.ContentElementName); @@ -420,6 +432,8 @@ * Writes out the attribute set * in an HTML-compliant manner. * + * @param elem an element + * @param needsIndenting indention will be added if {@code needsIndenting} is {@code true} * @exception IOException on any I/O error * @exception BadLocationException if pos represents an invalid * location within the document. @@ -442,6 +456,7 @@ * bold <b>, italic <i>, and <u> tags for the * text based on its attribute settings. * + * @param attr a set of attributes * @exception IOException on any I/O error */ @@ -553,6 +568,7 @@ * style attribute is set to contain the list of remaining * attributes just like inline styles. * + * @param attr a set of attributes * @exception IOException on any I/O error */ protected void writeNonHTMLAttributes(AttributeSet attr) throws IOException { @@ -608,6 +624,8 @@ /** * Returns true if we are currently in a <font> tag. + * + * @return {@code true} if we are currently in a <font> tag. */ protected boolean inFontTag() { return (fontAttributes != null); @@ -636,6 +654,7 @@ * any enclosing font tag before writing out a * new start tag. * + * @param style a font style * @exception IOException on any I/O error */ protected void startFontTag(String style) throws IOException {
--- a/jdk/src/share/classes/javax/swing/text/html/Option.java Thu Jun 19 16:54:59 2014 +0400 +++ b/jdk/src/share/classes/javax/swing/text/html/Option.java Thu Jun 19 16:57:14 2014 +0400 @@ -61,6 +61,8 @@ /** * Sets the label to be used for the option. + * + * @param label a label. */ public void setLabel(String label) { this.label = label; @@ -68,6 +70,8 @@ /** * Fetch the label associated with the option. + * + * @return the label associated with the option. */ public String getLabel() { return label; @@ -75,6 +79,8 @@ /** * Fetch the attributes associated with this option. + * + * @return the attributes associated with this option. */ public AttributeSet getAttributes() { return attr; @@ -89,6 +95,8 @@ /** * Sets the selected state. + * + * @param state a selection state */ protected void setSelection(boolean state) { selected = state; @@ -96,16 +104,21 @@ /** * Fetches the selection state associated with this option. + * + * @return the selection state. */ public boolean isSelected() { return selected; } /** - * Convenience method to return the string associated - * with the <code>value</code> attribute. If the - * value has not been specified, the label will be + * Convenient method to return the string associated + * with the {@code value} attribute. If the + * {@code value} has not been specified, the {@code label} will be * returned. + * + * @return the string associated with the {@code value} attribute, + * or {@code label} if the value has been not specified. */ public String getValue() { String value = (String) attr.getAttribute(HTML.Attribute.VALUE);
--- a/jdk/src/share/classes/javax/swing/text/html/ParagraphView.java Thu Jun 19 16:54:59 2014 +0400 +++ b/jdk/src/share/classes/javax/swing/text/html/ParagraphView.java Thu Jun 19 16:57:14 2014 +0400 @@ -128,6 +128,11 @@ } } + /** + * Convenient method to get the StyleSheet. + * + * @return the StyleSheet + */ protected StyleSheet getStyleSheet() { HTMLDocument doc = (HTMLDocument) getDocument(); return doc.getStyleSheet();
--- a/jdk/src/share/classes/javax/swing/text/html/StyleSheet.java Thu Jun 19 16:54:59 2014 +0400 +++ b/jdk/src/share/classes/javax/swing/text/html/StyleSheet.java Thu Jun 19 16:57:14 2014 +0400 @@ -156,7 +156,7 @@ // . When one of the AttributeSets is mutated by way of a // StyleConstants key, all the associated CSS keys are removed. This is // done so that the two representations don't get out of sync. For - // example, if the developer adds StyleConsants.BOLD, FALSE to an + // example, if the developer adds StyleConstants.BOLD, FALSE to an // AttributeSet that contains HTML.Tag.B, the HTML.Tag.B entry will // be removed. @@ -270,6 +270,9 @@ * with a selector "table p" and a new rule was added with a selector * of "p" the returned Style would include the new attributes from * the rule "p". + * + * @param selector a space separated String of the element names. + * @return the rule that best matches the selector. */ public Style getRule(String selector) { selector = cleanSelectorString(selector); @@ -284,6 +287,8 @@ * Adds a set of rules to the sheet. The rules are expected to * be in valid CSS format. Typically this would be called as * a result of parsing a <style> tag. + * + * @param rule a set of rules */ public void addRule(String rule) { if (rule != null) { @@ -315,6 +320,9 @@ * Translates a CSS declaration to an AttributeSet that represents * the CSS declaration. Typically this would be called as a * result of encountering an HTML style attribute. + * + * @param decl a CSS declaration + * @return a set of attributes that represents the CSS declaration. */ public AttributeSet getDeclaration(String decl) { if (decl == null) { @@ -334,6 +342,7 @@ * location of the stream and may be null. All relative * URLs specified in the stream will be based upon this * parameter. + * @throws java.io.IOException if I/O error occured. */ public void loadRules(Reader in, URL ref) throws IOException { CssParser parser = new CssParser(); @@ -344,6 +353,9 @@ * Fetches a set of attributes to use in the view for * displaying. This is basically a set of attributes that * can be used for View.getAttributes. + * + * @param v a view + * @return the of attributes */ public AttributeSet getViewAttributes(View v) { return new ViewAttributeSet(v); @@ -388,6 +400,7 @@ * any previously added style sheets. An added StyleSheet will never * override the rules of the receiving style sheet. * + * @param ss a StyleSheet * @since 1.3 */ public void addStyleSheet(StyleSheet ss) { @@ -410,6 +423,7 @@ /** * Removes the StyleSheet <code>ss</code> from those of the receiver. * + * @param ss a StyleSheet * @since 1.3 */ public void removeStyleSheet(StyleSheet ss) { @@ -435,6 +449,7 @@ * Returns an array of the linked StyleSheets. Will return null * if there are no linked StyleSheets. * + * @return an array of StyleSheets. * @since 1.3 */ public StyleSheet[] getStyleSheets() { @@ -458,6 +473,7 @@ * to become part of the receiver, create a new StyleSheet and use * addStyleSheet to link it in. * + * @param url an url * @since 1.3 */ public void importStyleSheet(URL url) { @@ -480,6 +496,7 @@ * Sets the base. All import statements that are relative, will be * relative to <code>base</code>. * + * @param base a base. * @since 1.3 */ public void setBase(URL base) { @@ -489,6 +506,7 @@ /** * Returns the base. * + * @return the base. * @since 1.3 */ public URL getBase() { @@ -498,6 +516,9 @@ /** * Adds a CSS attribute to the given set. * + * @param attr a set of attributes + * @param key a CSS property + * @param value an HTML attribute value * @since 1.3 */ public void addCSSAttribute(MutableAttributeSet attr, CSS.Attribute key, @@ -508,6 +529,11 @@ /** * Adds a CSS attribute to the given set. * + * @param attr a set of attributes + * @param key a CSS property + * @param value an HTML attribute value + * @return {@code true} if an HTML attribute {@code value} can be converted + * to a CSS attribute, false otherwise. * @since 1.3 */ public boolean addCSSAttributeFromHTML(MutableAttributeSet attr, @@ -527,6 +553,7 @@ * set of CSS attributes. * * @param htmlAttrSet AttributeSet containing the HTML attributes. + * @return the set of CSS attributes. */ public AttributeSet translateHTMLToCSS(AttributeSet htmlAttrSet) { AttributeSet cssAttrSet = css.translateHTMLToCSS(htmlAttrSet); @@ -917,6 +944,9 @@ /** * Fetches the box formatter to use for the given set * of CSS attributes. + * + * @param a a set of CSS attributes + * @return the box formatter. */ public BoxPainter getBoxPainter(AttributeSet a) { return new BoxPainter(a, css, this); @@ -925,6 +955,9 @@ /** * Fetches the list formatter to use for the given set * of CSS attributes. + * + * @param a a set of CSS attributes + * @return the list formatter. */ public ListPainter getListPainter(AttributeSet a) { return new ListPainter(a, this); @@ -932,6 +965,8 @@ /** * Sets the base font size, with valid values between 1 and 7. + * + * @param sz a font size. */ public void setBaseFontSize(int sz) { css.setBaseFontSize(sz); @@ -941,17 +976,29 @@ * Sets the base font size from the passed in String. The string * can either identify a specific font size, with legal values between * 1 and 7, or identify a relative font size such as +1 or -2. + * + * @param size a font size. */ public void setBaseFontSize(String size) { css.setBaseFontSize(size); } + /** + * + * Returns the index of HTML/CSS size model. + * + * @param pt a size of point + * @return the index of HTML/CSS size model. + */ public static int getIndexOfSize(float pt) { return CSS.getIndexOfSize(pt, sizeMapDefault); } /** * Returns the point size, given a size index. + * + * @param index a size index + * @return the point size value. */ public float getPointSize(int index) { return css.getPointSize(index, this); @@ -960,6 +1007,9 @@ /** * Given a string such as "+2", "-2", or "2", * returns a point size value. + * + * @param size a CSS string describing font size + * @return the point size value. */ public float getPointSize(String size) { return css.getPointSize(size, this); @@ -970,6 +1020,9 @@ * Note: This will only convert the HTML3.2 color strings * or a string of length 7; * otherwise, it will return null. + * + * @param string color string such as "RED" or "#NNNNNN" + * @return the color */ public Color stringToColor(String string) { return CSS.stringToColor(string); @@ -1816,6 +1869,7 @@ * @param v the view making the request. This is * used to get the AttributeSet, and may be used to * resolve percentage arguments. + * @return the inset needed for the margin, border and padding. * @exception IllegalArgumentException for an invalid direction */ public float getInset(int side, View v) {