javax.swing.text
Class AbstractDocument.BranchElement
- 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
public class AbstractDocument.BranchElement extends AbstractDocument.AbstractElement
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.beanspackage. Please seeXMLEncoder.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface javax.swing.text.AttributeSet
AttributeSet.CharacterAttribute, AttributeSet.ColorAttribute, AttributeSet.FontAttribute, AttributeSet.ParagraphAttribute
-
-
Field Summary
-
Fields inherited from interface javax.swing.text.AttributeSet
NameAttribute, ResolveAttribute
-
-
Constructor Summary
Constructors Constructor and Description BranchElement(Element parent, AttributeSet a)Constructs a composite element that initially contains no children.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description Enumerationchildren()Returns the children of the receiver as anEnumeration.booleangetAllowsChildren()Returns true if the receiver allows children.ElementgetElement(int index)Gets a child element.intgetElementCount()Gets the number of children for the element.intgetElementIndex(int offset)Gets the child element index closest to the given model offset.intgetEndOffset()Gets the ending offset in the model for the element.StringgetName()Gets the element name.intgetStartOffset()Gets the starting offset in the model for the element.booleanisLeaf()Checks whether the element is a leaf.ElementpositionToElement(int pos)Gets the child element that contains the given model position.voidreplace(int offset, int length, Element[] elems)Replaces content with a new set of elements.StringtoString()Converts the element to a string.-
Methods inherited from 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 Detail
BranchElement
public BranchElement(Element parent, AttributeSet a)
Constructs a composite element that initially contains no children.- Parameters:
-
parent- The parent element -
a- the attributes for the element - Since:
- 1.4
-
Method Detail
positionToElement
public Element positionToElement(int pos)
Gets the child element that contains the given model position.- Parameters:
-
pos- the position >= 0 - Returns:
- the element, null if none
replace
public void replace(int offset, int length, Element[] elems)Replaces content with a new set of elements.- Parameters:
-
offset- the starting offset >= 0 -
length- the length to replace >= 0 -
elems- the new elements
toString
public String toString()
Converts the element to a string.
getName
public String getName()
Gets the element name.- Specified by:
-
getNamein interfaceElement - Overrides:
-
getNamein classAbstractDocument.AbstractElement - Returns:
- the element name
getStartOffset
public int getStartOffset()
Gets the starting offset in the model for the element.- Specified by:
-
getStartOffsetin interfaceElement - Specified by:
-
getStartOffsetin classAbstractDocument.AbstractElement - Returns:
- the offset >= 0
- See Also:
-
Document,AbstractDocument
getEndOffset
public int getEndOffset()
Gets the ending offset in the model for the element.- Specified by:
-
getEndOffsetin interfaceElement - Specified by:
-
getEndOffsetin classAbstractDocument.AbstractElement - Returns:
- the offset >= 0
- Throws:
-
NullPointerException- if this element has no children - See Also:
-
Document,AbstractDocument
getElement
public Element getElement(int index)
Gets a child element.- Specified by:
-
getElementin interfaceElement - Specified by:
-
getElementin 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:
-
getElementCountin interfaceElement - Specified by:
-
getElementCountin 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:
-
getElementIndexin interfaceElement - Specified by:
-
getElementIndexin 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:
-
getAllowsChildrenin interfaceTreeNode - Specified by:
-
getAllowsChildrenin classAbstractDocument.AbstractElement - Returns:
- true if the receiver allows children, otherwise false
children
public Enumeration children()
Returns the children of the receiver as anEnumeration.- Specified by:
-
childrenin interfaceTreeNode - Specified by:
-
childrenin classAbstractDocument.AbstractElement - Returns:
- the children of the receiver
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
