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

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策