javax.swing.text
class AbstractDocument.AbstractElement

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

All Implemented Interfaces:

Serializable, Element, MutableAttributeSet, TreeNode

Direct Known Subclasses:

AbstractDocument.BranchElement, AbstractDocument.LeafElement

Enclosing class:

AbstractDocument

public abstract class AbstractDocument.AbstractElement
extends Object
implements Element, MutableAttributeSet, Serializable, TreeNode

Implements the abstract part of an element. By default elements support attributes by having a field that represents the immutable part of the current attribute set for the element. The element itself implements MutableAttributeSet which can be used to modify the set by fetching a new immutable set. The immutable sets are provided by the AttributeContext associated with the document.

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

AbstractDocument.AbstractElement

public AbstractDocument.AbstractElement(Element parent,
                                        AttributeSet a)

Creates a new AbstractElement.

Parameters:

parent - the parent element

a - the attributes for the element

addAttribute

public void addAttribute(Object name,
                         Object value)

Adds an attribute to the element.

Parameters:

name - the non-null attribute name

value - the attribute value

addAttributes

public void addAttributes(AttributeSet attr)

Adds a set of attributes to the element.

Parameters:

attr - the attributes to add

children

public abstract Enumeration children()

Returns the children of the receiver as an Enumeration.

Returns:

the children of the receiver as an Enumeration

containsAttribute

public boolean containsAttribute(Object name,
                                 Object value)

Checks whether a given attribute name/value is defined.

Parameters:

name - the non-null attribute name

value - the attribute value

Returns:

true if the name/value is defined

containsAttributes

public boolean containsAttributes(AttributeSet attrs)

Checks whether the element contains all the attributes.

Parameters:

attrs - the attributes to check

Returns:

true if the element contains all the attributes

copyAttributes

public AttributeSet copyAttributes()

Copies a set of attributes.

Returns:

the copy

dump

public void dump(PrintStream psOut,
                 int indentAmount)

Dumps a debugging representation of the element hierarchy.

Parameters:

psOut - the output stream

indentAmount - the indentation level >= 0

getAllowsChildren

public abstract boolean getAllowsChildren()

Returns true if the receiver allows children.

Returns:

true if the receiver allows children, otherwise false

getAttribute

public Object getAttribute(Object attrName)

Gets the value of an attribute.

Parameters:

attrName - the non-null attribute name

Returns:

the attribute value

getAttributeCount

public int getAttributeCount()

Gets the number of attributes that are defined.

Returns:

the number of attributes >= 0

getAttributeNames

public Enumeration getAttributeNames()

Gets the names of all attributes.

Returns:

the attribute names as an enumeration

getAttributes

public AttributeSet getAttributes()

Gets the attributes for the element.

Returns:

the attribute set

getChildAt

public TreeNode getChildAt(int childIndex)

Returns the child TreeNode at index childIndex.

Parameters:

childIndex

getChildCount

public int getChildCount()

Returns the number of children TreeNode's receiver contains.

Returns:

the number of children TreeNodews's receiver contains

getDocument

public Document getDocument()

Retrieves the underlying model.

Returns:

the model

getElement

public abstract Element getElement(int index)

Gets a child element.

Parameters:

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

Returns:

the child element

getElementCount

public abstract int getElementCount()

Gets the number of children for the element.

Returns:

the number of children >= 0

getElementIndex

public abstract 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

getEndOffset

public abstract int getEndOffset()

Gets the ending offset in the model for the element.

Returns:

the offset >= 0

getIndex

public int getIndex(TreeNode node)

Returns the index of node in the receivers children. If the receiver does not contain node, -1 will be returned.

Parameters:

node - the location of interest

Returns:

the index of node in the receiver's children, or -1 if absent

getName

public String getName()

Gets the name of the element.

Returns:

the name, null if none

getParent

public TreeNode getParent()

Returns the parent TreeNode of the receiver.

Returns:

the parent TreeNode of the receiver

getParentElement

public Element getParentElement()

Gets the parent of the element.

Returns:

the parent

getResolveParent

public AttributeSet getResolveParent()

Gets the resolving parent. If not overridden, the resolving parent defaults to the parent element.

Returns:

the attributes from the parent, null if none

getStartOffset

public abstract int getStartOffset()

Gets the starting offset in the model for the element.

Returns:

the offset >= 0

isDefined

public boolean isDefined(Object attrName)

Checks whether a given attribute is defined.

Parameters:

attrName - the non-null attribute name

Returns:

true if the attribute is defined

isEqual

public boolean isEqual(AttributeSet attr)

Checks whether two attribute sets are equal.

Parameters:

attr - the attribute set to check against

Returns:

true if the same

isLeaf

public abstract boolean isLeaf()

Checks whether the element is a leaf.

Returns:

true if a leaf

removeAttribute

public void removeAttribute(Object name)

Removes an attribute from the set.

Parameters:

name - the non-null attribute name

removeAttributes

public void removeAttributes(AttributeSet attrs)

Removes a set of attributes for the element.

Parameters:

attrs - the attributes

removeAttributes

public void removeAttributes(Enumeration names)

Removes a set of attributes for the element.

Parameters:

names - the attribute names

setResolveParent

public void setResolveParent(AttributeSet parent)

Sets the resolving parent.

Parameters:

parent - the parent, null if none