javax.swing.text
インタフェース Element

既知の実装クラスの一覧:

AbstractDocument.AbstractElement

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

public Document getDocument()

この要素に関連したドキュメントを取り出します。

戻り値:

ドキュメント

getParentElement

public Element getParentElement()

親要素を取り出します。ルートレベルの要素である場合は、null を返します。

戻り値:

親要素

getName

public String getName()

要素名を取り出します。要素を使って構造の特定のタイプを表す場合、これはタイプ名になります。

戻り値:

要素の名前

getAttributes

public AttributeSet getAttributes()

この要素が保持する属性のコレクションを取り出します。

戻り値:

要素の属性

getStartOffset

public int getStartOffset()

この要素が始まる、ドキュメントの先頭からのオフセットを取り出します。この要素が子要素を持っている場合、これは最初の子のオフセットになります。ドキュメントの位置としては、暗黙の転送バイアスがあります。

戻り値:

開始オフセット。0 以上で getEndOffset() より小さい

関連項目:

Document, AbstractDocument

getEndOffset

public int getEndOffset()

この要素が終わる、ドキュメントの先頭からのオフセットを取り出します。この要素が子要素を持っている場合、これは最後の子の終了オフセットになります。ドキュメントの位置としては、暗黙の逆転送バイアスがあります。

すべてのデフォルト Document 実装は AbstractDocument から派生します。AbstractDocument はドキュメントの最後に暗黙のブレークを形成します。その結果、ドキュメントの長さより長い値を返すこともできます。

戻り値:

終了オフセット。getStartOffset() より大きく getDocument().getLength() + 1 以下

関連項目:

Document, AbstractDocument

getElementIndex

public int getElementIndex(int offset)

指定オフセットに最も近い子要素のインデックスを取得します。オフセットはドキュメントの先頭との相対位置で指定されます。Element が葉の場合は -1 が返され、そうでない場合は指定した位置を最もよく表す Element のインデックスが返されます。位置が開始オフセットより小さい場合は、0 が返されます。また、位置が終了オフセット以上の場合は、getElementCount() - 1 が返されます。

パラメータ:

offset - 指定オフセット >= 0

戻り値:

要素のインデックス >= 0

getElementCount

public int getElementCount()

この要素が含む子要素の数を返します。この要素が葉要素の場合、ゼロが返されます。

戻り値:

子要素の数 >= 0

getElement

public Element getElement(int index)

指定されたインデックスの子要素を取り出します。

パラメータ:

index - 指定したインデックス >= 0

戻り値:

子要素

isLeaf

public boolean isLeaf()

この要素が葉の要素かどうかが判別されます。子を持つ可能性のある要素は、たとえその時点で子を持っていなくても、false を返します。

戻り値:

葉要素の場合は true、そうでない場合は false