com.sun.java.swing.text
Class AbstractDocument.LeafElement

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

Direct Known Subclasses:

HTMLDocument.RunElement

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 Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:

Element, Serialized Form

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

java.util.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.
java.lang.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.
java.lang.String	toString() Converts the element to a string.

Methods inherited from class com.sun.java.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 java.lang.String toString()

Converts the element to a string.

Returns:

the string

Overrides:

toString in class java.lang.Object

getStartOffset

public int getStartOffset()

Gets the starting offset in the model for the element.

Returns:

the offset >= 0

Overrides:

getStartOffset in class AbstractDocument.AbstractElement

getEndOffset

public int getEndOffset()

Gets the ending offset in the model for the element.

Returns:

the offset >= 0

Overrides:

getEndOffset in class AbstractDocument.AbstractElement

getName

public java.lang.String getName()

Gets the element name.

Returns:

the name

Overrides:

getName in class AbstractDocument.AbstractElement

getElementIndex

public int getElementIndex(int pos)

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

Parameters:

pos - the offset >= 0

Returns:

the element index >= 0

Overrides:

getElementIndex in class AbstractDocument.AbstractElement

getElement

public Element getElement(int index)

Gets a child element.

Parameters:

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

Returns:

the child element

Overrides:

getElement in class AbstractDocument.AbstractElement

getElementCount

public int getElementCount()

Returns the number of child elements.

Returns:

the number of children >= 0

Overrides:

getElementCount in class AbstractDocument.AbstractElement

isLeaf

public boolean isLeaf()

Checks whether the element is a leaf.

Returns:

true if a leaf

Overrides:

isLeaf in class AbstractDocument.AbstractElement

getAllowsChildren

public boolean getAllowsChildren()

Returns true if the receiver allows children.

Overrides:

getAllowsChildren in class AbstractDocument.AbstractElement

children

public java.util.Enumeration children()

Returns the children of the reciever as an Enumeration.

Overrides:

children in class AbstractDocument.AbstractElement