Class Element
- java.lang.Object
-
- javax.swing.text.html.parser.Element
- All Implemented Interfaces:
-
Serializable
,DTDConstants
public final class Element extends Object implements DTDConstants, Serializable
An element as described in a DTD using the ELEMENT construct. This is essential the description of a tag. It describes the type, content model, attributes, attribute types etc. It is used to correctly parse a document by the Parser.
- See Also:
-
DTD
,AttributeList
, Serialized Form
Field Summary
Modifier and Type | Field | Description |
---|---|---|
AttributeList | atts | The attributes |
ContentModel | content | The content model |
Object | data | A field to store user data. |
BitSet | exclusions | The set of elements that must not occur inside the element |
BitSet | inclusions | The set of elements that can occur inside the element |
int | index | The element index |
String | name | The name of the element |
boolean | oEnd |
|
boolean | oStart |
|
int | type | The element type |
Fields declared in interface javax.swing.text.html.parser.DTDConstants
ANY, CDATA, CONREF, CURRENT, DEFAULT, EMPTY, ENDTAG, ENTITIES, ENTITY, FIXED, GENERAL, ID, IDREF, IDREFS, IMPLIED, MD, MODEL, MS, NAME, NAMES, NMTOKEN, NMTOKENS, NOTATION, NUMBER, NUMBERS, NUTOKEN, NUTOKENS, PARAMETER, PI, PUBLIC, RCDATA, REQUIRED, SDATA, STARTTAG, SYSTEM
Method Summary
Modifier and Type | Method | Description |
---|---|---|
AttributeList | getAttribute(String name) | Get an attribute by name. |
AttributeList | getAttributeByValue(String value) | Get an attribute by value. |
AttributeList | getAttributes() | Get the attributes. |
ContentModel | getContent() | Get content model |
int | getIndex() | Get index. |
String | getName() | Get the name of the element. |
int | getType() | Get type. |
boolean | isEmpty() | Check if empty |
static int | name2type(String nm) | Converts |
boolean | omitEnd() | Return true if the end tag can be omitted. |
boolean | omitStart() | Return true if the start tag can be omitted. |
String | toString() | Convert to a string. |
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Field Detail
index
public int index
The element index
name
public String name
The name of the element
oStart
public boolean oStart
true
if the start tag can be omitted
oEnd
public boolean oEnd
true
if the end tag can be omitted
inclusions
public BitSet inclusions
The set of elements that can occur inside the element
exclusions
public BitSet exclusions
The set of elements that must not occur inside the element
type
public int type
The element type
content
public ContentModel content
The content model
atts
public AttributeList atts
The attributes
data
public Object data
A field to store user data. Mostly used to store style sheets.
Method Detail
getName
public String getName()
Get the name of the element.
- Returns:
- the name of the element
omitStart
public boolean omitStart()
Return true if the start tag can be omitted.
- Returns:
-
true
if the start tag can be omitted
omitEnd
public boolean omitEnd()
Return true if the end tag can be omitted.
- Returns:
-
true
if the end tag can be omitted
getType
public int getType()
Get type.
- Returns:
- the type of the element
getContent
public ContentModel getContent()
Get content model
- Returns:
- the content model
getAttributes
public AttributeList getAttributes()
Get the attributes.
- Returns:
- the
AttributeList
specifying the element
getIndex
public int getIndex()
Get index.
- Returns:
- the element index
isEmpty
public boolean isEmpty()
Check if empty
- Returns:
- true if the current element is empty
toString
public String toString()
Convert to a string.
getAttribute
public AttributeList getAttribute(String name)
Get an attribute by name.
- Parameters:
-
name
- the attribute name - Returns:
- the
AttributeList
for the givenname
getAttributeByValue
public AttributeList getAttributeByValue(String value)
Get an attribute by value.
- Parameters:
-
value
- the string representation of value - Returns:
- the
AttributeList
for the givenvalue
name2type
public static int name2type(String nm)
Converts nm
to type. Returns appropriate DTDConstants if the nm
is equal to CDATA, RCDATA, EMPTY or ANY, 0 otherwise.
- Parameters:
-
nm
- a name - Returns:
- appropriate DTDConstants if the
nm
is equal to CDATA, RCDATA, EMPTY or ANY, 0 otherwise.