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() この要素が葉要素かどうかを判定します。子を持つ可能性のある要素は、たとえその時点で子を持っていなくても、falseを返します。

メソッドの詳細

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