CSSTUDIO-2072 Remove the possibility to represent Display Names on the clipboard by surrounding them with sinqle-quote characters. If a Display Name is not entered, use the default for the Display Name.

abrahamwolk · abrahamwolk · commit 0ed448864096 · 2024-11-14T10:09:58.000+01:00
diff --git a/app/databrowser/src/main/java/org/csstudio/trends/databrowser3/Activator.java b/app/databrowser/src/main/java/org/csstudio/trends/databrowser3/Activator.java
@@ -86,33 +86,14 @@ public static ImageView getIcon(final String base_name)
         return new ImageView(getImage(base_name));
     }
 
-    public static void addPVsToPlotDialog(List<String> names,
+    public static void addPVsToPlotDialog(List<String> pvNames,
                                           UndoableActionManager undoableActionManager,
                                           Model model,
                                           Node nodeToPositionDialogOver)
     {
-        List<Pair<String, String>> namesWithDisplayNames = new ArrayList<>();
-        Optional<String> currentPVName = Optional.empty();
-        for (String name : names) {
-            if (name.startsWith("'") && name.endsWith("'") && name.length() >= 2) {
-                if (currentPVName.isPresent()) {
-                    namesWithDisplayNames.add(new Pair<>(currentPVName.get(), name.substring(1,name.length()-1)));
-                    currentPVName = Optional.empty();
-                }
-            }
-            else {
-                if (currentPVName.isPresent()) {
-                    namesWithDisplayNames.add(new Pair<>(currentPVName.get(), currentPVName.get()));
-                }
-                currentPVName = currentPVName.of(name);
-            }
-        }
-        if (currentPVName.isPresent()) {
-            namesWithDisplayNames.add(new Pair<>(currentPVName.get(), currentPVName.get()));
-        }
         // Offer potential PV name in dialog so user can edit/cancel
         // sim://sine sim://ramp sim://noise
-        AddPVDialog addPVDialog = new AddPVDialog(namesWithDisplayNames.size(), model, false);
+        AddPVDialog addPVDialog = new AddPVDialog(pvNames.size(), model, false);
 
         { // Set layout of addPVDialog:
             int addPVDialogWidth = 750;
@@ -132,15 +113,15 @@ public static void addPVsToPlotDialog(List<String> names,
             DialogHelper.positionDialog(addPVDialog, nodeToPositionDialogOver, (int) -addPVDialowWindow.getWidth()/2, (int) -addPVDialowWindow.getHeight()/2);
         }
 
-        for (int i=0; i<namesWithDisplayNames.size(); ++i) {
-            addPVDialog.setNameAndDisplayName(i, namesWithDisplayNames.get(i));
+        for (int i=0; i<pvNames.size(); ++i) {
+            addPVDialog.setNameAndDisplayName(i, pvNames.get(i));
         }
 
         if (!addPVDialog.showAndWait().orElse(false)) {
             return;
         }
 
-        for (int i=0; i<namesWithDisplayNames.size(); ++i) {
+        for (int i=0; i<pvNames.size(); ++i) {
             AxisConfig axis = addPVDialog.getOrCreateAxis(model, undoableActionManager, addPVDialog.getAxisIndex(i));
             AddModelItemCommand.forPV(undoableActionManager,
                                       model,
diff --git a/app/databrowser/src/main/java/org/csstudio/trends/databrowser3/imports/SampleImportAction.java b/app/databrowser/src/main/java/org/csstudio/trends/databrowser3/imports/SampleImportAction.java
@@ -9,6 +9,7 @@
 
 import java.io.File;
 import java.text.MessageFormat;
+import java.util.Optional;
 
 import org.csstudio.trends.databrowser3.Activator;
 import org.csstudio.trends.databrowser3.Messages;
@@ -64,7 +65,7 @@ private void run()
             final ArchiveDataSource imported = new ArchiveDataSource(url, type);
             // Add PV Item with data to model
             AddModelItemCommand.forPV(op_manager, model,
-                                      type, type, Preferences.scan_period, axis, imported);
+                                      type, Optional.empty(), Preferences.scan_period, axis, imported);
         }
         catch (Exception ex)
         {
diff --git a/app/databrowser/src/main/java/org/csstudio/trends/databrowser3/ui/AddModelItemCommand.java b/app/databrowser/src/main/java/org/csstudio/trends/databrowser3/ui/AddModelItemCommand.java
@@ -8,6 +8,7 @@
 package org.csstudio.trends.databrowser3.ui;
 
 import java.text.MessageFormat;
+import java.util.Optional;
 
 import org.csstudio.trends.databrowser3.Messages;
 import org.csstudio.trends.databrowser3.model.ArchiveDataSource;
@@ -34,6 +35,7 @@ public class AddModelItemCommand extends UndoableAction
      *  @param operations_manager OperationsManager where command will be reg'ed
      *  @param model Model were PV is to be added
      *  @param pv_name Name of new PV
+     *  @param optional_display_name Optional Display Name to associate with the PV
      *  @param period scan period
      *  @param axis Axis
      *  @param archive Archive data source
@@ -43,7 +45,7 @@ public static AddModelItemCommand forPV(
             final UndoableActionManager operations_manager,
             final Model model,
             final String pv_name,
-            final String display_name,
+            final Optional<String> optional_display_name,
             final double period,
             final AxisConfig axis,
             final ArchiveDataSource archive)
@@ -53,7 +55,9 @@ public static AddModelItemCommand forPV(
         try
         {
             item = new PVItem(pv_name, period);
-            item.setDisplayName(display_name);
+            if (optional_display_name.isPresent()) {
+                item.setDisplayName(optional_display_name.get());
+            }
             if (archive != null)
                 item.addArchiveDataSource(archive);
             else
diff --git a/app/databrowser/src/main/java/org/csstudio/trends/databrowser3/ui/AddPVDialog.java b/app/databrowser/src/main/java/org/csstudio/trends/databrowser3/ui/AddPVDialog.java
@@ -10,6 +10,7 @@
 import java.text.MessageFormat;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
 import java.util.stream.Collectors;
 
 import javafx.scene.control.Button;
@@ -237,12 +238,13 @@ private Node createContent(final Model model, final int count)
 
     /** Set initial name. Only effective when called before dialog is opened.
      *  @param i Index
-     *  @param nameAndDisplayName Suggested name
+     *  @param pvName Suggested name
      */
-    public void setNameAndDisplayName(final int i, final Pair<String, String> nameAndDisplayName)
+    public void setNameAndDisplayName(final int i, final String pvName)
     {
-        nameAndDisplayNames.get(i).getKey().setText(nameAndDisplayName.getKey());
-        nameAndDisplayNames.get(i).getValue().setText(nameAndDisplayName.getValue());
+        nameAndDisplayNames.get(i).getKey().setText(pvName);
+        nameAndDisplayNames.get(i).getValue().setText("");
+        nameAndDisplayNames.get(i).getValue().setPromptText("Default");
     }
 
     /** @param i Index
@@ -254,11 +256,17 @@ public String getName(final int i)
     }
 
     /** @param i Index
-     *  @return Display name associated with PV
+     *  @return Optionally, the display name to be associated with the PV in the Data Browser
      */
-    public String getDisplayName(final int i)
+    public Optional<String> getDisplayName(final int i)
     {
-        return nameAndDisplayNames.get(i).getValue().getText().trim();
+        String trimmedDisplayName = nameAndDisplayNames.get(i).getValue().getText().trim();
+        if (trimmedDisplayName.isEmpty()) {
+            return Optional.empty();
+        }
+        else {
+            return Optional.of(trimmedDisplayName);
+        }
     }
 
     /** @param i Index
diff --git a/app/databrowser/src/main/java/org/csstudio/trends/databrowser3/ui/Controller.java b/app/databrowser/src/main/java/org/csstudio/trends/databrowser3/ui/Controller.java
@@ -279,7 +279,7 @@ public void droppedPVNames(List<ProcessVariable> names,
                 DialogHelper.positionDialog(dlg, plot.getPlot(), -200, -200);
                 for (int i=0; i<names.size(); ++i) {
                     String pvName = names.get(i).getName();
-                    dlg.setNameAndDisplayName(i, new Pair(pvName, pvName));
+                    dlg.setNameAndDisplayName(i, pvName);
                 }
                 if (! dlg.showAndWait().orElse(false))
                     return;
diff --git a/app/databrowser/src/main/java/org/csstudio/trends/databrowser3/ui/search/AddToPlotAction.java b/app/databrowser/src/main/java/org/csstudio/trends/databrowser3/ui/search/AddToPlotAction.java
@@ -8,6 +8,7 @@
 package org.csstudio.trends.databrowser3.ui.search;
 
 import java.util.List;
+import java.util.Optional;
 
 import javafx.util.Pair;
 import org.csstudio.trends.databrowser3.Activator;
@@ -50,7 +51,7 @@ public AddToPlotAction(final Node node, final Model model, final UndoableActionM
             DialogHelper.positionDialog(dlg, node, 200, -200);
             for (int i=0; i<channels.size(); ++i) {
                 String channelName = channels.get(i).getName();
-                dlg.setNameAndDisplayName(i, new Pair(channelName, channelName));
+                dlg.setNameAndDisplayName(i, channelName);
             }
             if (! dlg.showAndWait().orElse(false))
                 return;
@@ -61,7 +62,7 @@ public AddToPlotAction(final Node node, final Model model, final UndoableActionM
                 final AxisConfig axis = dlg.getOrCreateAxis(model, undo, dlg.getAxisIndex(i));
                 AddModelItemCommand.forPV(undo, model,
                         channel.getName(),
-                        channel.getName(),
+                        Optional.empty(),
                         0.0,
                         axis,
                         channel.getArchiveDataSource());

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`
`10`	`10`	`import java.io.File;`
`11`	`11`	`import java.text.MessageFormat;`
	`12`	`+import java.util.Optional;`
`12`	`13`
`13`	`14`	`import org.csstudio.trends.databrowser3.Activator;`
`14`	`15`	`import org.csstudio.trends.databrowser3.Messages;`
`@@ -64,7 +65,7 @@ private void run()`
`64`	`65`	`final ArchiveDataSource imported = new ArchiveDataSource(url, type);`
`65`	`66`	`// Add PV Item with data to model`
`66`	`67`	`AddModelItemCommand.forPV(op_manager, model,`
`67`		`- type, type, Preferences.scan_period, axis, imported);`
	`68`	`+ type, Optional.empty(), Preferences.scan_period, axis, imported);`
`68`	`69`	`}`
`69`	`70`	`catch (Exception ex)`
`70`	`71`	`{`
Original file line number	Diff line number	Diff line change
`@@ -279,7 +279,7 @@ public void droppedPVNames(List<ProcessVariable> names,`
`279`	`279`	`DialogHelper.positionDialog(dlg, plot.getPlot(), -200, -200);`
`280`	`280`	`for (int i=0; i<names.size(); ++i) {`
`281`	`281`	`String pvName = names.get(i).getName();`
`282`		`- dlg.setNameAndDisplayName(i, new Pair(pvName, pvName));`
	`282`	`+ dlg.setNameAndDisplayName(i, pvName);`
`283`	`283`	`}`
`284`	`284`	`if (! dlg.showAndWait().orElse(false))`
`285`	`285`	`return;`