Merge pull request #3195 from ControlSystemStudio/CSSTUDIO-2572

CSSTUDIO-2572: Add a "Jump to Log Entry" TextField to the Logbook application
ControlSystemStudio · Nov 20, 2024 · 8559774 · 8559774
2 parents e660df0 + 3eb00b2
commit 8559774
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 7 deletions.
diff --git a/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/LogEntryDisplayController.java b/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/LogEntryDisplayController.java
@@ -27,6 +27,7 @@
 import javafx.fxml.FXML;
 import javafx.scene.Node;
 import javafx.scene.control.Button;
+import javafx.scene.control.TextField;
 import javafx.scene.control.ToggleButton;
 import javafx.scene.control.ToolBar;
 import javafx.scene.image.ImageView;
@@ -40,9 +41,14 @@
 import org.phoebus.olog.es.api.model.OlogLog;
 import org.phoebus.ui.javafx.ImageCache;
 
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
 
 public class LogEntryDisplayController {
 
+    static Logger log = Logger.getLogger(LogEntryDisplayController.class.getName());
+
     @FXML
     @SuppressWarnings("unused")
     private SingleLogEntryDisplayController singleLogEntryDisplayController;
@@ -69,6 +75,8 @@ public class LogEntryDisplayController {
     private Node singleLogEntryDisplay;
     @FXML
     private Node mergedLogEntryDisplay;
+    @FXML
+    private TextField jumpToLogEntryTextField;
 
     ImageView goBackButtonIcon = ImageCache.getImageView(LogEntryDisplayController.class, "/icons/backward_nav.png");
     ImageView goBackButtonIconDisabled = ImageCache.getImageView(LogEntryDisplayController.class, "/icons/backward_disabled.png");
@@ -112,6 +120,19 @@ public void initialize() {
             goForwardButton.disableProperty().addListener(goForwardButtonDisabledPropertyChangeListener);
             goForwardButtonDisabledPropertyChangeListener.changed(goForwardButton.disableProperty(), false, true);
         }
+
+        jumpToLogEntryTextField.setPromptText(Messages.LogEntryID);
+        jumpToLogEntryTextField.focusedProperty().addListener((property, oldValue, newValue) -> {
+            if (oldValue && !newValue) {
+                // When clicking away without first pressing enter, restore the current value of jumpToLogEntryTextField:
+                if (logEntryProperty.get() != null) {
+                    jumpToLogEntryTextField.setText(logEntryProperty.get().getId().toString());
+                }
+                else {
+                    jumpToLogEntryTextField.setText("");
+                }
+            }
+        });
     }
 
     @FXML
@@ -133,6 +154,28 @@ public void showHideLogEntryGroup() {
         }
     }
 
+    @FXML
+    public void jumpToLogEntry() {
+        String logEntryIDToJumpToString = jumpToLogEntryTextField.getText();
+        long logEntryIDToJumpTo;
+        try {
+            logEntryIDToJumpTo = Long.parseLong(logEntryIDToJumpToString);
+        }
+        catch (NumberFormatException numberFormatException) {
+            return;
+        }
+
+        if (logEntryIDToJumpTo > 0) {
+            if (logEntryTableViewController.goBackAndGoForwardActions.isPresent()) {
+                boolean success = logEntryTableViewController.goBackAndGoForwardActions.get().loadLogEntryWithID(logEntryIDToJumpTo);
+                if (!success) {
+                    log.log(Level.WARNING, "Error loading entry with log entry ID: " + logEntryIDToJumpTo + ".");
+                }
+            }
+        }
+        Platform.runLater(() -> jumpToLogEntryTextField.end());
+    }
+
     @FXML
     public void reply() {
         // Show a new editor dialog. When user selects to save the reply entry, update the original log entry
@@ -175,7 +218,8 @@ public void setLogEntry(LogEntry logEntry) {
                 currentViewProperty.set(SINGLE);
                 showHideLogEntryGroupButton.selectedProperty().set(false);
                 hasLinkedEntriesProperty.set(logEntry.getProperties()
-                        .stream().anyMatch(p -> p.getName().equals(LogGroupProperty.NAME)));;
+                        .stream().anyMatch(p -> p.getName().equals(LogGroupProperty.NAME)));
+                jumpToLogEntryTextField.setText(logEntryProperty.get().getId().toString());
             });
         }
     }

diff --git a/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/LogEntryTable.java b/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/LogEntryTable.java
@@ -172,12 +172,17 @@ private void addGoForwardAction() {
             }
         }
 
-        private void loadLogEntryWithID(Long id) {
-            goForwardActions.clear();
-            addGoBackAction();
-
-            LogEntry logEntry = controller.client.getLog(id);
-            gotoLogEntry(logEntry);
+        protected boolean loadLogEntryWithID(Long id) {
+            try {
+                LogEntry logEntry = controller.client.getLog(id);
+                goForwardActions.clear();
+                addGoBackAction();
+                gotoLogEntry(logEntry);
+                return true;
+            }
+            catch (RuntimeException runtimeException) {
+                return false;
+            }
         }
 
         protected void goBack() {

diff --git a/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/Messages.java b/app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/Messages.java
@@ -38,12 +38,14 @@ public class Messages
             Forward,
             GroupingFailed,
             GroupSelectedEntries,
+            JumpToLogEntry,
             Level,
             Logbook,
             LogbookNotSupported,
             LogbooksSearchFailTitle,
             LogbookServiceUnavailableTitle,
             LogbookServiceHasNoLogbooks,
+            LogEntryID,
             NewLogEntry,
             NoAttachments,
             NoClipboardContent,

diff --git a/app/logbook/olog/ui/src/main/resources/org/phoebus/logbook/olog/ui/LogEntryDisplay.fxml b/app/logbook/olog/ui/src/main/resources/org/phoebus/logbook/olog/ui/LogEntryDisplay.fxml
@@ -33,6 +33,8 @@
                 <ToggleButton fx:id="showHideLogEntryGroupButton" contentDisplay="RIGHT" mnemonicParsing="false"
                               text="%ShowHideLogEntryGroup" disable="true" onAction="#showHideLogEntryGroup"/>
                 <Region fx:id="spring" /> <!-- Spring to make the next elements right-aligned. -->
+                <Label text="%JumpToLogEntry" />
+                <TextField fx:id="jumpToLogEntryTextField" onAction="#jumpToLogEntry" alignment="CENTER_LEFT" prefWidth="100"/>
                 <Button fx:id="goBackButton" mnemonicParsing="false"
                         onAction="#goBack" text="%Back" disable="true" />
                 <Button fx:id="goForwardButton" mnemonicParsing="false"

diff --git a/app/logbook/olog/ui/src/main/resources/org/phoebus/logbook/olog/ui/messages.properties b/app/logbook/olog/ui/src/main/resources/org/phoebus/logbook/olog/ui/messages.properties
@@ -55,6 +55,7 @@ Help=Help
 HitsPerPage=Hits per page:
 ImageWidth=Width
 ImageHeight=Height
+JumpToLogEntry=Jump to Log Entry: 
 Level=Level
 Logbook=Logbook
 Logbooks=Logbooks:
@@ -64,6 +65,7 @@ LogbookServiceHasNoLogbooks=Logbook service "{0}" has no logbooks or is not avai
 LogbooksSearchFailTitle=Logbook Search Error
 LogbooksTitle=Select Logbooks
 LogbooksTooltip=Add logbook to the log entry.
+LogEntryID=Log Entry ID
 NoClipboardContent=Clipboard does not contain any content that may be added as attachment.
 NoAttachments=No Attachments
 NoProperties=No Properties