モジュール java.desktop
パッケージ java.beans

インタフェースBeanInfo

既知のすべてのサブインタフェース:
BeanContextServiceProviderBeanInfo
既知のすべての実装クラス:
SimpleBeanInfo
public interface BeanInfo
BeanInfoクラスを作成し、Beanのメソッド、プロパティ、イベントおよびその他の機能に関する明示的な情報を提供するには、BeanInfoインタフェースを使用します。

Beanの開発時に、アプリケーション・タスクに必要なBean機能を実装し、残りのBeanInfo機能を省略できます。 これらは、Beanメソッドの低レベル・リフレクションの使用および標準デザイン・パターンの適用による自動解析で取得されます。 各種の記述子クラスを介して追加のBean情報を提供することもできます。

BeanInfoクラスにとって便利な基本クラスであるSimpleBeanInfoクラスを参照してください。 SimpleBeanInfoクラスのメソッドおよびプロパティをオーバーライドして固有の情報を定義できます。

Bean動作についてさらに学習するには、Introspectorクラスも参照してください。

導入されたバージョン:
1.1

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    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に関する全般的な情報を提供するBean記述子を返します。
    int
    getDefaultEventIndex()
    このBeanが使用されるときに一般的に適用されるデフォルト・イベントが割り当てられます。
    int
    getDefaultPropertyIndex()
    このBeanがカスタマイズされるときによく更新されるデフォルト・プロパティが割り当てられます。
    EventSetDescriptor[]
    getEventSetDescriptors()
    このBeanによってトリガーされるイベントのタイプを定義する、イベント記述子を返します。
    Image
    getIcon​(int iconKind)
    ツール・ボックスまたはツールバーでBeanを表すために使用できるイメージを返します。
    MethodDescriptor[]
    getMethodDescriptors()
    このBeanによってサポートされる外部から見えるメソッドを定義する、メソッド記述子を返します。
    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に関する全般的な情報を提供するBean記述子を返します。
      戻り値:
      BeanDescriptorオブジェクト、自動解析によって情報が取得される場合はnull

    • getEventSetDescriptors

      EventSetDescriptor[] getEventSetDescriptors()
      このBeanによってトリガーされるイベントのタイプを定義する、イベント記述子を返します。
      戻り値:
      EventSetDescriptorオブジェクトの配列、自動解析によって情報が取得される場合はnull

    • getDefaultEventIndex

      int getDefaultEventIndex()
      このBeanが使用されるときに一般的に適用されるデフォルト・イベントが割り当てられます。
      戻り値:
      getEventSetDescriptorsメソッドによって返されるEventSetDescriptor配列内のデフォルト・イベントのインデックス、デフォルト・イベントがない場合は-1

    • getPropertyDescriptors

      PropertyDescriptor[] getPropertyDescriptors()
      Beanのすべてのプロパティの記述子を返します。

      プロパティがインデックス化されている場合には、結果配列内のそのエントリはPropertyDescriptorクラスのIndexedPropertyDescriptorサブクラスに属します。 getPropertyDescriptorsメソッドのクライアントは、instanceof演算子を使用して、渡されたPropertyDescriptorがIndexedPropertyDescriptorかどうかを判定できます。

      戻り値:
      PropertyDescriptorオブジェクトの配列、自動解析によって情報が取得される場合はnull

    • getDefaultPropertyIndex

      int getDefaultPropertyIndex()
      このBeanがカスタマイズされるときによく更新されるデフォルト・プロパティが割り当てられます。
      戻り値:
      getPropertyDescriptorsメソッドによって返されるPropertyDescriptor配列内のデフォルト・プロパティのインデックス、デフォルト・プロパティがない場合は-1

    • getMethodDescriptors

      MethodDescriptor[] getMethodDescriptors()
      このBeanによってサポートされる外部から見えるメソッドを定義する、メソッド記述子を返します。
      戻り値:
      MethodDescriptorオブジェクトの配列、自動解析によって情報が取得される場合はnull

    • getAdditionalBeanInfo

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

      異なるBeanInfoオブジェクトによって提供される情報の間で競合またはオーバーラップがある場合は、追加のBeanInfoオブジェクトよりも現在のBeanInfoオブジェクトが優先されます。 大きいインデックスの配列要素が小さいインデックスの配列要素よりも優先されます。

      戻り値:
      BeanInfoオブジェクトの配列、追加のBeanInfoオブジェクトがない場合はnull

    • getIcon

      Image getIcon​(int iconKind)
      ツール・ボックスまたはツールバーでBeanを表すために使用できるイメージを返します。

      アイコンには4つの種類(16 x 16カラー、32 x 32カラー、16 x 16モノクロ、32 x 32モノクロ)があります。 単一アイコンをサポートするBeanを実装する場合は、16 x 16カラーを使用することをお薦めします。 アイコンには透明な背景を設定することをお薦めします。

      パラメータ:
      iconKind - リクエストされたアイコンの種類
      戻り値:
      リクエストされたアイコンを表すイメージ・オブジェクト、適切なアイコンを入手できない場合はnull
      関連項目:
      ICON_COLOR_16x16、ICON_COLOR_32x32、ICON_MONO_16x16、ICON_MONO_32x32