Package org.csstudio.opibuilder.widgets.model

Class KnobModel

java.lang.Object

org.csstudio.opibuilder.model.AbstractWidgetModel

org.csstudio.opibuilder.model.AbstractPVWidgetModel

org.csstudio.opibuilder.widgets.model.AbstractScaledWidgetModel

org.csstudio.opibuilder.widgets.model.AbstractMarkedWidgetModel

org.csstudio.opibuilder.widgets.model.KnobModel

All Implemented Interfaces:

IPVWidgetModel, IAdaptable, IPropertySource

public class KnobModel
extends AbstractMarkedWidgetModel

This class defines a knob widget model.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID	The ID of this widget model.
static final int	MINIMUM_SIZE
static final String	PROP_EFFECT3D	True if the widget is drawn with advanced graphics.
static final String	PROP_INCREMENT	The minimum increment step when dragging the thumb.
static final String	PROP_KNOB_COLOR	Color of the knob.
static final String	PROP_RAMP_GRADIENT	True if ramp is gradient.
static final String	PROP_SHOW_VALUE_LABEL	Show value label.
static final String	PROP_THUMB_COLOR	Color of the thumb.

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

isControlWidget, PROP_HI_COLOR, PROP_HI_LEVEL, PROP_HIHI_COLOR, PROP_HIHI_LEVEL, PROP_LIMITS_FROM_PV, PROP_LO_COLOR, PROP_LO_LEVEL, PROP_LOLO_COLOR, PROP_LOLO_LEVEL, PROP_SHOW_HI, PROP_SHOW_HIHI, PROP_SHOW_LO, PROP_SHOW_LOLO, PROP_SHOW_MARKERS

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

PROP_LOG_SCALE, PROP_MAJOR_TICK_STEP_HINT, PROP_MAX, PROP_MIN, PROP_SCALE_FONT, PROP_SCALE_FORMAT, PROP_SHOW_MINOR_TICKS, PROP_SHOW_SCALE, PROP_TRANSPARENT, PROP_VALUE_LABEL_FORMAT

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

Method Summary

Modifier and Type	Method	Description
protected void	configureProperties()	Configure the properties of the widget.
double	getIncrement()	Return the increment value.
Color	getKnobColor()
Color	getThumbColor()	Gets the RGB for thumb.
String	getTypeID()
boolean	isEffect3D()
boolean	isRampGradient()
boolean	isShowValueLabel()

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

getHiColor, getHihiColor, getHihiLevel, getHiLevel, getLoColor, getLoLevel, getLoloColor, getLoloLevel, isControlWidget, isLimitsFromPV, isShowHi, isShowHihi, isShowLo, isShowLolo, isShowMarkers

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

getMajorTickStepHint, getMaximum, getMinimum, getScaleFont, getScaleFormat, getValueLabelFormat, isLogScaleEnabled, isShowMinorTicks, isShowScale, isTransparent

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_KNOB_COLOR

public static final String PROP_KNOB_COLOR

Color of the knob.

See Also:

• Constant Field Values

PROP_EFFECT3D

public static final String PROP_EFFECT3D

True if the widget is drawn with advanced graphics. In some platforms, advance graphics may not be available, in which case the widget will not be drawn with advanced graphics even this is set to true.

See Also:

• Constant Field Values

PROP_SHOW_VALUE_LABEL

public static final String PROP_SHOW_VALUE_LABEL

Show value label.

See Also:

• Constant Field Values

PROP_THUMB_COLOR

public static final String PROP_THUMB_COLOR

Color of the thumb.

See Also:

• Constant Field Values

PROP_RAMP_GRADIENT

public static final String PROP_RAMP_GRADIENT

True if ramp is gradient.

See Also:

• Constant Field Values

PROP_INCREMENT

public static final String PROP_INCREMENT

The minimum increment step when dragging the thumb.

See Also:

• Constant Field Values

MINIMUM_SIZE

public static final int MINIMUM_SIZE

See Also:

• Constant Field Values

ID

public static final String ID

The ID of this widget model.

See Also:

• Constant Field Values

Constructor Details

KnobModel

public KnobModel()

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 AbstractMarkedWidgetModel

getTypeID

public String getTypeID()

Specified by:

getTypeID in class AbstractWidgetModel

Returns:

the unique typeID of the model.

getKnobColor

public Color getKnobColor()

Returns:

the knob color

isEffect3D

public boolean isEffect3D()

Returns:

true if the widget would be painted with 3D effect, false otherwise

isShowValueLabel

public boolean isShowValueLabel()

Returns:

true if the widget would be painted with 3D effect, false otherwise

getThumbColor

public Color getThumbColor()

Gets the RGB for thumb.

Returns:

The thumb color

isRampGradient

public boolean isRampGradient()

Returns:

true if the ramp is gradient, false otherwise

getIncrement

public double getIncrement()

Return the increment value.

Returns:

The increment value.