CSSTUDIO-2071 & CSSTUDIO-2081: Add options to copy & append PV names (with descriptions) to Display Runtime & to WidgetInfoDialog

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

@@ -42,6 +42,7 @@ public class Messages
                          BoolButtonError_Body,
                          BoolButtonError_Title,
                          Blue,
+                         Cancel,
                          ColorDialog_Current,
                          ColorDialog_Custom,
                          ColorDialog_Default,
@@ -62,6 +63,12 @@ public class Messages
                          ConvertToEmbeddedJavaScript,
                          ConvertToEmbeddedPython,
                          ConvertToScriptFile,
+                         CopyPVName,
+                         CopyPVNames,
+                         CopyPVNameAndDescription,
+                         CopyPVNamesAndDescriptions,
+                         Description,
+                         DeSelectAll,
                          Edit,
                          ExportWidgetInfo,
                          ExportFailed,
@@ -102,6 +109,7 @@ public class Messages
                          PointsTable_Empty,
                          PointsTable_X,
                          PointsTable_Y,
+                         PVName,
                          Red,
                          Remove,
                          Row,
@@ -136,6 +144,7 @@ public class Messages
                          ScriptsDialog_ScriptsTT,
                          ScriptsDialog_Title,
                          Select,
+                         SelectAll,
                          ShowConfirmationDialogTitle,
                          ShowErrorDialogTitle,
                          ShowMessageDialogTitle,

app/display/representation-javafx/src/main/resources/org/csstudio/display/builder/representation/javafx/messages.properties

@@ -24,6 +24,7 @@ Alpha=Alpha
 Blue=Blue
 BoolButtonError_Body=Confirmation dialog supported only for toggle mode.
 BoolButtonError_Title=Unsupported configuration
+Cancel=Cancel
 ColorDialog_Current=Current
 ColorDialog_Custom=Custom Color
 ColorDialog_Default=Default
@@ -45,6 +46,12 @@ ConvertToEmbeddedJavaScript=Convert to Embedded JavaScript\u2026
 ConvertToEmbeddedPython=Convert to Embedded Python\u2026
 ConvertToScriptFile=Convert to Script File
 Copy=Copy
+CopyPVName=Copy PV Name
+CopyPVNames=Copy PV Names
+CopyPVNameAndDescription=Copy PV Name & Description
+CopyPVNamesAndDescriptions=Copy PV Names & Descriptions
+Description=Description
+DeSelectAll=De-Select All
 Duplicate=Duplicate
 Edit=Edit\u2026 
 ExportWidgetInfo=Export to file
@@ -84,6 +91,7 @@ PointsDialog_Title=Edit Points
 PointsTable_Empty=No points
 PointsTable_X=X
 PointsTable_Y=Y
+PVName=PV Name
 Red=Red
 Remove=Remove
 Row=Row
@@ -118,6 +126,7 @@ ScriptsDialog_PythonScriptFile=my_script.py
 ScriptsDialog_ScriptsTT=Select external script file or edit embedded script text
 ScriptsDialog_Title=Scripts
 Select=Select\u2026
+SelectAll=Select All
 ShowConfirmationDialogTitle=Please Confirm
 ShowErrorDialogTitle=Error
 ShowMessageDialogTitle=Message

app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/ContextMenuAppendPvToClipboard.java

@@ -0,0 +1,52 @@
+package org.csstudio.display.builder.runtime;
+
+import javafx.scene.image.Image;
+import javafx.scene.input.Clipboard;
+import javafx.scene.input.ClipboardContent;
+import org.phoebus.core.types.ProcessVariable;
+import org.phoebus.framework.selection.Selection;
+import org.phoebus.ui.javafx.ImageCache;
+import org.phoebus.ui.spi.ContextMenuEntry;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class ContextMenuAppendPvToClipboard implements ContextMenuEntry {
+    @Override
+    public String getName() {
+        return Messages.AppendPVNameToClipboard;
+    }
+
+    private Image icon = ImageCache.getImage(ImageCache.class, "/icons/copy.png");
+    @Override
+    public Image getIcon() {
+        return icon;
+    }
+
+    @Override
+    public Class<?> getSupportedType() {
+        return ProcessVariable.class;
+    }
+
+    @Override
+    public void call(final Selection selection)
+    {
+        List<ProcessVariable> pvs = selection.getSelections();
+        String pvNamesToAppendToClipboard = pvs.stream().map(ProcessVariable::getName).collect(Collectors.joining(System.lineSeparator()));
+
+        Clipboard clipboard = Clipboard.getSystemClipboard();
+        String newContentInClipboard;
+        {
+            String existingContentInClipboard;
+            if (clipboard.hasString()) {
+                existingContentInClipboard = clipboard.getString() + "\n";
+            } else {
+                existingContentInClipboard = "";
+            }
+            newContentInClipboard = existingContentInClipboard + pvNamesToAppendToClipboard;
+        }
+        ClipboardContent newContent = new ClipboardContent();
+        newContent.putString(newContentInClipboard);
+        clipboard.setContent(newContent);
+    }
+}

app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/ContextMenuAppendPvToClipboardWithDescription.java

@@ -0,0 +1,205 @@
+package org.csstudio.display.builder.runtime;
+
+import javafx.application.Platform;
+import javafx.scene.control.Alert;
+import javafx.scene.control.Button;
+import javafx.scene.control.ButtonType;
+import javafx.scene.control.ScrollPane;
+import javafx.scene.control.TextField;
+import javafx.scene.control.Tooltip;
+import javafx.scene.image.Image;
+import javafx.scene.input.Clipboard;
+import javafx.scene.input.ClipboardContent;
+import javafx.scene.input.KeyCode;
+import javafx.scene.layout.ColumnConstraints;
+import javafx.scene.layout.GridPane;
+import javafx.scene.layout.Priority;
+import javafx.scene.layout.Region;
+import javafx.scene.text.Text;
+import javafx.stage.Window;
+import javafx.util.Pair;
+import org.csstudio.display.builder.runtime.app.DisplayRuntimeInstance;
+import org.phoebus.core.types.ProcessVariable;
+import org.phoebus.framework.selection.Selection;
+import org.phoebus.ui.dialog.DialogHelper;
+import org.phoebus.ui.docking.DockItem;
+import org.phoebus.ui.docking.DockPane;
+import org.phoebus.ui.javafx.ImageCache;
+import org.phoebus.ui.spi.ContextMenuEntry;
+
+import java.util.List;
+import java.util.Optional;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.FutureTask;
+import java.util.function.BiConsumer;
+import java.util.stream.Collectors;
+
+public class ContextMenuAppendPvToClipboardWithDescription implements ContextMenuEntry {
+    @Override
+    public String getName() {
+        return Messages.AppendPVNameToClipboardWithDescription;
+    }
+
+    private Image icon = ImageCache.getImage(ImageCache.class, "/icons/copy.png");
+    @Override
+    public Image getIcon() {
+        return icon;
+    }
+
+    @Override
+    public Class<?> getSupportedType() {
+        return ProcessVariable.class;
+    }
+
+    @Override
+    public void call(final Selection selection)
+    {
+        List<ProcessVariable> pvs = selection.getSelections();
+        String pvNamesToAppendToClipboard = pvs.stream().map(ProcessVariable::getName).collect(Collectors.joining(System.lineSeparator()));
+
+        String defaultDescription;
+        {
+            var activeDockPane = DockPane.getActiveDockPane();
+            var activeDockItem = (DockItem) activeDockPane.getSelectionModel().getSelectedItem();
+            if (activeDockItem.getApplication() instanceof DisplayRuntimeInstance) {
+                DisplayRuntimeInstance displayRuntimeInstance = (DisplayRuntimeInstance) activeDockItem.getApplication();
+                defaultDescription = displayRuntimeInstance.getDisplayName();
+            }
+            else {
+                defaultDescription = "";
+            }
+        }
+
+        BiConsumer<String, String> appendPVAndDescriptionToClipboardContinuation = (pvName, description) -> {
+            Clipboard clipboard = Clipboard.getSystemClipboard();
+            String newContentInClipboard;
+            {
+                String existingContentInClipboard;
+                if (clipboard.hasString()) {
+                    existingContentInClipboard = clipboard.getString() + "\n";
+                } else {
+                    existingContentInClipboard = "";
+                }
+                newContentInClipboard = existingContentInClipboard + pvName + "," + description;
+            }
+            ClipboardContent newContent = new ClipboardContent();
+            newContent.putString(newContentInClipboard);
+            clipboard.setContent(newContent);
+        };
+
+        String pvName = pvNamesToAppendToClipboard;
+
+        addDescriptionToPvNameModalDialog(pvName,
+                                          defaultDescription,
+                                          "Append",
+                                          appendPVAndDescriptionToClipboardContinuation);
+    }
+
+    public static void addDescriptionToPvNameModalDialog(String pvName,
+                                                         String defaultDescription,
+                                                         String acceptButtonText,
+                                                         BiConsumer continuation) {
+        Window windowToPositionTheConfirmationDialogOver = DockPane.getActiveDockPane().getScene().getWindow();
+
+        ButtonType acceptButtonType = new ButtonType(acceptButtonText);
+        ButtonType cancelButtonType = new ButtonType("Cancel");
+
+        FutureTask<Optional<Pair<String, String>>> displayConfirmationWindow = new FutureTask(() -> {
+            Alert prompt = new Alert(Alert.AlertType.NONE);
+
+            prompt.getDialogPane().getButtonTypes().add(cancelButtonType);
+            Button cancelButton = (Button) prompt.getDialogPane().lookupButton(cancelButtonType);
+            cancelButton.setTooltip(new Tooltip(cancelButton.getText()));
+
+            prompt.getDialogPane().getButtonTypes().add(acceptButtonType);
+            Button acceptButton = (Button) prompt.getDialogPane().lookupButton(acceptButtonType);
+            acceptButton.setTooltip(new Tooltip(acceptButton.getText()));
+
+            GridPane gridPane = new GridPane();
+            gridPane.setPrefWidth(Double.MAX_VALUE);
+            gridPane.setVgap(4);
+
+            ColumnConstraints firstColumnColumnConstraints = new ColumnConstraints();
+            gridPane.getColumnConstraints().add(0, firstColumnColumnConstraints);
+            ColumnConstraints secondColumnColumnConstraints = new ColumnConstraints();
+            secondColumnColumnConstraints.setHgrow(Priority.ALWAYS);
+            secondColumnColumnConstraints.setFillWidth(true);
+            gridPane.getColumnConstraints().add(1, secondColumnColumnConstraints);
+
+            int currentRow = 0;
+
+            Text pvNameLabelText = new Text("PV Name: ");
+            pvNameLabelText.setStyle("-fx-font-size: 14; -fx-font-weight: bold; ");
+            gridPane.add(pvNameLabelText, 0, currentRow);
+
+            Text pvNameText = new Text(pvName);
+            pvNameText.setStyle("-fx-font-size: 14; -fx-font-style: italic; ");
+            gridPane.add(pvNameText, 1, currentRow);
+            currentRow++;
+
+            Text descriptionLabelText = new Text("Description: ");
+            descriptionLabelText.setStyle("-fx-font-size: 14; -fx-font-weight: bold; ");
+            gridPane.add(descriptionLabelText, 0, currentRow);
+
+            TextField descriptionText = new TextField(defaultDescription);
+            descriptionText.setStyle("-fx-font-size: 14; ");
+            descriptionText.setOnKeyPressed(keyEvent -> {
+                if (keyEvent.getCode() == KeyCode.ENTER) {
+                    keyEvent.consume();
+                    acceptButton.fire();
+                }
+            });
+            gridPane.add(descriptionText, 1, currentRow);
+            currentRow++;
+
+            prompt.getDialogPane().setOnKeyPressed(keyEvent -> {
+                if (keyEvent.getCode() == KeyCode.ESCAPE) {
+                    keyEvent.consume();
+                    cancelButton.fire();
+                }
+            });
+
+            ScrollPane scrollPane = new ScrollPane();
+            scrollPane.setContent(gridPane);
+
+            prompt.getDialogPane().setContent(gridPane);
+
+            prompt.setHeaderText("Append PV Name with Description to the Clipboard");
+            prompt.setTitle("Append PV Name with Description to the Clipboard");
+
+            int prefWidth = 500;
+            int prefHeight = 150;
+            prompt.getDialogPane().setPrefSize(prefWidth, prefHeight);
+            prompt.getDialogPane().setMinSize(Region.USE_PREF_SIZE, Region.USE_PREF_SIZE);
+            prompt.setResizable(false);
+
+            DialogHelper.positionDialog(prompt, windowToPositionTheConfirmationDialogOver.getScene().getRoot(), -prefWidth/2, -prefHeight/2);
+            descriptionText.requestFocus();
+            descriptionText.selectAll();
+
+            if (prompt.showAndWait().orElse(ButtonType.CANCEL) == acceptButtonType) {
+                String description = descriptionText.getText();
+                Pair<String, String> pvNameAndDescription = new Pair<>(pvName, description);
+                return Optional.of(pvNameAndDescription);
+            }
+            else {
+                return Optional.empty();
+            }
+        });
+
+        if (Platform.isFxApplicationThread()) {
+            displayConfirmationWindow.run();
+        }
+        else {
+            Platform.runLater(displayConfirmationWindow);
+        }
+        try {
+            Optional<Pair<String, String>> maybePVNameAndDescription = displayConfirmationWindow.get();
+            maybePVNameAndDescription.ifPresent(pair -> continuation.accept(pair.getKey(), pair.getValue()));
+        } catch (ExecutionException e) {
+            ;    // Do nothing.
+        } catch (InterruptedException e) {
+            ;    // Do nothing.
+        }
+    }
+}

app/probe/src/main/java/org/phoebus/applications/probe/ContextMenuPvAndValueToClipboard.java → app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/ContextMenuCopyPvAndValueToClipboard.java

@@ -5,13 +5,13 @@
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *******************************************************************************/
-package org.phoebus.applications.probe;
-
-import static org.phoebus.applications.probe.Probe.logger;
+package org.csstudio.display.builder.runtime;
 
 import java.util.List;
 import java.util.logging.Level;
 
+import static org.csstudio.display.builder.runtime.WidgetRuntime.logger;
+
 import org.epics.vtype.Alarm;
 import org.epics.vtype.AlarmSeverity;
 import org.epics.vtype.Time;
@@ -27,7 +27,7 @@
  *  @author Kay Kasemir
  */
 @SuppressWarnings("nls")
-public class ContextMenuPvAndValueToClipboard extends ContextMenuPvToClipboard
+public class ContextMenuCopyPvAndValueToClipboard extends ContextMenuCopyPvToClipboard
 {
     @Override
     public String getName()

app/probe/src/main/java/org/phoebus/applications/probe/ContextMenuPvToClipboard.java → app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/ContextMenuCopyPvToClipboard.java

@@ -5,7 +5,7 @@
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *******************************************************************************/
-package org.phoebus.applications.probe;
+package org.csstudio.display.builder.runtime;
 
 import java.util.List;
 import java.util.stream.Collectors;
@@ -27,7 +27,7 @@
  *  @author Kay Kasemir
  */
 @SuppressWarnings("nls")
-public class ContextMenuPvToClipboard implements ContextMenuEntry
+public class ContextMenuCopyPvToClipboard implements ContextMenuEntry
 {
     private static final Class<?> supportedTypes = ProcessVariable.class;