Class 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 Detail

      • 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
    • Constructor Detail

      • ActionButtonWidget

        public ActionButtonWidget()
    • 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 class Widget
        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 class Widget
        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