Package org.csstudio.opibuilder.widgets.model

Class AbstractBoolControlModel

java.lang.Object

org.csstudio.opibuilder.model.AbstractWidgetModel

org.csstudio.opibuilder.model.AbstractPVWidgetModel

org.csstudio.opibuilder.widgets.model.AbstractBoolWidgetModel

org.csstudio.opibuilder.widgets.model.AbstractBoolControlModel

All Implemented Interfaces:

IPVWidgetModel, IAdaptable, IPropertySource

Direct Known Subclasses:

BoolButtonModel, BoolSwitchModel, ImageBoolButtonModel

public class AbstractBoolControlModel
extends AbstractBoolWidgetModel

Abstract model for boolean controls.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CONFIRM_TIP
static final String	ID	The ID of this widget model.
static final String	PROP_CONFIRM_DIALOG	If a confirm dialog should be shown before performing action.
static final String	PROP_CONFIRM_TIP	The message which will be shown on confirm dialog.
static final String	PROP_PASSWORD	The password needed to perform action
static final String	PROP_PUSH_ACTION_INDEX	The action which will be executed when widget is pushed.
static final String	PROP_RELEASED_ACTION_INDEX	The action which will be executed when widget is released.
static final String	PROP_TOGGLE_BUTTON	If the button should be a toggle button.

Fields inherited from class org.csstudio.opibuilder.widgets.model.AbstractBoolWidgetModel

PROP_BIT, PROP_BOOL_LABEL_POS, PROP_DATA_TYPE, PROP_OFF_COLOR, PROP_OFF_LABEL, PROP_OFF_STATE, PROP_ON_COLOR, PROP_ON_LABEL, PROP_ON_STATE, PROP_SHOW_BOOL_LABEL

Fields inherited from class org.csstudio.opibuilder.model.AbstractWidgetModel

PROP_ACTIONS, PROP_BORDER_COLOR, PROP_BORDER_STYLE, PROP_BORDER_WIDTH, PROP_COLOR_BACKGROUND, PROP_COLOR_FOREGROUND, PROP_ENABLED, PROP_FONT, PROP_HEIGHT, PROP_NAME, PROP_RULES, PROP_SCALE_OPTIONS, PROP_SCRIPTS, PROP_SRC_CONNECTIONS, PROP_TGT_CONNECTIONS, PROP_TOOLTIP, PROP_VISIBLE, PROP_WIDGET_TYPE, PROP_WIDGET_UID, PROP_WIDTH, PROP_XPOS, PROP_YPOS, VERSION

Fields inherited from interface org.csstudio.opibuilder.model.IPVWidgetModel

PROP_ALARM_PULSING, PROP_BACKCOLOR_ALARMSENSITIVE, PROP_BORDER_ALARMSENSITIVE, PROP_FORECOLOR_ALARMSENSITIVE, PROP_PVNAME, PROP_PVVALUE

Constructor Summary

Constructors

Constructor	Description
AbstractBoolControlModel()

Method Summary

Modifier and Type	Method	Description
protected void	configureProperties()	Configure the properties of the widget.
String	getConfirmTip()
String	getPassword()
int	getPushActionIndex()	Return the index of the selected WidgetAction from the ActionData.
int	getReleasedActionIndex()	Return the index of the selected WidgetAction from the ActionData.
AbstractBoolControlFigure.ShowConfirmDialog	getShowConfirmDialog()
String	getTypeID()
boolean	isToggleButton()

Methods inherited from class org.csstudio.opibuilder.widgets.model.AbstractBoolWidgetModel

getBit, getBoolLabelPosition, getDataType, getOffColor, getOffLabel, getOffState, getOnColor, getOnLabel, getOnState, isShowBoolLabel

Methods inherited from class org.csstudio.opibuilder.model.AbstractPVWidgetModel

configureBaseProperties, getDelegate, getPVName, getTooltip, isAlarmPulsing, isBackColorAlarmSensitve, isBorderAlarmSensitve, isForeColorAlarmSensitve, processVersionDifference

Methods inherited from class org.csstudio.opibuilder.model.AbstractWidgetModel

addConnection, addProperty, addProperty, addPVProperty, doScale, flipHorizontally, flipHorizontally, flipVertically, flipVertically, generateNewWUID, getActionsInput, getAdapter, getAllPropertyIDs, getBackgroundColor, getBorderColor, getBorderStyle, getBorderWidth, getBounds, getCastedPropertyValue, getEditableValue, getExecutionMode, getFont, getForegroundColor, getHeight, getIndex, getLocation, getName, getNestedDepth, getOriginLocation, getOriginSize, getParent, getProperty, getPropertyDescriptors, getPropertyValue, getPVMap, getRawPropertyValue, getRawTooltip, getRGBFromColorProperty, getRootDisplayModel, getRootDisplayModel, getRulesInput, getRuntimePropertyList, getScaledSize, getScaleOptions, getScriptsInput, getSize, getSourceConnections, getSWTColorFromColorProperty, getTargetConnections, getType, getVersion, getVersionOnFile, getWidgetType, getWidth, getWUID, getX, getY, isEnabled, isPropertySet, isVisible, removeProperty, removePVProperty, resetPropertyValue, rotate90, rotate90, scale, scaleConnections, setBackgroundColor, setBorderColor, setBorderStyle, setBorderWidth, setBounds, setBounds, setEnabled, setExecutionMode, setForegroundColor, setHeight, setLocation, setLocation, setName, setParent, setPropertyDescription, setPropertyValue, setPropertyValue, setPropertyVisible, setPropertyVisibleAndSavable, setScaleOptions, setSize, setSize, setTooltip, setVersionOnFile, setWidth, setX, setY

Methods inherited from class java.lang.Object

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

Field Details

PROP_TOGGLE_BUTTON

public static final String PROP_TOGGLE_BUTTON

If the button should be a toggle button.

See Also:

• Constant Field Values

PROP_CONFIRM_DIALOG

public static final String PROP_CONFIRM_DIALOG

If a confirm dialog should be shown before performing action.

See Also:

• Constant Field Values

PROP_PASSWORD

public static final String PROP_PASSWORD

The password needed to perform action

See Also:

• Constant Field Values

PROP_CONFIRM_TIP

public static final String PROP_CONFIRM_TIP

The message which will be shown on confirm dialog.

See Also:

• Constant Field Values

DEFAULT_CONFIRM_TIP

public static final String DEFAULT_CONFIRM_TIP

See Also:

• Constant Field Values

PROP_PUSH_ACTION_INDEX

public static final String PROP_PUSH_ACTION_INDEX

The action which will be executed when widget is pushed. It is the index the actions in actions property.

See Also:

• Constant Field Values

PROP_RELEASED_ACTION_INDEX

public static final String PROP_RELEASED_ACTION_INDEX

The action which will be executed when widget is released. It is the index the action in actions property.

See Also:

• Constant Field Values

ID

public static final String ID

The ID of this widget model.

See Also:

• Constant Field Values

Constructor Details

AbstractBoolControlModel

public AbstractBoolControlModel()

Method Details

configureProperties

protected void configureProperties()

Description copied from class: AbstractWidgetModel

Configure the properties of the widget. Subclass should add new properties in this method.

Overrides:

configureProperties in class AbstractBoolWidgetModel

getTypeID

public String getTypeID()

Specified by:

getTypeID in class AbstractWidgetModel

Returns:

the unique typeID of the model.

isToggleButton

public boolean isToggleButton()

Returns:

true if the button is toggle.

getShowConfirmDialog

public AbstractBoolControlFigure.ShowConfirmDialog getShowConfirmDialog()

Returns:

true if the confirm dialog should be shown, false otherwise

getPassword

public String getPassword()

Returns:

the password

getConfirmTip

public String getConfirmTip()

Returns:

the confirm tip

getPushActionIndex

public int getPushActionIndex()

Return the index of the selected WidgetAction from the ActionData. The Action is running when the button is released.

Returns:

The index

getReleasedActionIndex

public int getReleasedActionIndex()

Return the index of the selected WidgetAction from the ActionData. The Action is running when the button is released.

Returns:

The index