Module java.desktop
Package javax.swing.text.html

## Class HTML.Tag

- java.lang.Object
- - javax.swing.text.html.HTML.Tag

- Direct Known Subclasses:
    `HTML.UnknownTag`
  Enclosing class:
    HTML

      public static class HTML.Tag
      extends Object

  Typesafe enumeration for an HTML tag. Although the set of HTML tags is a closed set, we have left the set open so that people can add their own tag types to their custom parser and still communicate to the reader.

- - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `static HTML.Tag` | `A` | Tag <a>
    `static HTML.Tag` | `ADDRESS` | Tag <address>
    `static HTML.Tag` | `APPLET` | Tag <applet>
    `static HTML.Tag` | `AREA` | Tag <area>
    `static HTML.Tag` | `B` | Tag <b>
    `static HTML.Tag` | `BASE` | Tag <base>
    `static HTML.Tag` | `BASEFONT` | Tag <basefont>
    `static HTML.Tag` | `BIG` | Tag <big>
    `static HTML.Tag` | `BLOCKQUOTE` | Tag <blockquote>
    `static HTML.Tag` | `BODY` | Tag <body>
    `static HTML.Tag` | `BR` | Tag <br>
    `static HTML.Tag` | `CAPTION` | Tag <caption>
    `static HTML.Tag` | `CENTER` | Tag <center>
    `static HTML.Tag` | `CITE` | Tag <cite>
    `static HTML.Tag` | `CODE` | Tag <code>
    `static HTML.Tag` | `COMMENT` | All comments are labeled with this tag.
    `static HTML.Tag` | `CONTENT` | All text content is labeled with this tag.
    `static HTML.Tag` | `DD` | Tag <dd>
    `static HTML.Tag` | `DFN` | Tag <dfn>
    `static HTML.Tag` | `DIR` | Tag <dir>
    `static HTML.Tag` | `DIV` | Tag <div>
    `static HTML.Tag` | `DL` | Tag <dl>
    `static HTML.Tag` | `DT` | Tag <dt>
    `static HTML.Tag` | `EM` | Tag <em>
    `static HTML.Tag` | `FONT` | Tag <font>
    `static HTML.Tag` | `FORM` | Tag <form>
    `static HTML.Tag` | `FRAME` | Tag <frame>
    `static HTML.Tag` | `FRAMESET` | Tag <frameset>
    `static HTML.Tag` | `H1` | Tag <h1>
    `static HTML.Tag` | `H2` | Tag <h2>
    `static HTML.Tag` | `H3` | Tag <h3>
    `static HTML.Tag` | `H4` | Tag <h4>
    `static HTML.Tag` | `H5` | Tag <h5>
    `static HTML.Tag` | `H6` | Tag <h6>
    `static HTML.Tag` | `HEAD` | Tag <head>
    `static HTML.Tag` | `HR` | Tag <hr>
    `static HTML.Tag` | `HTML` | Tag <html>
    `static HTML.Tag` | `I` | Tag <i>
    `static HTML.Tag` | `IMG` | Tag <img>
    `static HTML.Tag` | `IMPLIED` | All text content must be in a paragraph element.
    `static HTML.Tag` | `INPUT` | Tag <input>
    `static HTML.Tag` | `ISINDEX` | Tag <isindex>
    `static HTML.Tag` | `KBD` | Tag <kbd>
    `static HTML.Tag` | `LI` | Tag <li>
    `static HTML.Tag` | `LINK` | Tag <link>
    `static HTML.Tag` | `MAP` | Tag <map>
    `static HTML.Tag` | `MENU` | Tag <menu>
    `static HTML.Tag` | `META` | Tag <meta>
    `static HTML.Tag` | `NOFRAMES` | Tag <noframes>
    `static HTML.Tag` | `OBJECT` | Tag <object>
    `static HTML.Tag` | `OL` | Tag <ol>
    `static HTML.Tag` | `OPTION` | Tag <option>
    `static HTML.Tag` | `P` | Tag <p>
    `static HTML.Tag` | `PARAM` | Tag <param>
    `static HTML.Tag` | `PRE` | Tag <pre>
    `static HTML.Tag` | `S` | Tag <s>
    `static HTML.Tag` | `SAMP` | Tag <samp>
    `static HTML.Tag` | `SCRIPT` | Tag <script>
    `static HTML.Tag` | `SELECT` | Tag <select>
    `static HTML.Tag` | `SMALL` | Tag <small>
    `static HTML.Tag` | `SPAN` | Tag <span>
    `static HTML.Tag` | `STRIKE` | Tag <strike>
    `static HTML.Tag` | `STRONG` | Tag <strong>
    `static HTML.Tag` | `STYLE` | Tag <style>
    `static HTML.Tag` | `SUB` | Tag <sub>
    `static HTML.Tag` | `SUP` | Tag <sup>
    `static HTML.Tag` | `TABLE` | Tag <table>
    `static HTML.Tag` | `TD` | Tag <td>
    `static HTML.Tag` | `TEXTAREA` | Tag <textarea>
    `static HTML.Tag` | `TH` | Tag <th>
    `static HTML.Tag` | `TITLE` | Tag <title>
    `static HTML.Tag` | `TR` | Tag <tr>
    `static HTML.Tag` | `TT` | Tag <tt>
    `static HTML.Tag` | `U` | Tag <u>
    `static HTML.Tag` | `UL` | Tag <ul>
    `static HTML.Tag` | `VAR` | Tag <var>

  - ### Constructor Summary

    Constructors
    Modifier | Constructor | Description
    --- | --- | ---
    `` | `Tag()` |
    `protected` | `Tag​(String id)` | Creates a new `Tag` with the specified `id`, and with `causesBreak` and `isBlock` set to `false`.
    `protected` | `Tag​(String id, boolean causesBreak, boolean isBlock)` | Creates a new `Tag` with the specified `id`; `causesBreak` and `isBlock` are defined by the user.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | `breaksFlow()` | Returns `true` if this tag causes a line break to the flow of data, otherwise returns `false`.
    `boolean` | `isBlock()` | Returns `true` if this tag is a block tag, which is a tag used to add structure to a document.
    `boolean` | `isPreformatted()` | Returns `true` if this tag is pre-formatted, which is true if the tag is either `PRE` or `TEXTAREA`.
    `String` | `toString()` | Returns the string representation of the tag.

    - ### Methods declared in class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### A

          public static final HTML.Tag A

      Tag <a>

    - #### ADDRESS

          public static final HTML.Tag ADDRESS

      Tag <address>

    - #### APPLET

          public static final HTML.Tag APPLET

      Tag <applet>

    - #### AREA

          public static final HTML.Tag AREA

      Tag <area>

    - #### B

          public static final HTML.Tag B

      Tag <b>

    - #### BASE

          public static final HTML.Tag BASE

      Tag <base>

    - #### BASEFONT

          public static final HTML.Tag BASEFONT

      Tag <basefont>

    - #### BIG

          public static final HTML.Tag BIG

      Tag <big>

    - #### BLOCKQUOTE

          public static final HTML.Tag BLOCKQUOTE

      Tag <blockquote>

    - #### BODY

          public static final HTML.Tag BODY

      Tag <body>

    - #### BR

          public static final HTML.Tag BR

      Tag <br>

    - #### CAPTION

          public static final HTML.Tag CAPTION

      Tag <caption>

    - #### CENTER

          public static final HTML.Tag CENTER

      Tag <center>

    - #### CITE

          public static final HTML.Tag CITE

      Tag <cite>

    - #### CODE

          public static final HTML.Tag CODE

      Tag <code>

    - #### DD

          public static final HTML.Tag DD

      Tag <dd>

    - #### DFN

          public static final HTML.Tag DFN

      Tag <dfn>

    - #### DIR

          public static final HTML.Tag DIR

      Tag <dir>

    - #### DIV

          public static final HTML.Tag DIV

      Tag <div>

    - #### DL

          public static final HTML.Tag DL

      Tag <dl>

    - #### DT

          public static final HTML.Tag DT

      Tag <dt>

    - #### EM

          public static final HTML.Tag EM

      Tag <em>

    - #### FONT

          public static final HTML.Tag FONT

      Tag <font>

    - #### FORM

          public static final HTML.Tag FORM

      Tag <form>

    - #### FRAME

          public static final HTML.Tag FRAME

      Tag <frame>

    - #### FRAMESET

          public static final HTML.Tag FRAMESET

      Tag <frameset>

    - #### H1

          public static final HTML.Tag H1

      Tag <h1>

    - #### H2

          public static final HTML.Tag H2

      Tag <h2>

    - #### H3

          public static final HTML.Tag H3

      Tag <h3>

    - #### H4

          public static final HTML.Tag H4

      Tag <h4>

    - #### H5

          public static final HTML.Tag H5

      Tag <h5>

    - #### H6

          public static final HTML.Tag H6

      Tag <h6>

    - #### HEAD

          public static final HTML.Tag HEAD

      Tag <head>

    - #### HR

          public static final HTML.Tag HR

      Tag <hr>

    - #### HTML

          public static final HTML.Tag HTML

      Tag <html>

    - #### I

          public static final HTML.Tag I

      Tag <i>

    - #### IMG

          public static final HTML.Tag IMG

      Tag <img>

    - #### INPUT

          public static final HTML.Tag INPUT

      Tag <input>

    - #### ISINDEX

          public static final HTML.Tag ISINDEX

      Tag <isindex>

    - #### KBD

          public static final HTML.Tag KBD

      Tag <kbd>

    - #### LI

          public static final HTML.Tag LI

      Tag <li>

    - #### LINK

          public static final HTML.Tag LINK

      Tag <link>

    - #### MAP

          public static final HTML.Tag MAP

      Tag <map>

    - #### MENU

          public static final HTML.Tag MENU

      Tag <menu>

    - #### META

          public static final HTML.Tag META

      Tag <meta>

    - #### NOFRAMES

          public static final HTML.Tag NOFRAMES

      Tag <noframes>

    - #### OBJECT

          public static final HTML.Tag OBJECT

      Tag <object>

    - #### OL

          public static final HTML.Tag OL

      Tag <ol>

    - #### OPTION

          public static final HTML.Tag OPTION

      Tag <option>

    - #### P

          public static final HTML.Tag P

      Tag <p>

    - #### PARAM

          public static final HTML.Tag PARAM

      Tag <param>

    - #### PRE

          public static final HTML.Tag PRE

      Tag <pre>

    - #### SAMP

          public static final HTML.Tag SAMP

      Tag <samp>

    - #### SCRIPT

          public static final HTML.Tag SCRIPT

      Tag <script>

    - #### SELECT

          public static final HTML.Tag SELECT

      Tag <select>

    - #### SMALL

          public static final HTML.Tag SMALL

      Tag <small>

    - #### SPAN

          public static final HTML.Tag SPAN

      Tag <span>

    - #### STRIKE

          public static final HTML.Tag STRIKE

      Tag <strike>

    - #### S

          public static final HTML.Tag S

      Tag <s>

    - #### STRONG

          public static final HTML.Tag STRONG

      Tag <strong>

    - #### STYLE

          public static final HTML.Tag STYLE

      Tag <style>

    - #### SUB

          public static final HTML.Tag SUB

      Tag <sub>

    - #### SUP

          public static final HTML.Tag SUP

      Tag <sup>

    - #### TABLE

          public static final HTML.Tag TABLE

      Tag <table>

    - #### TD

          public static final HTML.Tag TD

      Tag <td>

    - #### TEXTAREA

          public static final HTML.Tag TEXTAREA

      Tag <textarea>

    - #### TH

          public static final HTML.Tag TH

      Tag <th>

    - #### TITLE

          public static final HTML.Tag TITLE

      Tag <title>

    - #### TR

          public static final HTML.Tag TR

      Tag <tr>

    - #### TT

          public static final HTML.Tag TT

      Tag <tt>

    - #### U

          public static final HTML.Tag U

      Tag <u>

    - #### UL

          public static final HTML.Tag UL

      Tag <ul>

    - #### VAR

          public static final HTML.Tag VAR

      Tag <var>

    - #### IMPLIED

          public static final HTML.Tag IMPLIED

      All text content must be in a paragraph element. If a paragraph didn't exist when content was encountered, a paragraph is manufactured.

      This is a tag synthesized by the HTML reader. Since elements are identified by their tag type, we create a some fake tag types to mark the elements that were manufactured.

    - #### CONTENT

          public static final HTML.Tag CONTENT

      All text content is labeled with this tag.

      This is a tag synthesized by the HTML reader. Since elements are identified by their tag type, we create a some fake tag types to mark the elements that were manufactured.

    - #### COMMENT

          public static final HTML.Tag COMMENT

      All comments are labeled with this tag.

      This is a tag synthesized by the HTML reader. Since elements are identified by their tag type, we create a some fake tag types to mark the elements that were manufactured.

  - ### Constructor Detail

    - #### Tag

          public Tag()

      Since:
        1.3

    - #### Tag

          protected Tag​(String id)

      Creates a new `Tag` with the specified `id`, and with `causesBreak` and `isBlock` set to `false`.
      Parameters:
        `id` - the id of the new tag

    - #### Tag

          protected Tag​(String id,
                        boolean causesBreak,
                        boolean isBlock)

      Creates a new `Tag` with the specified `id`; `causesBreak` and `isBlock` are defined by the user.
      Parameters:
        `id` - the id of the new tag
        `causesBreak` - `true` if this tag causes a break to the flow of data
        `isBlock` - `true` if the tag is used to add structure to a document

  - ### Method Detail

    - #### isBlock

          public boolean isBlock()

      Returns `true` if this tag is a block tag, which is a tag used to add structure to a document.
      Returns:
        `true` if this tag is a block tag, otherwise returns `false`

    - #### breaksFlow

          public boolean breaksFlow()

      Returns `true` if this tag causes a line break to the flow of data, otherwise returns `false`.
      Returns:
        `true` if this tag causes a line break to the flow of data, otherwise returns `false`

    - #### isPreformatted

          public boolean isPreformatted()

      Returns `true` if this tag is pre-formatted, which is true if the tag is either `PRE` or `TEXTAREA`.
      Returns:
        `true` if this tag is pre-formatted, otherwise returns `false`

    - #### toString

          public String toString()

      Returns the string representation of the tag.
      Overrides:
        `toString` in class `Object`
      Returns:
        the `String` representation of the tag