feat (display): RTTank-based Progress Bar backend — scale, alarm limits, and stacking support (opt-in via preference)

app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/widgets/Convert_activeBarClass.java

@@ -28,7 +28,22 @@ public Convert_activeBarClass(final EdmConverter converter, final Widget parent,
         convertColor(r.getBgColor(), widget.propBackgroundColor());
         widget.propHorizontal().setValue(!"vertical".equals(r.getOrientation()));
         widget.propPVName().setValue(convertPVName(r.getIndicatorPv()));
+
+        widget.propScaleVisible().setValue(r.isShowScale());
         widget.propLimitsFromPV().setValue(r.isLimitsFromDb());
+        if (!r.isLimitsFromDb() && r.getMax() > r.getMin())
+        {
+            widget.propMinimum().setValue(r.getMin());
+            widget.propMaximum().setValue(r.getMax());
+        }
+
+        // EDM precision 0 usually means "not set"
+        if (r.getPrecision() > 0)
+            widget.propPrecision().setValue(r.getPrecision());
+
+        // EDM only knows border on/off
+        if (r.isBorder())
+            widget.propBorderWidth().setValue(1);
     }
 
     @Override

app/display/editor/src/main/java/org/csstudio/display/builder/editor/properties/PropertyPanelSection.java

@@ -59,6 +59,8 @@
 import org.csstudio.display.builder.model.properties.RulesWidgetProperty;
 import org.csstudio.display.builder.model.properties.ScriptsWidgetProperty;
 import org.csstudio.display.builder.model.properties.WidgetClassProperty;
+import org.csstudio.display.builder.model.widgets.ProgressBarWidget;
+import org.csstudio.display.builder.representation.Preferences;
 import org.csstudio.display.builder.representation.javafx.FilenameSupport;
 import org.phoebus.ui.color.NamedWidgetColor;
 import org.phoebus.ui.color.WidgetColor;
@@ -148,6 +150,22 @@ public boolean hasFocus() {
         return has_focus;
     }
 
+    /** Some widgets can be drawn by the stock JavaFX renderer or by an
+     *  RTTank based one that adds a scale, selected via preference.
+     *  Properties that only the RTTank renderer honours are hidden while
+     *  the stock renderer is in use, so the panel only lists what has
+     *  an effect.
+     *
+     *  @param property Property about to be listed
+     *  @return {@code true} if the property has no effect with the current renderer
+     */
+    private static boolean unusedByCurrentRenderer(final WidgetProperty<?> property) {
+        if (property.getWidget() instanceof ProgressBarWidget)
+            return !Preferences.progressbar_scale_mode
+                && ProgressBarWidget.SCALE_MODE_PROPS.contains(property.getName());
+        return false;
+    }
+
     void fill(final UndoableActionManager undo,
               final Collection<WidgetProperty<?>> properties,
               final List<Widget> other) {
@@ -163,6 +181,9 @@ void fill(final UndoableActionManager undo,
             if (property instanceof WidgetClassProperty && class_mode)
                 continue;
 
+            if (unusedByCurrentRenderer(property))
+                continue;
+
             // Start of new category that needs to be shown?
             if (property.getCategory() != category) {
                 category = property.getCategory();

app/display/model/src/main/java/org/csstudio/display/builder/model/Messages.java

@@ -241,6 +241,7 @@ public class Messages
                          WidgetProperties_HourTickMarkColor,
                          WidgetProperties_HourTickMarkVisible,
                          WidgetProperties_Increment,
+                         WidgetProperties_InnerPadding,
                          WidgetProperties_InitialIndex,
                          WidgetProperties_Insets,
                          WidgetProperties_Interactive,
@@ -326,6 +327,7 @@ public class Messages
                          WidgetProperties_ShowLoLo,
                          WidgetProperties_ShowMinorTicks,
                          WidgetProperties_PerpendicularTickLabels,
+                         WidgetProperties_ShowScaleLabels,
                          WidgetProperties_ShowOK,
                          WidgetProperties_ShowScale,
                          WidgetProperties_ShowUnits,

app/display/model/src/main/java/org/csstudio/display/builder/model/widgets/ProgressBarWidget.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2015-2022 Oak Ridge National Laboratory.
+ * Copyright (c) 2015-2026 Oak Ridge National Laboratory.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -8,15 +8,11 @@
 package org.csstudio.display.builder.model.widgets;
 
 import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propBackgroundColor;
-import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propFillColor;
 import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propHorizontal;
-import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propLimitsFromPV;
-import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propMaximum;
-import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propMinimum;
-import static org.csstudio.display.builder.model.widgets.plots.PlotWidgetProperties.propLogscale;
 
 import java.util.Arrays;
 import java.util.List;
+import java.util.Set;
 
 import org.csstudio.display.builder.model.Version;
 import org.csstudio.display.builder.model.Widget;
@@ -34,12 +30,41 @@
 import org.w3c.dom.Element;
 
 /** Widget that displays a progress bar
+ *
+ *  <p>Extends {@link ScaledPVWidget} so the bar offers the same range,
+ *  scale and alarm limit properties as the {@link TankWidget}.
+ *  The scale related properties only take effect with the RTTank based
+ *  renderer, see {@link #SCALE_MODE_PROPS}.
+ *
+ *  <p>Existing {@code .bob} files load unchanged: {@code fill_color},
+ *  {@code background_color}, {@code horizontal}, {@code limits_from_pv},
+ *  {@code minimum}, {@code maximum} and {@code log_scale} keep their
+ *  XML names. Older Phoebus versions ignore the new properties.
+ *
  *  @author Kay Kasemir
  *  @author Amanda Carpenter
+ *  @author Heredie Delvalle - CLS, scale support
  */
 @SuppressWarnings("nls")
-public class ProgressBarWidget extends PVWidget
+public class ProgressBarWidget extends ScaledPVWidget
 {
+    /** Properties that only have an effect with the RTTank based renderer
+     *  ({@code progressbar_scale_mode=true}).
+     *
+     *  <p>The property editor hides these while the stock JavaFX renderer
+     *  is in use. Properties that both renderers honour, like the range,
+     *  {@code horizontal}, {@code log_scale}, fill and background color,
+     *  are not listed here.
+     */
+    public static final Set<String> SCALE_MODE_PROPS = Set.of(
+        "format", "precision", "font", "foreground_color",
+        "scale_visible", "show_minor_ticks", "show_scale_labels",
+        "opposite_scale_visible", "perpendicular_tick_labels",
+        "inner_padding", "tank_border_width",
+        "alarm_limits_from_pv", "show_alarm_limits",
+        "level_lolo", "level_low", "level_high", "level_hihi",
+        "minor_alarm_color", "major_alarm_color");
+
     /** Widget descriptor */
     public static final WidgetDescriptor WIDGET_DESCRIPTOR =
         new WidgetDescriptor("progressbar", WidgetCategory.MONITOR,
@@ -55,7 +80,7 @@
         }
     };
 
-    /** Widget configurator to read legacy *.opi files*/
+    /** Widget configurator to read legacy *.opi files */
     private static class ProgressBarConfigurator extends WidgetConfigurator
     {
         public ProgressBarConfigurator(final Version xml_version)
@@ -82,14 +107,18 @@
                     bar.propY().setValue(bar.propY().getValue() + reduce);
                     bar.propHeight().setValue(bar.propHeight().getValue() - reduce);
                 }
-                // Do use space below where BOY placed markers for the bar itself.
-                // In the future, there could be a scale.
 
                 final Element el = XMLUtil.getChildElement(xml, "color_fillbackground");
                 if (el != null)
                     bar.propBackgroundColor().readFromXML(model_reader, el);
 
-                // Create text update for the value indicator
+                // BOY names that differ from ours. level_hihi and level_lolo match.
+                readLegacyElement(model_reader, xml, "show_scale", bar.propScaleVisible());
+                readLegacyElement(model_reader, xml, "scale_font", bar.propFont());
+                readLegacyElement(model_reader, xml, "level_hi", bar.propLevelHigh());
+                readLegacyElement(model_reader, xml, "level_lo", bar.propLevelLow());
+
+                // Create a companion TextUpdate widget for the BOY value label.
                 if (XMLUtil.getChildBoolean(xml, "show_label").orElse(true))
                 {
                     final Document doc = xml.getOwnerDocument();
@@ -116,6 +145,14 @@
 
             return true;
         }
+
+        private static void readLegacyElement(final ModelReader model_reader, final Element xml,
+                                              final String name, final WidgetProperty<?> property) throws Exception
+        {
+            final Element element = XMLUtil.getChildElement(xml, name);
+            if (element != null)
+                property.readFromXML(model_reader, element);
+        }
     }
 
     @Override
@@ -125,37 +162,24 @@
         return new ProgressBarConfigurator(persisted_version);
     }
 
-    private volatile WidgetProperty<Boolean> limits_from_pv;
-    private volatile WidgetProperty<Double> minimum;
-    private volatile WidgetProperty<Double> maximum;
-    private volatile WidgetProperty<Boolean> log_scale;
-    private volatile WidgetProperty<WidgetColor> fill_color;
     private volatile WidgetProperty<WidgetColor> background_color;
-    private volatile WidgetProperty<Boolean> horizontal;
+    private volatile WidgetProperty<Boolean>     horizontal;
+    private volatile WidgetProperty<Integer>     inner_padding;
 
     /** Constructor */
     public ProgressBarWidget()
     {
-        super(WIDGET_DESCRIPTOR.getType());
+        super(WIDGET_DESCRIPTOR.getType(), 100, 20);
     }
 
     @Override
     protected void defineProperties(final List<WidgetProperty<?>> properties)
     {
         super.defineProperties(properties);
-        properties.add(fill_color = propFillColor.createProperty(this, new WidgetColor(60, 255, 60)));
+        defineScaleLookProperties(properties, false, false);
         properties.add(background_color = propBackgroundColor.createProperty(this, new WidgetColor(250, 250, 250)));
-        properties.add(limits_from_pv = propLimitsFromPV.createProperty(this, true));
-        properties.add(minimum = propMinimum.createProperty(this, 0.0));
-        properties.add(maximum = propMaximum.createProperty(this, 100.0));
-        properties.add(log_scale = propLogscale.createProperty(this, false));
-        properties.add(horizontal = propHorizontal.createProperty(this, true));
-    }
-
-    /** @return 'fill_color' property */
-    public WidgetProperty<WidgetColor> propFillColor()
-    {
-        return fill_color;
+        properties.add(horizontal       = propHorizontal.createProperty(this, true));
+        properties.add(inner_padding    = propInnerPadding.createProperty(this, 3));
     }
 
     /** @return 'background_color' property */
@@ -164,33 +188,15 @@
         return background_color;
     }
 
-    /** @return 'limits_from_pv' property */
-    public WidgetProperty<Boolean> propLimitsFromPV()
-    {
-        return limits_from_pv;
-    }
-
-    /** @return 'minimum' property */
-    public WidgetProperty<Double> propMinimum()
-    {
-        return minimum;
-    }
-
-    /** @return 'maximum' property */
-    public WidgetProperty<Double> propMaximum()
-    {
-        return maximum;
-    }
-
-    /** @return 'log_scale' property */
-    public WidgetProperty<Boolean> propLogScale()
-    {
-        return log_scale;
-    }
-
     /** @return 'horizontal' property */
     public WidgetProperty<Boolean> propHorizontal()
     {
         return horizontal;
     }
+
+    /** @return 'inner_padding' property */
+    public WidgetProperty<Integer> propInnerPadding()
+    {
+        return inner_padding;
+    }
 }