org.apache.geronimo.connector.deployment.dconfigbean
Class ConnectionDefinitionInstanceBeanInfo

java.lang.Object
  org.apache.geronimo.connector.deployment.dconfigbean.ConnectionDefinitionInstanceBeanInfo

All Implemented Interfaces:

BeanInfo

public class ConnectionDefinitionInstanceBeanInfo
extends Object
implements BeanInfo

Field Summary

Fields inherited from interface java.beans.BeanInfo

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32

Constructor Summary

ConnectionDefinitionInstanceBeanInfo()

Method Summary

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 EventSetDescriptors.
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 MethodDescriptors.
PropertyDescriptor[]	getPropertyDescriptors() Gets the beans PropertyDescriptors.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionDefinitionInstanceBeanInfo

public ConnectionDefinitionInstanceBeanInfo()

Method Detail

getDefaultEventIndex

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

Specified by:

getDefaultEventIndex in interface BeanInfo

Returns:

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

Returns -1 if there is no default event.

getDefaultPropertyIndex

public 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 BeanInfo

Returns:

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

Returns -1 if there is no default property.

getIcon

public 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 BeanInfo

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.

getBeanDescriptor

public BeanDescriptor getBeanDescriptor()

Gets the beans BeanDescriptor.

Specified by:

getBeanDescriptor in interface BeanInfo

Returns:

A BeanDescriptor providing overall information about the bean, such as its displayName, its customizer, etc. May return null if the information should be obtained by automatic analysis.

getAdditionalBeanInfo

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

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.

Specified by:

getAdditionalBeanInfo in interface BeanInfo

Returns:

an array of BeanInfo objects. May return null.

getEventSetDescriptors

public EventSetDescriptor[] getEventSetDescriptors()

Gets the beans EventSetDescriptors.

Specified by:

getEventSetDescriptors in interface BeanInfo

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 MethodDescriptor[] getMethodDescriptors()

Gets the beans MethodDescriptors.

Specified by:

getMethodDescriptors in interface BeanInfo

Returns:

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

getPropertyDescriptors

public PropertyDescriptor[] getPropertyDescriptors()

Gets the beans PropertyDescriptors.

Specified by:

getPropertyDescriptors in interface BeanInfo

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.