Merge pull request #3102 from ControlSystemStudio/CSSTUDIO-1704-action-button-widget

Save & restore actions and actions ordering

Author: shroffk

app/display/actions/src/main/java/org/csstudio/display/actions/OpenFileAction.java

@@ -72,11 +72,6 @@ public void writeToXML(ModelWriter modelWriter, XMLStreamWriter writer) throws E
         writer.writeEndElement();
     }
 
-    @Override
-    public boolean matchesAction(String actionId) {
-        return actionId.equalsIgnoreCase(OPEN_FILE);
-    }
-
     @Override
     public Image getImage() {
         return ImageCache.getImage(ActionsDialog.class, "/icons/open_file.png");

app/display/actions/src/main/java/org/csstudio/display/actions/OpenWebPageAction.java

@@ -60,11 +60,6 @@ public void writeToXML(ModelWriter modelWriter, XMLStreamWriter writer) throws E
         writer.writeEndElement();
     }
 
-    @Override
-    public boolean matchesAction(String actionId) {
-        return actionId.equalsIgnoreCase(OPEN_WEBPAGE);
-    }
-
     @Override
     public Image getImage() {
         return ImageCache.getImage(ActionsDialog.class, "/icons/web_browser.png");

app/display/actions/src/main/java/org/csstudio/display/actions/WritePVAction.java

@@ -86,11 +86,6 @@ public Image getImage() {
         return ImageCache.getImage(ActionsDialog.class, "/icons/write_pv.png");
     }
 
-    @Override
-    public boolean matchesAction(String actionId) {
-        return actionId.equalsIgnoreCase(WRITE_PV);
-    }
-
     public String getPV() {
         return pv;
     }

app/display/model/src/main/java/org/csstudio/display/builder/model/properties/ActionsWidgetProperty.java

@@ -87,7 +87,7 @@ public void readFromXML(final ModelReader modelReader, final Element propertyXml
             // the action type id.
             ServiceLoader<ActionInfo> loader = ServiceLoader.load(ActionInfo.class);
             Optional<ServiceLoader.Provider<ActionInfo>> optionalActionInfo =
-                    loader.stream().filter(p -> p.get().matchesAction(type)).findFirst();
+                    loader.stream().filter(p -> p.get().getType().equalsIgnoreCase(type) || p.get().matchesAction(type)).findFirst();
             if (optionalActionInfo.isPresent()) {
                 actionInfo = optionalActionInfo.get().get();
             } else {

app/display/model/src/main/java/org/csstudio/display/builder/model/spi/ActionInfo.java

@@ -29,11 +29,14 @@
 import org.w3c.dom.Element;
 
 import javax.xml.stream.XMLStreamWriter;
+import java.util.Comparator;
 import java.util.List;
 
-public interface ActionInfo {
+public interface ActionInfo extends Comparable<ActionInfo> {
 
     /**
+     * If action type is not sufficient to determine match, implementations may add additional logic
+     * to resolve match. For instance: legacy display formats may use a different string to define the action type.
      * @param actionId Action id, e.g. open_display.
      * @return <code>true</code> if the input string is implemented by the {@link ActionInfo}.
      */
@@ -42,8 +45,7 @@ default boolean matchesAction(String actionId) {
     }
 
     /**
-     * The id/type of action, which is either a fully qualified class name, or a legacy identifier
-     * string like 'open_display'. Must be unique between all implementations.
+     * Non-null identifier, must be unique between all implementations.
      *
      * @return The action 'type'.
      */
@@ -117,4 +119,18 @@ default List<MenuItem> getContextMenuItems(Widget widget) {
      * @return The {@link ActionInfo} object with committed values.
      */
     ActionInfo commit();
+
+    /**
+     * Comparator for the sake of sorting {@link ActionInfo}s. Uses {@link ActionInfo#getDescription()}.
+     * @param other the object to be compared.
+     * @return Any occurrence of <code>null</code> in the {@link ActionInfo#getDescription()}
+     * fields will return 0. Otherwise, comparison of {@link ActionInfo#getDescription()}.
+     */
+    @Override
+    default int compareTo(ActionInfo other){
+        if(getDescription() == null || other.getDescription() == null){
+            return 0;
+        }
+        return getDescription().compareTo(other.getDescription());
+    }
 }

app/display/representation-javafx/src/main/java/org/csstudio/display/builder/representation/javafx/actionsdialog/ActionsDialogController.java

@@ -20,6 +20,8 @@
 
 import static org.csstudio.display.builder.representation.ToolkitRepresentation.logger;
 
+import java.util.Comparator;
+import java.util.List;
 import java.util.ServiceLoader;
 import java.util.logging.Level;
 import java.util.stream.Collectors;
@@ -103,7 +105,7 @@ protected void updateItem(final ActionsDialogActionItem actionsDialogActionItem,
                 logger.log(Level.WARNING, "Error displaying " + actionsDialogActionItem, ex);
             }
         }
-    };
+    }
 
     /** Initialize */
     @FXML
@@ -116,7 +118,10 @@ public void initialize() {
 
         ServiceLoader<ActionInfo> actionInfos = ServiceLoader.load(ActionInfo.class);
 
-        for (ActionInfo actionInfo : actionInfos)
+        // Order actions, see ActionInfo#compareTo
+        List<ActionInfo> sortedActionInfos = actionInfos.stream().map(p -> p.get()).sorted().toList();
+
+        for (ActionInfo actionInfo : sortedActionInfos)
         {
             final ImageView icon = new ImageView(actionInfo.getImage());
             final MenuItem item = new MenuItem(actionInfo.toString(), icon);

app/save-and-restore/app/doc/images/open_filter.png

@@ -384,6 +384,12 @@ The search result table of the Search And Filter view also supports a contect me
 
 .. image:: images/search-result-context-menu.png
 
+Invoke a restore operation from search result
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Snapshot and composite snapshot items in the search result table support an additional context menu item users can
+choose in order to perform a restore operation.
+
 Snapshot View Context Menu
 --------------------------
 
@@ -416,4 +422,36 @@ Authorization uses a role-based approach like so:
 
 Roles are defined and managed on the service. Role (group) membership is managed in Active Directory or LDAP.
 
+Integration with the Display Builder application
+------------------------------------------------
+
+It is possible to configure Display Builder actions to interact with the Save-And-Restore application. Such actions are available as either items
+in the context menu of a Display Builder widget, or actions associated with an Action Button widget, or both.
+
+When Save-And-Restore actions are executed, the application is launched or put in focus. The following action types
+are supported:
+
+* | Open a configuration, snapshot or composite snapshot node in the Save-And-Restore application.
+  | This can be used to quickly access a particular node in order to invoke a restore operation.
+* | Open a named filter in the Save-And-Restore application.
+  | This will open/show the search and filter view and automatically perform the search associated with the named filter.
+  | This feature can be used to quickly navigate from a Display Builder screen to a view containing a set of commonly used snapshots.
+
+Configuring actions
+^^^^^^^^^^^^^^^^^^^
+
+When configuring an action in the Display Builder editor, supported actions are available from a list:
+
+.. image:: images/select_action.png
+   :width: 70%
+
+For the open node action, user may either paste the unique id of a node into the input field, or launch a
+browser to select a node:
+
+.. image:: images/open_node.png
+   :width: 70%
+
+For the open filter action, user can select from a drop-down list showing existing named filters:
 
+.. image:: images/open_filter.png
+   :width: 70%