java.lang.Object
javax.swing.text.AbstractDocument.AbstractElement
javax.swing.text.AbstractDocument.BranchElement
- All Implemented Interfaces:
Serializable
,AttributeSet
,Element
,MutableAttributeSet
,TreeNode
- Direct Known Subclasses:
DefaultStyledDocument.SectionElement
,HTMLDocument.BlockElement
- Enclosing class:
AbstractDocument
Implements a composite element that contains other elements.
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. As of 1.4, support for long term storage
of all JavaBeans
has been added to the java.beans
package.
Please see XMLEncoder
.
-
Nested Class Summary
Nested classes/interfaces declared in interface javax.swing.text.AttributeSet
AttributeSet.CharacterAttribute, AttributeSet.ColorAttribute, AttributeSet.FontAttribute, AttributeSet.ParagraphAttribute
-
Field Summary
Fields declared in interface javax.swing.text.AttributeSet
NameAttribute, ResolveAttribute
-
Constructor Summary
ConstructorDescriptionBranchElement
(Element parent, AttributeSet a) Constructs a composite element that initially contains no children. -
Method Summary
Modifier and TypeMethodDescriptionchildren()
Returns the children of the receiver as anEnumeration
.boolean
Returns true if the receiver allows children.getElement
(int index) Gets a child element.int
Gets the number of children for the element.int
getElementIndex
(int offset) Gets the child element index closest to the given model offset.int
Gets the ending offset in the model for the element.getName()
Gets the element name.int
Gets the starting offset in the model for the element.boolean
isLeaf()
Checks whether the element is a leaf.positionToElement
(int pos) Gets the child element that contains the given model position.void
Replaces content with a new set of elements.toString()
Converts the element to a string.Methods declared in class javax.swing.text.AbstractDocument.AbstractElement
addAttribute, addAttributes, containsAttribute, containsAttributes, copyAttributes, dump, getAttribute, getAttributeCount, getAttributeNames, getAttributes, getChildAt, getChildCount, getDocument, getIndex, getParent, getParentElement, getResolveParent, isDefined, isEqual, removeAttribute, removeAttributes, removeAttributes, setResolveParent
-
Constructor Details
-
BranchElement
Constructs a composite element that initially contains no children.- Parameters:
parent
- The parent elementa
- the attributes for the element- Since:
- 1.4
-
-
Method Details
-
positionToElement
Gets the child element that contains the given model position.- Parameters:
pos
- the position >= 0- Returns:
- the element, null if none
-
replace
Replaces content with a new set of elements.- Parameters:
offset
- the starting offset >= 0length
- the length to replace >= 0elems
- the new elements
-
toString
Converts the element to a string. -
getName
Gets the element name.- Specified by:
getName
in interfaceElement
- Overrides:
getName
in classAbstractDocument.AbstractElement
- Returns:
- the element name
-
getStartOffset
public int getStartOffset()Gets the starting offset in the model for the element.- Specified by:
getStartOffset
in interfaceElement
- Specified by:
getStartOffset
in classAbstractDocument.AbstractElement
- Returns:
- the offset >= 0
- See Also:
-
getEndOffset
public int getEndOffset()Gets the ending offset in the model for the element.- Specified by:
getEndOffset
in interfaceElement
- Specified by:
getEndOffset
in classAbstractDocument.AbstractElement
- Returns:
- the offset >= 0
- Throws:
NullPointerException
- if this element has no children- See Also:
-
getElement
Gets a child element.- Specified by:
getElement
in interfaceElement
- Specified by:
getElement
in classAbstractDocument.AbstractElement
- Parameters:
index
- the child index, >= 0 && < getElementCount()- Returns:
- the child element, null if none
-
getElementCount
public int getElementCount()Gets the number of children for the element.- Specified by:
getElementCount
in interfaceElement
- Specified by:
getElementCount
in classAbstractDocument.AbstractElement
- Returns:
- the number of children >= 0
-
getElementIndex
public int getElementIndex(int offset) Gets the child element index closest to the given model offset.- Specified by:
getElementIndex
in interfaceElement
- Specified by:
getElementIndex
in classAbstractDocument.AbstractElement
- Parameters:
offset
- the offset >= 0- Returns:
- the element index >= 0
-
isLeaf
public boolean isLeaf()Checks whether the element is a leaf. -
getAllowsChildren
public boolean getAllowsChildren()Returns true if the receiver allows children.- Specified by:
getAllowsChildren
in interfaceTreeNode
- Specified by:
getAllowsChildren
in classAbstractDocument.AbstractElement
- Returns:
- true if the receiver allows children, otherwise false
-
children
Returns the children of the receiver as anEnumeration
.- Specified by:
children
in interfaceTreeNode
- Specified by:
children
in classAbstractDocument.AbstractElement
- Returns:
- the children of the receiver
-