AbstractDocument.BranchElement (Java Platform SE 8 ) (original) (raw)

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.beans package. Please see XMLEncoder.

Nested Class Summary

 * ### Nested classes/interfaces inherited from interface javax.swing.text.[AttributeSet](../../../javax/swing/text/AttributeSet.html "interface in javax.swing.text")  
 `[AttributeSet.CharacterAttribute](../../../javax/swing/text/AttributeSet.CharacterAttribute.html "interface in javax.swing.text"), [AttributeSet.ColorAttribute](../../../javax/swing/text/AttributeSet.ColorAttribute.html "interface in javax.swing.text"), [AttributeSet.FontAttribute](../../../javax/swing/text/AttributeSet.FontAttribute.html "interface in javax.swing.text"), [AttributeSet.ParagraphAttribute](../../../javax/swing/text/AttributeSet.ParagraphAttribute.html "interface in javax.swing.text")`

Field Summary

* ### Fields inherited from interface javax.swing.text.[AttributeSet](../../../javax/swing/text/AttributeSet.html "interface in javax.swing.text")  
`[NameAttribute](../../../javax/swing/text/AttributeSet.html#NameAttribute), [ResolveAttribute](../../../javax/swing/text/AttributeSet.html#ResolveAttribute)`

Constructor Summary

Constructors

Constructor	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	Description
Enumeration	children()	Returns the children of the receiver as anEnumeration.
boolean	getAllowsChildren()	Returns true if the receiver allows children.
Element	getElement(int index)	Gets a child element.
int	getElementCount()	Gets the number of children for the element.
int	getElementIndex(int offset)	Gets the child element index closest to the given model offset.
int	getEndOffset()	Gets the ending offset in the model for the element.
String	getName()	Gets the element name.
int	getStartOffset()	Gets the starting offset in the model for the element.
boolean	isLeaf()	Checks whether the element is a leaf.
Element	positionToElement(int pos)	Gets the child element that contains the given model position.
void	replace(int offset, int length,Element[] elems)	Replaces content with a new set of elements.
String	toString()	Converts the element to a string.

   * ### Methods inherited from class javax.swing.text.[AbstractDocument.AbstractElement](../../../javax/swing/text/AbstractDocument.AbstractElement.html "class in javax.swing.text")  
   `[addAttribute](../../../javax/swing/text/AbstractDocument.AbstractElement.html#addAttribute-java.lang.Object-java.lang.Object-), [addAttributes](../../../javax/swing/text/AbstractDocument.AbstractElement.html#addAttributes-javax.swing.text.AttributeSet-), [containsAttribute](../../../javax/swing/text/AbstractDocument.AbstractElement.html#containsAttribute-java.lang.Object-java.lang.Object-), [containsAttributes](../../../javax/swing/text/AbstractDocument.AbstractElement.html#containsAttributes-javax.swing.text.AttributeSet-), [copyAttributes](../../../javax/swing/text/AbstractDocument.AbstractElement.html#copyAttributes--), [dump](../../../javax/swing/text/AbstractDocument.AbstractElement.html#dump-java.io.PrintStream-int-), [getAttribute](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getAttribute-java.lang.Object-), [getAttributeCount](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getAttributeCount--), [getAttributeNames](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getAttributeNames--), [getAttributes](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getAttributes--), [getChildAt](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getChildAt-int-), [getChildCount](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getChildCount--), [getDocument](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getDocument--), [getIndex](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getIndex-javax.swing.tree.TreeNode-), [getParent](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getParent--), [getParentElement](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getParentElement--), [getResolveParent](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getResolveParent--), [isDefined](../../../javax/swing/text/AbstractDocument.AbstractElement.html#isDefined-java.lang.Object-), [isEqual](../../../javax/swing/text/AbstractDocument.AbstractElement.html#isEqual-javax.swing.text.AttributeSet-), [removeAttribute](../../../javax/swing/text/AbstractDocument.AbstractElement.html#removeAttribute-java.lang.Object-), [removeAttributes](../../../javax/swing/text/AbstractDocument.AbstractElement.html#removeAttributes-javax.swing.text.AttributeSet-), [removeAttributes](../../../javax/swing/text/AbstractDocument.AbstractElement.html#removeAttributes-java.util.Enumeration-), [setResolveParent](../../../javax/swing/text/AbstractDocument.AbstractElement.html#setResolveParent-javax.swing.text.AttributeSet-)`  
   * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

Constructor Detail

 * #### BranchElement  
 public BranchElement([Element](../../../javax/swing/text/Element.html "interface in javax.swing.text") parent,  
                      [AttributeSet](../../../javax/swing/text/AttributeSet.html "interface in javax.swing.text") 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](../../../javax/swing/text/Element.html "interface in javax.swing.text") 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](../../../javax/swing/text/Element.html "interface in javax.swing.text")[] 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](../../../java/lang/String.html "class in java.lang") toString()  
Converts the element to a string.  
Overrides:  
`[toString](../../../java/lang/Object.html#toString--)` in class `[Object](../../../java/lang/Object.html "class in java.lang")`  
Returns:  
the string  
* #### getName  
public [String](../../../java/lang/String.html "class in java.lang") getName()  
Gets the element name.  
Specified by:  
`[getName](../../../javax/swing/text/Element.html#getName--)` in interface `[Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")`  
Overrides:  
`[getName](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getName--)` in class `[AbstractDocument.AbstractElement](../../../javax/swing/text/AbstractDocument.AbstractElement.html "class in javax.swing.text")`  
Returns:  
the element name  
* #### getStartOffset  
public int getStartOffset()  
Gets the starting offset in the model for the element.  
Specified by:  
`[getStartOffset](../../../javax/swing/text/Element.html#getStartOffset--)` in interface `[Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")`  
Specified by:  
`[getStartOffset](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getStartOffset--)` in class `[AbstractDocument.AbstractElement](../../../javax/swing/text/AbstractDocument.AbstractElement.html "class in javax.swing.text")`  
Returns:  
the offset >= 0  
See Also:  
[Document](../../../javax/swing/text/Document.html "interface in javax.swing.text"), [AbstractDocument](../../../javax/swing/text/AbstractDocument.html "class in javax.swing.text")  
* #### getEndOffset  
public int getEndOffset()  
Gets the ending offset in the model for the element.  
Specified by:  
`[getEndOffset](../../../javax/swing/text/Element.html#getEndOffset--)` in interface `[Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")`  
Specified by:  
`[getEndOffset](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getEndOffset--)` in class `[AbstractDocument.AbstractElement](../../../javax/swing/text/AbstractDocument.AbstractElement.html "class in javax.swing.text")`  
Returns:  
the offset >= 0  
Throws:  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if this element has no children  
See Also:  
[Document](../../../javax/swing/text/Document.html "interface in javax.swing.text"), [AbstractDocument](../../../javax/swing/text/AbstractDocument.html "class in javax.swing.text")  
* #### getElement  
public [Element](../../../javax/swing/text/Element.html "interface in javax.swing.text") getElement(int index)  
Gets a child element.  
Specified by:  
`[getElement](../../../javax/swing/text/Element.html#getElement-int-)` in interface `[Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")`  
Specified by:  
`[getElement](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getElement-int-)` in class `[AbstractDocument.AbstractElement](../../../javax/swing/text/AbstractDocument.AbstractElement.html "class in javax.swing.text")`  
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](../../../javax/swing/text/Element.html#getElementCount--)` in interface `[Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")`  
Specified by:  
`[getElementCount](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getElementCount--)` in class `[AbstractDocument.AbstractElement](../../../javax/swing/text/AbstractDocument.AbstractElement.html "class in javax.swing.text")`  
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](../../../javax/swing/text/Element.html#getElementIndex-int-)` in interface `[Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")`  
Specified by:  
`[getElementIndex](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getElementIndex-int-)` in class `[AbstractDocument.AbstractElement](../../../javax/swing/text/AbstractDocument.AbstractElement.html "class in javax.swing.text")`  
Parameters:  
`offset` \- the offset >= 0  
Returns:  
the element index >= 0  
* #### isLeaf  
public boolean isLeaf()  
Checks whether the element is a leaf.  
Specified by:  
`[isLeaf](../../../javax/swing/text/Element.html#isLeaf--)` in interface `[Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")`  
Specified by:  
`[isLeaf](../../../javax/swing/tree/TreeNode.html#isLeaf--)` in interface `[TreeNode](../../../javax/swing/tree/TreeNode.html "interface in javax.swing.tree")`  
Specified by:  
`[isLeaf](../../../javax/swing/text/AbstractDocument.AbstractElement.html#isLeaf--)` in class `[AbstractDocument.AbstractElement](../../../javax/swing/text/AbstractDocument.AbstractElement.html "class in javax.swing.text")`  
Returns:  
true if a leaf  
* #### getAllowsChildren  
public boolean getAllowsChildren()  
Returns true if the receiver allows children.  
Specified by:  
`[getAllowsChildren](../../../javax/swing/tree/TreeNode.html#getAllowsChildren--)` in interface `[TreeNode](../../../javax/swing/tree/TreeNode.html "interface in javax.swing.tree")`  
Specified by:  
`[getAllowsChildren](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getAllowsChildren--)` in class `[AbstractDocument.AbstractElement](../../../javax/swing/text/AbstractDocument.AbstractElement.html "class in javax.swing.text")`  
Returns:  
true if the receiver allows children, otherwise false  
* #### children  
public [Enumeration](../../../java/util/Enumeration.html "interface in java.util") children()  
Returns the children of the receiver as an`Enumeration`.  
Specified by:  
`[children](../../../javax/swing/tree/TreeNode.html#children--)` in interface `[TreeNode](../../../javax/swing/tree/TreeNode.html "interface in javax.swing.tree")`  
Specified by:  
`[children](../../../javax/swing/text/AbstractDocument.AbstractElement.html#children--)` in class `[AbstractDocument.AbstractElement](../../../javax/swing/text/AbstractDocument.AbstractElement.html "class in javax.swing.text")`  
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, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

AbstractDocument.BranchElement (Java Platform SE 8 ) (original) (raw)

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail