AbstractDocument.BranchElement (Java Platform SE 6) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="AbstractDocument.BranchElement (Java Platform SE 6)"; } } Overview  Package   Class  Use  Tree  Deprecated  Index  Help  Java™ PlatformStandard Ed. 6  PREV CLASS   NEXT CLASS FRAMES    NO FRAMES     All Classes SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD 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.BranchElementextends 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 JavaBeansTM has been added to the java.beans package. Please see XMLEncoder. 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 AbstractDocument.BranchElement(Element parent, AttributeSet a)           Constructs a composite element that initially contains no children.   Method Summary  Enumeration children()           Returns the children of the receiver as an Enumeration.  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 addAttribute, addAttributes, containsAttribute, containsAttributes, copyAttributes, dump, getAttribute, getAttributeCount, getAttributeNames, getAttributes, getChildAt, getChildCount, getDocument, getIndex, getParent, getParentElement, getResolveParent, isDefined, isEqual, removeAttribute, removeAttributes, removeAttributes, setResolveParent   Methods inherited from class java.lang.Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait   Constructor Detail AbstractDocument.BranchElement public AbstractDocument.BranchElement(Element parent, AttributeSet a) Constructs a composite element that initially contains no children. Parameters:parent - The parent elementa - the attributes for the elementSince: 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 >= 0length - the length to replace >= 0elems - the new elements toString public String toString() Converts the element to a string. Overrides:toString in class Object Returns:the string getName public String getName() Gets the element name. Specified by:getName in interface ElementOverrides:getName in class AbstractDocument.AbstractElement Returns:the element name getStartOffset public int getStartOffset() Gets the starting offset in the model for the element. Specified by:getStartOffset in interface ElementSpecified by:getStartOffset in class AbstractDocument.AbstractElement Returns:the offset >= 0See Also:Document, AbstractDocument getEndOffset public int getEndOffset() Gets the ending offset in the model for the element. Specified by:getEndOffset in interface ElementSpecified by:getEndOffset in class AbstractDocument.AbstractElement Returns:the offset >= 0 Throws: NullPointerException - if this element has no childrenSee Also:Document, AbstractDocument getElement public Element getElement(int index) Gets a child element. Specified by:getElement in interface ElementSpecified by:getElement in class AbstractDocument.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 interface ElementSpecified by:getElementCount in class AbstractDocument.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 interface ElementSpecified by:getElementIndex in class AbstractDocument.AbstractElement Parameters:offset - the offset >= 0 Returns:the element index >= 0 isLeaf public boolean isLeaf() Checks whether the element is a leaf. Specified by:isLeaf in interface ElementSpecified by:isLeaf in interface TreeNodeSpecified by:isLeaf in class AbstractDocument.AbstractElement Returns:true if a leaf getAllowsChildren public boolean getAllowsChildren() Returns true if the receiver allows children. Specified by:getAllowsChildren in interface TreeNodeSpecified by:getAllowsChildren in class AbstractDocument.AbstractElement Returns:true if the receiver allows children, otherwise false children public Enumeration children() Returns the children of the receiver as an Enumeration. Specified by:children in interface TreeNodeSpecified by:children in class AbstractDocument.AbstractElement Returns:the children of the receiver Overview  Package   Class  Use  Tree  Deprecated  Index  Help  Java™ PlatformStandard Ed. 6  PREV CLASS   NEXT CLASS FRAMES    NO FRAMES     All Classes SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD Submit a bug or featureFor further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples. Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.