javax.swing.text
接口 Element

所有已知实现类：

AbstractDocument.AbstractElement, AbstractDocument.BranchElement, AbstractDocument.LeafElement, DefaultStyledDocument.SectionElement, HTMLDocument.BlockElement, HTMLDocument.RunElement

public interface Element

描述文档的结构元素的接口。主要是为了体现 SGML 元素的精髓。

方法摘要

AttributeSet	getAttributes() 获取此元素包含的属性集合。
Document	getDocument() 获取与此元素关联的文档。
Element	getElement(int index) 获取给定索引处的子元素。
int	getElementCount() 获得此元素包含的子元素数。
int	getElementIndex(int offset) 获得离给定偏移量最近的子元素索引。
int	getEndOffset() 获取此元素结束处的文档起始偏移量。
String	getName() 获取元素的名称。
Element	getParentElement() 获得父元素。
int	getStartOffset() 获取此元素开始处的文档起始偏移量。
boolean	isLeaf() 确定此元素是否为叶元素。

方法详细信息

getDocument

Document getDocument()

获取与此元素关联的文档。

返回：

文档

getParentElement

Element getParentElement()

获得父元素。如果该元素为根元素，则返回 null。

返回：

父元素

getName

String getName()

获取元素的名称。如果该元素用于表示某些类型的结构，这将是类型名。

返回：

元素名称

getAttributes

AttributeSet getAttributes()

获取此元素包含的属性集合。

返回：

元素的属性

getStartOffset

int getStartOffset()

获取此元素开始处的文档起始偏移量。如果此元素有子级，这将是其第一个子级的偏移量。至于文档位置，则可能存在向前的偏差。

返回：

起始偏移量，该值 >= 0 且 < getEndOffset()；

另请参见：

Document, AbstractDocument

getEndOffset

int getEndOffset()

获取此元素结束处的文档起始偏移量。如果此元素有子级，这将是其最后一个子级的结束偏移量。至于文档位置，则可能存在向后的偏差。

所有默认的 Document 实现都继承自 AbstractDocument。AbstractDocument 在文档的结束处模仿了一个暗含的中断。因此，它有可能返回一个大于文档长度的值。

返回：

结束偏移量，该值 > getStartOffset() 且 <= getDocument().getLength() + 1

另请参见：

Document, AbstractDocument

getElementIndex

int getElementIndex(int offset)

获得离给定偏移量最近的子元素索引。偏移量的指定是相对于文档起始处的。如果 Element 是叶元素，则返回 -1；否则返回最能代表给定位置的 Element 索引。如果位置小于起始偏移量，则返回 0。如果位置大于或等于结束偏移量，则返回 getElementCount() - 1。

参数：

offset - 指定的偏移量，该值 >= 0

返回：

元素索引，该值 >= 0

getElementCount

int getElementCount()

获得此元素包含的子元素数。如果此元素是叶元素，则返回零。

返回：

子元素数，该值 >= 0

getElement

Element getElement(int index)

获取给定索引处的子元素。

参数：

index - 指定的索引，该值 >= 0

返回：

子元素

isLeaf

boolean isLeaf()

确定此元素是否为叶元素。可能 有子级的元素（即便现在还没有子级）将返回 false。

返回：

如果为叶元素，则返回 true；否则返回 false