cern.gp.beans

Class BeanInfoSupport

java.lang.Object

java.beans.SimpleBeanInfo

cern.gp.beans.BeanInfoSupport

All Implemented Interfaces:

java.beans.BeanInfo

Direct Known Subclasses:

AcceptorBeanBeanInfo, ColoredBeanBeanInfo

public class BeanInfoSupport
extends java.beans.SimpleBeanInfo

Utility class that provides default implementation and caching for all aspect of the BeanInfo.

Should be subclassed in order to overwrite the protected methods.

Author:

Lionel Mestre

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.beans.EventSetDescriptor[]	EMPTY_EVENT_SET Empty array of event set descriptor that you can return in getEventSetDescriptorsLazy in order not to have any event set and to prevent the Introspector to introspect the event set from the bean
protected static java.beans.MethodDescriptor[]	EMPTY_METHOD_SET Empty array of method descriptors that you can return in getMethodDescriptorsLazy in order not to have any method descriptor and to prevent the Introspector to introspect the methods from the bean
protected static java.beans.PropertyDescriptor[]	EMPTY_PROPERTY_SET Empty array of property set that you can return in getPropertyDescriptorsLazy in order not to have any property and to prevent the Introspector to introspect the properties from the bean

Fields inherited from interface java.beans.BeanInfo

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32

Constructor Summary

Constructors

Constructor and Description
BeanInfoSupport()

Method Summary

Modifier and Type	Method and Description
protected java.beans.EventSetDescriptor	createPropertyChangeEventSet(java.lang.Class beanClass) Returns a new EventSetDescriptor for PropertyChangeEvent.
java.beans.BeanInfo[]	getAdditionalBeanInfo()
java.beans.BeanDescriptor	getBeanDescriptor() Gets the bean's BeanDescriptors.
protected java.beans.BeanDescriptor	getBeanDescriptorLazy() Returns the bean descriptor for this bean info.
int	getDefaultEventIndex() A bean may have a "default" event that is the event that will mostly commonly be used by human's when using the bean.
protected int	getDefaultEventIndexLazy() Returns the index of the event.
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.
protected int	getDefaultPropertyIndexLazy() Returns the index of the default property.
java.beans.EventSetDescriptor[]	getEventSetDescriptors() Gets the bean's EventSetDescriptors.
protected java.beans.EventSetDescriptor[]	getEventSetDescriptorsLazy() Returns the event set descriptors for this bean info.
java.awt.Image	getIcon(int iconKind) This method returns an image object that can be used to represent the bean in toolboxes, toolbars, etc.
protected java.lang.String	getIconNameC16() Returns the name of the icon C16.
protected java.lang.String	getIconNameC32() Returns the name of the icon C32.
protected java.lang.String	getIconNameM16() Returns the name of the icon M16.
protected java.lang.String	getIconNameM32() Returns the name of the icon M32.
java.beans.MethodDescriptor[]	getMethodDescriptors() Gets the bean's MethodDescriptors.
protected java.beans.MethodDescriptor[]	getMethodDescriptorsLazy() Returns the method descriptors for this bean info.
java.beans.PropertyDescriptor[]	getPropertyDescriptors() Gets the bean's PropertyDescriptors.
protected java.beans.PropertyDescriptor[]	getPropertyDescriptorsLazy() Returns the property descriptors for this bean info.
protected java.lang.Class	getSuperclass() Returns the superclass of the class this bean info is for.

Methods inherited from class java.beans.SimpleBeanInfo

loadImage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_PROPERTY_SET

protected static final java.beans.PropertyDescriptor[] EMPTY_PROPERTY_SET

Empty array of property set that you can return in getPropertyDescriptorsLazy in order not to have any property and to prevent the Introspector to introspect the properties from the bean

EMPTY_METHOD_SET

protected static final java.beans.MethodDescriptor[] EMPTY_METHOD_SET

Empty array of method descriptors that you can return in getMethodDescriptorsLazy in order not to have any method descriptor and to prevent the Introspector to introspect the methods from the bean

EMPTY_EVENT_SET

protected static final java.beans.EventSetDescriptor[] EMPTY_EVENT_SET

Empty array of event set descriptor that you can return in getEventSetDescriptorsLazy in order not to have any event set and to prevent the Introspector to introspect the event set from the bean

Constructor Detail

BeanInfoSupport

public BeanInfoSupport()

Method Detail

getBeanDescriptorLazy

protected java.beans.BeanDescriptor getBeanDescriptorLazy()

Returns the bean descriptor for this bean info.

Returns:

the bean descriptor for this bean info.

getPropertyDescriptorsLazy

protected java.beans.PropertyDescriptor[] getPropertyDescriptorsLazy()
                                                              throws java.beans.IntrospectionException

Returns the property descriptors for this bean info. Default implementation returns null which means that the Introspector will perform the introspection to get the PropertyDescriptors This method is guarantee to be called once

Returns:

the property descriptors for this bean info.

Throws:

java.beans.IntrospectionException

getEventSetDescriptorsLazy

protected java.beans.EventSetDescriptor[] getEventSetDescriptorsLazy()
                                                              throws java.beans.IntrospectionException

Returns the event set descriptors for this bean info. Default implementation returns null which means that the Introspector will perform the introspection to get the EventSetDescriptors This method is guarantee to be called once

Returns:

the event set descriptors for this bean info.

Throws:

java.beans.IntrospectionException

getMethodDescriptorsLazy

protected java.beans.MethodDescriptor[] getMethodDescriptorsLazy()
                                                          throws java.beans.IntrospectionException

Returns the method descriptors for this bean info. Default implementation returns null which means that the Introspector will perform the introspection to get the MethodDescriptors. This method is guarantee to be called once

Returns:

the method descriptors for this bean info.

Throws:

java.beans.IntrospectionException

getIconNameM16

protected java.lang.String getIconNameM16()

Returns the name of the icon M16. Default implementation returns null.

Returns:

the name of the icon M16 or null if no icon.

getIconNameM32

protected java.lang.String getIconNameM32()

Returns the name of the icon M32. Default implementation returns null.

Returns:

the name of the icon M32 or null if no icon.

getIconNameC16

protected java.lang.String getIconNameC16()

Returns the name of the icon C16. Default implementation returns null.

Returns:

the name of the icon C16 or null if no icon.

getIconNameC32

protected java.lang.String getIconNameC32()

Returns the name of the icon C32. Default implementation returns null.

Returns:

the name of the icon C32 or null if no icon.

getDefaultPropertyIndexLazy

protected int getDefaultPropertyIndexLazy()

Returns the index of the default property. Default implementation returns -1.

Returns:

the index of the default property.

getDefaultEventIndexLazy

protected int getDefaultEventIndexLazy()

Returns the index of the event. Default implementation returns -1.

Returns:

the index of the default event.

getSuperclass

protected java.lang.Class getSuperclass()

Returns the superclass of the class this bean info is for. This is used in order to look for additional BeanInfo. Default implementation returns null which means that there is no additional BeanInfo

Returns:

the superclass of the class this bean info is for or null.

createPropertyChangeEventSet

protected java.beans.EventSetDescriptor createPropertyChangeEventSet(java.lang.Class beanClass)
                                                              throws java.beans.IntrospectionException

Returns a new EventSetDescriptor for PropertyChangeEvent. Call this method inside the method getEventSetDescriptorsLazy in order to include PropertyChangeEvent in the array of EventSetDescriptor you return. You do that if the bean class has the methods addPropertyChangeListener and removePropertyChangeListener.

Parameters:

beanClass - the class of the bean this BeanInfo is for

Returns:

A EventSetDescriptor for the PropertyChange events.

Throws:

java.beans.IntrospectionException - if the EventSetDescriptor cannot be built.

getAdditionalBeanInfo

public final java.beans.BeanInfo[] getAdditionalBeanInfo()

Specified by:

getAdditionalBeanInfo in interface java.beans.BeanInfo

Overrides:

getAdditionalBeanInfo in class java.beans.SimpleBeanInfo

getBeanDescriptor

public final java.beans.BeanDescriptor getBeanDescriptor()

Gets the bean's BeanDescriptors.

Specified by:

getBeanDescriptor in interface java.beans.BeanInfo

Overrides:

getBeanDescriptor in class java.beans.SimpleBeanInfo

Returns:

BeanDescriptor describing the editable properties of this bean. May return null if the information should be obtained by automatic analysis.

getPropertyDescriptors

public final java.beans.PropertyDescriptor[] getPropertyDescriptors()

Gets the bean's PropertyDescriptors.

Specified by:

getPropertyDescriptors in interface java.beans.BeanInfo

Overrides:

getPropertyDescriptors in class java.beans.SimpleBeanInfo

Returns:

An array of PropertyDescriptors describing the editable properties supported by this bean. May return 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 PropertyDescriptor. A client of getPropertyDescriptors can use "instanceof" to check if a given PropertyDescriptor is an IndexedPropertyDescriptor.

getEventSetDescriptors

public final java.beans.EventSetDescriptor[] getEventSetDescriptors()

Gets the bean's EventSetDescriptors.

Specified by:

getEventSetDescriptors in interface java.beans.BeanInfo

Overrides:

getEventSetDescriptors in class java.beans.SimpleBeanInfo

Returns:

An array of EventSetDescriptors describing the kinds of events fired by this bean. May return null if the information should be obtained by automatic analysis.

getMethodDescriptors

public final java.beans.MethodDescriptor[] getMethodDescriptors()

Gets the bean's MethodDescriptors.

Specified by:

getMethodDescriptors in interface java.beans.BeanInfo

Overrides:

getMethodDescriptors in class java.beans.SimpleBeanInfo

Returns:

An array of MethodDescriptors describing the methods implemented by this bean. May return null if the information should be obtained by automatic analysis.

getDefaultPropertyIndex

public final 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.

Specified by:

getDefaultPropertyIndex in interface java.beans.BeanInfo

Overrides:

getDefaultPropertyIndex in class java.beans.SimpleBeanInfo

Returns:

Index of default property in the PropertyDescriptor array returned by getPropertyDescriptors.

Returns -1 if there is no default property.

getDefaultEventIndex

public final int getDefaultEventIndex()

A bean may have a "default" event that is the event that will mostly commonly be used by human's when using the bean.

Specified by:

getDefaultEventIndex in interface java.beans.BeanInfo

Overrides:

getDefaultEventIndex in class java.beans.SimpleBeanInfo

Returns:

Index of default event in the EventSetDescriptor array returned by getEventSetDescriptors.

Returns -1 if there is no default event.

getIcon

public final java.awt.Image getIcon(int iconKind)

This method returns an image object that can be used to represent the bean in toolboxes, toolbars, etc. Icon images will typically be GIFs, but may in future include other formats.

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.

Specified by:

getIcon in interface java.beans.BeanInfo

Overrides:

getIcon in class java.beans.SimpleBeanInfo

Parameters:

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.

Returns:

An image object representing the requested icon. May return null if no suitable icon is available.