AbstractDocument.BranchElement (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

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, 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^TM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.

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, children, containsAttribute, containsAttributes, copyAttributes, dump, getAllowsChildren, getAttribute, getAttributeCount, getAttributeNames, getAttributes, getChildAt, getChildCount, getDocument, getElement, getElementCount, getElementIndex, getEndOffset, getIndex, getName, getParent, getParentElement, getResolveParent, getStartOffset, isDefined, isEqual, isLeaf, removeAttribute, removeAttributes, removeAttributes, setResolveParent`

Methods inherited from class javax.swing.text.AbstractDocument.AbstractElement


addAttribute, addAttributes, children, containsAttribute, containsAttributes, copyAttributes, dump, getAllowsChildren, getAttribute, getAttributeCount, getAttributeNames, getAttributes, getChildAt, getChildCount, getDocument, getElement, getElementCount, getElementIndex, getEndOffset, getIndex, getName, getParent, getParentElement, getResolveParent, getStartOffset, isDefined, isEqual, isLeaf, removeAttribute, removeAttributes, removeAttributes, setResolveParent

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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 element; a - the attributes for the element

Method Detail

children

public Enumeration children()

Returns the children of the receiver as an Enumeration.

Overrides:: children in class AbstractDocument.AbstractElement
Returns:: the children of the receiver

getAllowsChildren

public boolean getAllowsChildren()

Returns true if the receiver allows children.

Overrides:: getAllowsChildren in class AbstractDocument.AbstractElement
Returns:: true if the receiver allows children, otherwise false

getElement

public Element getElement(int index)

Gets a child element.

Overrides:: 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.

Overrides:: 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.

Overrides:: getElementIndex in class AbstractDocument.AbstractElement
Parameters:: offset - the offset >= 0
Returns:: the element index >= 0

getEndOffset

public int getEndOffset()

Gets the ending offset in the model for the element.

Overrides:: getEndOffset in class AbstractDocument.AbstractElement
Returns:: the offset >= 0

getName

public String getName()

Gets the element name.

Overrides:: getName in class AbstractDocument.AbstractElement
Returns:: the element name

getStartOffset

public int getStartOffset()

Gets the starting offset in the model for the element.

Overrides:: getStartOffset in class AbstractDocument.AbstractElement
Returns:: the offset >= 0

isLeaf

public boolean isLeaf()

Checks whether the element is a leaf.

Overrides:: isLeaf in class AbstractDocument.AbstractElement
Returns:: true if a leaf

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.

Overrides:: toString in class Object
Returns:: the string