Class TankWidget


  • public class TankWidget
    extends PVWidget
    Widget that displays a tank with variable fill level
    • 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
    • Constructor Detail

      • TankWidget

        public TankWidget()
    • 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
      • 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 class Widget
        Parameters:
        name - Property name
        Returns:
        WidgetProperty
        Throws:
        java.lang.IllegalArgumentException - if property is unknown
        java.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