Home » openjdk-7 » javax » swing » text » [javadoc | source]
javax.swing.text
public interface: Element [javadoc | source]

All Known Implementing Classes:
    BidiRootElement, BidiElement, BranchElement, AbstractElement, LeafElement

Interface to describe a structural piece of a document. It is intended to capture the spirit of an SGML element.
Method from javax.swing.text.Element Summary:
getAttributes,   getDocument,   getElement,   getElementCount,   getElementIndex,   getEndOffset,   getName,   getParentElement,   getStartOffset,   isLeaf
Method from javax.swing.text.Element Detail:
 public AttributeSet getAttributes()
    Fetches the collection of attributes this element contains.
 public Document getDocument()
    Fetches the document associated with this element.
 public Element getElement(int index)
    Fetches the child element at the given index.
 public int getElementCount()
    Gets the number of child elements contained by this element. If this element is a leaf, a count of zero is returned.
 public int getElementIndex(int offset)
    Gets the child element index closest to the given offset. The offset is specified relative to the beginning of the document. Returns -1 if the Element is a leaf, otherwise returns the index of the Element that best represents the given location. Returns 0 if the location is less than the start offset. Returns getElementCount() - 1 if the location is greater than or equal to the end offset.
 public int getEndOffset()
    Fetches the offset from the beginning of the document that this element ends at. If this element has children, this will be the end offset of the last child. As a document position, there is an implied backward bias.

    All the default Document implementations descend from AbstractDocument. AbstractDocument models an implied break at the end of the document. As a result of this, it is possible for this to return a value greater than the length of the document.

 public String getName()
    Fetches the name of the element. If the element is used to represent some type of structure, this would be the type name.
 public Element getParentElement()
    Fetches the parent element. If the element is a root level element returns null.
 public int getStartOffset()
    Fetches the offset from the beginning of the document that this element begins at. If this element has children, this will be the offset of the first child. As a document position, there is an implied forward bias.
 public boolean isLeaf()
    Is this element a leaf element? An element that may have children, even if it currently has no children, would return false.