Package org.csstudio.opibuilder.widgets.model

Class ImageBoolButtonModel

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

org.csstudio.opibuilder.widgets.model.ImageBoolButtonModel

All Implemented Interfaces:

IPVWidgetModel, IAdaptable, IPropertySource

public class ImageBoolButtonModel
extends AbstractBoolControlModel

The widget model for Boolean Switch.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID	The ID of this widget model.
static final String	PROP_ALIGN_TO_NEAREST_SECOND	True if the widget animation start should be aligned to the nearest second.
static final String	PROP_AUTOSIZE	True if the button size is automatically adjusted to the size of the image.
static final String	PROP_NO_ANIMATION	True if the widget doesn't show animation even it is a animated image file.
static final String	PROP_OFF_IMAGE	Image on the button when it is off.
static final String	PROP_ON_IMAGE	Image on the button when it is on.
static final String	PROP_STRETCH	True if the image should be stretched to the button size.
static final String	PROP_TRANSPARENCY

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

DEFAULT_CONFIRM_TIP, PROP_CONFIRM_DIALOG, PROP_CONFIRM_TIP, PROP_PASSWORD, PROP_PUSH_ACTION_INDEX, PROP_RELEASED_ACTION_INDEX, PROP_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
ImageBoolButtonModel()

Method Summary

Modifier and Type	Method	Description
protected void	configureProperties()	Configure the properties of the widget.
String	getOffImagePath()
String	getOnImagePath()
String	getTypeID()
boolean	isAlignedToNearestSecond()
boolean	isAutoSize()
boolean	isStopAnimation()
boolean	isStretch()	Returns if the image should be stretched.

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

getConfirmTip, getPassword, getPushActionIndex, getReleasedActionIndex, getShowConfirmDialog, 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_ON_IMAGE

public static final String PROP_ON_IMAGE

Image on the button when it is on.

See Also:

• Constant Field Values

PROP_OFF_IMAGE

public static final String PROP_OFF_IMAGE

Image on the button when it is off.

See Also:

• Constant Field Values

PROP_STRETCH

public static final String PROP_STRETCH

True if the image should be stretched to the button size.

See Also:

• Constant Field Values

PROP_AUTOSIZE

public static final String PROP_AUTOSIZE

True if the button size is automatically adjusted to the size of the image.

See Also:

• Constant Field Values

PROP_NO_ANIMATION

public static final String PROP_NO_ANIMATION

True if the widget doesn't show animation even it is a animated image file.

See Also:

• Constant Field Values

PROP_ALIGN_TO_NEAREST_SECOND

public static final String PROP_ALIGN_TO_NEAREST_SECOND

True if the widget animation start should be aligned to the nearest second.

See Also:

• Constant Field Values

PROP_TRANSPARENCY

public static final String PROP_TRANSPARENCY

See Also:

• Constant Field Values

ID

public static final String ID

The ID of this widget model.

See Also:

• Constant Field Values

Constructor Details

ImageBoolButtonModel

public ImageBoolButtonModel()

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 AbstractBoolControlModel

getTypeID

public String getTypeID()

Overrides:

getTypeID in class AbstractBoolControlModel

Returns:

the unique typeID of the model.

isStretch

public boolean isStretch()

Returns if the image should be stretched.

Returns:

True is it should be stretched, false otherwise

isAutoSize

public boolean isAutoSize()

Returns:

True if the widget should be auto sized according the image size.

getOnImagePath

public String getOnImagePath()

Returns:

the path of the on image.

getOffImagePath

public String getOffImagePath()

Returns:

the path of the off image.

isStopAnimation

public boolean isStopAnimation()

Returns:

True if the animation is stopped.

isAlignedToNearestSecond

public boolean isAlignedToNearestSecond()