public interface

Element

javax.swing.text.Element
Known Indirect Subclasses

Class Overview

Interface to describe a structural piece of a document. It is intended to capture the spirit of an SGML element.

Summary

Public Methods
abstract AttributeSet getAttributes()
Fetches the collection of attributes this element contains.
abstract Document getDocument()
Fetches the document associated with this element.
abstract Element getElement(int index)
Fetches the child element at the given index.
abstract int getElementCount()
Gets the number of child elements contained by this element.
abstract int getElementIndex(int offset)
Gets the child element index closest to the given offset.
abstract int getEndOffset()
Fetches the offset from the beginning of the document that this element ends at.
abstract String getName()
Fetches the name of the element.
abstract Element getParentElement()
Fetches the parent element.
abstract int getStartOffset()
Fetches the offset from the beginning of the document that this element begins at.
abstract boolean isLeaf()
Is this element a leaf element? An element that may have children, even if it currently has no children, would return false.

Public Methods

public abstract AttributeSet getAttributes ()

Fetches the collection of attributes this element contains.

Returns
  • the attributes for the element

public abstract Document getDocument ()

Fetches the document associated with this element.

Returns
  • the document

public abstract Element getElement (int index)

Fetches the child element at the given index.

Parameters
index the specified index >= 0
Returns
  • the child element

public abstract 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 >= 0

public abstract 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.

Parameters
offset the specified offset >= 0
Returns
  • the element index >= 0

public abstract 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.

Returns
  • the ending offset > getStartOffset() and <= getDocument().getLength() + 1
See Also

public abstract 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

public abstract Element getParentElement ()

Fetches the parent element. If the element is a root level element returns null.

Returns
  • the parent element

public abstract 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.

Returns
  • the starting offset >= 0 and < getEndOffset();
See Also

public abstract boolean isLeaf ()

Is this element a leaf element? An element that may have children, even if it currently has no children, would return false.

Returns
  • true if a leaf element else false