全パッケージ  クラス階層  このパッケージ  前項目  次項目  インデックス

インタフェース java.beans.BeanInfo

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

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

ユーザは各種デスクリプタクラスの一部としてあまりに多くの種類の情報を提供する機会を与えられることになります。しかし、あわてることはありません。各種構築子が必要とする最小限のコア情報を提供するだけで十分です。

BeanInfo クラスの便利な「何もしない」ベースクラスを提供する SimpleBeanInfo クラスも参照してください。これは明確な情報を提供したい特定の箇所をオーバーライドできます。

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

Variable Index

o ICON_COLOR_16x16
16 x 16 のカラーアイコンを示す定数。
o ICON_COLOR_32x32
32 x 32 のカラーアイコンを示す定数。
o ICON_MONO_16x16
16 x 16 のモノクロアイコンを示す定数。
o ICON_MONO_32x32
32 x 32 のモノクロアイコンを示す定数。

Method Index

o getAdditionalBeanInfo()
このメソッドは BeanInfo オブジェクトが現在の bean に関する追加情報を提供する他の BeanInfo オブジェクトの任意のコレクションを返すことを可能にする。
o getBeanDescriptor()
o getDefaultEventIndex()
bean は人が bean を使用するときもっとも良く使われるイベントである「デフォルト」のイベントを持つことができる。
o getDefaultPropertyIndex()
bean は bean をカスタマイズする人がアップデートにもっとも良く選ぶプロパティである「デフォルト」のプロパティを持つことができます。
o getEventSetDescriptors()
o getIcon(int)
このメソッドはツールボックスやツールバーなどで bean を表すために使用できるイメージオブジェクトを返す。
o getMethodDescriptors()
o getPropertyDescriptors()

Variables

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

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

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

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

Methods

o getBeanDescriptor 
  public abstract BeanDescriptor getBeanDescriptor()
返り値:
bean の displayName やカスタマイザなど、bean に関する全般的な情報を提供する BeanDescriptor。情報を自動解析で求めるべきならば null を返すことがある。
o getEventSetDescriptors 
  public abstract EventSetDescriptor[] getEventSetDescriptors()
返り値:
この bean が発するイベントの種類を示す EventSetDescriptors の配列。情報を自動解析で求めるべきならば null を返すことがある。
o getDefaultEventIndex 
  public abstract int getDefaultEventIndex()
bean は人が bean を使用するときもっとも良く使われるイベントである「デフォルト」のイベントを持つことができます。

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

デフォルトのイベントがなければ 1 を返す。

o getPropertyDescriptors 
  public abstract PropertyDescriptor[] getPropertyDescriptors()
返り値:
この bean がサポートする編集可能なプロパティを記述する PropertyDescriptors の配列。情報を自動解析で求めるべきならば null を返すことがある。

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

o getDefaultPropertyIndex 
  public abstract int getDefaultPropertyIndex()
bean は bean をカスタマイズする人がアップデートにもっとも良く選ぶ「デフォルト」のプロパティを持つことができます。

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

デフォルトプロパティがなければ 1 を返す。

o getMethodDescriptors 
  public abstract MethodDescriptor[] getMethodDescriptors()
返り値:
この bean がサポートする外部から見えるメソッドを記述する MethodDescriptors の配列。情報を自動解析で求めるべきならば null を返すことがある。
o getAdditionalBeanInfo 
  public abstract BeanInfo[] getAdditionalBeanInfo()
このメソッドは BeanInfo オブジェクトが現在の bean に関する追加情報を提供する他の BeanInfo オブジェクトの任意のコレクションを返すことを可能にします。

異なる BeanInfo オブジェクトが提供する情報に矛盾か重複がある場合は現在の BeanInfo が getAdditionalBeanInfo オブジェクトに優先し、配列内の後の要素が前のものよりも優先します。

返り値:
BeanInfo オブジェクトの配列。null を返すこともある。
o getIcon 
  public abstract Image getIcon(int iconKind)
このメソッドはツールボックスやツールバーなどで bean を表すために使用できるイメージオブジェクトを返します。アイコンイメージは一般的に GIF ですが、将来は他のフォーマットが含まれる可能性があります。

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

アイコンには 4 つの種類（16x16 カラー、32x32 カラー、16x16 モノクロ、32x32 モノクロ）があります。bean が 1 つのアイコンしかサポートしない場合には 16x16 カラーを推奨します。

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

パラメータ:
要求されたアイコンの種類。定数 ICON_COLOR_16x16、ICON_COLOR_32x32、ICON_MONO_16x16、または ICON_MONO_32x32 のいずれか。
返り値:
要求されたアイコンを表すイメージオブジェクト。適切なアイコンがなければ null を返す。 
全パッケージ  クラス階層  このパッケージ  前項目  次項目  インデックス