Package com.inductiveautomation.vision.api.designer.beans

Class DefaultBeanInfo

java.lang.Object

java.beans.SimpleBeanInfo

com.inductiveautomation.vision.api.designer.beans.DefaultBeanInfo

All Implemented Interfaces:

BeanInfo

Direct Known Subclasses:

CommonBeanInfo, FPMIAppBeanInfo, FPMIWindowBeanInfo

public class DefaultBeanInfo
extends SimpleBeanInfo

A BeanInfo is part of the JavaBean spec - it is a class that describes a visual bean. This BeanInfo is the root class for bean infos in the Vision system. Note: Most BeanInfos implementations will actually be a subclass of CommonBeanInfo.

Field Summary

Fields

Modifier and Type	Field	Description
protected Class	beanClass
static final int	BOUND_MASK	This flag marks a property as "Bound".
static final String	CATEGORY_KEY	This key is used on a PropertyDescriptor to give it a category.
static final int	CONSTRAINED_MASK	Not used.
static final String	DISPLAY_ORDER_KEY	This key is used on a PropertyDescriptor to give an explicit order to properties.
static final int	EXPERT_MASK	Use this flag to mark a property as expert so that it shows up under the "Expert" and "All" filters.
static final int	HIDDEN_MASK	Use this flag to mark a property that won't be available in the Designer, but will be serialized.
protected LoggerEx	log
static final int	NO_MASK
static final String	NOT_BINDABLE_KEY
static final int	NOT_BINDABLE_MASK	Use this flag to mark a property that shouldn't ever be the target of a binding.
static final String	NOT_TRANSLATABLE_KEY
static final int	NOT_TRANSLATABLE_MASK	This marks a property as not compatible with the automatic translation system.
static final int	PREFERRED_MASK	Use this flag to mark the property as a preferred property - these are the properties that show up under the "Basic" filter.
static final int	PREFFERED_MASK	Deprecated. Misspelled.
static final String	TRANSIENT_KEY
static final int	TRANSIENT_MASK	Use this flag to mark a property as transient (so it will not be serialized).

Fields inherited from interface java.beans.BeanInfo

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32

Constructor Summary

Constructors

Constructor	Description
DefaultBeanInfo(Class c, CustomizerDescriptor... customizerDescriptor)	Create a new BeanInfo for teh given class that will use the provided customizers (if any).

Method Summary

Modifier and Type	Method	Description
protected void	addBoundProp(String name, String display, String desc, String category)	Adds a property that has the BOUND_MASK flag.
protected void	addBoundProp(String name, String display, String desc, String category, int flags)	Adds a property that has the BOUND_MASK flag, and potentially other flags.
protected void	addEnumProp(String name, String display, String desc, String category, int[] values, String[] names)	Adds an "enum property".
protected void	addEnumProp(String name, String display, String desc, String category, int[] values, String[] names, int flags)
protected void	addEnumProp(String name, String display, String desc, String category, Class<? extends Enum> enumClass)	Adds an property based upon enum constants.
protected void	addEnumProp(String name, String display, String desc, String category, Class<? extends Enum> enumClass, int flags)
protected void	addEventSet(Class sourceClass, String eventSetName, Class listenerType, Class eventObjectType, String[] listenerMethodNames)	This overload of addEventSet(Class, String, Class, String[]) is for when the event object type cannot be derived from the event set name.
protected void	addEventSet(Class sourceClass, String eventSetName, Class listenerType, Class eventObjectType, String[] listenerMethodNames, String addListenerMethodName, String removeListenerMethodName, String getListenerMethodName)	Overload of addEventSet(Class, String, Class, String[]) that has explicit arguments for the event object type and listener names.
protected void	addEventSet(Class sourceClass, String eventSetName, Class listenerType, String listenerMethodName)	This overload of addEventSet(Class, String, Class, String[]) is used for events that have a single listener method.
protected void	addEventSet(Class sourceClass, String eventSetName, Class listenerType, String[] listenerMethodNames)	Adds an "event set" that this bean supports.
protected void	addMethod(MethodDescriptor method)	(Bean methods are not used in Ignition)
protected void	addMethod(String name, Class[] args, String displayName)	(Bean methods are not used in Ignition)
protected void	addMethod(String name, Class arg, String displayName)	(Bean methods are not used in Ignition)
protected void	addProp(PropertyDescriptor prop)	Adds the property, appending it to the display order (see DISPLAY_ORDER_KEY).
protected void	addProp(String name, String display, String desc, int flags)	Adds a property to the bean.
protected void	addProp(String name, String display, String desc, String category)	Adds a property to the bean.
protected void	addProp(String name, String display, String desc, String category, int flags)	Adds a property to the bean.
protected void	addProp(String name, String display, String desc, String category, int flags, Class<? extends SwingEditorSupport> customEditor)	Adds a property that has a custom editor.
protected void	addTransientProp(String name, String display, String desc, int flags)
protected void	addTransientProp(String name, String display, String desc, String category, int flags)
protected void	addTransientProp(String name, String display, String desc, String category, int flags, Class<? extends SwingEditorSupport> editor)
protected PropertyDescriptor	createProp(String name, String display, String desc, String category)	Creates an instance of PropertyDescriptor.
protected PropertyDescriptor	createProp(String name, String display, String desc, String category, int flags)	Creates an instance of PropertyDescriptor with flags.
protected PropertyDescriptor	createProp(String name, String display, String desc, String category, int flags, Class<? extends SwingEditorSupport> customEditor)	Creates an instanceof a PropertyDescriptor with a custom editor class.
protected PropertyDescriptor	findProperty(String name)	Looks up a property by name.
final VisionBeanDescriptor	getBeanDescriptor()
EventSetDescriptor[]	getEventSetDescriptors()
Image	getIcon(int kind)
protected String	getIconPath()
protected String	getIconPrefix()
protected String	getIconResource(int kind)
final MethodDescriptor[]	getMethodDescriptors()
final PropertyDescriptor[]	getPropertyDescriptors()
protected void	initDesc()	Implement this function to initialize the BeanDescriptor.
protected void	initEventSets()	This is called by the constructor, meant to be overridden by subclasses.
protected void	initMethods()	This is called by the constructor, meant to be overridden by subclasses.
protected void	initProperties()	This is called by the constructor, meant to be overridden by subclasses.
protected void	removeProp(String name)	Removes the property with the given name from this bean info.
protected void	setBackgroundProperty(PropertyDescriptor prop)	Sets the background property (see setBackgroundProperty(String)
protected void	setBackgroundProperty(String propName)	Sets the background property, used by the eyedropper tool to know what property to set to alter the background.
protected void	setFlags(PropertyDescriptor prop, int flags)	Apply the given flags to the property descriptor.
protected void	setFlags(String propName, int flags)
protected void	setForegroundProperty(PropertyDescriptor prop)	Sets the foreground property, see setForegroundProperty(String)
protected void	setForegroundProperty(String propName)	Sets the foreground property, used by the eyedropper tool to know what property to set to alter the foreground.
String	toString()

Methods inherited from class java.beans.SimpleBeanInfo

getAdditionalBeanInfo, getDefaultEventIndex, getDefaultPropertyIndex, loadImage

Methods inherited from class java.lang.Object

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

Field Details

TRANSIENT_KEY

public static final String TRANSIENT_KEY

See Also:

• Constant Field Values

NOT_BINDABLE_KEY

public static final String NOT_BINDABLE_KEY

See Also:

• Constant Field Values

NOT_TRANSLATABLE_KEY

public static final String NOT_TRANSLATABLE_KEY

See Also:

• Constant Field Values

DISPLAY_ORDER_KEY

public static final String DISPLAY_ORDER_KEY

This key is used on a PropertyDescriptor to give an explicit order to properties. The value must be an Integer. The addProp(PropertyDescriptor) method automatically adds a display order to the property.

See Also:

• Constant Field Values

CATEGORY_KEY

public static final String CATEGORY_KEY

This key is used on a PropertyDescriptor to give it a category. The value must be a String.

See Also:

• Constant Field Values

NO_MASK

public static final int NO_MASK

See Also:

• Constant Field Values

BOUND_MASK

public static final int BOUND_MASK

This flag marks a property as "Bound". This means that the component will fire PropertyChangeEvents whenever this property changes. This makes the property available for other bindings via property bindings and expression bindings. It does not mean that the property can have bindings on it. That's true for all properties of supported types.

See Also:

• Constant Field Values

CONSTRAINED_MASK

public static final int CONSTRAINED_MASK

Not used.

See Also:

• Constant Field Values

EXPERT_MASK

public static final int EXPERT_MASK

Use this flag to mark a property as expert so that it shows up under the "Expert" and "All" filters.

See Also:

• Constant Field Values

HIDDEN_MASK

public static final int HIDDEN_MASK

Use this flag to mark a property that won't be available in the Designer, but will be serialized.

See Also:

• Constant Field Values

PREFERRED_MASK

public static final int PREFERRED_MASK

Use this flag to mark the property as a preferred property - these are the properties that show up under the "Basic" filter.

See Also:

• Constant Field Values

PREFFERED_MASK

@Deprecated
public static final int PREFFERED_MASK

Deprecated.

Misspelled. Use PREFERRED_MASK

See Also:

• Constant Field Values

NOT_TRANSLATABLE_MASK

public static final int NOT_TRANSLATABLE_MASK

This marks a property as not compatible with the automatic translation system.

See Also:

• Constant Field Values

TRANSIENT_MASK

public static final int TRANSIENT_MASK

Use this flag to mark a property as transient (so it will not be serialized). Equivalent to using the Transient attribute on the getter and/or setter.

See Also:

• Constant Field Values

NOT_BINDABLE_MASK

public static final int NOT_BINDABLE_MASK

Use this flag to mark a property that shouldn't ever be the target of a binding.

See Also:

• Constant Field Values

beanClass

protected Class beanClass

log

protected LoggerEx log

Constructor Details

DefaultBeanInfo

public DefaultBeanInfo(Class c,
 CustomizerDescriptor... customizerDescriptor)

Create a new BeanInfo for teh given class that will use the provided customizers (if any). This constructor will call the following protected methods which are assumed to have been overridden:

• initDesc()
• initProperties()
• initMethods()
• initEventSets()

Method Details

addMethod

protected void addMethod(String name,
 Class arg,
 String displayName)
                  throws SecurityException,
NoSuchMethodException

(Bean methods are not used in Ignition)

Throws:

SecurityException

NoSuchMethodException

addMethod

protected void addMethod(String name,
 Class[] args,
 String displayName)
                  throws SecurityException,
NoSuchMethodException

(Bean methods are not used in Ignition)

Throws:

SecurityException

NoSuchMethodException

addMethod

protected void addMethod(MethodDescriptor method)

(Bean methods are not used in Ignition)

createProp

protected PropertyDescriptor createProp(String name,
 String display,
 String desc,
 String category)
                                 throws IntrospectionException

Creates an instance of PropertyDescriptor.

Parameters:

name - The name of the property. Must match the getter/setter in the bean class.

display - The display name of the Property.

desc - A description of the property.

category - The category for the property.

Returns:

A new PropertyDescriptor instance.

Throws:

IntrospectionException

createProp

protected PropertyDescriptor createProp(String name,
 String display,
 String desc,
 String category,
 int flags)
                                 throws IntrospectionException

Creates an instance of PropertyDescriptor with flags.

Throws:

IntrospectionException

createProp

protected PropertyDescriptor createProp(String name,
 String display,
 String desc,
 String category,
 int flags,
 Class<? extends SwingEditorSupport> customEditor)
                                 throws IntrospectionException

Creates an instanceof a PropertyDescriptor with a custom editor class.

Parameters:

customEditor - The class for the editor for this property.

Throws:

IntrospectionException

setFlags

protected void setFlags(String propName,
 int flags)

setFlags

protected void setFlags(PropertyDescriptor prop,
 int flags)

Apply the given flags to the property descriptor. The following flags are available:

• BOUND_MASK
• CONSTRAINED_MASK
• EXPERT_MASK
• HIDDEN_MASK
• PREFERRED_MASK
• TRANSIENT_MASK

addBoundProp

protected void addBoundProp(String name,
 String display,
 String desc,
 String category)
                     throws IntrospectionException

Adds a property that has the BOUND_MASK flag.

Throws:

IntrospectionException

addBoundProp

protected void addBoundProp(String name,
 String display,
 String desc,
 String category,
 int flags)
                     throws IntrospectionException

Adds a property that has the BOUND_MASK flag, and potentially other flags.

Throws:

IntrospectionException

addProp

protected void addProp(String name,
 String display,
 String desc,
 String category,
 int flags,
 Class<? extends SwingEditorSupport> customEditor)
                throws IntrospectionException

Adds a property that has a custom editor.

Throws:

IntrospectionException

addProp

protected void addProp(String name,
 String display,
 String desc,
 String category)
                throws IntrospectionException

Adds a property to the bean.

Throws:

IntrospectionException

addProp

protected void addProp(String name,
 String display,
 String desc,
 int flags)
                throws IntrospectionException

Adds a property to the bean.

Throws:

IntrospectionException

addProp

protected void addProp(String name,
 String display,
 String desc,
 String category,
 int flags)
                throws IntrospectionException

Adds a property to the bean.

Throws:

IntrospectionException

addTransientProp

protected void addTransientProp(String name,
 String display,
 String desc,
 int flags)
                         throws IntrospectionException

Throws:

IntrospectionException

addTransientProp

protected void addTransientProp(String name,
 String display,
 String desc,
 String category,
 int flags)
                         throws IntrospectionException

Throws:

IntrospectionException

addTransientProp

protected void addTransientProp(String name,
 String display,
 String desc,
 String category,
 int flags,
 Class<? extends SwingEditorSupport> editor)
                         throws IntrospectionException

Throws:

IntrospectionException

addProp

protected void addProp(PropertyDescriptor prop)

Adds the property, appending it to the display order (see DISPLAY_ORDER_KEY). This display order will also be used for the order of serialization by default in DescriptorComparator even if the HIDDEN_MASK is applied

removeProp

protected void removeProp(String name)

Removes the property with the given name from this bean info. If the property isn't found, nothing happens.

findProperty

protected PropertyDescriptor findProperty(String name)

Looks up a property by name.

Returns:

The PropertyDescriptor if the property is found, otherwise null

setForegroundProperty

protected void setForegroundProperty(String propName)

Sets the foreground property, used by the eyedropper tool to know what property to set to alter the foreground.

setForegroundProperty

protected void setForegroundProperty(PropertyDescriptor prop)

Sets the foreground property, see setForegroundProperty(String)

setBackgroundProperty

protected void setBackgroundProperty(String propName)

Sets the background property, used by the eyedropper tool to know what property to set to alter the background.

setBackgroundProperty

protected void setBackgroundProperty(PropertyDescriptor prop)

Sets the background property (see setBackgroundProperty(String)

addEnumProp

protected void addEnumProp(String name,
 String display,
 String desc,
 String category,
 int[] values,
 String[] names)
                    throws IntrospectionException

Adds an "enum property". This is an integer-typed property whose value should be one of a fixed set of named values. The values and names are added here, and will be presented as a pick-list in the Designer.

Parameters:

values - The list of acceptable values for this property.

names - The names of the acceptable values, must match-up with the values in values

Throws:

IntrospectionException

addEnumProp

protected void addEnumProp(String name,
 String display,
 String desc,
 String category,
 int[] values,
 String[] names,
 int flags)
                    throws IntrospectionException

Throws:

IntrospectionException

addEnumProp

protected void addEnumProp(String name,
 String display,
 String desc,
 String category,
 Class<? extends Enum> enumClass)
                    throws IntrospectionException

Adds an property based upon enum constants. Note: this value must still be an integer, but the int values and display values for the acceptable values will be derived from the enum

Throws:

IntrospectionException

addEnumProp

protected void addEnumProp(String name,
 String display,
 String desc,
 String category,
 Class<? extends Enum> enumClass,
 int flags)
                    throws IntrospectionException

Throws:

IntrospectionException

addEventSet

protected void addEventSet(Class sourceClass,
 String eventSetName,
 Class listenerType,
 String listenerMethodName)
                    throws IntrospectionException

This overload of addEventSet(Class, String, Class, String[]) is used for events that have a single listener method.

Throws:

IntrospectionException

addEventSet

protected void addEventSet(Class sourceClass,
 String eventSetName,
 Class listenerType,
 String[] listenerMethodNames)
                    throws IntrospectionException

Adds an "event set" that this bean supports. An event set is a set of events that will be fired and the corresponding add/remove listener methods that must be present on the bean. By adding event sets, users will be able to respond to those events using scripting.

For example, if a component wanted to advertise that it throws focus events, it would do this in it's BeanInfo's implementation of initEventSets():

 addEventSet(Component.class, "focus", 
 FocusListener.class, new String[] { "focusGained", "focusLost" });
 

Parameters:

sourceClass - The class where the add/remove listener functions are declared. Not necessarily your class, maybe Component or some other superclass.

eventSetName - The name of the event, such that the add/remove listener names can be derived as "addEventSetNameListener" and "removeEventSetNameListener". (the first letter will be capitalized for you).

listenerType - The type of the listener for this event (e.g. FocusListener)

listenerMethodNames - The names of the methods called on the a listener (e.g. {"focusGained", "focusList"})

Throws:

IntrospectionException

addEventSet

protected void addEventSet(Class sourceClass,
 String eventSetName,
 Class listenerType,
 Class eventObjectType,
 String[] listenerMethodNames)
                    throws IntrospectionException

This overload of addEventSet(Class, String, Class, String[]) is for when the event object type cannot be derived from the event set name.

Throws:

IntrospectionException

addEventSet

protected void addEventSet(Class sourceClass,
 String eventSetName,
 Class listenerType,
 Class eventObjectType,
 String[] listenerMethodNames,
 String addListenerMethodName,
 String removeListenerMethodName,
 String getListenerMethodName)
                    throws IntrospectionException

Overload of addEventSet(Class, String, Class, String[]) that has explicit arguments for the event object type and listener names.

Throws:

IntrospectionException

initProperties

protected void initProperties()
                       throws IntrospectionException

This is called by the constructor, meant to be overridden by subclasses.

Throws:

IntrospectionException

initMethods

protected void initMethods()
                    throws SecurityException,
NoSuchMethodException

This is called by the constructor, meant to be overridden by subclasses.

Throws:

SecurityException

NoSuchMethodException

initEventSets

protected void initEventSets()
                      throws IntrospectionException

This is called by the constructor, meant to be overridden by subclasses.

Throws:

IntrospectionException

initDesc

protected void initDesc()

Implement this function to initialize the BeanDescriptor. Use getBeanDescriptor() to find the bean descriptor and set it's meta props to be appropriate values for this bean.

getBeanDescriptor

public final VisionBeanDescriptor getBeanDescriptor()

Specified by:

getBeanDescriptor in interface BeanInfo

Overrides:

getBeanDescriptor in class SimpleBeanInfo

getMethodDescriptors

public final MethodDescriptor[] getMethodDescriptors()

Specified by:

getMethodDescriptors in interface BeanInfo

Overrides:

getMethodDescriptors in class SimpleBeanInfo

getPropertyDescriptors

public final PropertyDescriptor[] getPropertyDescriptors()

Specified by:

getPropertyDescriptors in interface BeanInfo

Overrides:

getPropertyDescriptors in class SimpleBeanInfo

getEventSetDescriptors

public EventSetDescriptor[] getEventSetDescriptors()

Specified by:

getEventSetDescriptors in interface BeanInfo

Overrides:

getEventSetDescriptors in class SimpleBeanInfo

getIcon

public Image getIcon(int kind)

Specified by:

getIcon in interface BeanInfo

Overrides:

getIcon in class SimpleBeanInfo

getIconResource

protected String getIconResource(int kind)

getIconPath

protected String getIconPath()

getIconPrefix

protected String getIconPrefix()

toString

public String toString()

Overrides:

toString in class Object