Package org.csstudio.opibuilder.widgets.model

Class ActionButtonModel

java.lang.Object

org.csstudio.opibuilder.model.AbstractWidgetModel

org.csstudio.opibuilder.model.AbstractPVWidgetModel

org.csstudio.opibuilder.widgets.model.ActionButtonModel

All Implemented Interfaces:

IPVWidgetModel, ITextModel, IAdaptable, IPropertySource

Direct Known Subclasses:

NativeButtonModel

public class ActionButtonModel
extends AbstractPVWidgetModel
implements ITextModel

An action button widget model.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ActionButtonModel.Style

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID	The ID of this widget model.
static final String	PROP_ACTION_INDEX	The index of the action to be executed when button is pushed.
static final String	PROP_IMAGE	Image on the button.
static final String	PROP_RELEASED_ACTION_INDEX	The index of the action to be executed when released.
static final String	PROP_STYLE	Button Style
static final String	PROP_TEXT	Text on the button.
static final String	PROP_TOGGLE_BUTTON	If yes, the button will not bounce up when clicked.

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
ActionButtonModel()

Method Summary

Modifier and Type	Method	Description
protected void	configureProperties()	Configure the properties of the widget.
int	getActionIndex()	Return the index of the selected WidgetAction from the ActionData.
String	getImagePath()
int	getReleasedActionIndex()	Return the index of the selected WidgetAction from the ActionData.
ActionButtonModel.Style	getStyle()
String	getText()	Return the label text.
String	getTypeID()
org.osgi.framework.Version	getVersion()
boolean	isToggleButton()	Returns whether the button is a toggle button.
void	setStyle(ActionButtonModel.Style style)
void	setText(String text)

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, 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_STYLE

public static final String PROP_STYLE

Button Style

See Also:

• Constant Field Values

PROP_TEXT

public static final String PROP_TEXT

Text on the button.

See Also:

• Constant Field Values

PROP_IMAGE

public static final String PROP_IMAGE

Image on the button.

See Also:

• Constant Field Values

PROP_ACTION_INDEX

public static final String PROP_ACTION_INDEX

The index of the action to be executed when button is pushed. It is corresponding to the action sort index in actions property.

See Also:

• Constant Field Values

PROP_RELEASED_ACTION_INDEX

public static final String PROP_RELEASED_ACTION_INDEX

The index of the action to be executed when released. It is corresponding to the action sort index in actions property.

See Also:

• Constant Field Values

PROP_TOGGLE_BUTTON

public static final String PROP_TOGGLE_BUTTON

If yes, the button will not bounce up when clicked.

See Also:

• Constant Field Values

ID

public static final String ID

The ID of this widget model.

See Also:

• Constant Field Values

Constructor Details

ActionButtonModel

public ActionButtonModel()

Method Details

getTypeID

public String getTypeID()

Specified by:

getTypeID in class AbstractWidgetModel

Returns:

the unique typeID of the model.

configureProperties

protected void configureProperties()

Description copied from class: AbstractWidgetModel

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

Specified by:

configureProperties in class AbstractWidgetModel

getActionIndex

public int getActionIndex()

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

getReleasedActionIndex

public int getReleasedActionIndex()

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

getText

public String getText()

Return the label text.

Specified by:

getText in interface ITextModel

setText

public void setText(String text)

Specified by:

setText in interface ITextModel

getImagePath

public String getImagePath()

isToggleButton

public boolean isToggleButton()

Returns whether the button is a toggle button.

getStyle

public ActionButtonModel.Style getStyle()

getVersion

public org.osgi.framework.Version getVersion()

Overrides:

getVersion in class AbstractWidgetModel

Returns:

version of this widget model.

setStyle

public void setStyle(ActionButtonModel.Style style)