Package Summary  Overview Summary

class:AbstractDocument.BranchElement [NONE]
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 JavaBeans has been added to the java.beans package. Please see XMLEncoder.

constructor:AbstractDocument.BranchElement(javax.swing.text.Element,javax.swing.text.AttributeSet) [NONE]

  • 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:positionToElement(int) [NONE]

  • 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

    • method:replace(int,int,javax.swing.text.Element[]) [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

    method:toString() [NONE]

    toString

    public String toString()
    Converts the element to a string.
    Overrides:
    toString in class Object
    Returns:
    the string

    method:getName() [NONE]

    getName

    public String getName()
    Gets the element name.
    Specified by:
    getName in interface Element
    Overrides:
    getName in class AbstractDocument.AbstractElement
    Returns:
    the element name

    method:getStartOffset() [NONE]

    getStartOffset

    public int getStartOffset()
    Gets the starting offset in the model for the element.
    Specified by:
    getStartOffset in interface Element
    Specified by:
    getStartOffset in class AbstractDocument.AbstractElement
    Returns:
    the offset >= 0
    See Also:

    method:getEndOffset() [NONE]

    getEndOffset

    public int getEndOffset()
    Gets the ending offset in the model for the element.
    Specified by:
    getEndOffset in interface Element
    Specified by:
    getEndOffset in class AbstractDocument.AbstractElement
    Returns:
    the offset >= 0
    Throws:
    NullPointerException - if this element has no children
    See Also:

    method:getElement(int) [NONE]

    getElement

    public Element getElement (int index)
    Gets a child element.
    Specified by:
    getElement in interface Element
    Specified by:
    getElement in class AbstractDocument.AbstractElement
    Parameters:
    index - the child index, >= 0 && < getElementCount()
    Returns:
    the child element, null if none

    method:getElementCount() [NONE]

    getElementCount

    public int getElementCount()
    Gets the number of children for the element.
    Specified by:
    getElementCount in interface Element
    Specified by:
    getElementCount in class AbstractDocument.AbstractElement
    Returns:
    the number of children >= 0

    method:getElementIndex(int) [NONE]

    getElementIndex

    public int getElementIndex (int offset)
    Gets the child element index closest to the given model offset.
    Specified by:
    getElementIndex in interface Element
    Specified by:
    getElementIndex in class AbstractDocument.AbstractElement
    Parameters:
    offset - the offset >= 0
    Returns:
    the element index >= 0

    method:isLeaf() [NONE]

    isLeaf

    public boolean isLeaf()
    Checks whether the element is a leaf.
    Specified by:
    isLeaf in interface Element
    Specified by:
    isLeaf in interface TreeNode
    Specified by:
    isLeaf in class AbstractDocument.AbstractElement
    Returns:
    true if a leaf

    method:getAllowsChildren() [NONE]

    getAllowsChildren

    public boolean getAllowsChildren()
    Returns true if the receiver allows children.
    Specified by:
    getAllowsChildren in interface TreeNode
    Specified by:
    getAllowsChildren in class AbstractDocument.AbstractElement
    Returns:
    true if the receiver allows children, otherwise false

    method:children() [NONE]

    children

    public Enumeration<TreeNode> children()
    Returns the children of the receiver as an Enumeration.
    Specified by:
    children in interface TreeNode
    Specified by:
    children in class AbstractDocument.AbstractElement
    Returns:
    the children of the receiver

    © 2023 Oracle Corporation and/or its affiliates