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

Class CommonBeanInfo

java.lang.Object

java.beans.SimpleBeanInfo

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

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

All Implemented Interfaces:

BeanInfo

Direct Known Subclasses:

AbstractButtonBeanInfo, AlarmJournalTableBeanInfo, AlarmStatusTableBeanInfo, AlertSummaryTableBeanInfo, BasicContainerBeanInfo, ColumnSelectorPanelBeanInfo, EquipmentScheduleViewBeanInfo, FileExplorerBeanInfo, LanguageSelectorBeanInfo, LinearScaleBeanInfo, MovingAnalogIndicatorBeanInfo, PathBasedVisionShapeBeanInfo, PDFViewerBeanInfo, PMIBarChartBeanInfo, PMIBarcodeBeanInfo, PMIBoxWhiskerChartBeanInfo, PMIChartBeanInfo, PMICheckBoxBeanInfo, PMICircleBeanInfo, PMIComboBoxBeanInfo, PMICommentsPanel2BeanInfo, PMICommentsPanelBeanInfo, PMICompassBeanInfo, PMICylindricalTankBeanInfo, PMIDateRangeBeanInfo, PMIDateTimeSelectorBeanInfo, PMIDayViewBeanInfo, PMIDigitalDisplayBeanInfo, PMIEasyChartBeanInfo, PMIEditorPaneBeanInfo, PMIFillLevelIndicatorBeanInfo, PMIFormattedTextFieldBeanInfo, PMIGanttChartBeanInfo, PMIImageBeanInfo, PMIIPCamViewerBeanInfo, PMILabelBeanInfo, PMILightrailSignalBeanInfo, PMILineBeanInfo, PMIListBeanInfo, PMIMeterBeanInfo, PMIMomentaryButton2BeanInfo, PMIMomentaryButtonBeanInfo, PMIMonthViewBeanInfo, PMIMultiStateIndicatorBeanInfo, PMINStateButtonBeanInfo, PMINumericLabelBeanInfo, PMINumericTextFieldBeanInfo, PMIPaintableCanvasBeanInfo, PMIPasswordFieldBeanInfo, PMIPieChartBeanInfo, PMIPipeBeanInfo, PMIPipeJointBeanInfo, PMIPolygonBeanInfo, PMIProgressBarBeanInfo, PMIRadioButtonBeanInfo, PMIRectangleBeanInfo, PMISignalGeneratorBeanInfo, PMISliderBeanInfo, PMISoundComponentBeanInfo, PMISpinnerBeanInfo, PMIStatusChartBeanInfo, PMITableBeanInfo, PMITabStripBeanInfo, PMITextAreaBeanInfo, PMITextFieldBeanInfo, PMIThermometerBeanInfo, PMITimerBeanInfo, PMIToggleButtonBeanInfo, PMITrackSegmentBeanInfo, PMITreeViewBeanInfo, PMIWeekViewBeanInfo, RadarChart2BeanInfo, RadarChartBeanInfo, ReportPanelBeanInfo, ReportViewerBeanInfo, RosterManagementPanelBeanInfo, RowSelectorTreeBeanInfo, ScheduleManagementPanelBeanInfo, SFCMonitoringPanelBeanInfo, ShapeGroupBeanInfo, SparklineChartBeanInfo, TagBrowseTreeBeanInfo, TemplateCanvasBeanInfo, TemplateHolderBeanInfo, TemplateRepeaterBeanInfo, UserManagementPanelBeanInfo, VisionAdvancedTableBeanInfo, VisionTemplateBeanInfo

public class CommonBeanInfo
extends DefaultBeanInfo

CommonBeanInfo is the base class of all BeanInfo classes used by the Vision module. When you make a subclass of CommonBeanInfo, you'll override initProperties() and DefaultBeanInfo.getIcon(int). You may also override initEventSets().

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CAT_APPEARANCE
static final String	CAT_BEHAVIOR
static final String	CAT_COMMON
static final String	CAT_DATA
static final String	CAT_DEPRECATED
static final String	CAT_LAYOUT
static final String	CAT_POSITION
static final String	DOUBLE_CLICK_CUSTOMIZER_KEY	Use this as a key on your bean descriptor whose value is your customizer's VALUE_NAME to make double-clicking on your bean open up that customizer.
static final String	DOUBLE_CLICK_HANDLER	Use this as a key on your bean descriptor whose value is an instance of DoubleClickHandler, and that double-click handler will be called on double-clicks of instances of this bean
static final String	EDIT_CLICK_HANDLER	Use this as a key on your bean descriptor whose value is an instance of DoubleClickHandler, and that edit-click will be called when your bean is edit-clicked.
static final String	RIGHT_CLICK_HANDLER	Use this key on your bean descriptor if you want to add custom actions to the right-click menu of your component.
static final String	SECURITY_RESTRICTIONS	This key is used on the bean descriptor to hold a List<ComponentRestriction> that are compatible with this bean type.
static final String	TAG_DROP_HANDLER_KEY
static final String	TERM_FINDER_CLASS	The class that should be instantiated as a custom translation term finder.

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
CommonBeanInfo(Class c)	Use this constructor for components with no customizers
CommonBeanInfo(Class c, CustomizerDescriptor... custDesc)	Use this constructor if your component uses customizers.
CommonBeanInfo(Class c, Class customizer)	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected void	addCursorCode()	Adds the cursorCode property with correct enum translation, with no special flags
protected void	addCursorCode(int flags)
protected void	addDataQuality()	Adds the dataQuality property using BOUND_MASK | EXPERT_MASK
protected static void	addFocusEvents(DefaultBeanInfo info)	Call this in to initEventSets() add focus events to your component.
static void	addInputEventSets(DefaultBeanInfo info)	Adds focus and key events
static void	addJComponentEventSets(DefaultBeanInfo info)	Adds propertyChange, mouse, and mouseMotion events sets.
protected static void	addKeyEvents(DefaultBeanInfo info)	Call this in to initEventSets() add key events to your component.
protected void	addRotation()	Adds the rotation property
protected void	addVisualProps()	Adds rotation property
protected void	configureTagDropHandler(DefaultTagDropHandler handler)	Subclasses should override this to add custom mappings to the default tag drop handler.
protected TagDropHandler	createTagDropHandler()	Creates the tag drop handler to be installed for this component.
protected void	initComponentRestrictions(List<ComponentRestriction> restrictions)	Adds appropriate restrictions based on the bean's attributes.
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.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, getIcon, getIconPath, getIconPrefix, getIconResource, getMethodDescriptors, getPropertyDescriptors, initDesc, 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

Field Details

TAG_DROP_HANDLER_KEY

public static final String TAG_DROP_HANDLER_KEY

See Also:

• Constant Field Values

DOUBLE_CLICK_CUSTOMIZER_KEY

public static final String DOUBLE_CLICK_CUSTOMIZER_KEY

Use this as a key on your bean descriptor whose value is your customizer's VALUE_NAME to make double-clicking on your bean open up that customizer.

See Also:

• Constant Field Values

DOUBLE_CLICK_HANDLER

public static final String DOUBLE_CLICK_HANDLER

Use this as a key on your bean descriptor whose value is an instance of DoubleClickHandler, and that double-click handler will be called on double-clicks of instances of this bean

See Also:

• Constant Field Values

EDIT_CLICK_HANDLER

public static final String EDIT_CLICK_HANDLER

Use this as a key on your bean descriptor whose value is an instance of DoubleClickHandler, and that edit-click will be called when your bean is edit-clicked. An edit-click is a click on an already selected component.

See Also:

• Constant Field Values

RIGHT_CLICK_HANDLER

public static final String RIGHT_CLICK_HANDLER

Use this key on your bean descriptor if you want to add custom actions to the right-click menu of your component. The value should be an instance of ComponentPopupInitializer.

See Also:

• Constant Field Values

SECURITY_RESTRICTIONS

public static final String SECURITY_RESTRICTIONS

This key is used on the bean descriptor to hold a List<ComponentRestriction> that are compatible with this bean type. CommonBeanInfo will automatically add the following:

• A VisibilityRestriction to any bean that exposes its visible property.
• An EnabledRestriction to any bean that is a --something or other for new enabled stuff--
• An OverlayRestriction to any bean that is a QualityMonitor.

See Also:

• Constant Field Values

TERM_FINDER_CLASS

public static final String TERM_FINDER_CLASS

The class that should be instantiated as a custom translation term finder. If not set, a standard component finder will be used.

See Also:

• Constant Field Values

CAT_COMMON

public static final String CAT_COMMON

See Also:

• Constant Field Values

CAT_APPEARANCE

public static final String CAT_APPEARANCE

See Also:

• Constant Field Values

CAT_POSITION

public static final String CAT_POSITION

See Also:

• Constant Field Values

CAT_BEHAVIOR

public static final String CAT_BEHAVIOR

See Also:

• Constant Field Values

CAT_DATA

public static final String CAT_DATA

See Also:

• Constant Field Values

CAT_LAYOUT

public static final String CAT_LAYOUT

See Also:

• Constant Field Values

CAT_DEPRECATED

public static final String CAT_DEPRECATED

See Also:

• Constant Field Values

Constructor Details

CommonBeanInfo

public CommonBeanInfo(Class c)

Use this constructor for components with no customizers

CommonBeanInfo

@Deprecated
public CommonBeanInfo(Class c,
 Class customizer)

Deprecated.

CommonBeanInfo

public CommonBeanInfo(Class c,
 CustomizerDescriptor... custDesc)

Use this constructor if your component uses customizers. Common customizers have static descriptors available. For example, your subclass might call this constructor as follows if it has dynamic properties and styles:

 super(MyComponent.class,
   new CustomizerDescriptor[] {
     DynamicPropertyProviderCustomizer.VALUE_DESCRIPTOR,
     StyleCustomizer.VALUE_DESCRIPTOR });
 

Method Details

installTagDropHandler

protected void installTagDropHandler()

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 createTagDropHandler(). If that function returns a subclass of DefaultTagDropHandler, then it will also call 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 configureTagDropHandler(DefaultTagDropHandler) to simply set-up the default tag drop handler for the component.

createTagDropHandler

protected TagDropHandler createTagDropHandler()

Creates the tag drop handler to be installed for this component. Default implementation creates a DefaultTagDropHandler

configureTagDropHandler

protected void configureTagDropHandler(DefaultTagDropHandler handler)

Subclasses should override this to add custom mappings to the default tag drop handler. By default the only mapping installed is to bind the component's toolTipText property to the tag's Tooltip property.

Example. Suppose your component has an integer property named "myValue " and when a SQLTag was dropped on your component you want to set up a tag binding for "myValue" to the sqltag's value. You'd configure the tag drop handler like this:

 handler.addBinding(TagProp.Value, "myValue");
 

initComponentRestrictions

protected void initComponentRestrictions(List<ComponentRestriction> restrictions)

Adds appropriate restrictions based on the bean's attributes.

See Also:

• SECURITY_RESTRICTIONS

initProperties

protected void initProperties()
                       throws IntrospectionException

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 DefaultBeanInfo

Throws:

IntrospectionException

See Also:

• addCursorCode()
• addDataQuality()
• addVisualProps()

addCursorCode

protected void addCursorCode()
                      throws IntrospectionException

Adds the cursorCode property with correct enum translation, with no special flags

Throws:

IntrospectionException

addCursorCode

protected void addCursorCode(int flags)
                      throws IntrospectionException

Throws:

IntrospectionException

addDataQuality

protected void addDataQuality()
                       throws IntrospectionException

Adds the dataQuality property using BOUND_MASK | EXPERT_MASK

Throws:

IntrospectionException

addRotation

protected void addRotation()
                    throws IntrospectionException,
SecurityException

Adds the rotation property

Throws:

IntrospectionException

SecurityException

addVisualProps

protected void addVisualProps()
                       throws IntrospectionException,
SecurityException

Adds rotation property

Throws:

IntrospectionException

SecurityException

initEventSets

protected void initEventSets()
                      throws IntrospectionException

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 DefaultBeanInfo

Throws:

IntrospectionException

addJComponentEventSets

public static void addJComponentEventSets(DefaultBeanInfo info)
                                   throws IntrospectionException

Adds propertyChange, mouse, and mouseMotion events sets. This is automatically called by the default implementation of initEventSets()

Throws:

IntrospectionException

addInputEventSets

public static void addInputEventSets(DefaultBeanInfo info)
                              throws IntrospectionException

Adds focus and key events

Throws:

IntrospectionException

addFocusEvents

protected static void addFocusEvents(DefaultBeanInfo info)
                              throws IntrospectionException

Call this in to initEventSets() add focus events to your component.

Throws:

IntrospectionException

addKeyEvents

protected static void addKeyEvents(DefaultBeanInfo info)
                            throws IntrospectionException

Call this in to initEventSets() add key events to your component.

Throws:

IntrospectionException