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

java.lang.Object extended by javax.swing.text.AbstractDocument.AbstractElement extended by javax.swing.text.AbstractDocument.LeafElement
All Implemented Interfaces:
Serializable, Element, MutableAttributeSet, TreeNode
Direct Known Subclasses:
HTMLDocument.RunElement
Enclosing class:
AbstractDocument
public class AbstractDocument.LeafElement
extends AbstractDocument.AbstractElement

Implements an element that directly represents content of some kind.

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 {@link java.beans.XMLEncoder}.

Constructor Summary
AbstractDocument.LeafElement(Element parent, AttributeSet a, int offs0, int offs1)

          Constructs an element that represents content within the document (has 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()

          Returns the number of child elements.
 int
getElementIndex(int pos)

          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.
 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractDocument.LeafElement

public AbstractDocument.LeafElement(Element parent,
                                    AttributeSet a,
                                    int offs0,
                                    int offs1)
Constructs an element that represents content within the document (has no children).

Parameters:
parent - The parent element
a - The element attributes
offs0 - The start offset >= 0
offs1 - The end offset >= offs0
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

getElementCount

public int getElementCount()
Returns the number of child elements.

Overrides:
getElementCount in class AbstractDocument.AbstractElement
Returns:
the number of children >= 0

getElementIndex

public int getElementIndex(int pos)
Gets the child element index closest to the given model offset.

Overrides:
getElementIndex in class AbstractDocument.AbstractElement
Parameters:
pos - 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 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

toString

public String toString()
Converts the element to a string.

Overrides:
toString in class Object
Returns:
the string
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
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.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.