Convert some fields to TextArea (#11886)

* Add custom paste behavior to EditorTextField * Changed TextArea to TextField for CleanupUrlMenu * Changed TextArea to TextField in UrlEditor * Changed DOI menu to accept textfield instead of textarea * Changed TextArea into TextField in the IdentifierEditor * Changed TextArea into TextField in the ISSN editor * Changed TextArea into TextField in the OwnerEditor * Added fix CHANGELOG.md * Modified the name to additionalPasteActionHandler and removed comments * Update src/main/java/org/jabref/gui/fieldeditors/contextmenu/EditorMenus.java * Add kbd around Tab * Changed the interface to Runnable and removed the unused PasteActionHandler interface --------- Co-authored-by: Oliver Kopp <[email protected]>
JabRef · Oct 13, 2024 · 8404312 · 8404312
1 parent 70a8ff3
commit 8404312
Show file tree

Hide file tree

Showing 13 changed files with 61 additions and 53 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -88,6 +88,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We fixed an issue where the Undo/Redo buttons were active even when all libraries are closed. [#11837](https://github.com/JabRef/jabref/issues/11837)
 - We fixed an issue where recently opened files were not displayed in the main menu properly. [#9042](https://github.com/JabRef/jabref/issues/9042)
 - We fixed an issue where the DOI lookup would show an error when a DOI was found for an entry. [#11850](https://github.com/JabRef/jabref/issues/11850)
+- We fixed an issue where <kbd>Tab</kbd> cannot be used to jump to next field in some single-line fields. [#11785](https://github.com/JabRef/jabref/issues/11785)
 
 ### Removed
 

diff --git a/src/main/java/org/jabref/gui/edit/CopyDoiUrlAction.java b/src/main/java/org/jabref/gui/edit/CopyDoiUrlAction.java
@@ -2,7 +2,7 @@
 
 import java.util.Optional;
 
-import javafx.scene.control.TextArea;
+import javafx.scene.control.TextField;
 
 import org.jabref.gui.ClipBoardManager;
 import org.jabref.gui.DialogService;
@@ -16,12 +16,12 @@
  */
 public class CopyDoiUrlAction extends SimpleCommand {
 
-    private final TextArea component;
+    private final TextField component;
     private final StandardActions action;
     private final DialogService dialogService;
     private final ClipBoardManager clipBoardManager;
 
-    public CopyDoiUrlAction(TextArea component, StandardActions action, DialogService dialogService, ClipBoardManager clipBoardManager) {
+    public CopyDoiUrlAction(TextField component, StandardActions action, DialogService dialogService, ClipBoardManager clipBoardManager) {
         this.component = component;
         this.action = action;
         this.dialogService = dialogService;

diff --git a/src/main/java/org/jabref/gui/fieldeditors/EditorTextArea.java b/src/main/java/org/jabref/gui/fieldeditors/EditorTextArea.java
@@ -21,7 +21,7 @@ public class EditorTextArea extends TextArea implements Initializable, ContextMe
     /**
      * Variable that contains user-defined behavior for paste action.
      */
-    private PasteActionHandler pasteActionHandler = () -> {
+    private Runnable pasteActionHandler = () -> {
         // Set empty paste behavior by default
     };
 
@@ -57,7 +57,7 @@ public void initialize(URL location, ResourceBundle resources) {
      *
      * @param handler an instance of PasteActionHandler that describes paste behavior
      */
-    public void setPasteActionHandler(PasteActionHandler handler) {
+    public void setPasteActionHandler(Runnable handler) {
         Objects.requireNonNull(handler);
         this.pasteActionHandler = handler;
     }
@@ -68,14 +68,6 @@ public void setPasteActionHandler(PasteActionHandler handler) {
     @Override
     public void paste() {
         super.paste();
-        pasteActionHandler.handle();
-    }
-
-    /**
-     * Interface presents user-described paste behaviour applying to paste method
-     */
-    @FunctionalInterface
-    public interface PasteActionHandler {
-        void handle();
+        pasteActionHandler.run();
     }
 }
diff --git a/src/main/java/org/jabref/gui/fieldeditors/EditorTextField.java b/src/main/java/org/jabref/gui/fieldeditors/EditorTextField.java
@@ -2,6 +2,7 @@
 
 import java.net.URL;
 import java.util.List;
+import java.util.Objects;
 import java.util.ResourceBundle;
 import java.util.function.Supplier;
 
@@ -19,6 +20,9 @@
 public class EditorTextField extends TextField implements Initializable, ContextMenuAddable {
 
     private final ContextMenu contextMenu = new ContextMenu();
+    private Runnable additionalPasteActionHandler = () -> {
+        // No additional paste behavior
+    };
 
     public EditorTextField() {
         this("");
@@ -47,4 +51,15 @@ public void initContextMenu(final Supplier<List<MenuItem>> items, KeyBindingRepo
     public void initialize(URL location, ResourceBundle resources) {
         // not needed
     }
+
+    public void setAdditionalPasteActionHandler(Runnable handler) {
+        Objects.requireNonNull(handler);
+        this.additionalPasteActionHandler = handler;
+    }
+
+    @Override
+    public void paste() {
+        super.paste();
+        additionalPasteActionHandler.run();
+    }
 }
diff --git a/src/main/java/org/jabref/gui/fieldeditors/ISSNEditor.fxml b/src/main/java/org/jabref/gui/fieldeditors/ISSNEditor.fxml
@@ -3,11 +3,11 @@
 <?import javafx.scene.control.Button?>
 <?import javafx.scene.control.Tooltip?>
 <?import javafx.scene.layout.HBox?>
-<?import org.jabref.gui.fieldeditors.EditorTextArea?>
+<?import org.jabref.gui.fieldeditors.EditorTextField?>
 <?import org.jabref.gui.icon.JabRefIconView?>
 <fx:root xmlns:fx="http://javafx.com/fxml/1" type="HBox" xmlns="http://javafx.com/javafx/8.0.112"
          fx:controller="org.jabref.gui.fieldeditors.ISSNEditor">
-    <EditorTextArea fx:id="textArea"/>
+    <EditorTextField fx:id="textField"/>
         <Button fx:id="journalInfoButton"
                 onAction="#showJournalInfo"
                 styleClass="icon-button">

diff --git a/src/main/java/org/jabref/gui/fieldeditors/ISSNEditor.java b/src/main/java/org/jabref/gui/fieldeditors/ISSNEditor.java
@@ -27,7 +27,7 @@
 
 public class ISSNEditor extends HBox implements FieldEditorFX {
     @FXML private ISSNEditorViewModel viewModel;
-    @FXML private EditorTextArea textArea;
+    @FXML private EditorTextField textField;
     @FXML private Button journalInfoButton;
     @FXML private Button fetchInformationByIdentifierButton;
 
@@ -60,9 +60,9 @@ public ISSNEditor(Field field,
                 stateManager,
                 preferences);
 
-        establishBinding(textArea, viewModel.textProperty(), keyBindingRepository, undoAction, redoAction);
-        textArea.initContextMenu(new DefaultMenu(textArea), keyBindingRepository);
-        new EditorValidator(preferences).configureValidation(viewModel.getFieldValidator().getValidationStatus(), textArea);
+        establishBinding(textField, viewModel.textProperty(), keyBindingRepository, undoAction, redoAction);
+        textField.initContextMenu(new DefaultMenu(textField), keyBindingRepository);
+        new EditorValidator(preferences).configureValidation(viewModel.getFieldValidator().getValidationStatus(), textField);
     }
 
     public ISSNEditorViewModel getViewModel() {
@@ -82,7 +82,7 @@ public Parent getNode() {
 
     @Override
     public void requestFocus() {
-        textArea.requestFocus();
+        textField.requestFocus();
     }
 
     @FXML

diff --git a/src/main/java/org/jabref/gui/fieldeditors/OwnerEditor.fxml b/src/main/java/org/jabref/gui/fieldeditors/OwnerEditor.fxml
@@ -3,11 +3,11 @@
 <?import javafx.scene.control.Button?>
 <?import javafx.scene.control.Tooltip?>
 <?import javafx.scene.layout.HBox?>
-<?import org.jabref.gui.fieldeditors.EditorTextArea?>
+<?import org.jabref.gui.fieldeditors.EditorTextField?>
 <?import org.jabref.gui.icon.JabRefIconView?>
 <fx:root xmlns:fx="http://javafx.com/fxml/1" type="HBox" xmlns="http://javafx.com/javafx/8.0.112"
          fx:controller="org.jabref.gui.fieldeditors.OwnerEditor">
-    <EditorTextArea fx:id="textArea" prefHeight="0.0" HBox.hgrow="ALWAYS"/>
+    <EditorTextField fx:id="textField" prefHeight="0.0" HBox.hgrow="ALWAYS"/>
     <Button onAction="#setOwner"
             styleClass="icon-button">
         <graphic>

diff --git a/src/main/java/org/jabref/gui/fieldeditors/OwnerEditor.java b/src/main/java/org/jabref/gui/fieldeditors/OwnerEditor.java
@@ -22,7 +22,7 @@
 public class OwnerEditor extends HBox implements FieldEditorFX {
 
     @FXML private OwnerEditorViewModel viewModel;
-    @FXML private EditorTextArea textArea;
+    @FXML private EditorTextField textField;
 
     @Inject private GuiPreferences preferences;
     @Inject private KeyBindingRepository keyBindingRepository;
@@ -38,9 +38,9 @@ public OwnerEditor(Field field,
                   .load();
 
         this.viewModel = new OwnerEditorViewModel(field, suggestionProvider, preferences, fieldCheckers, undoManager);
-        establishBinding(textArea, viewModel.textProperty(), keyBindingRepository, undoAction, redoAction);
-        textArea.initContextMenu(EditorMenus.getNameMenu(textArea), keyBindingRepository);
-        new EditorValidator(preferences).configureValidation(viewModel.getFieldValidator().getValidationStatus(), textArea);
+        establishBinding(textField, viewModel.textProperty(), keyBindingRepository, undoAction, redoAction);
+        textField.initContextMenu(EditorMenus.getNameMenu(textField), keyBindingRepository);
+        new EditorValidator(preferences).configureValidation(viewModel.getFieldValidator().getValidationStatus(), textField);
     }
 
     public OwnerEditorViewModel getViewModel() {

diff --git a/src/main/java/org/jabref/gui/fieldeditors/UrlEditor.fxml b/src/main/java/org/jabref/gui/fieldeditors/UrlEditor.fxml
@@ -3,11 +3,11 @@
 <?import javafx.scene.control.Button?>
 <?import javafx.scene.control.Tooltip?>
 <?import javafx.scene.layout.HBox?>
-<?import org.jabref.gui.fieldeditors.EditorTextArea?>
+<?import org.jabref.gui.fieldeditors.EditorTextField?>
 <?import org.jabref.gui.icon.JabRefIconView?>
 <fx:root xmlns:fx="http://javafx.com/fxml/1" type="HBox" xmlns="http://javafx.com/javafx/8.0.112"
          fx:controller="org.jabref.gui.fieldeditors.UrlEditor">
-    <EditorTextArea fx:id="textArea" prefHeight="0.0" HBox.hgrow="ALWAYS"/>
+    <EditorTextField fx:id="textField" prefHeight="0.0" HBox.hgrow="ALWAYS"/>
     <Button disable="${controller.viewModel.validUrlIsNotPresent}" onAction="#openExternalLink"
             styleClass="icon-button">
         <graphic>

diff --git a/src/main/java/org/jabref/gui/fieldeditors/UrlEditor.java b/src/main/java/org/jabref/gui/fieldeditors/UrlEditor.java
@@ -30,7 +30,7 @@
 public class UrlEditor extends HBox implements FieldEditorFX {
 
     @FXML private final UrlEditorViewModel viewModel;
-    @FXML private EditorTextArea textArea;
+    @FXML private EditorTextField textField;
 
     @Inject private DialogService dialogService;
     @Inject private GuiPreferences preferences;
@@ -48,15 +48,15 @@ public UrlEditor(Field field,
 
         this.viewModel = new UrlEditorViewModel(field, suggestionProvider, dialogService, preferences, fieldCheckers, undoManager);
 
-        establishBinding(textArea, viewModel.textProperty(), keyBindingRepository, undoAction, redoAction);
+        establishBinding(textField, viewModel.textProperty(), keyBindingRepository, undoAction, redoAction);
 
-        Supplier<List<MenuItem>> contextMenuSupplier = EditorMenus.getCleanupUrlMenu(textArea);
-        textArea.initContextMenu(contextMenuSupplier, preferences.getKeyBindingRepository());
+        Supplier<List<MenuItem>> contextMenuSupplier = EditorMenus.getCleanupUrlMenu(textField);
+        textField.initContextMenu(contextMenuSupplier, preferences.getKeyBindingRepository());
 
         // init paste handler for UrlEditor to format pasted url link in textArea
-        textArea.setPasteActionHandler(() -> textArea.setText(new CleanupUrlFormatter().format(new TrimWhitespaceFormatter().format(textArea.getText()))));
+        textField.setAdditionalPasteActionHandler(() -> textField.setText(new CleanupUrlFormatter().format(new TrimWhitespaceFormatter().format(textField.getText()))));
 
-        new EditorValidator(preferences).configureValidation(viewModel.getFieldValidator().getValidationStatus(), textArea);
+        new EditorValidator(preferences).configureValidation(viewModel.getFieldValidator().getValidationStatus(), textField);
     }
 
     public UrlEditorViewModel getViewModel() {

diff --git a/src/main/java/org/jabref/gui/fieldeditors/contextmenu/EditorMenus.java b/src/main/java/org/jabref/gui/fieldeditors/contextmenu/EditorMenus.java
@@ -6,7 +6,7 @@
 
 import javafx.scene.control.MenuItem;
 import javafx.scene.control.SeparatorMenuItem;
-import javafx.scene.control.TextArea;
+import javafx.scene.control.TextField;
 import javafx.scene.control.TextInputControl;
 
 import org.jabref.gui.ClipBoardManager;
@@ -51,35 +51,35 @@ public static Supplier<List<MenuItem>> getNameMenu(final TextInputControl textIn
     /**
      * The default context menu with a specific menu copying a DOI/ DOI URL.
      *
-     * @param textArea text-area that this menu will be connected to
+     * @param textField text-field that this menu will be connected to
      * @return menu containing items of the default menu and an item for copying a DOI/DOI URL
      */
-    public static Supplier<List<MenuItem>> getDOIMenu(TextArea textArea, DialogService dialogService) {
+    public static Supplier<List<MenuItem>> getDOIMenu(TextField textField, DialogService dialogService) {
         return () -> {
             ActionFactory factory = new ActionFactory();
             ClipBoardManager clipBoardManager = Injector.instantiateModelOrService(ClipBoardManager.class);
-            MenuItem copyDoiMenuItem = factory.createMenuItem(StandardActions.COPY_DOI, new CopyDoiUrlAction(textArea, StandardActions.COPY_DOI, dialogService, clipBoardManager));
-            MenuItem copyDoiUrlMenuItem = factory.createMenuItem(StandardActions.COPY_DOI_URL, new CopyDoiUrlAction(textArea, StandardActions.COPY_DOI_URL, dialogService, clipBoardManager));
+            MenuItem copyDoiMenuItem = factory.createMenuItem(StandardActions.COPY_DOI, new CopyDoiUrlAction(textField, StandardActions.COPY_DOI, dialogService, clipBoardManager));
+            MenuItem copyDoiUrlMenuItem = factory.createMenuItem(StandardActions.COPY_DOI_URL, new CopyDoiUrlAction(textField, StandardActions.COPY_DOI_URL, dialogService, clipBoardManager));
             List<MenuItem> menuItems = new ArrayList<>();
             menuItems.add(copyDoiMenuItem);
             menuItems.add(copyDoiUrlMenuItem);
             menuItems.add(new SeparatorMenuItem());
-            menuItems.addAll(new DefaultMenu(textArea).get());
+            menuItems.addAll(new DefaultMenu(textField).get());
             return menuItems;
         };
     }
 
     /**
      * The default context menu with a specific menu item to cleanup URL.
      *
-     * @param textArea text-area that this menu will be connected to
+     * @param textField text field that this menu will be connected to
      * @return menu containing items of the default menu and an item to cleanup a URL
      */
-    public static Supplier<List<MenuItem>> getCleanupUrlMenu(TextArea textArea) {
+    public static Supplier<List<MenuItem>> getCleanupUrlMenu(TextField textField) {
         return () -> {
             MenuItem cleanupURL = new MenuItem(Localization.lang("Cleanup URL link"));
-            cleanupURL.setDisable(textArea.textProperty().isEmpty().get());
-            cleanupURL.setOnAction(event -> textArea.setText(new CleanupUrlFormatter().format(textArea.getText())));
+            cleanupURL.setDisable(textField.textProperty().isEmpty().get());
+            cleanupURL.setOnAction(event -> textField.setText(new CleanupUrlFormatter().format(textField.getText())));
             List<MenuItem> menuItems = new ArrayList<>();
             menuItems.add(cleanupURL);
             return menuItems;

diff --git a/src/main/java/org/jabref/gui/fieldeditors/identifier/IdentifierEditor.fxml b/src/main/java/org/jabref/gui/fieldeditors/identifier/IdentifierEditor.fxml
@@ -5,11 +5,11 @@
 <?import javafx.scene.control.Tooltip?>
 <?import javafx.scene.layout.HBox?>
 <?import javafx.scene.layout.StackPane?>
-<?import org.jabref.gui.fieldeditors.EditorTextArea?>
+<?import org.jabref.gui.fieldeditors.EditorTextField?>
 <?import org.jabref.gui.icon.JabRefIconView?>
 <fx:root xmlns:fx="http://javafx.com/fxml/1" type="HBox" xmlns="http://javafx.com/javafx/8.0.112"
          fx:controller="org.jabref.gui.fieldeditors.identifier.IdentifierEditor">
-    <EditorTextArea fx:id="textArea" prefHeight="0.0" HBox.hgrow="ALWAYS"/>
+    <EditorTextField fx:id="textField" prefHeight="0.0" HBox.hgrow="ALWAYS"/>
     <Button disable="${controller.viewModel.isInvalidIdentifier}" onAction="#openExternalLink"
             styleClass="icon-button">
         <graphic>

diff --git a/src/main/java/org/jabref/gui/fieldeditors/identifier/IdentifierEditor.java b/src/main/java/org/jabref/gui/fieldeditors/identifier/IdentifierEditor.java
@@ -13,7 +13,7 @@
 import org.jabref.gui.DialogService;
 import org.jabref.gui.StateManager;
 import org.jabref.gui.autocompleter.SuggestionProvider;
-import org.jabref.gui.fieldeditors.EditorTextArea;
+import org.jabref.gui.fieldeditors.EditorTextField;
 import org.jabref.gui.fieldeditors.EditorValidator;
 import org.jabref.gui.fieldeditors.FieldEditorFX;
 import org.jabref.gui.fieldeditors.contextmenu.DefaultMenu;
@@ -36,7 +36,7 @@
 public class IdentifierEditor extends HBox implements FieldEditorFX {
 
     @FXML private BaseIdentifierEditorViewModel<?> viewModel;
-    @FXML private EditorTextArea textArea;
+    @FXML private EditorTextField textField;
     @FXML private Button fetchInformationByIdentifierButton;
     @FXML private Button lookupIdentifierButton;
 
@@ -74,20 +74,20 @@ public IdentifierEditor(Field field,
                   .root(this)
                   .load();
 
-        textArea.textProperty().bindBidirectional(viewModel.textProperty());
+        textField.textProperty().bindBidirectional(viewModel.textProperty());
 
         fetchInformationByIdentifierButton.setTooltip(
                 new Tooltip(Localization.lang("Get bibliographic data from %0", field.getDisplayName())));
         lookupIdentifierButton.setTooltip(
                 new Tooltip(Localization.lang("Look up %0", field.getDisplayName())));
 
         if (field.equals(DOI)) {
-            textArea.initContextMenu(EditorMenus.getDOIMenu(textArea, dialogService), preferences.getKeyBindingRepository());
+            textField.initContextMenu(EditorMenus.getDOIMenu(textField, dialogService), preferences.getKeyBindingRepository());
         } else {
-            textArea.initContextMenu(new DefaultMenu(textArea), preferences.getKeyBindingRepository());
+            textField.initContextMenu(new DefaultMenu(textField), preferences.getKeyBindingRepository());
         }
 
-        new EditorValidator(preferences).configureValidation(viewModel.getFieldValidator().getValidationStatus(), textArea);
+        new EditorValidator(preferences).configureValidation(viewModel.getFieldValidator().getValidationStatus(), textField);
     }
 
     public BaseIdentifierEditorViewModel<?> getViewModel() {