Summary: Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

public class

AbstractDocument.BranchElement

extends AbstractDocument.AbstractElement

java.lang.Object
↳	javax.swing.text.AbstractDocument.AbstractElement
	↳	javax.swing.text.AbstractDocument.BranchElement

Known Direct Subclasses

DefaultStyledDocument.SectionElement, HTMLDocument.BlockElement

Class Overview

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 XMLEncoder.

Summary

[Expand]

Inherited Fields

From interface javax.swing.text.AttributeSet

Public Constructors
	AbstractDocument.BranchElement(Element parent, AttributeSet a) Constructs a composite element that initially contains no children.

Public Methods
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.

[Expand]

Inherited Methods

From class javax.swing.text.AbstractDocument.AbstractElement

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface javax.swing.text.AttributeSet

abstract boolean	containsAttribute(Object name, Object value) Returns `true` if this set defines an attribute with the same name and an equal value.
abstract boolean	containsAttributes(AttributeSet attributes) Returns `true` if this set defines all the attributes from the given set with equal values.
abstract AttributeSet	copyAttributes() Returns an attribute set that is guaranteed not to change over time.
abstract Object	getAttribute(Object key) Fetches the value of the given attribute.
abstract int	getAttributeCount() Returns the number of attributes that are defined locally in this set.
abstract Enumeration<?>	getAttributeNames() Returns an enumeration over the names of the attributes that are defined locally in the set.
abstract AttributeSet	getResolveParent() Gets the resolving parent.
abstract boolean	isDefined(Object attrName) Checks whether the named attribute has a value specified in the set without resolving through another attribute set.
abstract boolean	isEqual(AttributeSet attr) Determines if the two attribute sets are equivalent.

From interface javax.swing.text.Element

abstract AttributeSet	getAttributes() Fetches the collection of attributes this element contains.
abstract Document	getDocument() Fetches the document associated with this element.
abstract Element	getElement(int index) Fetches the child element at the given index.
abstract int	getElementCount() Gets the number of child elements contained by this element.
abstract int	getElementIndex(int offset) Gets the child element index closest to the given offset.
abstract int	getEndOffset() Fetches the offset from the beginning of the document that this element ends at.
abstract String	getName() Fetches the name of the element.
abstract Element	getParentElement() Fetches the parent element.
abstract int	getStartOffset() Fetches the offset from the beginning of the document that this element begins at.
abstract boolean	isLeaf() Is this element a leaf element? An element that may have children, even if it currently has no children, would return `false`.

From interface javax.swing.text.MutableAttributeSet

From interface javax.swing.tree.TreeNode

Public Constructors

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

Public Methods

public Enumeration children ()

Returns the children of the receiver as an Enumeration.

Returns

the children of the receiver

public boolean getAllowsChildren ()

Returns true if the receiver allows children.

Returns

true if the receiver allows children, otherwise false

public Element getElement (int index)

Gets a child element.

Parameters

index	the child index, >= 0 && < getElementCount()

Returns

the child element, null if none

public int getElementCount ()

Gets the number of children for the element.

Returns

the number of children >= 0

public int getElementIndex (int offset)

Gets the child element index closest to the given model offset.

Parameters

offset	the offset >= 0

Returns

the element index >= 0

public int getEndOffset ()

Gets the ending offset in the model for the element.

Returns

the offset >= 0

Throws

NullPointerException	if this element has no children

public String getName ()

Gets the element name.

Returns

the element name

public int getStartOffset ()

Gets the starting offset in the model for the element.

Returns

the offset >= 0

public boolean isLeaf ()

Checks whether the element is a leaf.

Returns

true if a leaf

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

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

public String toString ()

Converts the element to a string.

Returns

the string

Interfaces

Classes

Exceptions

AbstractDocument.BranchElement

Class Overview

Summary

Public Constructors

public AbstractDocument.BranchElement (Element parent, AttributeSet a)

Parameters

Public Methods

public Enumeration children ()

Returns

public boolean getAllowsChildren ()

Returns

public Element getElement (int index)

Parameters

Returns

public int getElementCount ()

Returns

public int getElementIndex (int offset)

Parameters

Returns

public int getEndOffset ()

Returns

Throws

public String getName ()

Returns

public int getStartOffset ()

Returns

public boolean isLeaf ()

Returns

public Element positionToElement (int pos)

Parameters

Returns

public void replace (int offset, int length, Element[] elems)

Parameters

public String toString ()

Returns