This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.swing.text.html
class HTML.Tag

java.lang.Object extended by 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
static HTML.Tag A
          
static HTML.Tag ADDRESS
          
static HTML.Tag APPLET
          
static HTML.Tag AREA
          
static HTML.Tag B
          
static HTML.Tag BASE
          
static HTML.Tag BASEFONT
          
static HTML.Tag BIG
          
static HTML.Tag BLOCKQUOTE
          
static HTML.Tag BODY
          
static HTML.Tag BR
          
static HTML.Tag CAPTION
          
static HTML.Tag CENTER
          
static HTML.Tag CITE
          
static HTML.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
          
static HTML.Tag DFN
          
static HTML.Tag DIR
          
static HTML.Tag DIV
          
static HTML.Tag DL
          
static HTML.Tag DT
          
static HTML.Tag EM
          
static HTML.Tag FONT
          
static HTML.Tag FORM
          
static HTML.Tag FRAME
          
static HTML.Tag FRAMESET
          
static HTML.Tag H1
          
static HTML.Tag H2
          
static HTML.Tag H3
          
static HTML.Tag H4
          
static HTML.Tag H5
          
static HTML.Tag H6
          
static HTML.Tag HEAD
          
static HTML.Tag HR
          
static HTML.Tag HTML
          
static HTML.Tag I
          
static HTML.Tag IMG
          
static HTML.Tag IMPLIED
          All text content must be in a paragraph element.
static HTML.Tag INPUT
          
static HTML.Tag ISINDEX
          
static HTML.Tag KBD
          
static HTML.Tag LI
          
static HTML.Tag LINK
          
static HTML.Tag MAP
          
static HTML.Tag MENU
          
static HTML.Tag META
          
static HTML.Tag NOFRAMES
          
static HTML.Tag OBJECT
          
static HTML.Tag OL
          
static HTML.Tag OPTION
          
static HTML.Tag P
          
static HTML.Tag PARAM
          
static HTML.Tag PRE
          
static HTML.Tag S
          
static HTML.Tag SAMP
          
static HTML.Tag SCRIPT
          
static HTML.Tag SELECT
          
static HTML.Tag SMALL
          
static HTML.Tag SPAN
          
static HTML.Tag STRIKE
          
static HTML.Tag STRONG
          
static HTML.Tag STYLE
          
static HTML.Tag SUB
          
static HTML.Tag SUP
          
static HTML.Tag TABLE
          
static HTML.Tag TD
          
static HTML.Tag TEXTAREA
          
static HTML.Tag TH
          
static HTML.Tag TITLE
          
static HTML.Tag TR
          
static HTML.Tag TT
          
static HTML.Tag U
          
static HTML.Tag UL
          
static HTML.Tag VAR
          
 
Constructor Summary
 

          
protected

          Creates a new Tag with the specified id, and with causesBreak and isBlock set to false.
protected
HTML.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
 boolean

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

          Returns true if this tag is a block tag, which is a tag used to add structure to a document.
 boolean

          Returns true if this tag is pre-formatted, which is true if the tag is either PRE or TEXTAREA.
 String

          Returns the string representation of the tag.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

A

public static final HTML.Tag A

ADDRESS

public static final HTML.Tag ADDRESS

APPLET

public static final HTML.Tag APPLET

AREA

public static final HTML.Tag AREA

B

public static final HTML.Tag B

BASE

public static final HTML.Tag BASE

BASEFONT

public static final HTML.Tag BASEFONT

BIG

public static final HTML.Tag BIG

BLOCKQUOTE

public static final HTML.Tag BLOCKQUOTE

BODY

public static final HTML.Tag BODY

BR

public static final HTML.Tag BR

CAPTION

public static final HTML.Tag CAPTION

CENTER

public static final HTML.Tag CENTER

CITE

public static final HTML.Tag CITE

CODE

public static final HTML.Tag CODE

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.


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.


DD

public static final HTML.Tag DD

DFN

public static final HTML.Tag DFN

DIR

public static final HTML.Tag DIR

DIV

public static final HTML.Tag DIV

DL

public static final HTML.Tag DL

DT

public static final HTML.Tag DT

EM

public static final HTML.Tag EM

FONT

public static final HTML.Tag FONT

FORM

public static final HTML.Tag FORM

FRAME

public static final HTML.Tag FRAME

FRAMESET

public static final HTML.Tag FRAMESET

H1

public static final HTML.Tag H1

H2

public static final HTML.Tag H2

H3

public static final HTML.Tag H3

H4

public static final HTML.Tag H4

H5

public static final HTML.Tag H5

H6

public static final HTML.Tag H6

HEAD

public static final HTML.Tag HEAD

HR

public static final HTML.Tag HR

HTML

public static final HTML.Tag HTML

I

public static final HTML.Tag I

IMG

public static final HTML.Tag IMG

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.


INPUT

public static final HTML.Tag INPUT

ISINDEX

public static final HTML.Tag ISINDEX

KBD

public static final HTML.Tag KBD

LI

public static final HTML.Tag LI

LINK

public static final HTML.Tag LINK

MAP

public static final HTML.Tag MAP

MENU

public static final HTML.Tag MENU

META

public static final HTML.Tag META

NOFRAMES

public static final HTML.Tag NOFRAMES

OBJECT

public static final HTML.Tag OBJECT

OL

public static final HTML.Tag OL

OPTION

public static final HTML.Tag OPTION

P

public static final HTML.Tag P

PARAM

public static final HTML.Tag PARAM

PRE

public static final HTML.Tag PRE

S

public static final HTML.Tag S

SAMP

public static final HTML.Tag SAMP

SCRIPT

public static final HTML.Tag SCRIPT

SELECT

public static final HTML.Tag SELECT

SMALL

public static final HTML.Tag SMALL

SPAN

public static final HTML.Tag SPAN

STRIKE

public static final HTML.Tag STRIKE

STRONG

public static final HTML.Tag STRONG

STYLE

public static final HTML.Tag STYLE

SUB

public static final HTML.Tag SUB

SUP

public static final HTML.Tag SUP

TABLE

public static final HTML.Tag TABLE

TD

public static final HTML.Tag TD

TEXTAREA

public static final HTML.Tag TEXTAREA

TH

public static final HTML.Tag TH

TITLE

public static final HTML.Tag TITLE

TR

public static final HTML.Tag TR

TT

public static final HTML.Tag TT

U

public static final HTML.Tag U

UL

public static final HTML.Tag UL

VAR

public static final HTML.Tag VAR
Constructor Detail

HTML.Tag

public HTML.Tag()

HTML.Tag

protected HTML.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

HTML.Tag

protected HTML.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

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

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

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


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.