Class ActionButtonWidget
- 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.ActionButtonWidget
-
public class ActionButtonWidget extends PVWidget
Widget that provides button for invoking actions.The widget doesn't directly act on its primary PV. The PV is mostly used like a macro for actions that write to a "$(pv_name)" PV. It is used for the alarm sensitive border, and "text" (label) can have a special value "$(pv_value)" to update with value changes.
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_HEIGHT
static int
DEFAULT_WIDTH
static java.lang.String
VALUE_LABEL
When "text" has this value, it will reflect the primary PV's valuestatic 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 ActionButtonWidget()
-
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.org.csstudio.display.builder.model.Version
getVersion()
WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor>
propBackgroundColor()
WidgetProperty<java.lang.Boolean>
propConfirmDialog()
WidgetProperty<java.lang.String>
propConfirmMessage()
WidgetProperty<java.lang.Boolean>
propEnabled()
WidgetProperty<org.csstudio.display.builder.model.properties.WidgetFont>
propFont()
WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor>
propForegroundColor()
WidgetProperty<java.lang.String>
propPassword()
WidgetProperty<org.csstudio.display.builder.model.properties.RotationStep>
propRotationStep()
WidgetProperty<java.lang.String>
propText()
WidgetProperty<java.lang.Boolean>
propTransparent()
WidgetProperty<java.lang.Boolean>
runtimePropPVWritable()
-
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, getProperty, getPropertyByPath, getPropertyValue, getPropertyValue, getTopDisplayModel, getType, getUserData, getWidgetClass, isClean, propActions, propClass, propHeight, propName, propRules, propScripts, propWidth, propX, propY, setConfiguratorResult, setPropertyValue, setPropertyValue, setUserData, toString
-
-
-
-
Field Detail
-
DEFAULT_WIDTH
public static final int DEFAULT_WIDTH
- See Also:
- Constant Field Values
-
DEFAULT_HEIGHT
public static final int DEFAULT_HEIGHT
- See Also:
- Constant Field Values
-
VALUE_LABEL
public static final java.lang.String VALUE_LABEL
When "text" has this value, it will reflect the primary PV's value- See Also:
- Constant Field Values
-
WIDGET_DESCRIPTOR
public static final org.csstudio.display.builder.model.WidgetDescriptor WIDGET_DESCRIPTOR
Widget descriptor
-
-
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
-
getVersion
public org.csstudio.display.builder.model.Version getVersion()
- Overrides:
getVersion
in classWidget
- Returns:
- Widget version number
-
propText
public WidgetProperty<java.lang.String> propText()
- Returns:
- 'text' property
-
propFont
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetFont> propFont()
- Returns:
- 'font' property
-
propForegroundColor
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propForegroundColor()
- Returns:
- 'foreground_color' property
-
propBackgroundColor
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propBackgroundColor()
- Returns:
- 'background_color' property
-
propTransparent
public WidgetProperty<java.lang.Boolean> propTransparent()
- Returns:
- 'transparent' property
-
propRotationStep
public WidgetProperty<org.csstudio.display.builder.model.properties.RotationStep> propRotationStep()
- Returns:
- 'rotation_step' property
-
propEnabled
public WidgetProperty<java.lang.Boolean> propEnabled()
- Returns:
- 'enabled' property
-
runtimePropPVWritable
public final WidgetProperty<java.lang.Boolean> runtimePropPVWritable()
- Returns:
- 'pv_writable' property
-
propConfirmDialog
public WidgetProperty<java.lang.Boolean> propConfirmDialog()
- Returns:
- 'confirm_dialog' property
-
propConfirmMessage
public WidgetProperty<java.lang.String> propConfirmMessage()
- Returns:
- 'confirm_message' property
-
propPassword
public WidgetProperty<java.lang.String> propPassword()
- Returns:
- 'password' property
-
-