- 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.- See Also:
- Serialized Form
 
- 
- 
Nested Class Summary- 
Nested classes/interfaces declared in interface javax.swing.text.AttributeSetAttributeSet.CharacterAttribute, AttributeSet.ColorAttribute, AttributeSet.FontAttribute, AttributeSet.ParagraphAttribute
 
- 
 - 
Field Summary- 
Fields declared in interface javax.swing.text.AttributeSetNameAttribute, ResolveAttribute
 
- 
 - 
Constructor SummaryConstructors Constructor Description BranchElement(Element parent, AttributeSet a)Constructs a composite element that initially contains no children.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description Enumeration<TreeNode>children()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 declared in class javax.swing.text.AbstractDocument.AbstractElementaddAttribute, addAttributes, containsAttribute, containsAttributes, copyAttributes, dump, getAttribute, getAttributeCount, getAttributeNames, getAttributes, getChildAt, getChildCount, getDocument, getIndex, getParent, getParentElement, getResolveParent, isDefined, isEqual, removeAttribute, removeAttributes, removeAttributes, setResolveParent
 
- 
 
- 
- 
- 
Constructor Detail- 
BranchElementpublic 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- 
positionToElementpublic 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
 
 - 
replacepublic 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
 
 - 
toStringpublic String toString() Converts the element to a string.
 - 
getNamepublic String getName() Gets the element name.- Specified by:
- getNamein interface- Element
- Overrides:
- getNamein class- AbstractDocument.AbstractElement
- Returns:
- the element name
 
 - 
getStartOffsetpublic int getStartOffset() Gets the starting offset in the model for the element.- Specified by:
- getStartOffsetin interface- Element
- Specified by:
- getStartOffsetin class- AbstractDocument.AbstractElement
- Returns:
- the offset >= 0
- See Also:
- Document,- AbstractDocument
 
 - 
getEndOffsetpublic int getEndOffset() Gets the ending offset in the model for the element.- Specified by:
- getEndOffsetin interface- Element
- Specified by:
- getEndOffsetin class- AbstractDocument.AbstractElement
- Returns:
- the offset >= 0
- Throws:
- NullPointerException- if this element has no children
- See Also:
- Document,- AbstractDocument
 
 - 
getElementpublic Element getElement(int index) Gets a child element.- Specified by:
- getElementin interface- Element
- Specified by:
- getElementin class- AbstractDocument.AbstractElement
- Parameters:
- index- the child index, >= 0 && < getElementCount()
- Returns:
- the child element, null if none
 
 - 
getElementCountpublic int getElementCount() Gets the number of children for the element.- Specified by:
- getElementCountin interface- Element
- Specified by:
- getElementCountin class- AbstractDocument.AbstractElement
- Returns:
- the number of children >= 0
 
 - 
getElementIndexpublic int getElementIndex(int offset) Gets the child element index closest to the given model offset.- Specified by:
- getElementIndexin interface- Element
- Specified by:
- getElementIndexin class- AbstractDocument.AbstractElement
- Parameters:
- offset- the offset >= 0
- Returns:
- the element index >= 0
 
 - 
isLeafpublic boolean isLeaf() Checks whether the element is a leaf.
 - 
getAllowsChildrenpublic boolean getAllowsChildren() Returns true if the receiver allows children.- Specified by:
- getAllowsChildrenin interface- TreeNode
- Specified by:
- getAllowsChildrenin class- AbstractDocument.AbstractElement
- Returns:
- true if the receiver allows children, otherwise false
 
 - 
childrenpublic Enumeration<TreeNode> children() Returns the children of the receiver as anEnumeration.- Specified by:
- childrenin interface- TreeNode
- Specified by:
- childrenin class- AbstractDocument.AbstractElement
- Returns:
- the children of the receiver
 
 
- 
 
-