javax.swing.text
Class AbstractDocument.LeafElement

java.lang.Object
  |
  +--javax.swing.text.AbstractDocument.AbstractElement
        |
        +--javax.swing.text.AbstractDocument.LeafElement

All Implemented Interfaces:

AttributeSet, Element, MutableAttributeSet, Serializable, 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. A future release of Swing will provide support for long term persistence.

See Also:

Element, Serialized Form

Inner classes inherited from class javax.swing.text.AttributeSet

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

Fields inherited from interface javax.swing.text.AttributeSet

NameAttribute, ResolveAttribute

Constructor Summary

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

Method Summary

Enumeration	children() Returns the children of the reciever 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, finalize, 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, 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

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.

Overrides:

getStartOffset in class AbstractDocument.AbstractElement

Returns:

the offset >= 0

getEndOffset

public int getEndOffset()

Gets the ending offset in the model for the element.

Overrides:

getEndOffset in class AbstractDocument.AbstractElement

Returns:

the offset >= 0

getName

public String getName()

Gets the element name.

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.

Overrides:

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.

Overrides:

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.

Overrides:

getElementCount in class AbstractDocument.AbstractElement

Returns:

the number of children >= 0

isLeaf

public boolean isLeaf()

Checks whether the element is a leaf.

Overrides:

isLeaf in class AbstractDocument.AbstractElement

Returns:

true if a leaf

getAllowsChildren

public boolean getAllowsChildren()

Returns true if the receiver allows children.

Overrides:

getAllowsChildren in class AbstractDocument.AbstractElement

children

public Enumeration children()

Returns the children of the reciever as an Enumeration.

Overrides:

children in class AbstractDocument.AbstractElement