Package com.inductiveautomation.factorypmi.designer.beaninfo

Class TemplateCanvasBeanInfo

java.lang.Object

java.beans.SimpleBeanInfo

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

com.inductiveautomation.vision.api.designer.beans.CommonBeanInfo

com.inductiveautomation.factorypmi.designer.beaninfo.TemplateCanvasBeanInfo

All Implemented Interfaces:

BeanInfo

public class TemplateCanvasBeanInfo
extends CommonBeanInfo

Field Summary

Fields inherited from class com.inductiveautomation.vision.api.designer.beans.CommonBeanInfo

CAT_APPEARANCE, CAT_BEHAVIOR, CAT_COMMON, CAT_DATA, CAT_DEPRECATED, CAT_LAYOUT, CAT_POSITION, DOUBLE_CLICK_CUSTOMIZER_KEY, DOUBLE_CLICK_HANDLER, EDIT_CLICK_HANDLER, RIGHT_CLICK_HANDLER, SECURITY_RESTRICTIONS, TAG_DROP_HANDLER_KEY, TERM_FINDER_CLASS

Fields inherited from class com.inductiveautomation.vision.api.designer.beans.DefaultBeanInfo

beanClass, BOUND_MASK, CATEGORY_KEY, CONSTRAINED_MASK, DISPLAY_ORDER_KEY, EXPERT_MASK, HIDDEN_MASK, log, NO_MASK, NOT_BINDABLE_KEY, NOT_BINDABLE_MASK, NOT_TRANSLATABLE_KEY, NOT_TRANSLATABLE_MASK, PREFERRED_MASK, PREFFERED_MASK, TRANSIENT_KEY, TRANSIENT_MASK

Fields inherited from interface java.beans.BeanInfo

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32

Constructor Summary

Constructors

Constructor	Description
TemplateCanvasBeanInfo()

Method Summary

Modifier and Type	Method	Description
Image	getIcon(int kind)
protected void	initComponentRestrictions(List<ComponentRestriction> restrictions)	Overridden to avoid the overlay option, which isn't reliable due to how repainting is handled.
protected void	initDesc()	Implement this function to initialize the BeanDescriptor.
protected void	initEventSets()	Called to add the event sets that this component will fire and should be handled by user scripting.
protected void	initProperties()	CommonBeanInfo adds common properties, such as: preferredSize (hidden, for serialization) bounds (hidden, for serialization) name componentEnabled if the component is an EnabledEx visible border toolTipText font foreground background opaque
protected void	installTagDropHandler()	Called during construction to install a SQLTags drop handler for this component.

Methods inherited from class com.inductiveautomation.vision.api.designer.beans.CommonBeanInfo

addCursorCode, addCursorCode, addDataQuality, addFocusEvents, addInputEventSets, addJComponentEventSets, addKeyEvents, addRotation, addVisualProps, configureTagDropHandler, createTagDropHandler

Methods inherited from class com.inductiveautomation.vision.api.designer.beans.DefaultBeanInfo

addBoundProp, addBoundProp, addEnumProp, addEnumProp, addEnumProp, addEnumProp, addEventSet, addEventSet, addEventSet, addEventSet, addMethod, addMethod, addMethod, addProp, addProp, addProp, addProp, addProp, addTransientProp, addTransientProp, addTransientProp, createProp, createProp, createProp, findProperty, getBeanDescriptor, getEventSetDescriptors, getIconPath, getIconPrefix, getIconResource, getMethodDescriptors, getPropertyDescriptors, initMethods, removeProp, setBackgroundProperty, setBackgroundProperty, setFlags, setFlags, setForegroundProperty, setForegroundProperty, 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

Constructor Details

TemplateCanvasBeanInfo

public TemplateCanvasBeanInfo()

Method Details

initDesc

protected void initDesc()

Description copied from class: DefaultBeanInfo

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

Overrides:

initDesc in class DefaultBeanInfo

installTagDropHandler

protected void installTagDropHandler()

Description copied from class: CommonBeanInfo

Called during construction to install a SQLTags drop handler for this component. A SQLTags drop handler is stored as a property on the BeanDescriptor with the key "tagDropHandler", and must implement TagDropHandler.

The default implementation of this function calls CommonBeanInfo.createTagDropHandler(). If that function returns a subclass of DefaultTagDropHandler, then it will also call CommonBeanInfo.configureTagDropHandler(DefaultTagDropHandler). If you override this function, then both createTagDropHandler() and configureTagDropHandler() will not be used.

Typically you won't override this function. Most implementations will override CommonBeanInfo.configureTagDropHandler(DefaultTagDropHandler) to simply set-up the default tag drop handler for the component.

Overrides:

installTagDropHandler in class CommonBeanInfo

initComponentRestrictions

protected void initComponentRestrictions(List<ComponentRestriction> restrictions)

Overridden to avoid the overlay option, which isn't reliable due to how repainting is handled.

Overrides:

initComponentRestrictions in class CommonBeanInfo

See Also:

• CommonBeanInfo.SECURITY_RESTRICTIONS

initProperties

protected void initProperties()
                       throws IntrospectionException

Description copied from class: CommonBeanInfo

CommonBeanInfo adds common properties, such as:

• preferredSize (hidden, for serialization)
• bounds (hidden, for serialization)
• name
• componentEnabled if the component is an EnabledEx
• visible
• border
• toolTipText
• font
• foreground
• background
• opaque

It is typical to override this function and then call super(). If you want to hide some of these functions, call removeProp with their names. After that you can add your own properties.

Remember, only properties you add here will be serialized on your component. All properties must have proper getter/setter functions. If you need a property to be serialized but not shown, use the HIDDEN_MASK. If you want to expose a read-only bound property, use HIDDEN_MASK | BOUND_MASK.

Overrides:

initProperties in class CommonBeanInfo

Throws:

IntrospectionException

See Also:

• CommonBeanInfo.addCursorCode()
• CommonBeanInfo.addDataQuality()
• CommonBeanInfo.addVisualProps()

initEventSets

protected void initEventSets()
                      throws IntrospectionException

Description copied from class: CommonBeanInfo

Called to add the event sets that this component will fire and should be handled by user scripting. By default this implementation adds common JComponent events scuh as propertyChange, mouse, and mouseMotion

To add a new eventSet, call DefaultBeanInfo.addEventSet(Class, String, Class, String) or one of its overloads.

Overrides:

initEventSets in class CommonBeanInfo

Throws:

IntrospectionException

getIcon

public Image getIcon(int kind)

Specified by:

getIcon in interface BeanInfo

Overrides:

getIcon in class DefaultBeanInfo