Merge pull request #3486 from ControlSystemStudio/CSSTUDIO-2954

CSSTUDIO-2954 Add support for informative tooltips for widget properties

Author: shroffk

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

@@ -52,6 +52,19 @@ public class Messages
                          FontStyle_Regular,
                          GroupWidget_Description,
                          GroupWidget_Name,
+                         InformativeTooltipActions,
+                         InformativeTooltipAlarmBorder,
+                         InformativeTooltipHeight,
+                         InformativeTooltipName,
+                         InformativeTooltipPVName,
+                         InformativeTooltipRules,
+                         InformativeTooltipScripts,
+                         InformativeTooltipTooltip,
+                         InformativeTooltipVisible,
+                         InformativeTooltipWidgetClass,
+                         InformativeTooltipWidth,
+                         InformativeTooltipX,
+                         InformativeTooltipY,
                          Interpolation_Automatic,
                          Interpolation_Interpolate,
                          Interpolation_None,

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

@@ -211,14 +211,23 @@ public Widget(final String type, final int default_width, final int default_heig
         // -- Mandatory properties --
         prelim_properties.add(this.type = propType.createProperty(this, type));
         prelim_properties.add(name = propName.createProperty(this, ""));
+        name.setInformativeTooltip(Messages.InformativeTooltipName);
         prelim_properties.add(widget_class = propWidgetClass.createProperty(this, WidgetClassSupport.DEFAULT));
+        widget_class.setInformativeTooltip(Messages.InformativeTooltipWidgetClass);
         prelim_properties.add(x = propX.createProperty(this, 0));
+        x.setInformativeTooltip(Messages.InformativeTooltipX);
         prelim_properties.add(y = propY.createProperty(this, 0));
+        y.setInformativeTooltip(Messages.InformativeTooltipY);
         prelim_properties.add(width = propWidth.createProperty(this, default_width));
+        width.setInformativeTooltip(Messages.InformativeTooltipWidth);
         prelim_properties.add(height = propHeight.createProperty(this, default_height));
+        height.setInformativeTooltip(Messages.InformativeTooltipHeight);
         prelim_properties.add(actions = propActions.createProperty(this, ActionInfos.EMPTY));
+        actions.setInformativeTooltip(Messages.InformativeTooltipActions);
         prelim_properties.add(rules = propRules.createProperty(this, Collections.emptyList()));
+        rules.setInformativeTooltip(Messages.InformativeTooltipRules);
         prelim_properties.add(scripts = propScripts.createProperty(this, Collections.emptyList()));
+        scripts.setInformativeTooltip(Messages.InformativeTooltipScripts);
 
         // -- Widget-specific properties --
         defineProperties(prelim_properties);

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

@@ -11,6 +11,7 @@
 
 import java.lang.reflect.Constructor;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.logging.Level;
 
 import javax.xml.stream.XMLStreamWriter;
@@ -70,6 +71,8 @@ protected WidgetProperty(
         this.value = this.default_value;
     }
 
+    private Optional<String> informativeTooltip = Optional.empty();
+
     @SuppressWarnings("unchecked")
     @Override
     public WidgetProperty<T> clone()
@@ -121,6 +124,15 @@ public String getName()
         return descriptor.getName();
     }
 
+    public void setInformativeTooltip(String informativeTooltip) {
+        this.informativeTooltip = Optional.of(informativeTooltip);
+    }
+
+    /** @return Optional informative tooltip describing the property */
+    public Optional<String> getInformativeTooltip() {
+        return informativeTooltip;
+    }
+
     /** Get full path to property
      *
      *  <p>A widget property 'visible' might be the basic

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

@@ -82,9 +82,12 @@ protected void defineProperties (final List<WidgetProperty<?>> properties )
     {
         super.defineProperties(properties);
         properties.add(pv_name = propPVName.createProperty(this, ""));
+        pv_name.setInformativeTooltip(Messages.InformativeTooltipPVName);
         pv_name.addPropertyListener((property, oldValue, newValue) -> pv_value.setValue(null));
         properties.add(pv_value = runtimePropPVValue.createProperty(this, null));
         properties.add(alarm_border = propBorderAlarmSensitive.createProperty(this, true));
+        alarm_border.setInformativeTooltip(Messages.InformativeTooltipAlarmBorder);
+        var s = Messages.InformativeTooltipHeight;
     }
 
     @Override

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

@@ -13,6 +13,7 @@
 
 import java.util.List;
 
+import org.csstudio.display.builder.model.Messages;
 import org.csstudio.display.builder.model.Widget;
 import org.csstudio.display.builder.model.WidgetProperty;
 
@@ -57,7 +58,9 @@ protected void defineProperties(final List<WidgetProperty<?>> properties)
     {
         super.defineProperties(properties);
         properties.add(visible = propVisible.createProperty(this, true));
+        visible.setInformativeTooltip(Messages.InformativeTooltipVisible);
         properties.add(tooltip = propTooltip.createProperty(this, getInitialTooltip()));
+        tooltip.setInformativeTooltip(Messages.InformativeTooltipTooltip);
         // Start 'connected', assuming there are no PVs
         properties.add(connected = runtimePropConnected.createProperty(this, true));
     }

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

@@ -34,6 +34,19 @@ FontStyle_Italic=Italic
 FontStyle_Regular=Regular
 GroupWidget_Description=Group of widgets
 GroupWidget_Name=Group
+InformativeTooltipActions=Actions to execute when the widget is clicked on.
+InformativeTooltopAlarmBorder=Should an alarm border be shown around the widget when the displayed PV signals an alarm?
+InformativeTooltipHeight=The height of the widget in pixels.
+InformativeTooltipName=The name of the widget.
+InformativTooltipPVName=The name of the PV to connect to and to display in the widget.
+InformativeTooltipRules=Rules associated with the widget.
+InformativeTooltipScripts=Scripts associated with the widget.
+InformativeTooltipTooltip=Text to display in the tooltip of the widget when hovering with the mouse over the widget.
+InformativeTooltipVisible=Should the widget be visible?
+InformativeTooltipWidgetClass=The style class of the widget.
+InformativeTooltipWidth=The width of the widget in pixels.
+InformativeTooltipX=The x-coordinate of the widget counted in pixels from the left side of the screen.
+InformativeTooltipY=The y-coordinate of the widget counted in pixels from the top of the screen.
 Interpolation_Automatic=Automatic
 Interpolation_Interpolate=Interpolate
 Interpolation_None=None