Java Platform 1.2

javax.swing.text
Class AbstractDocument.LeafElement

java.lang.Object
  |
  +--javax.swing.text.AbstractDocument.AbstractElement
        |
        +--javax.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 applications running the same version of Swing. A future release of Swing will provide support for long term persistence.

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
 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.
Returns:
the string
Overrides:
toString in class 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 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 Enumeration children()
Returns the children of the reciever as an Enumeration.
Overrides:
children in class AbstractDocument.AbstractElement

Java Platform 1.2

Submit a bug or feature Version 1.2 of Java Platform API Specification
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.