BeanContextServiceProviderBeanInfo
SimpleBeanInfo
public interface BeanInfo
BeanInfo
interface to create a BeanInfo
class and provide explicit information about the methods, properties, events, and other features of your beans. When developing your bean, you can implement the bean features required for your application task omitting the rest of the BeanInfo
features. They will be obtained through the automatic analysis by using the low-level reflection of the bean methods and applying standard design patterns. You have an opportunity to provide additional bean information through various descriptor classes.
See the SimpleBeanInfo
class that is a convenient basic class for BeanInfo
classes. You can override the methods and properties of the SimpleBeanInfo
class to define specific information.
See also the Introspector
class to learn more about bean behavior.
Modifier and Type | Field | Description |
---|---|---|
static final int |
ICON_COLOR_16x16 |
Constant to indicate a 16 x 16 color icon. |
static final int |
ICON_COLOR_32x32 |
Constant to indicate a 32 x 32 color icon. |
static final int |
ICON_MONO_16x16 |
Constant to indicate a 16 x 16 monochrome icon. |
static final int |
ICON_MONO_32x32 |
Constant to indicate a 32 x 32 monochrome icon. |
Modifier and Type | Method | Description |
---|---|---|
BeanInfo[] |
getAdditionalBeanInfo() |
This method enables the current BeanInfo object to return an arbitrary collection of other BeanInfo objects that provide additional information about the current bean. |
BeanDescriptor |
getBeanDescriptor() |
Returns the bean descriptor that provides overall information about the bean, such as its display name or its customizer. |
int |
getDefaultEventIndex() |
A bean may have a default event typically applied when this bean is used. |
int |
getDefaultPropertyIndex() |
A bean may have a default property commonly updated when this bean is customized. |
EventSetDescriptor[] |
getEventSetDescriptors() |
Returns the event descriptors of the bean that define the types of events fired by this bean. |
Image |
getIcon |
Returns an image that can be used to represent the bean in toolboxes or toolbars. |
MethodDescriptor[] |
getMethodDescriptors() |
Returns the method descriptors of the bean that define the externally visible methods supported by this bean. |
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
object, or null
if the information is to be obtained through the automatic analysisEventSetDescriptor[] getEventSetDescriptors()
EventSetDescriptor
objects, or null
if the information is to be obtained through the automatic analysisint getDefaultEventIndex()
EventSetDescriptor
array returned by the getEventSetDescriptors
method, or -1 if there is no default eventPropertyDescriptor[] getPropertyDescriptors()
If a property is indexed, then its entry in the result array belongs to the IndexedPropertyDescriptor
subclass of the PropertyDescriptor
class. A client of the getPropertyDescriptors
method can use the instanceof
operator to check whether a given PropertyDescriptor
is an IndexedPropertyDescriptor
.
PropertyDescriptor
objects, or null
if the information is to be obtained through the automatic analysisint getDefaultPropertyIndex()
PropertyDescriptor
array returned by the getPropertyDescriptors
method, or -1 if there is no default propertyMethodDescriptor[] getMethodDescriptors()
MethodDescriptor
objects, or null
if the information is to be obtained through the automatic analysisBeanInfo[] getAdditionalBeanInfo()
BeanInfo
object to return an arbitrary collection of other BeanInfo
objects that provide additional information about the current bean. If there are conflicts or overlaps between the information provided by different BeanInfo
objects, the current BeanInfo
object takes priority over the additional BeanInfo
objects. Array elements with higher indices take priority over the elements with lower indices.
BeanInfo
objects, or null
if there are no additional BeanInfo
objectsImage getIcon(int iconKind)
There are four possible types of icons: 16 x 16 color, 32 x 32 color, 16 x 16 mono, and 32 x 32 mono. If you implement a bean so that it supports a single icon, it is recommended to use 16 x 16 color. Another recommendation is to set a transparent background for the icons.
iconKind
- the kind of icon requestednull
if no suitable icon is available
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/beans/BeanInfo.html