Package org.csstudio.opibuilder.widgets.model

Class AbstractScaledWidgetModel

java.lang.Object

org.csstudio.opibuilder.model.AbstractWidgetModel

org.csstudio.opibuilder.model.AbstractPVWidgetModel

org.csstudio.opibuilder.widgets.model.AbstractScaledWidgetModel

All Implemented Interfaces:

IPVWidgetModel, IAdaptable, IPropertySource

Direct Known Subclasses:

AbstractMarkedWidgetModel

public abstract class AbstractScaledWidgetModel
extends AbstractPVWidgetModel

This class defines a common widget model for any widget which has a scale.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_LOG_SCALE	True if the scale is log scale.
static final String	PROP_MAJOR_TICK_STEP_HINT	The minimum distance (in pixels) between major ticks.
static final String	PROP_MAX	Higher limit of the widget.
static final String	PROP_MIN	Lower limit of the widget.
static final String	PROP_SCALE_FONT	True if the scale is log scale.
static final String	PROP_SCALE_FORMAT	The numeric format pattern for the scale.
static final String	PROP_SHOW_MINOR_TICKS	Show minor ticks.
static final String	PROP_SHOW_SCALE	Show scale.
static final String	PROP_TRANSPARENT	True if the widget's background is transparent.
static final String	PROP_VALUE_LABEL_FORMAT	The numeric format pattern for the value 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
AbstractScaledWidgetModel()

Method Summary

Modifier and Type	Method	Description
protected void	configureProperties()	Configure the properties of the widget.
Integer	getMajorTickStepHint()
Double	getMaximum()
Double	getMinimum()
OPIFont	getScaleFont()
String	getScaleFormat()
String	getValueLabelFormat()
boolean	isLogScaleEnabled()
boolean	isShowMinorTicks()
boolean	isShowScale()
boolean	isTransparent()	Returns, if this widget should have a transparent background.

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, getTypeID, 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_TRANSPARENT

public static final String PROP_TRANSPARENT

True if the widget's background is transparent.

See Also:

• Constant Field Values

PROP_MIN

public static final String PROP_MIN

Lower limit of the widget.

See Also:

• Constant Field Values

PROP_MAX

public static final String PROP_MAX

Higher limit of the widget.

See Also:

• Constant Field Values

PROP_MAJOR_TICK_STEP_HINT

public static final String PROP_MAJOR_TICK_STEP_HINT

The minimum distance (in pixels) between major ticks.

See Also:

• Constant Field Values

PROP_SHOW_MINOR_TICKS

public static final String PROP_SHOW_MINOR_TICKS

Show minor ticks.

See Also:

• Constant Field Values

PROP_SHOW_SCALE

public static final String PROP_SHOW_SCALE

Show scale.

See Also:

• Constant Field Values

PROP_LOG_SCALE

public static final String PROP_LOG_SCALE

True if the scale is log scale.

See Also:

• Constant Field Values

PROP_SCALE_FONT

public static final String PROP_SCALE_FONT

True if the scale is log scale.

See Also:

• Constant Field Values

PROP_SCALE_FORMAT

public static final String PROP_SCALE_FORMAT

The numeric format pattern for the scale.

See Also:

• Constant Field Values

PROP_VALUE_LABEL_FORMAT

public static final String PROP_VALUE_LABEL_FORMAT

The numeric format pattern for the value label.

See Also:

• Constant Field Values

Constructor Details

AbstractScaledWidgetModel

public AbstractScaledWidgetModel()

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.

Specified by:

configureProperties in class AbstractWidgetModel

getMinimum

public Double getMinimum()

Returns:

the minimum value

getMaximum

public Double getMaximum()

Returns:

the maximum value

getMajorTickStepHint

public Integer getMajorTickStepHint()

Returns:

the major tick step hint value

isShowMinorTicks

public boolean isShowMinorTicks()

Returns:

true if the minor ticks should be shown, false otherwise

isShowScale

public boolean isShowScale()

Returns:

true if the scale should be shown, false otherwise

isLogScaleEnabled

public boolean isLogScaleEnabled()

Returns:

true if log scale enabled, false otherwise

isTransparent

public boolean isTransparent()

Returns, if this widget should have a transparent background.

Returns:

boolean True, if it should have a transparent background, false otherwise

getScaleFont

public OPIFont getScaleFont()

getScaleFormat

public String getScaleFormat()

getValueLabelFormat

public String getValueLabelFormat()