javax.swing.text

インタフェース AttributeSet

既知のすべてのサブインタフェース:

MutableAttributeSet, Style

既知のすべての実装クラス:

AbstractDocument.AbstractElement, AbstractDocument.BranchElement, AbstractDocument.LeafElement, DefaultStyledDocument.SectionElement, HTMLDocument.BlockElement, HTMLDocument.RunElement, SimpleAttributeSet, StyleContext.NamedStyle, StyleContext.SmallAttributeSet

public interface AttributeSet

一意な属性のコレクションです。AttributeSet は、読み取り専用の不変のインタフェースです。属性とは、キーと、キーに割り当てられた値のペアです。コレクションは、スタイルランや論理書式のようなものを表現できます。一般的にこれらは、フォントなどのグラフィック表現に影響する機能を記述します。キーの組み合わせには制限がなく、任意のものを記述できます。通常、View の実装は属性の定義に応じて、属性を表現するなんらかの描画を行います。

属性は階層構造の中で解釈処理することもできます。キーがローカルでは解釈せず、解釈処理側の親が存在する場合、キーは親を介して解釈されます。

関連項目:

MutableAttributeSet

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	インタフェースと説明
static interface	AttributeSet.CharacterAttribute このインタフェースはタイプシグニチャーであり、文字レベル表現に関与するあらゆる属性のキーに現れることが期待されます。
static interface	AttributeSet.ColorAttribute このインタフェースはタイプシグニチャーであり、色の表示に関与するあらゆる属性のキーに現れることが期待されます。
static interface	AttributeSet.FontAttribute このインタフェースはタイプシグニチャーであり、テキストの描画に使用するフォントの決定に関与するあらゆる属性のキーに現れることが期待されます。
static interface	AttributeSet.ParagraphAttribute このインタフェースはタイプシグニチャーであり、段落レベルの表現に関与する属性のキーに現れることが期待されます。

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static Object	NameAttribute 属性のコレクションに使用される属性名です。
static Object	ResolveAttribute 解釈処理側の親の属性セットが定義されている場合に、それを識別するために使用される属性名です。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
boolean	containsAttribute(Object name, Object value) このセットに、名前が同じで値の等しい属性が定義されている場合に true を返します。
boolean	containsAttributes(AttributeSet attributes) 指定のセットに含まれる、値の等しい属性すべてをこのセットが定義する場合、true を返します。
AttributeSet	copyAttributes() 時間が経っても変化しないことが保証された属性セットを返します。
Object	getAttribute(Object key) 指定された属性の値を取り出します。
int	getAttributeCount() このセット内にローカルに定義されている属性の数を返します。
Enumeration<?>	getAttributeNames() このセット内にローカルに定義されている属性の名前を列挙の形で返します。
AttributeSet	getResolveParent() 解釈処理側の親を返します。
boolean	isDefined(Object attrName) 別の属性セットで解決せずに、名前が指定された属性の値がセットで指定されたものであるかどうかを判定します。
boolean	isEqual(AttributeSet attr) 2 つの属性セットが等しいかどうかを判定します。

フィールドの詳細

NameAttribute

static final Object NameAttribute

属性のコレクションに使用される属性名です。

ResolveAttribute

static final Object ResolveAttribute

解釈処理側の親の属性セットが定義されている場合に、それを識別するために使用される属性名です。

メソッドの詳細

getAttributeCount

int getAttributeCount()

このセット内にローカルに定義されている属性の数を返します。親セット内に定義されている属性は含まれません。

戻り値:

属性の数 >= 0

isDefined

boolean isDefined(Object attrName)

別の属性セットで解決せずに、名前が指定された属性の値がセットで指定されたものであるかどうかを判定します。

パラメータ:

attrName - 属性名

戻り値:

属性が指定された値を持っている場合は true

isEqual

boolean isEqual(AttributeSet attr)

2 つの属性セットが等しいかどうかを判定します。

パラメータ:

attr - 属性セット

戻り値:

セットが等しい場合は true

copyAttributes

AttributeSet copyAttributes()

時間が経っても変化しないことが保証された属性セットを返します。

戻り値:

属性セットのコピー

getAttribute

Object getAttribute(Object key)

指定された属性の値を取り出します。値がローカルでは見つからない場合、解釈処理側の親があれば、それを介して上の階層で検索を続けます。検索は、値が見つかるか、親がなくなるまで続けられます。値が見つからない場合は、null を返します。

パラメータ:

key - 属性をバインドする null 以外のキー

戻り値:

属性の値。見つからない場合は null

getAttributeNames

Enumeration<?> getAttributeNames()

このセット内にローカルに定義されている属性の名前を列挙の形で返します。解釈処理側の親セット内に定義されている属性の名前は含まれません。Enumeration には任意の値を指定でき、特定の Object タイプに制約されません。

このメソッドが null を返すことはない。属性を一切持たないセットに対しては、空の Enumeration を返します。

戻り値:

名前

containsAttribute

boolean containsAttribute(Object name,
                        Object value)

このセットに、名前が同じで値の等しい属性が定義されている場合に true を返します。このような属性がローカルに存在しない場合、解釈処理側の親の階層で検索されます。

パラメータ:

name - null 以外の属性名

value - 値

戻り値:

セットが、ローカルまたは解釈処理側の親を通して値の等しい属性を定義している場合は true

例外:

NullPointerException - name と value のどちらかが null の場合

containsAttributes

boolean containsAttributes(AttributeSet attributes)

指定のセットに含まれる、値の等しい属性すべてをこのセットが定義する場合、true を返します。属性がローカルに存在しない場合、解釈処理側の親の階層で検索されます。

パラメータ:

attributes - チェック対象の属性セット

戻り値:

このセットが、ローカルまたは解釈処理側の親を通して値の等しいすべての属性を定義している場合は true

例外:

NullPointerException - attributes が null である場合

getResolveParent

AttributeSet getResolveParent()

解釈処理側の親を返します。

戻り値:

親