Merge pull request #3165 from ControlSystemStudio/add_toolbarentry_id

shroffk · web-flow · commit 5baf621679b6 · 2024-10-17T09:29:51.000-04:00
Add unique id to ToolbarEntry
diff --git a/app/credentials-management/src/main/java/org/phoebus/applications/credentialsmanagement/CredentialsManagementToolbarEntry.java b/app/credentials-management/src/main/java/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/credentials-management/src/main/resources/META-INF/services/org.phoebus.ui.spi.ToolbarEntry b/app/credentials-management/src/main/resources/META-INF/services/org.phoebus.ui.spi.ToolbarEntry
@@ -0,0 +1 @@
+org.phoebus.applications.credentialsmanagement.CredentialsManagementToolbarEntry
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/app/filebrowser/src/main/java/org/phoebus/applications/filebrowser/FileBrowserToolbarEntry.java b/app/filebrowser/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/app/log-configuration/src/main/java/org/phoebus/applications/utility/LoggingConfigurationToolbarEntry.java b/app/log-configuration/src/main/java/org/phoebus/applications/utility/LoggingConfigurationToolbarEntry.java
diff --git a/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/menu/LogEntryTableToolbarEntry.java b/app/logbook/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/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/menu/SendToLogBookToolbarEntry.java b/app/logbook/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/probe/src/main/resources/META-INF/services/org.phoebus.ui.spi.ToolbarEntry b/app/probe/src/main/resources/META-INF/services/org.phoebus.ui.spi.ToolbarEntry
@@ -0,0 +1 @@
+org.phoebus.applications.probe.ProbeToolbarEntry
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/pvtree/src/main/resources/META-INF/services/org.phoebus.ui.spi.ToolbarEntry b/app/pvtree/src/main/resources/META-INF/services/org.phoebus.ui.spi.ToolbarEntry
@@ -0,0 +1 @@
+org.phoebus.applications.pvtree.PVTreeToolbarEntry
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:
 #

Original file line number	Diff line number	Diff line change
`@@ -41,4 +41,13 @@ public Void call() throws Exception {`
`41`	`41`	`ApplicationService.createInstance(CredentialsManagementApp.name);`
`42`	`42`	`return null;`
`43`	`43`	`}`
	`44`	`+`
	`45`	`+ /**`
	`46`	`+ * DO NOT CHANGE RETURN VALUE!`
	`47`	`+ * @return The unique id of this {@link ToolbarEntry}.`
	`48`	`+ */`
	`49`	`+ @Override`
	`50`	`+ public String getId(){`
	`51`	`+ return "Credentials Management";`
	`52`	`+ }`
`44`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+org.phoebus.applications.credentialsmanagement.CredentialsManagementToolbarEntry`
Original file line number	Diff line number	Diff line change
`@@ -25,4 +25,13 @@ public Void call() throws Exception {`
`25`	`25`	`ApplicationService.createInstance(FileBrowserApp.Name);`
`26`	`26`	`return null;`
`27`	`27`	`}`
	`28`	`+`
	`29`	`+ /**`
	`30`	`+ * DO NOT CHANGE RETURN VALUE!`
	`31`	`+ * @return The unique id of this {@link ToolbarEntry}.`
	`32`	`+ */`
	`33`	`+ @Override`
	`34`	`+ public String getId(){`
	`35`	`+ return "File Browser";`
	`36`	`+ }`
`28`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,4 +37,13 @@ public Image getIcon()`
`37`	`37`	`{`
`38`	`38`	`return LogEntryTableApp.icon;`
`39`	`39`	`}`
	`40`	`+`
	`41`	`+ /**`
	`42`	`+ * DO NOT CHANGE RETURN VALUE!`
	`43`	`+ * @return The unique id of this {@link ToolbarEntry}.`
	`44`	`+ */`
	`45`	`+ @Override`
	`46`	`+ public String getId(){`
	`47`	`+ return "Log Entry Table";`
	`48`	`+ }`
`40`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,4 +39,13 @@ public Image getIcon()`
`39`	`39`	`{`
`40`	`40`	`return SendToLogBookApp.icon;`
`41`	`41`	`}`
	`42`	`+`
	`43`	`+ /**`
	`44`	`+ * DO NOT CHANGE RETURN VALUE!`
	`45`	`+ * @return The unique id of this {@link ToolbarEntry}.`
	`46`	`+ */`
	`47`	`+ @Override`
	`48`	`+ public String getId(){`
	`49`	`+ return "Send To Log Book";`
	`50`	`+ }`
`42`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,4 +40,13 @@ public Image getIcon()`
`40`	`40`	`{`
`41`	`41`	`return SendToLogBookApp.icon;`
`42`	`42`	`}`
	`43`	`+`
	`44`	`+ /**`
	`45`	`+ * DO NOT CHANGE RETURN VALUE!`
	`46`	`+ * @return The unique id of this {@link ToolbarEntry}.`
	`47`	`+ */`
	`48`	`+ @Override`
	`49`	`+ public String getId(){`
	`50`	`+ return "Send To Log Book";`
	`51`	`+ }`
`43`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,4 +20,13 @@ public Void call() throws Exception {`
`20`	`20`	`ApplicationService.createInstance(Probe.NAME);`
`21`	`21`	`return null;`
`22`	`22`	`}`
	`23`	`+`
	`24`	`+ /**`
	`25`	`+ * DO NOT CHANGE RETURN VALUE!`
	`26`	`+ * @return The unique id of this {@link ToolbarEntry}.`
	`27`	`+ */`
	`28`	`+ @Override`
	`29`	`+ public String getId(){`
	`30`	`+ return "Probe";`
	`31`	`+ }`
`23`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+org.phoebus.applications.probe.ProbeToolbarEntry`