Class AbstractDocument.LeafElement
- java.lang.Object
-
- javax.swing.text.AbstractDocument.AbstractElement
-
- javax.swing.text.AbstractDocument.LeafElement
-
- All Implemented Interfaces:
- Serializable, AttributeSet, 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 JavaBeans™ has been added to the
java.beans
package. Please seeXMLEncoder
.- See Also:
-
Element
-
-
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
Constructors Constructor and Description LeafElement(Element parent, AttributeSet a, int offs0, int offs1)
Constructs an element that represents content within the document (has no children).
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description 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()
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, containsAttribute, containsAttributes, copyAttributes, dump, getAttribute, getAttributeCount, getAttributeNames, getAttributes, getChildAt, getChildCount, getDocument, getIndex, getParent, getParentElement, getResolveParent, isDefined, isEqual, removeAttribute, removeAttributes, removeAttributes, setResolveParent
-
-
-
-
Constructor Detail
LeafElement
public 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 - Since:
- 1.4
-
Method Detail
toString
public String toString()
Converts the element to a string.
getStartOffset
public int getStartOffset()
Gets the starting offset in the model for the element.- Specified by:
-
getStartOffset
in interfaceElement
- Specified by:
-
getStartOffset
in classAbstractDocument.AbstractElement
- 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
in interfaceElement
- Specified by:
-
getEndOffset
in classAbstractDocument.AbstractElement
- Returns:
- the offset >= 0
- See Also:
-
Document
,AbstractDocument
getName
public String getName()
Gets the element name.- Specified by:
-
getName
in interfaceElement
- Overrides:
-
getName
in classAbstractDocument.AbstractElement
- Returns:
- the name
getElementIndex
public int getElementIndex(int pos)
Gets the child element index closest to the given model offset.- Specified by:
-
getElementIndex
in interfaceElement
- Specified by:
-
getElementIndex
in classAbstractDocument.AbstractElement
- Parameters:
-
pos
- the offset >= 0 - Returns:
- the element index >= 0
getElement
public Element getElement(int index)
Gets a child element.- Specified by:
-
getElement
in interfaceElement
- Specified by:
-
getElement
in classAbstractDocument.AbstractElement
- Parameters:
-
index
- the child index, >= 0 && < getElementCount() - Returns:
- the child element
getElementCount
public int getElementCount()
Returns the number of child elements.- Specified by:
-
getElementCount
in interfaceElement
- Specified by:
-
getElementCount
in classAbstractDocument.AbstractElement
- Returns:
- the number of children >= 0
isLeaf
public boolean isLeaf()
Checks whether the element is a leaf.
getAllowsChildren
public boolean getAllowsChildren()
Returns true if the receiver allows children.- Specified by:
-
getAllowsChildren
in interfaceTreeNode
- Specified by:
-
getAllowsChildren
in classAbstractDocument.AbstractElement
- Returns:
- true if the receiver allows children, otherwise false
children
public Enumeration children()
Returns the children of the receiver as anEnumeration
.- Specified by:
-
children
in interfaceTreeNode
- Specified by:
-
children
in classAbstractDocument.AbstractElement
- Returns:
- the children of the receiver
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.