Add unique id to ToolbarEntry

ControlSystemStudio · Oct 14, 2024 · 7d6ff4d · 7d6ff4d
1 parent f33eeb3
commit 7d6ff4d
Show file tree

Hide file tree

Showing 13 changed files with 111 additions and 12 deletions.
diff --git a/...ava/org/phoebus/applications/credentialsmanagement/CredentialsManagementToolbarEntry.java b/...ava/org/phoebus/applications/credentialsmanagement/CredentialsManagementToolbarEntry.java
@@ -41,4 +41,13 @@ public Void call() throws Exception {
         ApplicationService.createInstance(CredentialsManagementApp.name);
         return null;
     }
+
+    /**
+     * DO NOT CHANGE RETURN VALUE!
+     * @return The unique id of this {@link ToolbarEntry}.
+     */
+    @Override
+    public String getId(){
+        return "Credentials Management";
+    }
 }
diff --git a/app/databrowser/src/main/java/org/csstudio/trends/databrowser3/OpenDataBrowser.java b/app/databrowser/src/main/java/org/csstudio/trends/databrowser3/OpenDataBrowser.java
@@ -18,30 +18,34 @@
  *  @author Kay Kasemir
  */
 @SuppressWarnings("nls")
-public class OpenDataBrowser implements MenuEntry, ToolbarEntry
-{
+public class OpenDataBrowser implements MenuEntry, ToolbarEntry {
     @Override
-    public String getName()
-    {
+    public String getName() {
         return Messages.DataBrowser;
     }
 
     @Override
-    public String getMenuPath()
-    {
+    public String getMenuPath() {
         return Messages.DataBrowserMenuPath;
     }
 
     @Override
-    public Image getIcon()
-    {
+    public Image getIcon() {
         return ImageCache.getImage(getClass(), "/icons/databrowser.png");
     }
 
     @Override
-    public Void call() throws Exception
-    {
+    public Void call() throws Exception {
         ApplicationService.createInstance(DataBrowserApp.NAME);
         return null;
     }
+
+    /**
+     * DO NOT CHANGE RETURN VALUE!
+     * @return The unique id of this {@link ToolbarEntry}.
+     */
+    @Override
+    public String getId(){
+        return "Data Browser";
+    }
 }
diff --git a/...lebrowser/src/main/java/org/phoebus/applications/filebrowser/FileBrowserToolbarEntry.java b/...lebrowser/src/main/java/org/phoebus/applications/filebrowser/FileBrowserToolbarEntry.java
@@ -25,4 +25,13 @@ public Void call() throws Exception {
         ApplicationService.createInstance(FileBrowserApp.Name);
         return null;
     }
+
+    /**
+     * DO NOT CHANGE RETURN VALUE!
+     * @return The unique id of this {@link ToolbarEntry}.
+     */
+    @Override
+    public String getId(){
+        return "File Browser";
+    }
 }
diff --git a/...tion/src/main/java/org/phoebus/applications/utility/LoggingConfigurationToolbarEntry.java b/...tion/src/main/java/org/phoebus/applications/utility/LoggingConfigurationToolbarEntry.java
@@ -28,4 +28,13 @@ public Void call() throws Exception {
         ApplicationService.createInstance(LoggingConfigurationApplication.NAME);
         return null;
     }
+
+    /**
+     * DO NOT CHANGE RETURN VALUE!
+     * @return The unique id of this {@link ToolbarEntry}.
+     */
+    @Override
+    public String getId(){
+        return "Logging Config";
+    }
 }
diff --git a/...ook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/menu/LogEntryTableToolbarEntry.java b/...ook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/menu/LogEntryTableToolbarEntry.java
@@ -37,4 +37,13 @@ public Image getIcon()
     {
         return LogEntryTableApp.icon;
     }
+
+    /**
+     * DO NOT CHANGE RETURN VALUE!
+     * @return The unique id of this {@link ToolbarEntry}.
+     */
+    @Override
+    public String getId(){
+        return "Log Entry Table";
+    }
 }
diff --git a/...ook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/menu/SendToLogBookToolbarEntry.java b/...ook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/menu/SendToLogBookToolbarEntry.java
@@ -39,4 +39,13 @@ public Image getIcon()
     {
         return SendToLogBookApp.icon;
     }
+
+    /**
+     * DO NOT CHANGE RETURN VALUE!
+     * @return The unique id of this {@link ToolbarEntry}.
+     */
+    @Override
+    public String getId(){
+        return "Send To Log Book";
+    }
 }
diff --git a/app/logbook/ui/src/main/java/org/phoebus/logbook/ui/menu/SendToLogBookToolbarEntry.java b/app/logbook/ui/src/main/java/org/phoebus/logbook/ui/menu/SendToLogBookToolbarEntry.java
@@ -40,4 +40,13 @@ public Image getIcon()
     {
         return SendToLogBookApp.icon;
     }
+
+    /**
+     * DO NOT CHANGE RETURN VALUE!
+     * @return The unique id of this {@link ToolbarEntry}.
+     */
+    @Override
+    public String getId(){
+        return "Send To Log Book";
+    }
 }
diff --git a/app/probe/src/main/java/org/phoebus/applications/probe/ProbeToolbarEntry.java b/app/probe/src/main/java/org/phoebus/applications/probe/ProbeToolbarEntry.java
@@ -20,4 +20,13 @@ public Void call() throws Exception {
         ApplicationService.createInstance(Probe.NAME);
         return null;
     }
+
+    /**
+     * DO NOT CHANGE RETURN VALUE!
+     * @return The unique id of this {@link ToolbarEntry}.
+     */
+    @Override
+    public String getId(){
+        return "Probe";
+    }
 }
diff --git a/app/pvtree/src/main/java/org/phoebus/applications/pvtree/PVTreeToolbarEntry.java b/app/pvtree/src/main/java/org/phoebus/applications/pvtree/PVTreeToolbarEntry.java
@@ -27,4 +27,14 @@ public Void call() throws Exception
         ApplicationService.createInstance(PVTreeApplication.NAME);
         return null;
     }
+
+
+    /**
+     * DO NOT CHANGE RETURN VALUE!
+     * @return The unique id of this {@link ToolbarEntry}.
+     */
+    @Override
+    public String getId(){
+        return "PV Tree";
+    }
 }
diff --git a/app/scan/ui/src/main/java/org/csstudio/scan/ui/monitor/ScanMonitorMenuEntry.java b/app/scan/ui/src/main/java/org/csstudio/scan/ui/monitor/ScanMonitorMenuEntry.java
@@ -45,4 +45,14 @@ public Void call() throws Exception
         ApplicationService.createInstance(ScanMonitorApplication.NAME);
         return null;
     }
+
+
+    /**
+     * DO NOT CHANGE RETURN VALUE!
+     * @return The unique id of this {@link ToolbarEntry}.
+     */
+    @Override
+    public String getId(){
+        return "Scan Monitor";
+    }
 }
diff --git a/core/ui/src/main/java/org/phoebus/ui/application/ToolbarEntryService.java b/core/ui/src/main/java/org/phoebus/ui/application/ToolbarEntryService.java
@@ -34,7 +34,7 @@ private ToolbarEntryService() {
             // Add specific 'desired' entry
             ToolbarEntry found = null;
             for (ToolbarEntry entry : available)
-                if (entry.getName().equalsIgnoreCase(desired))
+                if (entry.getId().equalsIgnoreCase(desired))
                 {
                     found = entry;
                     break;

diff --git a/core/ui/src/main/java/org/phoebus/ui/spi/ToolbarEntry.java b/core/ui/src/main/java/org/phoebus/ui/spi/ToolbarEntry.java
@@ -31,4 +31,12 @@ public default Image getIcon()
     {
         return null;
     }
+
+    /**
+     * A unique id for the {@link ToolbarEntry}. Implementations <b>must</b> ensure that this
+     * is indeed unique and immutable. In particular, it should be insensitive to localization and
+     * customization of an app name.
+     * @return Unique id of the {@link ToolbarEntry}.
+     */
+    String getId();
 }
diff --git a/core/ui/src/main/resources/phoebus_ui_preferences.properties b/core/ui/src/main/resources/phoebus_ui_preferences.properties
@@ -54,7 +54,11 @@ home_display=examples:/01_main.bob?app=display_runtime,Example Display
 # An entry starting with "!" removes that item from the available entries.
 # The order of the initial buttons "Home, Top Resources, Layouts"
 # cannot be changed, but they can be suppressed by adding "!",
-# for example "Home, !Top Resources, !Layouts"
+# for example "Home, !Top Resources, !Layouts".
+#
+# The strings in the list of entries MUST match what is returned from
+# ToolbarEntry#getId(). This allows for customization/localization of app name
+# without the need to adjust the list.
 #
 # Examples:
 #