Interface java.awt.swing.text.Element
- Implementing Classes:
- AbstractDocument.AbstractElement
- public interface Element
Interface to describe a structural piece of a document. It
is intended to capture the spirit of an SGML element.
getDocument
public Document getDocument()
- Fetches the document associated with this element.
- Returns:
- the document
getParentElement
public Element getParentElement()
- Fetches the parent element. If the element is a root level
element returns null.
- Returns:
- the parent element
getName
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.
- Returns:
- the element name
getAttributes
public AttributeSet getAttributes()
- Fetches the collection of attributes this element contains.
- Returns:
- the attributes for the element
getStartOffset
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.
- Returns:
- the starting offset
getEndOffset
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.
- Returns:
- the ending offset
getElementIndex
public int getElementIndex(int offset)
- Gets the child element index closest to the given offset.
The offset is specified relative to the begining of the
document.
- Parameters:
offset
- the specified offset
- Returns:
- the element index
getElementCount
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.
- Returns:
- the number of child elements
getElement
public Element getElement(int index)
- Fetches the child element at the given index.
- Parameters:
index
- the specified index
- Returns:
- the child element
isLeaf
public boolean isLeaf()
- Is this element a leaf element?
- Returns:
- true if a leaf element else false
Submit a bug or feature
Submit comments/suggestions about new javadoc look.
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.