public interface BeanInfo
A bean implementor doesn't need to provide a complete set of explicit information. You can pick and choose which information you want to provide and the rest will be obtained by automatic analysis using low-level reflection of the bean classes' methods and applying standard design patterns.
You get the opportunity to provide lots and lots of different information as part of the various XyZDescriptor classes. But don't panic, you only really need to provide the minimal core information required by the various constructors.
See also the SimpleBeanInfo class which provides a convenient "noop" base class for BeanInfo classes, which you can override for those specific places where you want to return explicit info.
To learn about all the behaviour of a bean see the Introspector class.
Modifier and Type | Field and Description |
---|---|
static int |
ICON_COLOR_16x16
Constant to indicate a 16 x 16 color icon.
|
static int |
ICON_COLOR_32x32
Constant to indicate a 32 x 32 color icon.
|
static int |
ICON_MONO_16x16
Constant to indicate a 16 x 16 monochrome icon.
|
static int |
ICON_MONO_32x32
Constant to indicate a 32 x 32 monochrome icon.
|
Modifier and Type | Method and Description |
---|---|
BeanInfo[] |
getAdditionalBeanInfo()
This method allows a BeanInfo object to return an arbitrary collection
of other BeanInfo objects that provide additional information on the
current bean.
|
BeanDescriptor |
getBeanDescriptor()
Gets the beans
BeanDescriptor . |
int |
getDefaultEventIndex()
A bean may have a "default" event that is the event that will
mostly commonly be used by humans when using the bean.
|
int |
getDefaultPropertyIndex()
A bean may have a "default" property that is the property that will
mostly commonly be initially chosen for update by human's who are
customizing the bean.
|
EventSetDescriptor[] |
getEventSetDescriptors()
Gets the beans
EventSetDescriptor s. |
Image |
getIcon(int iconKind)
This method returns an image object that can be used to
represent the bean in toolboxes, toolbars, etc.
|
MethodDescriptor[] |
getMethodDescriptors()
Gets the beans
MethodDescriptor s. |
PropertyDescriptor[] |
getPropertyDescriptors()
Returns descriptors for all properties of the bean.
|
static final int ICON_COLOR_16x16
static final int ICON_COLOR_32x32
static final int ICON_MONO_16x16
static final int ICON_MONO_32x32
BeanDescriptor getBeanDescriptor()
BeanDescriptor
.EventSetDescriptor[] getEventSetDescriptors()
EventSetDescriptor
s.int getDefaultEventIndex()
Returns -1 if there is no default event.
PropertyDescriptor[] getPropertyDescriptors()
null
if the information
should be obtained by automatic analysis.
If a property is indexed, then its entry in the result array
will belong to the IndexedPropertyDescriptor
subclass
of the PropertyDescriptor
class.
A client of the getPropertyDescriptors
method
can use "instanceof
" to check
whether a given PropertyDescriptor
is an IndexedPropertyDescriptor
.
PropertyDescriptor
s
describing all properties supported by the bean
or null
int getDefaultPropertyIndex()
Returns -1 if there is no default property.
MethodDescriptor[] getMethodDescriptors()
MethodDescriptor
s.BeanInfo[] getAdditionalBeanInfo()
If there are conflicts or overlaps between the information provided by different BeanInfo objects, then the current BeanInfo takes precedence over the getAdditionalBeanInfo objects, and later elements in the array take precedence over earlier ones.
Image getIcon(int iconKind)
Beans aren't required to provide icons and may return null from this method.
There are four possible flavors of icons (16x16 color, 32x32 color, 16x16 mono, 32x32 mono). If a bean choses to only support a single icon we recommend supporting 16x16 color.
We recommend that icons have a "transparent" background so they can be rendered onto an existing background.
iconKind
- The kind of icon requested. This should be
one of the constant values ICON_COLOR_16x16, ICON_COLOR_32x32,
ICON_MONO_16x16, or ICON_MONO_32x32. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.