Class TankWidget
- java.lang.Object
-
- org.csstudio.display.builder.model.Widget
-
- org.csstudio.display.builder.model.widgets.VisibleWidget
-
- org.csstudio.display.builder.model.widgets.PVWidget
-
- org.csstudio.display.builder.model.widgets.TankWidget
-
public class TankWidget extends PVWidget
Widget that displays a tank with variable fill level
-
-
Field Summary
Fields Modifier and Type Field Description static org.csstudio.display.builder.model.WidgetPropertyDescriptor<org.csstudio.display.builder.model.properties.WidgetColor>
propEmptyColor
static org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Boolean>
propScaleVisible
static org.csstudio.display.builder.model.WidgetDescriptor
WIDGET_DESCRIPTOR
Widget descriptor-
Fields inherited from class org.csstudio.display.builder.model.widgets.PVWidget
RUNTIME_VALUE_NO_PV
-
Fields inherited from class org.csstudio.display.builder.model.Widget
BASE_WIDGET_VERSION, USER_DATA_REPRESENTATION, USER_DATA_RUNTIME, USER_DATA_SCRIPT_SUPPORT, USER_DATA_TOOLKIT_PARENT
-
-
Constructor Summary
Constructors Constructor Description TankWidget()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.csstudio.display.builder.model.WidgetConfigurator
getConfigurator(org.csstudio.display.builder.model.Version persisted_version)
Obtain configurator.WidgetProperty<?>
getProperty(java.lang.String name)
Get widget property.WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor>
propBackground()
WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor>
propEmptyColor()
WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor>
propFillColor()
WidgetProperty<org.csstudio.display.builder.model.properties.WidgetFont>
propFont()
WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor>
propForeground()
WidgetProperty<java.lang.Boolean>
propLimitsFromPV()
WidgetProperty<java.lang.Double>
propMaximum()
WidgetProperty<java.lang.Double>
propMinimum()
WidgetProperty<java.lang.Boolean>
propScaleVisible()
-
Methods inherited from class org.csstudio.display.builder.model.widgets.PVWidget
propBorderAlarmSensitive, propPVName, runtimePropValue
-
Methods inherited from class org.csstudio.display.builder.model.widgets.VisibleWidget
propTooltip, propVisible, runtimePropConnected
-
Methods inherited from class org.csstudio.display.builder.model.Widget
checkDisplayModel, checkProperty, checkProperty, clearUserData, expandPropertyNames, getDisplayModel, getEffectiveMacros, getID, getMacrosOrProperties, getName, getParent, getProperties, getProperty, getPropertyByPath, getPropertyValue, getPropertyValue, getTopDisplayModel, getType, getUserData, getVersion, getWidgetClass, isClean, propActions, propClass, propHeight, propName, propRules, propScripts, propWidth, propX, propY, setConfiguratorResult, setPropertyValue, setPropertyValue, setUserData, toString
-
-
-
-
Field Detail
-
WIDGET_DESCRIPTOR
public static final org.csstudio.display.builder.model.WidgetDescriptor WIDGET_DESCRIPTOR
Widget descriptor
-
propEmptyColor
public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<org.csstudio.display.builder.model.properties.WidgetColor> propEmptyColor
-
propScaleVisible
public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Boolean> propScaleVisible
-
-
Method Detail
-
getConfigurator
public org.csstudio.display.builder.model.WidgetConfigurator getConfigurator(org.csstudio.display.builder.model.Version persisted_version) throws java.lang.Exception
Description copied from class:Widget
Obtain configurator.While typically using the default
WidgetConfigurator
, widget may provide a different configurator for reading older persisted date.- Overrides:
getConfigurator
in classWidget
- Parameters:
persisted_version
- Version of the persisted data.- Returns:
- Widget configurator for that version
- Throws:
java.lang.Exception
- if persisted version cannot be handled
-
getProperty
public WidgetProperty<?> getProperty(java.lang.String name) throws java.lang.IllegalArgumentException, java.lang.IndexOutOfBoundsException
Description copied from class:Widget
Get widget property.Meant for rules, scripts and similar code which does not know the exact widget type and thus fetches properties by name.
Supports access to complex properties by path name, for example "y_axes[1].minimum" to get the minimum property of the second Y axis of a plot.
To allow use of legacy scripts and rules, the widget implementation may override to handle deprecated property names.
Caller presumes that the widget actually has the requested property, otherwise throwing Exception.
- Overrides:
getProperty
in classWidget
- Parameters:
name
- Property name- Returns:
WidgetProperty
- Throws:
java.lang.IllegalArgumentException
- if property is unknownjava.lang.IndexOutOfBoundsException
- See Also:
Widget.checkProperty(String)
-
propFont
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetFont> propFont()
- Returns:
- 'font' property
-
propForeground
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propForeground()
- Returns:
- 'foreground_color' property
-
propBackground
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propBackground()
- Returns:
- 'background_color' property
-
propFillColor
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propFillColor()
- Returns:
- 'fill_color' property
-
propEmptyColor
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propEmptyColor()
- Returns:
- 'empty_color' property
-
propScaleVisible
public WidgetProperty<java.lang.Boolean> propScaleVisible()
- Returns:
- 'scale_visible' property
-
propLimitsFromPV
public WidgetProperty<java.lang.Boolean> propLimitsFromPV()
- Returns:
- 'limits_from_pv' property
-
propMinimum
public WidgetProperty<java.lang.Double> propMinimum()
- Returns:
- 'minimum' property
-
propMaximum
public WidgetProperty<java.lang.Double> propMaximum()
- Returns:
- 'maximum' property
-
-