APIdia Launch Partner

Top Description Fields Constructors Methods

javax.swing.text.html.parser

public final Class Element

Class Inheritance

extends Object
implements DTDConstants, Serializable

java.lang.Object
javax.swing.text.html.parser.Element

All Implemented Interfaces

java.io.Serializable, javax.swing.text.html.parser.DTDConstants

Annotations

@SuppressWarnings:serial

Imports

java.io.Serializable, java.util.BitSet, .Map

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.

Author: Arthur van Hoff
See Also: DTD, AttributeList

Field Summary

Modifier and Type	Field and Description
public AttributeList	atts The attributes
public ContentModel	content The content model
private static final Map<String, Integer>	contentTypes
public Object	data A field to store user data.
public BitSet	exclusions The set of elements that must not occur inside the element
public BitSet	inclusions The set of elements that can occur inside the element
public int	index The element index
private static int	maxIndex
public String	name The name of the element
public boolean	oEnd `true` if the end tag can be omitted
public boolean	oStart `true` if the start tag can be omitted
public int	type The element type

Constructor Summary

Access	Constructor and Description
pack-priv	Element()
pack-priv	Element(String the name of the element name, int the index index) Create a new element.

Method Summary

Modifier and Type	Method and Description
public AttributeList	Returns: the `AttributeList` for the given `name` getAttribute(String the attribute name name) Get an attribute by name.
public AttributeList	Returns: the `AttributeList` for the given `value` getAttributeByValue(String the string representation of value value) Get an attribute by value.
public AttributeList	Returns: the `AttributeList` specifying the element getAttributes() Get the attributes.
public ContentModel	Returns: the content model getContent() Get content model
public int	Returns: the element index getIndex() Get index.
pack-priv static int	getMaxIndex()
public String	Returns: the name of the element getName() Get the name of the element.
public int	Returns: the type of the element getType() Get type.
public boolean	Returns: true if the current element is empty isEmpty() Check if empty
public static int	Returns: appropriate DTDConstants if the `nm` is equal to CDATA, RCDATA, EMPTY or ANY, 0 otherwise. name2type(String a name nm) Converts `nm` to type.
public boolean	Returns: `true` if the end tag can be omitted omitEnd() Return true if the end tag can be omitted.
public boolean	Returns: `true` if the start tag can be omitted omitStart() Return true if the start tag can be omitted.
public String	Returns: a string representation for the given `Element` instance toString() Overrides java.lang.Object.toString. Convert to a string.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

atts	back to summary
public AttributeList atts The attributes

content	back to summary
public ContentModel content The content model

contentTypes	back to summary
private static final Map<String, Integer> contentTypes

data	back to summary
public Object data A field to store user data. Mostly used to store style sheets.

exclusions	back to summary
public BitSet exclusions The set of elements that must not occur inside the element

inclusions	back to summary
public BitSet inclusions The set of elements that can occur inside the element

index	back to summary
public int index The element index

maxIndex	back to summary
private static int maxIndex

name	back to summary
public String name The name of the element

oEnd	back to summary
public boolean oEnd `true` if the end tag can be omitted

oStart	back to summary
public boolean oStart `true` if the start tag can be omitted

type	back to summary
public int type The element type

Constructor Detail

Element	back to summary
pack-priv Element()

Element

back to summary

pack-priv Element(String name, int index)

Create a new element.

Parameters

name:String: the name of the element
index:int: the index

Method Detail

getAttribute back to summary

public AttributeList getAttribute(String name)

Get an attribute by name.

Parameters

name:String: the attribute name

Returns:AttributeList

the AttributeList for the given name

getAttributeByValue back to summary

public AttributeList getAttributeByValue(String value)

Get an attribute by value.

Parameters

value:String: the string representation of value

Returns:AttributeList

the AttributeList for the given value

getAttributes back to summary

public AttributeList getAttributes()

Get the attributes.

Returns:AttributeList: the AttributeList specifying the element

getContent

back to summary

public ContentModel getContent()

Get content model

Returns:ContentModel: the content model

getIndex

back to summary

public int getIndex()

Get index.

Returns:int: the element index

getMaxIndex	back to summary
pack-priv static int getMaxIndex()

getName

back to summary

public String getName()

Get the name of the element.

Returns:String: the name of the element

getType

back to summary

public int getType()

Get type.

Returns:int: the type of the element

isEmpty

back to summary

public boolean isEmpty()

Check if empty

Returns:boolean: true if the current element is empty

name2type back to summary

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:String: a name

Returns:int

appropriate DTDConstants if the nm is equal to CDATA, RCDATA, EMPTY or ANY, 0 otherwise.

omitEnd back to summary

public boolean omitEnd()

Return true if the end tag can be omitted.

Returns:boolean: true if the end tag can be omitted

omitStart back to summary

public boolean omitStart()

Return true if the start tag can be omitted.

Returns:boolean: true if the start tag can be omitted

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Convert to a string.

Returns:String: a string representation for the given Element instance