Class MeterWidget


  • public class MeterWidget
    extends PVWidget
    Widget that displays a number on a meter
    • Field Detail

      • WIDGET_DESCRIPTOR

        public static final org.csstudio.display.builder.model.WidgetDescriptor WIDGET_DESCRIPTOR
      • METER_VERSION

        public static final org.csstudio.display.builder.model.Version METER_VERSION
        1.0.0: BOY 2.0.0: Display Builder meter based on 3rd party JFX lib 3.0.0: Simpler meter, drawn in background
      • propShowValue

        public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Boolean> propShowValue
      • propShowLimits

        public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Boolean> propShowLimits
      • propNeedleColor

        public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<org.csstudio.display.builder.model.properties.WidgetColor> propNeedleColor
      • propKnobColor

        public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<org.csstudio.display.builder.model.properties.WidgetColor> propKnobColor
    • Constructor Detail

      • MeterWidget

        public MeterWidget()
    • Method Detail

      • getVersion

        public org.csstudio.display.builder.model.Version getVersion()
        Overrides:
        getVersion in class Widget
        Returns:
        Widget version number
      • getConfigurator

        public org.csstudio.display.builder.model.WidgetConfigurator getConfigurator​(org.csstudio.display.builder.model.Version persistedVersion)
                                                                              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:
        persistedVersion - Version of the persisted data.
        Returns:
        Widget configurator for that version
        Throws:
        java.lang.Exception - if persisted version cannot be handled
      • 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
      • propFont

        public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetFont> propFont()
        Returns:
        'font' property
      • propFormat

        public WidgetProperty<org.phoebus.ui.vtype.FormatOption> propFormat()
        Returns:
        'format' property
      • propPrecision

        public WidgetProperty<java.lang.Integer> propPrecision()
        Returns:
        'precision' property
      • propShowValue

        public WidgetProperty<java.lang.Boolean> propShowValue()
        Returns:
        'show_value' property
      • propShowUnits

        public WidgetProperty<java.lang.Boolean> propShowUnits()
        Returns:
        'show_units' property
      • propShowLimits

        public WidgetProperty<java.lang.Boolean> propShowLimits()
        Returns:
        'show_limits' property
      • propNeedleColor

        public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propNeedleColor()
        Returns:
        'needle_color' property
      • propKnobColor

        public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propKnobColor()
        Returns:
        'knob_color' 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