javax.swing.text

Class AbstractDocument.LeafElement

java.lang.Object

javax.swing.text.AbstractDocument.AbstractElement

javax.swing.text.AbstractDocument.LeafElement

All Implemented Interfaces:

Serializable, AttributeSet, Element, MutableAttributeSet, TreeNode

Direct Known Subclasses:

HTMLDocument.RunElement

Enclosing class:

AbstractDocument

public class AbstractDocument.LeafElement
extends AbstractDocument.AbstractElement

Implements an element that directly represents content of some kind.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see XMLEncoder.

See Also:

Element

Nested Class Summary

Nested classes/interfaces inherited from interface javax.swing.text.AttributeSet

AttributeSet.CharacterAttribute, AttributeSet.ColorAttribute, AttributeSet.FontAttribute, AttributeSet.ParagraphAttribute

Field Summary

Fields inherited from interface javax.swing.text.AttributeSet

NameAttribute, ResolveAttribute

Constructor Summary

Constructors

Constructor and Description
AbstractDocument.LeafElement(Element parent, AttributeSet a, int offs0, int offs1) Constructs an element that represents content within the document (has no children).

Method Summary

Methods

Modifier and Type	Method and Description
Enumeration	children() Returns the children of the receiver as an Enumeration.
boolean	getAllowsChildren() Returns true if the receiver allows children.
Element	getElement(int index) Gets a child element.
int	getElementCount() Returns the number of child elements.
int	getElementIndex(int pos) Gets the child element index closest to the given model offset.
int	getEndOffset() Gets the ending offset in the model for the element.
String	getName() Gets the element name.
int	getStartOffset() Gets the starting offset in the model for the element.
boolean	isLeaf() Checks whether the element is a leaf.
String	toString() Converts the element to a string.

Methods inherited from class javax.swing.text.AbstractDocument.AbstractElement

addAttribute, addAttributes, containsAttribute, containsAttributes, copyAttributes, dump, getAttribute, getAttributeCount, getAttributeNames, getAttributes, getChildAt, getChildCount, getDocument, getIndex, getParent, getParentElement, getResolveParent, isDefined, isEqual, removeAttribute, removeAttributes, removeAttributes, setResolveParent

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDocument.LeafElement

public AbstractDocument.LeafElement(Element parent,
                            AttributeSet a,
                            int offs0,
                            int offs1)

Constructs an element that represents content within the document (has no children).

Parameters:

parent - The parent element

a - The element attributes

offs0 - The start offset >= 0

offs1 - The end offset >= offs0

Since:

1.4

Method Detail

toString

public String toString()

Converts the element to a string.

Overrides:

toString in class Object

Returns:

the string

getStartOffset

public int getStartOffset()

Gets the starting offset in the model for the element.

Specified by:

getStartOffset in interface Element

Specified by:

getStartOffset in class AbstractDocument.AbstractElement

Returns:

the offset >= 0

See Also:

Document, AbstractDocument

getEndOffset

public int getEndOffset()

Gets the ending offset in the model for the element.

Specified by:

getEndOffset in interface Element

Specified by:

getEndOffset in class AbstractDocument.AbstractElement

Returns:

the offset >= 0

See Also:

Document, AbstractDocument

getName

public String getName()

Gets the element name.

Specified by:

getName in interface Element

Overrides:

getName in class AbstractDocument.AbstractElement

Returns:

the name

getElementIndex

public int getElementIndex(int pos)

Gets the child element index closest to the given model offset.

Specified by:

getElementIndex in interface Element

Specified by:

getElementIndex in class AbstractDocument.AbstractElement

Parameters:

pos - the offset >= 0

Returns:

the element index >= 0

getElement

public Element getElement(int index)

Gets a child element.

Specified by:

getElement in interface Element

Specified by:

getElement in class AbstractDocument.AbstractElement

Parameters:

index - the child index, >= 0 && < getElementCount()

Returns:

the child element

getElementCount

public int getElementCount()

Returns the number of child elements.

Specified by:

getElementCount in interface Element

Specified by:

getElementCount in class AbstractDocument.AbstractElement

Returns:

the number of children >= 0

isLeaf

public boolean isLeaf()

Checks whether the element is a leaf.

Specified by:

isLeaf in interface Element

Specified by:

isLeaf in interface TreeNode

Specified by:

isLeaf in class AbstractDocument.AbstractElement

Returns:

true if a leaf

getAllowsChildren

public boolean getAllowsChildren()

Returns true if the receiver allows children.

Specified by:

getAllowsChildren in interface TreeNode

Specified by:

getAllowsChildren in class AbstractDocument.AbstractElement

Returns:

true if the receiver allows children, otherwise false

children

public Enumeration children()

Returns the children of the receiver as an Enumeration.

Specified by:

children in interface TreeNode

Specified by:

children in class AbstractDocument.AbstractElement

Returns:

the children of the receiver