All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Class java.awt.swing.text.AbstractDocument.BranchElement

java.lang.Object
    |
    +----java.awt.swing.text.AbstractDocument.AbstractElement
            |
            +----java.awt.swing.text.AbstractDocument.BranchElement

public class AbstractDocument.BranchElement
extends AbstractDocument.AbstractElement
Implements a composite element that contains other elements.


Constructor Index

 o AbstractDocument.BranchElement(AbstractDocument, Element, AttributeSet)
Construct a composite element that initially contains no children.

Method Index

 o getElement(int)
Gets a child element.
 o getElementCount()
Gets the number of children for the element.
 o getElementIndex(int)
Gets the child element index closest to the given model offset.
 o getEndOffset()
Gets the ending offset in the model for the element.
 o getName()
Gets the element name.
 o getStartOffset()
Gets the starting offset in the model for the element.
 o isLeaf()
Checks whether the element is a leaf.
 o positionToElement(int)
Convenience function to get the child element that contains the given position.
 o replace(int, int, Element[])
Replaces content with a new set of elements.
 o toString()
Converts the element to a string.

Constructors

 o AbstractDocument.BranchElement
public AbstractDocument.BranchElement(AbstractDocument this$0,
                                      Element parent,
                                      AttributeSet a)
Construct a composite element that initially contains no children.

Parameters:
parent - The parent element
a - the attributes for the element

Methods

 o positionToElement
public Element positionToElement(int pos)
Convenience function to get the child element that contains the given position.

Parameters:
pos - the position
Returns:
the element
 o replace
public void replace(int offset,
                    int length,
                    Element[] elems)
Replaces content with a new set of elements.

Parameters:
offset - the starting offset
length - the length to replace
elems - the new elements
 o toString
public String toString()
Converts the element to a string.

Returns:
the string
Overrides:
toString in class Object
 o getName
public String getName()
Gets the element name.

Returns:
the element name
Overrides:
getName in class AbstractDocument.AbstractElement
 o getStartOffset
public int getStartOffset()
Gets the starting offset in the model for the element.

Returns:
the offset
Overrides:
getStartOffset in class AbstractDocument.AbstractElement
 o getEndOffset
public int getEndOffset()
Gets the ending offset in the model for the element.

Returns:
the offset
Overrides:
getEndOffset in class AbstractDocument.AbstractElement
 o getElement
public Element getElement(int index)
Gets a child element.

Parameters:
index - the child index
Returns:
the child element
Overrides:
getElement in class AbstractDocument.AbstractElement
 o getElementCount
public int getElementCount()
Gets the number of children for the element.

Returns:
the number of children
Overrides:
getElementCount in class AbstractDocument.AbstractElement
 o getElementIndex
public int getElementIndex(int offset)
Gets the child element index closest to the given model offset.

Parameters:
offset - the offset
Returns:
the element index
Overrides:
getElementIndex in class AbstractDocument.AbstractElement
 o isLeaf
public boolean isLeaf()
Checks whether the element is a leaf.

Returns:
true if a leaf
Overrides:
isLeaf in class AbstractDocument.AbstractElement

All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Submit a bug or feature