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