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 のすべてのプロパティーの記述子を返します。

フィールドの詳細

ICON_COLOR_16x16

static final int ICON_COLOR_16x16

16×16 のカラーアイコンを示す定数です。

関連項目:

定数フィールド値

ICON_COLOR_32x32

static final int ICON_COLOR_32x32

32×32 のカラーアイコンを示す定数です。

関連項目:

定数フィールド値

ICON_MONO_16x16

static final int ICON_MONO_16x16

16×16 のモノクロアイコンを示す定数です。

関連項目:

定数フィールド値

ICON_MONO_32x32

static final int ICON_MONO_32x32

32×32 のモノクロアイコンを示す定数です。

関連項目:

定数フィールド値

メソッドの詳細

getBeanDescriptor

BeanDescriptor getBeanDescriptor()

Bean の BeanDescriptor を取得します。

戻り値:

Bean の displayName やカスタマイザなど、Bean に関する全般的な情報を提供する BeanDescriptor。情報を自動解析で取得するべきである場合は null を返すことがある。

getEventSetDescriptors

EventSetDescriptor[] getEventSetDescriptors()

Bean の EventSetDescriptor を取得します。

戻り値:

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

getDefaultEventIndex

int getDefaultEventIndex()

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

戻り値:

getEventSetDescriptors によって返される EventSetDescriptor 配列内のデフォルトイベントのインデックス。

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

getPropertyDescriptors

PropertyDescriptor[] getPropertyDescriptors()

Bean のすべてのプロパティーの記述子を返します。情報を自動解析で求める必要がある場合は null を返すことがあります。

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

戻り値:

Bean によってサポートされているすべてのプロパティーを記述する PropertyDescriptor の配列または null

getDefaultPropertyIndex

int getDefaultPropertyIndex()

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

戻り値:

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

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

getMethodDescriptors

MethodDescriptor[] getMethodDescriptors()

Bean の MethodDescriptor を取得します。

戻り値:

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

getAdditionalBeanInfo

BeanInfo[] getAdditionalBeanInfo()

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

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

戻り値:

BeanInfo オブジェクトの配列。null を返す場合もある。

getIcon

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 を返すことがある。