JavaTM 2
Platform
Std. Ed. v1.4.0

java.beans
インタフェース BeanInfo

既知のサブインタフェースの一覧:
BeanContextServiceProviderBeanInfo
既知の実装クラスの一覧:
SimpleBeanInfo

public interface BeanInfo

bean の実装者は、この BeanInfo インタフェースを実装する BeanInfo クラスを提供して、自分の bean のメソッド、プロパティ、イベントなどに関する明示的な情報を提供することができます。

bean の実装者は、明示的な情報をすべて提供する必要はありません。提供する情報を選ぶことができ、残りは bean クラスのメソッドの低レベルリフレクションを使用した自動解析および標準のデザインパターンの適用によって取得できます。

ユーザは、各 Descriptor クラスの一部として、非常に多くの種類の情報を提供する機会を与えられることになります。しかし、各コンストラクタが必要とする最小限のコア情報を提供するだけでも十分です。

BeanInfo クラスの便利な「無操作」基底クラスを提供する SimpleBeanInfo クラスも参照してください。これを使用すると、明示的な情報を提供したい特定の箇所をオーバーライドできます。

bean のすべての動作について知るには Introspector クラスを参照してください。


フィールドの概要
static int ICON_COLOR_16x16
          16×16 のカラーアイコンを示す定数です。
static int ICON_COLOR_32x32
          32×32 のカラーアイコンを示す定数です。
static int ICON_MONO_16x16
          16×16 のモノクロアイコンを示す定数です。
static int ICON_MONO_32x32
          32×32 のモノクロアイコンを示す定数です。
 
メソッドの概要
 BeanInfo[] getAdditionalBeanInfo()
          このメソッドは、BeanInfo オブジェクトが、現在の bean についての追加情報を提供するほかの BeanInfo オブジェクトの任意のコレクションを返すことができるようにします。
 BeanDescriptor getBeanDescriptor()
          bean の BeanDescriptor を取得します。
 int getDefaultEventIndex()
          bean は、人が bean を使用するときにもっとも多く使われるイベントを「デフォルト」のイベントとして持つことができます。
 int getDefaultPropertyIndex()
          bean は、カスタマイズされる際にもっとも多く選ばれるプロパティを「デフォルト」のプロパティとして持つことができます。
 EventSetDescriptor[] getEventSetDescriptors()
          bean の EventSetDescriptor を取得します。
 Image getIcon(int iconKind)
          このメソッドは、ツールボックスやツールバーなどで bean を表すために使用できるイメージオブジェクトを返します。
 MethodDescriptor[] getMethodDescriptors()
          bean の MethodDescriptor を取得します。
 PropertyDescriptor[] getPropertyDescriptors()
          bean の PropertyDescriptor を取得します。
 

フィールドの詳細

ICON_COLOR_16x16

public static final int ICON_COLOR_16x16
16×16 のカラーアイコンを示す定数です。

関連項目:
定数フィールド値

ICON_COLOR_32x32

public static final int ICON_COLOR_32x32
32×32 のカラーアイコンを示す定数です。

関連項目:
定数フィールド値

ICON_MONO_16x16

public static final int ICON_MONO_16x16
16×16 のモノクロアイコンを示す定数です。

関連項目:
定数フィールド値

ICON_MONO_32x32

public static final int ICON_MONO_32x32
32×32 のモノクロアイコンを示す定数です。

関連項目:
定数フィールド値
メソッドの詳細

getBeanDescriptor

public BeanDescriptor getBeanDescriptor()
bean の BeanDescriptor を取得します。

戻り値:
bean の displayName やカスタマイザなど、bean に関する全般的な情報を提供する BeanDescriptor。情報を自動解析で求める必要がある場合は null を返すことがある

getEventSetDescriptors

public EventSetDescriptor[] getEventSetDescriptors()
bean の EventSetDescriptor を取得します。

戻り値:
この bean がトリガするイベントの種類を示す EventSetDescriptors の配列。情報を自動解析で求める必要がある場合は null を返すことがある

getDefaultEventIndex

public int getDefaultEventIndex()
bean は、人が bean を使用するときにもっとも多く使われるイベントを「デフォルト」のイベントとして持つことができます。

戻り値:
getEventSetDescriptors が返す EventSetDescriptor 配列内のデフォルトイベントのインデックス

デフォルトのイベントがない場合は -1


getPropertyDescriptors

public PropertyDescriptor[] getPropertyDescriptors()
bean の PropertyDescriptor を取得します。

戻り値:
この bean がサポートする編集可能なプロパティを記述する PropertyDescriptors の配列。情報を自動解析で求める必要がある場合は null を返すことがある

プロパティがインデックス化されている場合には、結果の配列内のその項目は PropertyDescriptor の IndexedPropertyDescriptor サブクラスに属する。getPropertyDescriptors のクライアントは、"instanceof" を使用して、取得した PropertyDescriptor が IndexedPropertyDescriptor かどうかを判定できる


getDefaultPropertyIndex

public int getDefaultPropertyIndex()
bean は、カスタマイズされる際にもっとも多く選ばれるプロパティを「デフォルト」のプロパティとして持つことができます。

戻り値:
getPropertyDescriptors が返す PropertyDescriptor 配列内のデフォルトプロパティのインデックス

デフォルトプロパティがない場合は -1


getMethodDescriptors

public MethodDescriptor[] getMethodDescriptors()
bean の MethodDescriptor を取得します。

戻り値:
この bean がサポートする、外部から見えるメソッドを記述する MethodDescriptors の配列。情報を自動解析で求める必要がある場合は null を返すことがある

getAdditionalBeanInfo

public BeanInfo[] getAdditionalBeanInfo()
このメソッドは、BeanInfo オブジェクトが、現在の bean についての追加情報を提供するほかの BeanInfo オブジェクトの任意のコレクションを返すことができるようにします。

異なる BeanInfo オブジェクトによって提供された情報の間で不一致またはオーバーラップがある場合は、getAdditionalBeanInfo オブジェクトよりも現在の BeanInfo が優先され、配列内に以前からあった要素よりもあとから入った要素が優先されます。

戻り値:
BeanInfo オブジェクトの配列。null を返す場合がある

getIcon

public Image getIcon(int iconKind)
このメソッドは、ツールボックスやツールバーなどで bean を表すために使用できるイメージオブジェクトを返します。アイコンイメージは一般的には GIF ですが、将来はほかの形式が含まれる可能性があります。

必ずしも bean はアイコンを提供する必要はなく、このメソッドで null を返す場合があります。

アイコンには 4 つの種類 (16×16 カラー、32×32 カラー、16×16 モノクロ、32×32 モノクロ) があります。bean が 1 つのアイコンしかサポートしない場合は、16×16 カラーをお勧めします。

アイコンは、既存のバックグラウンドに描画できるように、透明のバックグラウンドを持つことをお勧めします。

パラメータ:
iconKind - 要求されたアイコンの種類。定数 ICON_COLOR_16x16、ICON_COLOR_32x32、ICON_MONO_16x16、または ICON_MONO_32x32 のどれか
戻り値:
要求されたアイコンを表すイメージオブジェクト。適切なアイコンがない場合は null

JavaTM 2
Platform
Std. Ed. v1.4.0

バグの報告と機能のリクエスト
これ以外の API リファレンスおよび開発者用ドキュメントについては、 Java 2 SDK SE 開発者用ドキュメントを参照してください。 開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、 およびコード実例が含まれています。

Java、Java 2D、および JDBC は米国ならびにその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.