src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlTree.java

Mon, 21 Jan 2013 00:45:35 -0500

author
bpatel
date
Mon, 21 Jan 2013 00:45:35 -0500
changeset 1568
5f0731e4e5e6
parent 1417
522a1ee72340
child 1736
74cd21f2c2fe
permissions
-rw-r--r--

8006124: javadoc/doclet should be updated to support profiles
Reviewed-by: jjg

bpatel@766 1 /*
jjg@1358 2 * Copyright (c) 2010, 2012, Oracle and/or its affiliates. All rights reserved.
bpatel@766 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
bpatel@766 4 *
bpatel@766 5 * This code is free software; you can redistribute it and/or modify it
bpatel@766 6 * under the terms of the GNU General Public License version 2 only, as
bpatel@766 7 * published by the Free Software Foundation. Oracle designates this
bpatel@766 8 * particular file as subject to the "Classpath" exception as provided
bpatel@766 9 * by Oracle in the LICENSE file that accompanied this code.
bpatel@766 10 *
bpatel@766 11 * This code is distributed in the hope that it will be useful, but WITHOUT
bpatel@766 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
bpatel@766 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
bpatel@766 14 * version 2 for more details (a copy is included in the LICENSE file that
bpatel@766 15 * accompanied this code).
bpatel@766 16 *
bpatel@766 17 * You should have received a copy of the GNU General Public License version
bpatel@766 18 * 2 along with this work; if not, write to the Free Software Foundation,
bpatel@766 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
bpatel@766 20 *
bpatel@766 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
bpatel@766 22 * or visit www.oracle.com if you need additional information or have any
bpatel@766 23 * questions.
bpatel@766 24 */
bpatel@766 25
bpatel@766 26 package com.sun.tools.doclets.formats.html.markup;
bpatel@766 27
jjg@1364 28 import java.io.IOException;
jjg@1364 29 import java.io.Writer;
bpatel@766 30 import java.util.*;
jjg@1364 31
bpatel@766 32 import com.sun.tools.doclets.internal.toolkit.Content;
bpatel@766 33 import com.sun.tools.doclets.internal.toolkit.util.*;
bpatel@766 34
bpatel@766 35 /**
bpatel@766 36 * Class for generating HTML tree for javadoc output.
bpatel@766 37 *
jjg@1359 38 * <p><b>This is NOT part of any supported API.
jjg@1359 39 * If you write code that depends on this, you do so at your own risk.
jjg@1359 40 * This code and its internal interfaces are subject to change or
jjg@1359 41 * deletion without notice.</b>
jjg@1359 42 *
bpatel@766 43 * @author Bhavesh Patel
bpatel@766 44 */
bpatel@766 45 public class HtmlTree extends Content {
bpatel@766 46
bpatel@766 47 private HtmlTag htmlTag;
bpatel@766 48 private Map<HtmlAttr,String> attrs = Collections.<HtmlAttr,String>emptyMap();
bpatel@766 49 private List<Content> content = Collections.<Content>emptyList();
bpatel@766 50 public static final Content EMPTY = new StringContent("");
bpatel@766 51
bpatel@766 52 /**
bpatel@766 53 * Constructor to construct HtmlTree object.
bpatel@766 54 *
bpatel@766 55 * @param tag HTML tag for the HtmlTree object
bpatel@766 56 */
bpatel@766 57 public HtmlTree(HtmlTag tag) {
bpatel@766 58 htmlTag = nullCheck(tag);
bpatel@766 59 }
bpatel@766 60
bpatel@766 61 /**
bpatel@766 62 * Constructor to construct HtmlTree object.
bpatel@766 63 *
bpatel@766 64 * @param tag HTML tag for the HtmlTree object
bpatel@766 65 * @param contents contents to be added to the tree
bpatel@766 66 */
bpatel@766 67 public HtmlTree(HtmlTag tag, Content... contents) {
bpatel@766 68 this(tag);
bpatel@766 69 for (Content content: contents)
bpatel@766 70 addContent(content);
bpatel@766 71 }
bpatel@766 72
bpatel@766 73 /**
bpatel@766 74 * Adds an attribute for the HTML tag.
bpatel@766 75 *
bpatel@766 76 * @param attrName name of the attribute
bpatel@766 77 * @param attrValue value of the attribute
bpatel@766 78 */
bpatel@766 79 public void addAttr(HtmlAttr attrName, String attrValue) {
bpatel@766 80 if (attrs.isEmpty())
bpatel@766 81 attrs = new LinkedHashMap<HtmlAttr,String>();
bpatel@766 82 attrs.put(nullCheck(attrName), nullCheck(attrValue));
bpatel@766 83 }
bpatel@766 84
bpatel@766 85 /**
bpatel@766 86 * Adds a style for the HTML tag.
bpatel@766 87 *
bpatel@766 88 * @param style style to be added
bpatel@766 89 */
bpatel@766 90 public void addStyle(HtmlStyle style) {
bpatel@766 91 addAttr(HtmlAttr.CLASS, style.toString());
bpatel@766 92 }
bpatel@766 93
bpatel@766 94 /**
bpatel@766 95 * Adds content for the HTML tag.
bpatel@766 96 *
bpatel@766 97 * @param tagContent tag content to be added
bpatel@766 98 */
bpatel@766 99 public void addContent(Content tagContent) {
bpatel@766 100 if (tagContent == HtmlTree.EMPTY || tagContent.isValid()) {
bpatel@766 101 if (content.isEmpty())
bpatel@766 102 content = new ArrayList<Content>();
bpatel@766 103 content.add(tagContent);
bpatel@766 104 }
bpatel@766 105 }
bpatel@766 106
bpatel@766 107 /**
bpatel@766 108 * This method adds a string content to the htmltree. If the last content member
bpatel@766 109 * added is a StringContent, append the string to that StringContent or else
bpatel@766 110 * create a new StringContent and add it to the html tree.
bpatel@766 111 *
bpatel@766 112 * @param stringContent string content that needs to be added
bpatel@766 113 */
bpatel@766 114 public void addContent(String stringContent) {
bpatel@766 115 if (!content.isEmpty()) {
bpatel@766 116 Content lastContent = content.get(content.size() - 1);
bpatel@766 117 if (lastContent instanceof StringContent)
bpatel@766 118 lastContent.addContent(stringContent);
bpatel@766 119 else
bpatel@766 120 addContent(new StringContent(stringContent));
bpatel@766 121 }
bpatel@766 122 else
bpatel@766 123 addContent(new StringContent(stringContent));
bpatel@766 124 }
bpatel@766 125
bpatel@766 126 /**
bpatel@766 127 * Generates an HTML anchor tag.
bpatel@766 128 *
bpatel@766 129 * @param ref reference url for the anchor tag
bpatel@766 130 * @param body content for the anchor tag
bpatel@766 131 * @return an HtmlTree object
bpatel@766 132 */
bpatel@766 133 public static HtmlTree A(String ref, Content body) {
bpatel@766 134 HtmlTree htmltree = new HtmlTree(HtmlTag.A, nullCheck(body));
bpatel@766 135 htmltree.addAttr(HtmlAttr.HREF, nullCheck(ref));
bpatel@766 136 return htmltree;
bpatel@766 137 }
bpatel@766 138
bpatel@766 139 /**
bpatel@766 140 * Generates an HTML anchor tag with name attribute and content.
bpatel@766 141 *
bpatel@766 142 * @param name name for the anchor tag
bpatel@766 143 * @param body content for the anchor tag
bpatel@766 144 * @return an HtmlTree object
bpatel@766 145 */
bpatel@766 146 public static HtmlTree A_NAME(String name, Content body) {
bpatel@766 147 HtmlTree htmltree = HtmlTree.A_NAME(name);
bpatel@766 148 htmltree.addContent(nullCheck(body));
bpatel@766 149 return htmltree;
bpatel@766 150 }
bpatel@766 151
bpatel@766 152 /**
bpatel@766 153 * Generates an HTML anchor tag with name attribute.
bpatel@766 154 *
bpatel@766 155 * @param name name for the anchor tag
bpatel@766 156 * @return an HtmlTree object
bpatel@766 157 */
bpatel@766 158 public static HtmlTree A_NAME(String name) {
bpatel@766 159 HtmlTree htmltree = new HtmlTree(HtmlTag.A);
bpatel@766 160 htmltree.addAttr(HtmlAttr.NAME, nullCheck(name));
bpatel@766 161 return htmltree;
bpatel@766 162 }
bpatel@766 163
bpatel@766 164 /**
bpatel@766 165 * Generates a CAPTION tag with some content.
bpatel@766 166 *
bpatel@766 167 * @param body content for the tag
bpatel@766 168 * @return an HtmlTree object for the CAPTION tag
bpatel@766 169 */
bpatel@766 170 public static HtmlTree CAPTION(Content body) {
bpatel@766 171 HtmlTree htmltree = new HtmlTree(HtmlTag.CAPTION, nullCheck(body));
bpatel@766 172 return htmltree;
bpatel@766 173 }
bpatel@766 174
bpatel@766 175 /**
bpatel@766 176 * Generates a CODE tag with some content.
bpatel@766 177 *
bpatel@766 178 * @param body content for the tag
bpatel@766 179 * @return an HtmlTree object for the CODE tag
bpatel@766 180 */
bpatel@766 181 public static HtmlTree CODE(Content body) {
bpatel@766 182 HtmlTree htmltree = new HtmlTree(HtmlTag.CODE, nullCheck(body));
bpatel@766 183 return htmltree;
bpatel@766 184 }
bpatel@766 185
bpatel@766 186 /**
bpatel@766 187 * Generates a DD tag with some content.
bpatel@766 188 *
bpatel@766 189 * @param body content for the tag
bpatel@766 190 * @return an HtmlTree object for the DD tag
bpatel@766 191 */
bpatel@766 192 public static HtmlTree DD(Content body) {
bpatel@766 193 HtmlTree htmltree = new HtmlTree(HtmlTag.DD, nullCheck(body));
bpatel@766 194 return htmltree;
bpatel@766 195 }
bpatel@766 196
bpatel@766 197 /**
bpatel@766 198 * Generates a DL tag with some content.
bpatel@766 199 *
bpatel@766 200 * @param body content for the tag
bpatel@766 201 * @return an HtmlTree object for the DL tag
bpatel@766 202 */
bpatel@766 203 public static HtmlTree DL(Content body) {
bpatel@766 204 HtmlTree htmltree = new HtmlTree(HtmlTag.DL, nullCheck(body));
bpatel@766 205 return htmltree;
bpatel@766 206 }
bpatel@766 207
bpatel@766 208 /**
bpatel@766 209 * Generates a DIV tag with the style class attributes. It also encloses
bpatel@766 210 * a content.
bpatel@766 211 *
bpatel@766 212 * @param styleClass stylesheet class for the tag
bpatel@766 213 * @param body content for the tag
bpatel@766 214 * @return an HtmlTree object for the DIV tag
bpatel@766 215 */
bpatel@766 216 public static HtmlTree DIV(HtmlStyle styleClass, Content body) {
bpatel@766 217 HtmlTree htmltree = new HtmlTree(HtmlTag.DIV, nullCheck(body));
bpatel@766 218 if (styleClass != null)
bpatel@766 219 htmltree.addStyle(styleClass);
bpatel@766 220 return htmltree;
bpatel@766 221 }
bpatel@766 222
bpatel@766 223 /**
bpatel@766 224 * Generates a DIV tag with some content.
bpatel@766 225 *
bpatel@766 226 * @param body content for the tag
bpatel@766 227 * @return an HtmlTree object for the DIV tag
bpatel@766 228 */
bpatel@766 229 public static HtmlTree DIV(Content body) {
bpatel@766 230 return DIV(null, body);
bpatel@766 231 }
bpatel@766 232
bpatel@766 233 /**
bpatel@766 234 * Generates a DT tag with some content.
bpatel@766 235 *
bpatel@766 236 * @param body content for the tag
bpatel@766 237 * @return an HtmlTree object for the DT tag
bpatel@766 238 */
bpatel@766 239 public static HtmlTree DT(Content body) {
bpatel@766 240 HtmlTree htmltree = new HtmlTree(HtmlTag.DT, nullCheck(body));
bpatel@766 241 return htmltree;
bpatel@766 242 }
bpatel@766 243
bpatel@766 244 /**
bpatel@766 245 * Generates a EM tag with some content.
bpatel@766 246 *
bpatel@766 247 * @param body content to be added to the tag
bpatel@766 248 * @return an HtmlTree object for the EM tag
bpatel@766 249 */
bpatel@766 250 public static HtmlTree EM(Content body) {
bpatel@766 251 HtmlTree htmltree = new HtmlTree(HtmlTag.EM, nullCheck(body));
bpatel@766 252 return htmltree;
bpatel@766 253 }
bpatel@766 254
bpatel@766 255 /**
bpatel@766 256 * Generates a FRAME tag.
bpatel@766 257 *
bpatel@766 258 * @param src the url of the document to be shown in the frame
bpatel@766 259 * @param name specifies the name of the frame
bpatel@766 260 * @param title the title for the frame
bpatel@766 261 * @param scrolling specifies whether to display scrollbars in the frame
bpatel@766 262 * @return an HtmlTree object for the FRAME tag
bpatel@766 263 */
bpatel@766 264 public static HtmlTree FRAME(String src, String name, String title, String scrolling) {
bpatel@766 265 HtmlTree htmltree = new HtmlTree(HtmlTag.FRAME);
bpatel@766 266 htmltree.addAttr(HtmlAttr.SRC, nullCheck(src));
bpatel@766 267 htmltree.addAttr(HtmlAttr.NAME, nullCheck(name));
bpatel@766 268 htmltree.addAttr(HtmlAttr.TITLE, nullCheck(title));
bpatel@766 269 if (scrolling != null)
bpatel@766 270 htmltree.addAttr(HtmlAttr.SCROLLING, scrolling);
bpatel@766 271 return htmltree;
bpatel@766 272 }
bpatel@766 273
bpatel@766 274 /**
bpatel@766 275 * Generates a Frame tag.
bpatel@766 276 *
bpatel@766 277 * @param src the url of the document to be shown in the frame
bpatel@766 278 * @param name specifies the name of the frame
bpatel@766 279 * @param title the title for the frame
bpatel@766 280 * @return an HtmlTree object for the SPAN tag
bpatel@766 281 */
bpatel@766 282 public static HtmlTree FRAME(String src, String name, String title) {
bpatel@766 283 return FRAME(src, name, title, null);
bpatel@766 284 }
bpatel@766 285
bpatel@766 286 /**
bpatel@766 287 * Generates a FRAMESET tag.
bpatel@766 288 *
bpatel@766 289 * @param cols the size of columns in the frameset
bpatel@766 290 * @param rows the size of rows in the frameset
bpatel@766 291 * @param title the title for the frameset
bpatel@766 292 * @param onload the script to run when the document loads
bpatel@766 293 * @return an HtmlTree object for the FRAMESET tag
bpatel@766 294 */
bpatel@766 295 public static HtmlTree FRAMESET(String cols, String rows, String title, String onload) {
bpatel@766 296 HtmlTree htmltree = new HtmlTree(HtmlTag.FRAMESET);
bpatel@766 297 if (cols != null)
bpatel@766 298 htmltree.addAttr(HtmlAttr.COLS, cols);
bpatel@766 299 if (rows != null)
bpatel@766 300 htmltree.addAttr(HtmlAttr.ROWS, rows);
bpatel@766 301 htmltree.addAttr(HtmlAttr.TITLE, nullCheck(title));
bpatel@766 302 htmltree.addAttr(HtmlAttr.ONLOAD, nullCheck(onload));
bpatel@766 303 return htmltree;
bpatel@766 304 }
bpatel@766 305
bpatel@766 306 /**
bpatel@766 307 * Generates a heading tag (h1 to h6) with the title and style class attributes. It also encloses
bpatel@766 308 * a content.
bpatel@766 309 *
bpatel@766 310 * @param headingTag the heading tag to be generated
bpatel@766 311 * @param printTitle true if title for the tag needs to be printed else false
bpatel@766 312 * @param styleClass stylesheet class for the tag
bpatel@766 313 * @param body content for the tag
bpatel@766 314 * @return an HtmlTree object for the tag
bpatel@766 315 */
bpatel@766 316 public static HtmlTree HEADING(HtmlTag headingTag, boolean printTitle,
bpatel@766 317 HtmlStyle styleClass, Content body) {
bpatel@766 318 HtmlTree htmltree = new HtmlTree(headingTag, nullCheck(body));
bpatel@766 319 if (printTitle)
bpatel@766 320 htmltree.addAttr(HtmlAttr.TITLE, Util.stripHtml(body.toString()));
bpatel@766 321 if (styleClass != null)
bpatel@766 322 htmltree.addStyle(styleClass);
bpatel@766 323 return htmltree;
bpatel@766 324 }
bpatel@766 325
bpatel@766 326 /**
bpatel@766 327 * Generates a heading tag (h1 to h6) with style class attribute. It also encloses
bpatel@766 328 * a content.
bpatel@766 329 *
bpatel@766 330 * @param headingTag the heading tag to be generated
bpatel@766 331 * @param styleClass stylesheet class for the tag
bpatel@766 332 * @param body content for the tag
bpatel@766 333 * @return an HtmlTree object for the tag
bpatel@766 334 */
bpatel@766 335 public static HtmlTree HEADING(HtmlTag headingTag, HtmlStyle styleClass, Content body) {
bpatel@766 336 return HEADING(headingTag, false, styleClass, body);
bpatel@766 337 }
bpatel@766 338
bpatel@766 339 /**
bpatel@766 340 * Generates a heading tag (h1 to h6) with the title attribute. It also encloses
bpatel@766 341 * a content.
bpatel@766 342 *
bpatel@766 343 * @param headingTag the heading tag to be generated
bpatel@766 344 * @param printTitle true if the title for the tag needs to be printed else false
bpatel@766 345 * @param body content for the tag
bpatel@766 346 * @return an HtmlTree object for the tag
bpatel@766 347 */
bpatel@766 348 public static HtmlTree HEADING(HtmlTag headingTag, boolean printTitle, Content body) {
bpatel@766 349 return HEADING(headingTag, printTitle, null, body);
bpatel@766 350 }
bpatel@766 351
bpatel@766 352 /**
bpatel@766 353 * Generates a heading tag (h1 to h6) with some content.
bpatel@766 354 *
bpatel@766 355 * @param headingTag the heading tag to be generated
bpatel@766 356 * @param body content for the tag
bpatel@766 357 * @return an HtmlTree object for the tag
bpatel@766 358 */
bpatel@766 359 public static HtmlTree HEADING(HtmlTag headingTag, Content body) {
bpatel@766 360 return HEADING(headingTag, false, null, body);
bpatel@766 361 }
bpatel@766 362
bpatel@766 363 /**
bpatel@766 364 * Generates an HTML tag with lang attribute. It also adds head and body
bpatel@766 365 * content to the HTML tree.
bpatel@766 366 *
bpatel@766 367 * @param lang language for the HTML document
bpatel@766 368 * @param head head for the HTML tag
bpatel@766 369 * @param body body for the HTML tag
bpatel@766 370 * @return an HtmlTree object for the HTML tag
bpatel@766 371 */
bpatel@766 372 public static HtmlTree HTML(String lang, Content head, Content body) {
bpatel@766 373 HtmlTree htmltree = new HtmlTree(HtmlTag.HTML, nullCheck(head), nullCheck(body));
bpatel@766 374 htmltree.addAttr(HtmlAttr.LANG, nullCheck(lang));
bpatel@766 375 return htmltree;
bpatel@766 376 }
bpatel@766 377
bpatel@766 378 /**
bpatel@766 379 * Generates a I tag with some content.
bpatel@766 380 *
bpatel@766 381 * @param body content for the tag
bpatel@766 382 * @return an HtmlTree object for the I tag
bpatel@766 383 */
bpatel@766 384 public static HtmlTree I(Content body) {
bpatel@766 385 HtmlTree htmltree = new HtmlTree(HtmlTag.I, nullCheck(body));
bpatel@766 386 return htmltree;
bpatel@766 387 }
bpatel@766 388
bpatel@766 389 /**
bpatel@766 390 * Generates a LI tag with some content.
bpatel@766 391 *
bpatel@766 392 * @param body content for the tag
bpatel@766 393 * @return an HtmlTree object for the LI tag
bpatel@766 394 */
bpatel@766 395 public static HtmlTree LI(Content body) {
bpatel@766 396 return LI(null, body);
bpatel@766 397 }
bpatel@766 398
bpatel@766 399 /**
bpatel@766 400 * Generates a LI tag with some content.
bpatel@766 401 *
bpatel@766 402 * @param styleClass style for the tag
bpatel@766 403 * @param body content for the tag
bpatel@766 404 * @return an HtmlTree object for the LI tag
bpatel@766 405 */
bpatel@766 406 public static HtmlTree LI(HtmlStyle styleClass, Content body) {
bpatel@766 407 HtmlTree htmltree = new HtmlTree(HtmlTag.LI, nullCheck(body));
bpatel@766 408 if (styleClass != null)
bpatel@766 409 htmltree.addStyle(styleClass);
bpatel@766 410 return htmltree;
bpatel@766 411 }
bpatel@766 412
bpatel@766 413 /**
bpatel@766 414 * Generates a LINK tag with the rel, type, href and title attributes.
bpatel@766 415 *
bpatel@766 416 * @param rel relevance of the link
bpatel@766 417 * @param type type of link
bpatel@766 418 * @param href the path for the link
bpatel@766 419 * @param title title for the link
bpatel@766 420 * @return an HtmlTree object for the LINK tag
bpatel@766 421 */
bpatel@766 422 public static HtmlTree LINK(String rel, String type, String href, String title) {
bpatel@766 423 HtmlTree htmltree = new HtmlTree(HtmlTag.LINK);
bpatel@766 424 htmltree.addAttr(HtmlAttr.REL, nullCheck(rel));
bpatel@766 425 htmltree.addAttr(HtmlAttr.TYPE, nullCheck(type));
bpatel@766 426 htmltree.addAttr(HtmlAttr.HREF, nullCheck(href));
bpatel@766 427 htmltree.addAttr(HtmlAttr.TITLE, nullCheck(title));
bpatel@766 428 return htmltree;
bpatel@766 429 }
bpatel@766 430
bpatel@766 431 /**
bpatel@766 432 * Generates a META tag with the http-equiv, content and charset attributes.
bpatel@766 433 *
jjg@1358 434 * @param httpEquiv http equiv attribute for the META tag
bpatel@766 435 * @param content type of content
jjg@1358 436 * @param charSet character set used
bpatel@766 437 * @return an HtmlTree object for the META tag
bpatel@766 438 */
bpatel@766 439 public static HtmlTree META(String httpEquiv, String content, String charSet) {
bpatel@766 440 HtmlTree htmltree = new HtmlTree(HtmlTag.META);
bpatel@766 441 htmltree.addAttr(HtmlAttr.HTTP_EQUIV, nullCheck(httpEquiv));
bpatel@766 442 htmltree.addAttr(HtmlAttr.CONTENT, nullCheck(content));
bpatel@766 443 htmltree.addAttr(HtmlAttr.CHARSET, nullCheck(charSet));
bpatel@766 444 return htmltree;
bpatel@766 445 }
bpatel@766 446
bpatel@766 447 /**
bpatel@766 448 * Generates a META tag with the name and content attributes.
bpatel@766 449 *
bpatel@766 450 * @param name name attribute
bpatel@766 451 * @param content type of content
bpatel@766 452 * @return an HtmlTree object for the META tag
bpatel@766 453 */
bpatel@766 454 public static HtmlTree META(String name, String content) {
bpatel@766 455 HtmlTree htmltree = new HtmlTree(HtmlTag.META);
bpatel@766 456 htmltree.addAttr(HtmlAttr.NAME, nullCheck(name));
bpatel@766 457 htmltree.addAttr(HtmlAttr.CONTENT, nullCheck(content));
bpatel@766 458 return htmltree;
bpatel@766 459 }
bpatel@766 460
bpatel@766 461 /**
bpatel@766 462 * Generates a NOSCRIPT tag with some content.
bpatel@766 463 *
bpatel@766 464 * @param body content of the noscript tag
bpatel@766 465 * @return an HtmlTree object for the NOSCRIPT tag
bpatel@766 466 */
bpatel@766 467 public static HtmlTree NOSCRIPT(Content body) {
bpatel@766 468 HtmlTree htmltree = new HtmlTree(HtmlTag.NOSCRIPT, nullCheck(body));
bpatel@766 469 return htmltree;
bpatel@766 470 }
bpatel@766 471
bpatel@766 472 /**
bpatel@766 473 * Generates a P tag with some content.
bpatel@766 474 *
bpatel@766 475 * @param body content of the Paragraph tag
bpatel@766 476 * @return an HtmlTree object for the P tag
bpatel@766 477 */
bpatel@766 478 public static HtmlTree P(Content body) {
bpatel@766 479 return P(null, body);
bpatel@766 480 }
bpatel@766 481
bpatel@766 482 /**
bpatel@766 483 * Generates a P tag with some content.
bpatel@766 484 *
bpatel@766 485 * @param styleClass style of the Paragraph tag
bpatel@766 486 * @param body content of the Paragraph tag
bpatel@766 487 * @return an HtmlTree object for the P tag
bpatel@766 488 */
bpatel@766 489 public static HtmlTree P(HtmlStyle styleClass, Content body) {
bpatel@766 490 HtmlTree htmltree = new HtmlTree(HtmlTag.P, nullCheck(body));
bpatel@766 491 if (styleClass != null)
bpatel@766 492 htmltree.addStyle(styleClass);
bpatel@766 493 return htmltree;
bpatel@766 494 }
bpatel@766 495
bpatel@766 496 /**
bpatel@1417 497 * Generates a SCRIPT tag with the type and src attributes.
bpatel@1417 498 *
bpatel@1417 499 * @param type type of link
bpatel@1417 500 * @param src the path for the script
bpatel@1417 501 * @return an HtmlTree object for the SCRIPT tag
bpatel@1417 502 */
bpatel@1417 503 public static HtmlTree SCRIPT(String type, String src) {
bpatel@1417 504 HtmlTree htmltree = new HtmlTree(HtmlTag.SCRIPT);
bpatel@1417 505 htmltree.addAttr(HtmlAttr.TYPE, nullCheck(type));
bpatel@1417 506 htmltree.addAttr(HtmlAttr.SRC, nullCheck(src));
bpatel@1417 507 return htmltree;
bpatel@1417 508 }
bpatel@1417 509
bpatel@1417 510 /**
bpatel@766 511 * Generates a SMALL tag with some content.
bpatel@766 512 *
bpatel@766 513 * @param body content for the tag
bpatel@766 514 * @return an HtmlTree object for the SMALL tag
bpatel@766 515 */
bpatel@766 516 public static HtmlTree SMALL(Content body) {
bpatel@766 517 HtmlTree htmltree = new HtmlTree(HtmlTag.SMALL, nullCheck(body));
bpatel@766 518 return htmltree;
bpatel@766 519 }
bpatel@766 520
bpatel@766 521 /**
bpatel@766 522 * Generates a STRONG tag with some content.
bpatel@766 523 *
bpatel@766 524 * @param body content for the tag
bpatel@766 525 * @return an HtmlTree object for the STRONG tag
bpatel@766 526 */
bpatel@766 527 public static HtmlTree STRONG(Content body) {
bpatel@766 528 HtmlTree htmltree = new HtmlTree(HtmlTag.STRONG, nullCheck(body));
bpatel@766 529 return htmltree;
bpatel@766 530 }
bpatel@766 531
bpatel@766 532 /**
bpatel@766 533 * Generates a SPAN tag with some content.
bpatel@766 534 *
bpatel@766 535 * @param body content for the tag
bpatel@766 536 * @return an HtmlTree object for the SPAN tag
bpatel@766 537 */
bpatel@766 538 public static HtmlTree SPAN(Content body) {
bpatel@766 539 return SPAN(null, body);
bpatel@766 540 }
bpatel@766 541
bpatel@766 542 /**
bpatel@766 543 * Generates a SPAN tag with style class attribute and some content.
bpatel@766 544 *
bpatel@766 545 * @param styleClass style class for the tag
bpatel@766 546 * @param body content for the tag
bpatel@766 547 * @return an HtmlTree object for the SPAN tag
bpatel@766 548 */
bpatel@766 549 public static HtmlTree SPAN(HtmlStyle styleClass, Content body) {
bpatel@766 550 HtmlTree htmltree = new HtmlTree(HtmlTag.SPAN, nullCheck(body));
bpatel@766 551 if (styleClass != null)
bpatel@766 552 htmltree.addStyle(styleClass);
bpatel@766 553 return htmltree;
bpatel@766 554 }
bpatel@766 555
bpatel@766 556 /**
bpatel@1417 557 * Generates a SPAN tag with id and style class attributes. It also encloses
bpatel@1417 558 * a content.
bpatel@1417 559 *
bpatel@1417 560 * @param id the id for the tag
bpatel@1417 561 * @param styleClass stylesheet class for the tag
bpatel@1417 562 * @param body content for the tag
bpatel@1417 563 * @return an HtmlTree object for the SPAN tag
bpatel@1417 564 */
bpatel@1417 565 public static HtmlTree SPAN(String id, HtmlStyle styleClass, Content body) {
bpatel@1417 566 HtmlTree htmltree = new HtmlTree(HtmlTag.SPAN, nullCheck(body));
bpatel@1417 567 htmltree.addAttr(HtmlAttr.ID, nullCheck(id));
bpatel@1417 568 if (styleClass != null)
bpatel@1417 569 htmltree.addStyle(styleClass);
bpatel@1417 570 return htmltree;
bpatel@1417 571 }
bpatel@1417 572
bpatel@1417 573 /**
bpatel@766 574 * Generates a Table tag with border, width and summary attributes and
bpatel@766 575 * some content.
bpatel@766 576 *
bpatel@766 577 * @param border border for the table
bpatel@766 578 * @param width width of the table
bpatel@766 579 * @param summary summary for the table
bpatel@766 580 * @param body content for the table
bpatel@766 581 * @return an HtmlTree object for the TABLE tag
bpatel@766 582 */
bpatel@766 583 public static HtmlTree TABLE(int border, int width, String summary,
bpatel@766 584 Content body) {
bpatel@766 585 HtmlTree htmltree = new HtmlTree(HtmlTag.TABLE, nullCheck(body));
bpatel@766 586 htmltree.addAttr(HtmlAttr.BORDER, Integer.toString(border));
bpatel@766 587 htmltree.addAttr(HtmlAttr.WIDTH, Integer.toString(width));
bpatel@766 588 htmltree.addAttr(HtmlAttr.SUMMARY, nullCheck(summary));
bpatel@766 589 return htmltree;
bpatel@766 590 }
bpatel@766 591
bpatel@766 592 /**
bpatel@766 593 * Generates a Table tag with style class, border, cell padding,
bpatel@766 594 * cellspacing and summary attributes and some content.
bpatel@766 595 *
bpatel@766 596 * @param styleClass style of the table
bpatel@766 597 * @param border border for the table
bpatel@766 598 * @param cellPadding cell padding for the table
bpatel@766 599 * @param cellSpacing cell spacing for the table
bpatel@766 600 * @param summary summary for the table
bpatel@766 601 * @param body content for the table
bpatel@766 602 * @return an HtmlTree object for the TABLE tag
bpatel@766 603 */
bpatel@766 604 public static HtmlTree TABLE(HtmlStyle styleClass, int border, int cellPadding,
bpatel@766 605 int cellSpacing, String summary, Content body) {
bpatel@766 606 HtmlTree htmltree = new HtmlTree(HtmlTag.TABLE, nullCheck(body));
bpatel@766 607 if (styleClass != null)
bpatel@766 608 htmltree.addStyle(styleClass);
bpatel@766 609 htmltree.addAttr(HtmlAttr.BORDER, Integer.toString(border));
bpatel@766 610 htmltree.addAttr(HtmlAttr.CELLPADDING, Integer.toString(cellPadding));
bpatel@766 611 htmltree.addAttr(HtmlAttr.CELLSPACING, Integer.toString(cellSpacing));
bpatel@766 612 htmltree.addAttr(HtmlAttr.SUMMARY, nullCheck(summary));
bpatel@766 613 return htmltree;
bpatel@766 614 }
bpatel@766 615
bpatel@766 616 /**
bpatel@766 617 * Generates a Table tag with border, cell padding,
bpatel@766 618 * cellspacing and summary attributes and some content.
bpatel@766 619 *
bpatel@766 620 * @param border border for the table
bpatel@766 621 * @param cellPadding cell padding for the table
bpatel@766 622 * @param cellSpacing cell spacing for the table
bpatel@766 623 * @param summary summary for the table
bpatel@766 624 * @param body content for the table
bpatel@766 625 * @return an HtmlTree object for the TABLE tag
bpatel@766 626 */
bpatel@766 627 public static HtmlTree TABLE(int border, int cellPadding,
bpatel@766 628 int cellSpacing, String summary, Content body) {
bpatel@766 629 return TABLE(null, border, cellPadding, cellSpacing, summary, body);
bpatel@766 630 }
bpatel@766 631
bpatel@766 632 /**
bpatel@766 633 * Generates a TD tag with style class attribute and some content.
bpatel@766 634 *
bpatel@766 635 * @param styleClass style for the tag
bpatel@766 636 * @param body content for the tag
bpatel@766 637 * @return an HtmlTree object for the TD tag
bpatel@766 638 */
bpatel@766 639 public static HtmlTree TD(HtmlStyle styleClass, Content body) {
bpatel@766 640 HtmlTree htmltree = new HtmlTree(HtmlTag.TD, nullCheck(body));
bpatel@766 641 if (styleClass != null)
bpatel@766 642 htmltree.addStyle(styleClass);
bpatel@766 643 return htmltree;
bpatel@766 644 }
bpatel@766 645
bpatel@766 646 /**
bpatel@766 647 * Generates a TD tag for an HTML table with some content.
bpatel@766 648 *
bpatel@766 649 * @param body content for the tag
bpatel@766 650 * @return an HtmlTree object for the TD tag
bpatel@766 651 */
bpatel@766 652 public static HtmlTree TD(Content body) {
bpatel@766 653 return TD(null, body);
bpatel@766 654 }
bpatel@766 655
bpatel@766 656 /**
bpatel@766 657 * Generates a TH tag with style class and scope attributes and some content.
bpatel@766 658 *
bpatel@766 659 * @param styleClass style for the tag
bpatel@766 660 * @param scope scope of the tag
bpatel@766 661 * @param body content for the tag
bpatel@766 662 * @return an HtmlTree object for the TH tag
bpatel@766 663 */
bpatel@766 664 public static HtmlTree TH(HtmlStyle styleClass, String scope, Content body) {
bpatel@766 665 HtmlTree htmltree = new HtmlTree(HtmlTag.TH, nullCheck(body));
bpatel@766 666 if (styleClass != null)
bpatel@766 667 htmltree.addStyle(styleClass);
bpatel@766 668 htmltree.addAttr(HtmlAttr.SCOPE, nullCheck(scope));
bpatel@766 669 return htmltree;
bpatel@766 670 }
bpatel@766 671
bpatel@766 672 /**
bpatel@766 673 * Generates a TH tag with scope attribute and some content.
bpatel@766 674 *
bpatel@766 675 * @param scope scope of the tag
bpatel@766 676 * @param body content for the tag
bpatel@766 677 * @return an HtmlTree object for the TH tag
bpatel@766 678 */
bpatel@766 679 public static HtmlTree TH(String scope, Content body) {
bpatel@766 680 return TH(null, scope, body);
bpatel@766 681 }
bpatel@766 682
bpatel@766 683 /**
bpatel@766 684 * Generates a TITLE tag with some content.
bpatel@766 685 *
bpatel@766 686 * @param body content for the tag
bpatel@766 687 * @return an HtmlTree object for the TITLE tag
bpatel@766 688 */
bpatel@766 689 public static HtmlTree TITLE(Content body) {
bpatel@766 690 HtmlTree htmltree = new HtmlTree(HtmlTag.TITLE, nullCheck(body));
bpatel@766 691 return htmltree;
bpatel@766 692 }
bpatel@766 693
bpatel@766 694 /**
bpatel@766 695 * Generates a TR tag for an HTML table with some content.
bpatel@766 696 *
bpatel@766 697 * @param body content for the tag
bpatel@766 698 * @return an HtmlTree object for the TR tag
bpatel@766 699 */
bpatel@766 700 public static HtmlTree TR(Content body) {
bpatel@766 701 HtmlTree htmltree = new HtmlTree(HtmlTag.TR, nullCheck(body));
bpatel@766 702 return htmltree;
bpatel@766 703 }
bpatel@766 704
bpatel@766 705 /**
bpatel@766 706 * Generates a UL tag with the style class attribute and some content.
bpatel@766 707 *
bpatel@766 708 * @param styleClass style for the tag
bpatel@766 709 * @param body content for the tag
bpatel@766 710 * @return an HtmlTree object for the UL tag
bpatel@766 711 */
bpatel@766 712 public static HtmlTree UL(HtmlStyle styleClass, Content body) {
bpatel@766 713 HtmlTree htmltree = new HtmlTree(HtmlTag.UL, nullCheck(body));
bpatel@766 714 htmltree.addStyle(nullCheck(styleClass));
bpatel@766 715 return htmltree;
bpatel@766 716 }
bpatel@766 717
bpatel@766 718 /**
bpatel@766 719 * {@inheritDoc}
bpatel@766 720 */
bpatel@766 721 public boolean isEmpty() {
bpatel@766 722 return (!hasContent() && !hasAttrs());
bpatel@766 723 }
bpatel@766 724
bpatel@766 725 /**
bpatel@766 726 * Returns true if the HTML tree has content.
bpatel@766 727 *
bpatel@766 728 * @return true if the HTML tree has content else return false
bpatel@766 729 */
bpatel@766 730 public boolean hasContent() {
bpatel@766 731 return (!content.isEmpty());
bpatel@766 732 }
bpatel@766 733
bpatel@766 734 /**
bpatel@766 735 * Returns true if the HTML tree has attributes.
bpatel@766 736 *
bpatel@766 737 * @return true if the HTML tree has attributes else return false
bpatel@766 738 */
bpatel@766 739 public boolean hasAttrs() {
bpatel@766 740 return (!attrs.isEmpty());
bpatel@766 741 }
bpatel@766 742
bpatel@766 743 /**
bpatel@766 744 * Returns true if the HTML tree has a specific attribute.
bpatel@766 745 *
bpatel@766 746 * @param attrName name of the attribute to check within the HTML tree
bpatel@766 747 * @return true if the HTML tree has the specified attribute else return false
bpatel@766 748 */
bpatel@766 749 public boolean hasAttr(HtmlAttr attrName) {
bpatel@766 750 return (attrs.containsKey(attrName));
bpatel@766 751 }
bpatel@766 752
bpatel@766 753 /**
bpatel@766 754 * Returns true if the HTML tree is valid. This check is more specific to
bpatel@766 755 * standard doclet and not exactly similar to W3C specifications. But it
bpatel@766 756 * ensures HTML validation.
bpatel@766 757 *
bpatel@766 758 * @return true if the HTML tree is valid
bpatel@766 759 */
bpatel@766 760 public boolean isValid() {
bpatel@766 761 switch (htmlTag) {
bpatel@766 762 case A :
bpatel@766 763 return (hasAttr(HtmlAttr.NAME) || (hasAttr(HtmlAttr.HREF) && hasContent()));
bpatel@766 764 case BR :
bpatel@766 765 return (!hasContent() && (!hasAttrs() || hasAttr(HtmlAttr.CLEAR)));
bpatel@766 766 case FRAME :
bpatel@766 767 return (hasAttr(HtmlAttr.SRC) && !hasContent());
bpatel@766 768 case HR :
bpatel@766 769 return (!hasContent());
bpatel@766 770 case IMG :
bpatel@766 771 return (hasAttr(HtmlAttr.SRC) && hasAttr(HtmlAttr.ALT) && !hasContent());
bpatel@766 772 case LINK :
bpatel@766 773 return (hasAttr(HtmlAttr.HREF) && !hasContent());
bpatel@766 774 case META :
bpatel@766 775 return (hasAttr(HtmlAttr.CONTENT) && !hasContent());
bpatel@1417 776 case SCRIPT :
bpatel@1417 777 return ((hasAttr(HtmlAttr.TYPE) && hasAttr(HtmlAttr.SRC) && !hasContent()) ||
bpatel@1417 778 (hasAttr(HtmlAttr.TYPE) && hasContent()));
bpatel@766 779 default :
bpatel@766 780 return hasContent();
bpatel@766 781 }
bpatel@766 782 }
bpatel@766 783
bpatel@766 784 /**
bpatel@766 785 * Returns true if the element is an inline element.
bpatel@766 786 *
bpatel@766 787 * @return true if the HTML tag is an inline element
bpatel@766 788 */
bpatel@766 789 public boolean isInline() {
bpatel@766 790 return (htmlTag.blockType == HtmlTag.BlockType.INLINE);
bpatel@766 791 }
bpatel@766 792
bpatel@766 793 /**
bpatel@766 794 * {@inheritDoc}
bpatel@766 795 */
jjg@1364 796 @Override
jjg@1364 797 public boolean write(Writer out, boolean atNewline) throws IOException {
jjg@1364 798 if (!isInline() && !atNewline)
jjg@1364 799 out.write(DocletConstants.NL);
bpatel@766 800 String tagString = htmlTag.toString();
jjg@1364 801 out.write("<");
jjg@1364 802 out.write(tagString);
bpatel@766 803 Iterator<HtmlAttr> iterator = attrs.keySet().iterator();
bpatel@766 804 HtmlAttr key;
bpatel@766 805 String value = "";
bpatel@766 806 while (iterator.hasNext()) {
bpatel@766 807 key = iterator.next();
bpatel@766 808 value = attrs.get(key);
jjg@1364 809 out.write(" ");
jjg@1364 810 out.write(key.toString());
bpatel@819 811 if (!value.isEmpty()) {
jjg@1364 812 out.write("=\"");
jjg@1364 813 out.write(value);
jjg@1364 814 out.write("\"");
bpatel@819 815 }
bpatel@766 816 }
jjg@1364 817 out.write(">");
jjg@1364 818 boolean nl = false;
bpatel@766 819 for (Content c : content)
jjg@1364 820 nl = c.write(out, nl);
bpatel@819 821 if (htmlTag.endTagRequired()) {
jjg@1364 822 out.write("</");
jjg@1364 823 out.write(tagString);
jjg@1364 824 out.write(">");
bpatel@819 825 }
jjg@1364 826 if (!isInline()) {
jjg@1364 827 out.write(DocletConstants.NL);
jjg@1364 828 return true;
jjg@1364 829 } else {
jjg@1364 830 return false;
jjg@1364 831 }
bpatel@766 832 }
bpatel@766 833 }

mercurial