AbstractDocument.BranchElement (Java 2 Platform SE 5.0) (original) (raw)

javax.swing.text

Class AbstractDocument.BranchElement

java.lang.Object extended by 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 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](../../../javax/swing/text/AbstractDocument.BranchElement.html#AbstractDocument.BranchElement%28javax.swing.text.Element, javax.swing.text.AttributeSet%29)(Element parent,AttributeSet a) Constructs a composite element that initially contains no children.

Method Summary
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](../../../javax/swing/text/AbstractDocument.BranchElement.html#replace%28int, int, javax.swing.text.Element[]%29)(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](../../../javax/swing/text/AbstractDocument.AbstractElement.html#addAttribute%28java.lang.Object, java.lang.Object%29), addAttributes, [containsAttribute](../../../javax/swing/text/AbstractDocument.AbstractElement.html#containsAttribute%28java.lang.Object, java.lang.Object%29), containsAttributes, copyAttributes, [dump](../../../javax/swing/text/AbstractDocument.AbstractElement.html#dump%28java.io.PrintStream, int%29), getAttribute, getAttributeCount, getAttributeNames, getAttributes, getChildAt, getChildCount, getDocument, getIndex, getParent, getParentElement, getResolveParent, isDefined, isEqual, removeAttribute, removeAttributes, removeAttributes, setResolveParent

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

[addAttribute](../../../javax/swing/text/AbstractDocument.AbstractElement.html#addAttribute%28java.lang.Object, java.lang.Object%29), addAttributes, [containsAttribute](../../../javax/swing/text/AbstractDocument.AbstractElement.html#containsAttribute%28java.lang.Object, java.lang.Object%29), containsAttributes, copyAttributes, [dump](../../../javax/swing/text/AbstractDocument.AbstractElement.html#dump%28java.io.PrintStream, int%29), 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](../../../java/lang/Object.html#wait%28long, int%29)

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

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](../../../java/lang/Object.html#toString%28%29) in class [Object](../../../java/lang/Object.html "class in java.lang")

Returns:

the string

getName

public String getName()

Gets the element name.

Specified by:

[getName](../../../javax/swing/text/Element.html#getName%28%29) in interface [Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")

Overrides:

[getName](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getName%28%29) 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%28%29) in interface [Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")

Specified by:

[getStartOffset](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getStartOffset%28%29) in class [AbstractDocument.AbstractElement](../../../javax/swing/text/AbstractDocument.AbstractElement.html "class in javax.swing.text")

Returns:

the offset >= 0

See Also:

Document, AbstractDocument

getEndOffset

public int getEndOffset()

Gets the ending offset in the model for the element.

Specified by:

[getEndOffset](../../../javax/swing/text/Element.html#getEndOffset%28%29) in interface [Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")

Specified by:

[getEndOffset](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getEndOffset%28%29) 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, AbstractDocument

getElement

public Element getElement(int index)

Gets a child element.

Specified by:

[getElement](../../../javax/swing/text/Element.html#getElement%28int%29) in interface [Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")

Specified by:

[getElement](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getElement%28int%29) 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%28%29) in interface [Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")

Specified by:

[getElementCount](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getElementCount%28%29) 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%28int%29) in interface [Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")

Specified by:

[getElementIndex](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getElementIndex%28int%29) 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%28%29) in interface [Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")

Specified by:

[isLeaf](../../../javax/swing/tree/TreeNode.html#isLeaf%28%29) in interface [TreeNode](../../../javax/swing/tree/TreeNode.html "interface in javax.swing.tree")

Specified by:

[isLeaf](../../../javax/swing/text/AbstractDocument.AbstractElement.html#isLeaf%28%29) 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%28%29) in interface [TreeNode](../../../javax/swing/tree/TreeNode.html "interface in javax.swing.tree")

Specified by:

[getAllowsChildren](../../../javax/swing/text/AbstractDocument.AbstractElement.html#getAllowsChildren%28%29) 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 children()

Returns the children of the receiver as anEnumeration.

Specified by:

[children](../../../javax/swing/tree/TreeNode.html#children%28%29) in interface [TreeNode](../../../javax/swing/tree/TreeNode.html "interface in javax.swing.tree")

Specified by:

[children](../../../javax/swing/text/AbstractDocument.AbstractElement.html#children%28%29) 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 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.