JavaTM 2 Platform
Standard Ed. 6

java.beans
介面 BeanInfo

所有已知子介面:
BeanContextServiceProviderBeanInfo
所有已知實作類別:
SimpleBeanInfo

public interface BeanInfo

希望提供有關其 bean 的顯式資訊的 bean 實作者可以提供某個 BeanInfo 類別,該類別實作此 BeanInfo 介面並提供有關其 bean 的方法、屬性、事件等顯式資訊。

bean 實作者不必提供一組完整的顯式資訊。可以挑選出希望提供的資訊,其餘部分將通過使用 bean 類別方法的低層級別反射和應用標準設計網要的自動分析來獲得。

有機會提供大量不同的資訊作為各種 XyZDescriptor 類別的一部分。但不必驚慌,真正需要的只是提供各種建構子所需的最少核心資訊。

請參見 SimpleBeanInfo 類別,它提供了用於 BeanInfo 類別的一個便捷 "noop" 基礎類別,可以為那些想要返回顯式資訊的特定位置覆寫該基礎類別。

要學習有關 bean 的所有行為,請參見 Introspector 類別。


欄位摘要
static int ICON_COLOR_16x16
          指示 16 x 16 彩色圖標的常數。
static int ICON_COLOR_32x32
          指示 32 x 32 彩色圖標的常數。
static int ICON_MONO_16x16
          指示 16 x 16 單色圖標的常數。
static int ICON_MONO_32x32
          指示 32 x 32 單色圖標的常數。
 
方法摘要
 BeanInfo[] getAdditionalBeanInfo()
          此方法允許 BeanInfo 物件返回提供關於當前 bean 額外資訊的 BeanInfo 物件組成的任意集合。
 BeanDescriptor getBeanDescriptor()
          獲得 beans BeanDescriptor
 int getDefaultEventIndex()
          bean 可能有一個「預設」事件,即使用 bean 時通常最有可能由使用者使用的事件。
 int getDefaultPropertyIndex()
          bean 可能有一個「預設」屬性,即通常最有可能由自定義 bean 的使用者一開始就選擇更新的屬性。
 EventSetDescriptor[] getEventSetDescriptors()
          獲得 beans EventSetDescriptor
 Image getIcon(int iconKind)
          此方法返回一個圖像物件,可用該物件表示工具框、工具欄等中的 bean。
 MethodDescriptor[] getMethodDescriptors()
          獲得 beans MethodDescriptor
 PropertyDescriptor[] getPropertyDescriptors()
          獲得 beans PropertyDescriptor
 

欄位詳細資訊

ICON_COLOR_16x16

static final int ICON_COLOR_16x16
指示 16 x 16 彩色圖標的常數。

另請參見:
常數欄位值

ICON_COLOR_32x32

static final int ICON_COLOR_32x32
指示 32 x 32 彩色圖標的常數。

另請參見:
常數欄位值

ICON_MONO_16x16

static final int ICON_MONO_16x16
指示 16 x 16 單色圖標的常數。

另請參見:
常數欄位值

ICON_MONO_32x32

static final int ICON_MONO_32x32
指示 32 x 32 單色圖標的常數。

另請參見:
常數欄位值
方法詳細資訊

getBeanDescriptor

BeanDescriptor getBeanDescriptor()
獲得 beans BeanDescriptor

返回:
提供有關 bean 的全面資訊的 BeanDescriptor,比如其 displayName、customizer 等等。如果該資訊應該通過自動分析獲得,則可能返回 null。

getEventSetDescriptors

EventSetDescriptor[] getEventSetDescriptors()
獲得 beans EventSetDescriptor

返回:
描述由此 bean 觸發事件種類別的 EventSetDescriptor 陣列。如果該資訊應該通過自動分析獲得,則可能返回 null。

getDefaultEventIndex

int getDefaultEventIndex()
bean 可能有一個「預設」事件,即使用 bean 時通常最有可能由使用者使用的事件。

返回:
位於由 getEventSetDescriptors 返回的 EventSetDescriptor 陣列中的預設事件的索引。

如果沒有預設事件,則返回 -1。


getPropertyDescriptors

PropertyDescriptor[] getPropertyDescriptors()
獲得 beans PropertyDescriptor

返回:
描述受此 bean 支持的可編輯屬性的 PropertyDescriptor 陣列。如果該資訊應該通過自動分析獲得,則可能返回 null。

如果某個屬性已建立索引,則結果陣列中該屬性的條目將屬於 PropertyDescriptor 的 IndexedPropertyDescriptor 子類別。getPropertyDescriptors 的客戶端可以使用 "instanceof" 來檢查給定 PropertyDescriptor 是否是一個 IndexedPropertyDescriptor。


getDefaultPropertyIndex

int getDefaultPropertyIndex()
bean 可能有一個「預設」屬性,即通常最有可能由自定義 bean 的使用者一開始就選擇更新的屬性。

返回:
位於由 getPropertyDescriptors 返回的 PropertyDescriptor 陣列中的預設屬性的索引。

如果沒有預設屬性,則返回 -1。


getMethodDescriptors

MethodDescriptor[] getMethodDescriptors()
獲得 beans MethodDescriptor

返回:
描述受此 bean 支持的擴展可見方法的 MethodDescriptor 陣列。如果該資訊應該通過自動分析獲得,則可能返回 null。

getAdditionalBeanInfo

BeanInfo[] getAdditionalBeanInfo()
此方法允許 BeanInfo 物件返回提供關於當前 bean 額外資訊的 BeanInfo 物件組成的任意集合。

如果不同 BeanInfo 物件提供的資訊之間有衝突和重疊,則當前 BeanInfo 優先於 getAdditionalBeanInfo 物件,陣列中後面的元素優先於前面的元素。

返回:
BeanInfo 物件陣列。可能返回 null。

getIcon

Image getIcon(int iconKind)
此方法返回一個圖像物件,可用該物件表示工具框、工具欄等中的 bean。圖標圖像通常是 GIF,但將來可能包括其他格式。

bean 不需要提供圖標,並且可能從此方法返回 null。

有四種可能的圖標樣式(16x16 彩色、32x32 彩色、16x16 單色、32x32 單色)。如果 bean 選擇只支持一個圖標,則建議支持 16x16 彩色。

建議該圖標有一個「透明的」背景,這樣就可以將它們呈現在現有的背景上。

參數:
iconKind - 所請求圖標的種類別。此參數應該是以下常數值之一:ICON_COLOR_16x16、ICON_COLOR_32x32、ICON_MONO_16x16 和 ICON_MONO_32x32。
返回:
表示所請求圖標的圖像物件。如果沒有合適的圖標可用,則可能返回 null。

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

版權所有 2008 Sun Microsystems, Inc. 保留所有權利。請遵守GNU General Public License, version 2 only