JournalAbbreviation search feature

CHANGELOG.md

@@ -24,6 +24,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 - We added a feature that allows the user to choose whether to trust the target site when unable to find a valid certification path from the file download site. [#7616](https://github.com/JabRef/jabref/issues/7616)
 - We added a feature that allows the user to open all linked files of multiple selected entries by "Open file" option. [#6966](https://github.com/JabRef/jabref/issues/6966)
 - We added a keybinding preset for new entries. [#7705](https://github.com/JabRef/jabref/issues/7705)
+- We added a search feature for journal abbreviations [#7804](https://github.com/JabRef/jabref/pull/7804).
 
 ### Changed
 

src/main/java/org/jabref/gui/preferences/journals/AbbreviationViewModel.java

@@ -94,4 +94,18 @@ public boolean equals(Object o) {
     public int hashCode() {
         return Objects.hash(getName(), isPseudoAbbreviation());
     }
+
+    public boolean containsCaseIndependent(String s) {
+        s = s.toLowerCase();
+        if (this.abbreviation.get().toLowerCase().contains(s)) {
+            return true;
+        }
+        if (this.name.get().toLowerCase().contains(s)) {
+            return true;
+        }
+        if (this.shortestUniqueAbbreviation.get().toLowerCase().contains(s)) {
+            return true;
+        }
+        return false;
+    }
 }

src/main/java/org/jabref/gui/preferences/journals/JournalAbbreviationsTab.fxml

@@ -10,6 +10,8 @@
 <?import javafx.scene.layout.HBox?>
 <?import javafx.scene.layout.Pane?>
 <?import javafx.scene.layout.VBox?>
+<?import org.controlsfx.control.textfield.CustomTextField?>
+<?import javafx.geometry.Insets?>
 <fx:root spacing="10.0" type="VBox"
          xmlns="http://javafx.com/javafx" xmlns:fx="http://javafx.com/fxml"
          fx:controller="org.jabref.gui.preferences.journals.JournalAbbreviationsTab">
@@ -64,4 +66,9 @@
             <ProgressIndicator fx:id="progressIndicator" maxHeight="30.0" opacity="0.4"/>
         </placeholder>
     </TableView>
+    <CustomTextField fx:id="searchBox" promptText="%Search" VBox.vgrow="NEVER">
+        <VBox.margin>
+            <Insets bottom="3.0" left="3.0" right="3.0" top="3.0"/>
+        </VBox.margin>
+    </CustomTextField>
 </fx:root>

src/main/java/org/jabref/gui/preferences/journals/JournalAbbreviationsTab.java

@@ -2,6 +2,7 @@
 
 import javax.inject.Inject;
 
+import javafx.collections.transformation.FilteredList;
 import javafx.fxml.FXML;
 import javafx.scene.control.Button;
 import javafx.scene.control.ComboBox;
@@ -20,6 +21,7 @@
 
 import com.airhacks.afterburner.views.ViewLoader;
 import com.tobiasdiez.easybind.EasyBind;
+import org.controlsfx.control.textfield.CustomTextField;
 
 /**
  * This class controls the user interface of the journal abbreviations dialog. The UI elements and their layout are
@@ -33,13 +35,16 @@ public class JournalAbbreviationsTab extends AbstractPreferenceTabView<JournalAb
     @FXML private TableColumn<AbbreviationViewModel, String> journalTableNameColumn;
     @FXML private TableColumn<AbbreviationViewModel, String> journalTableAbbreviationColumn;
     @FXML private TableColumn<AbbreviationViewModel, String> journalTableShortestUniqueAbbreviationColumn;
+    private FilteredList<AbbreviationViewModel> filteredAbbreviations;
     @FXML private ComboBox<AbbreviationsFileViewModel> journalFilesBox;
     @FXML private Button addAbbreviationButton;
     @FXML private Button removeAbbreviationButton;
     @FXML private Button openAbbreviationListButton;
     @FXML private Button addAbbreviationListButton;
     @FXML private Button removeAbbreviationListButton;
 
+    @FXML private CustomTextField searchBox;
+
     @Inject private TaskExecutor taskExecutor;
     @Inject private JournalAbbreviationRepository abbreviationRepository;
 
@@ -53,9 +58,23 @@ public JournalAbbreviationsTab() {
     private void initialize() {
         viewModel = new JournalAbbreviationsTabViewModel(preferencesService, dialogService, taskExecutor, abbreviationRepository);
 
+        filteredAbbreviations = new FilteredList<>(viewModel.abbreviationsProperty(), s -> true);
+
         setButtonStyles();
         setUpTable();
         setBindings();
+
+        searchBox.textProperty().addListener((observable, previousText, newText) -> {
+            if (newText.isEmpty()) {
+                filteredAbbreviations.setPredicate(s -> true);
+            } else {
+                filteredAbbreviations.setPredicate(s -> s.containsCaseIndependent(newText));
+            }
+            journalAbbreviationsTable.getSelectionModel().clearSelection();
+            journalAbbreviationsTable.getSelectionModel().selectFirst();
+        });
+        searchBox.setPromptText(Localization.lang("Search") + "...");
+        searchBox.setLeft(IconTheme.JabRefIcons.SEARCH.getGraphicNode());
     }
 
     private void setButtonStyles() {
@@ -78,7 +97,7 @@ private void setUpTable() {
     }
 
     private void setBindings() {
-        journalAbbreviationsTable.itemsProperty().bindBidirectional(viewModel.abbreviationsProperty());
+        journalAbbreviationsTable.setItems(filteredAbbreviations);
 
         EasyBind.subscribe(journalAbbreviationsTable.getSelectionModel().selectedItemProperty(), newValue ->
                 viewModel.currentAbbreviationProperty().set(newValue));

src/test/java/org/jabref/logic/journals/AbbreviationTest.java

@@ -1,8 +1,12 @@
 package org.jabref.logic.journals;
 
+import org.jabref.gui.preferences.journals.AbbreviationViewModel;
+
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 class AbbreviationTest {
 
@@ -101,4 +105,13 @@ void testDefaultAndShortestUniqueAbbreviationsAreSame() {
         Abbreviation abbreviation = new Abbreviation("Long Name", "L N");
         assertEquals(abbreviation.getAbbreviation(), abbreviation.getShortestUniqueAbbreviation());
     }
+
+    @Test
+    void testStringIsFoundInAllAbbreviationFields() {
+        AbbreviationViewModel abbreviationViewModel = new AbbreviationViewModel(new Abbreviation("Long Name", "abbr", "unique"));
+        assertTrue(abbreviationViewModel.containsCaseIndependent("name"));
+        assertTrue(abbreviationViewModel.containsCaseIndependent("bBr"));
+        assertTrue(abbreviationViewModel.containsCaseIndependent("Uniq"));
+        assertFalse(abbreviationViewModel.containsCaseIndependent("Something else"));
+    }
 }