refactor: x/y plot widget remove unused grid_color property

Author: cjenkscybercom

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

@@ -40,7 +40,9 @@ public Convert_xyGraphClass(final EdmConverter converter, final Widget parent, f
 
         convertColor(r.getBgColor(), widget.propBackground());
         convertColor(r.getFgColor(), widget.propForeground());
-        convertColor(r.getFgColor(), widget.propGridColor());
+        widget.propYAxes().getValue().forEach(propYAxis -> {
+            convertColor(r.getFgColor(), propYAxis.color());
+        });
 
         // X Axis
         if (r.getXLabel() == null)

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

@@ -122,6 +122,18 @@ protected MarkerProperty(final Widget widget, final String name)
     /** Legacy properties that have already triggered a warning */
     private final CopyOnWriteArraySet<String> warnings_once = new CopyOnWriteArraySet<>();
 
+    /** Moving gridline color to individual Y-Axes was a backwards-incompatible change
+     *  So the major was incremented from 2.0.0 to 3.0.0
+     */
+    private static final Version VERSION = Version.parse("3.0.0");
+
+    /** @return Widget version number */
+    @Override
+    public Version getVersion()
+    {
+        return VERSION;
+    }
+
     /** Configurator that handles legacy properties */
     private static class Configurator extends WidgetConfigurator
     {
@@ -136,6 +148,7 @@ public boolean configureFromXML(final ModelReader model_reader, final Widget wid
         {
             configureAllPropertiesFromMatchingXML(model_reader, widget, xml);
 
+            // Legacy widget
             if (xml_version.getMajor() < 2)
             {
                 if (StripchartWidget.isLegacyStripchart(xml))
@@ -176,6 +189,24 @@ public boolean configureFromXML(final ModelReader model_reader, final Widget wid
                     for (TraceWidgetProperty trace : plot.propTraces().getValue())
                         trace.traceName().setValue("");
             }
+
+            // Newer widgets with some high-level properties moved to individual axes
+            if (xml_version.getMajor() < 3) {
+
+                final XYPlotWidget plot = (XYPlotWidget) widget;
+
+                // If grid color was specified, then use it on each axis
+                Element gridColor = XMLUtil.getChildElement(xml, "grid_color");
+                if(gridColor != null) {
+                    plot.y_axes.getValue().forEach(axis -> {
+                        try {
+                            axis.color().readFromXML(model_reader, gridColor);
+                        } catch (Exception e) {
+                            logger.log(Level.WARNING, "Could not read widget color from grid_color of V2 X/Y Plot Widget");
+                        }
+                    });
+                }
+            }
             return true;
         }
 
@@ -303,7 +334,6 @@ private boolean handleLegacyTraces(final ModelReader model_reader,
 
     private volatile WidgetProperty<WidgetColor> foreground;
     private volatile WidgetProperty<WidgetColor> background;
-    private volatile WidgetProperty<WidgetColor> grid;
     private volatile WidgetProperty<String> title;
     private volatile WidgetProperty<WidgetFont> title_font;
     private volatile WidgetProperty<Boolean> show_toolbar;
@@ -332,7 +362,6 @@ protected void defineProperties(final List<WidgetProperty<?>> properties)
         super.defineProperties(properties);
         properties.add(foreground = propForegroundColor.createProperty(this, WidgetColorService.getColor(NamedWidgetColors.TEXT)));
         properties.add(background = propBackgroundColor.createProperty(this, WidgetColorService.getColor(NamedWidgetColors.BACKGROUND)));
-        properties.add(grid = propGridColor.createProperty(this, WidgetColorService.getColor(NamedWidgetColors.GRID)));
         properties.add(title = PlotWidgetProperties.propTitle.createProperty(this, ""));
         properties.add(title_font = PlotWidgetProperties.propTitleFont.createProperty(this, WidgetFontService.get(NamedWidgetFonts.HEADER2)));
         properties.add(show_toolbar = propToolbar.createProperty(this,false));
@@ -399,12 +428,6 @@ public WidgetProperty<WidgetColor> propForeground()
         return foreground;
     }
 
-    /** @return 'grid_color' property */
-    public WidgetProperty<WidgetColor> propGridColor()
-    {
-        return grid;
-    }
-
     /** @return 'title' property */
     public WidgetProperty<String> propTitle()
     {

app/display/representation-javafx/src/main/java/org/csstudio/display/builder/representation/javafx/widgets/plots/XYPlotRepresentation.java

@@ -475,7 +475,6 @@ protected void registerListeners()
 
         model_widget.propBackground().addUntypedPropertyListener(config_listener);
         model_widget.propForeground().addUntypedPropertyListener(config_listener);
-        model_widget.propGridColor().addUntypedPropertyListener(config_listener);
         model_widget.propTitle().addUntypedPropertyListener(config_listener);
         model_widget.propTitleFont().addUntypedPropertyListener(config_listener);
         model_widget.propToolbar().addUntypedPropertyListener(config_listener);
@@ -508,7 +507,6 @@ protected void unregisterListeners()
     {
         model_widget.propBackground().removePropertyListener(config_listener);
         model_widget.propForeground().removePropertyListener(config_listener);
-        model_widget.propGridColor().removePropertyListener(config_listener);
         model_widget.propTitle().removePropertyListener(config_listener);
         model_widget.propTitleFont().removePropertyListener(config_listener);
         model_widget.propToolbar().removePropertyListener(config_listener);
@@ -638,7 +636,6 @@ private void updateConfig()
         final Color foreground = JFXUtil.convert(model_widget.propForeground().getValue());
         plot.setForeground(foreground);
         plot.setBackground(JFXUtil.convert(model_widget.propBackground().getValue()));
-//        plot.setGridColor(JFXUtil.convert(model_widget.propGridColor().getValue()));
         plot.setTitleFont(JFXUtil.convert(model_widget.propTitleFont().getValue()));
         plot.setTitle(model_widget.propTitle().getValue());