From 8afe793947a5f5c8f4c49614d1757236ab9c3ab9 Mon Sep 17 00:00:00 2001
From: Loay Ghreeb <52158423+LoayGhreeb@users.noreply.github.com>
Date: Fri, 8 Mar 2024 12:20:07 +0200
Subject: [PATCH] Use tags editor for auto completion preferences (#10990)

* Use tags for auto completion preferences

* Suggest all fields without internal
---
 .../AutoCompletePreferences.java              |  5 ---
 .../autocompletion/AutoCompletionTab.fxml     |  6 +--
 .../autocompletion/AutoCompletionTab.java     | 33 +++++++++++++++--
 .../AutoCompletionTabViewModel.java           | 37 +++++++++++++++----
 4 files changed, 62 insertions(+), 19 deletions(-)

diff --git a/src/main/java/org/jabref/gui/autocompleter/AutoCompletePreferences.java b/src/main/java/org/jabref/gui/autocompleter/AutoCompletePreferences.java
index 160abb9ecb3..12689f76f99 100644
--- a/src/main/java/org/jabref/gui/autocompleter/AutoCompletePreferences.java
+++ b/src/main/java/org/jabref/gui/autocompleter/AutoCompletePreferences.java
@@ -10,7 +10,6 @@
 import javafx.collections.ObservableSet;
 
 import org.jabref.model.entry.field.Field;
-import org.jabref.model.entry.field.FieldFactory;
 
 public class AutoCompletePreferences {
 
@@ -80,8 +79,4 @@ public void setNameFormat(NameFormat nameFormat) {
     public ObservableSet<Field> getCompleteFields() {
         return completeFields;
     }
-
-    public String getCompleteNamesAsString() {
-        return FieldFactory.serializeFieldsList(completeFields);
-    }
 }
diff --git a/src/main/java/org/jabref/gui/preferences/autocompletion/AutoCompletionTab.fxml b/src/main/java/org/jabref/gui/preferences/autocompletion/AutoCompletionTab.fxml
index d4f96a6178c..09ac50e21ee 100644
--- a/src/main/java/org/jabref/gui/preferences/autocompletion/AutoCompletionTab.fxml
+++ b/src/main/java/org/jabref/gui/preferences/autocompletion/AutoCompletionTab.fxml
@@ -4,10 +4,10 @@
 <?import javafx.scene.control.CheckBox?>
 <?import javafx.scene.control.Label?>
 <?import javafx.scene.control.RadioButton?>
-<?import javafx.scene.control.TextField?>
 <?import javafx.scene.control.ToggleGroup?>
 <?import javafx.scene.layout.HBox?>
 <?import javafx.scene.layout.VBox?>
+<?import com.dlsc.gemsfx.TagsField?>
 <fx:root spacing="10.0" type="VBox"
          xmlns="http://javafx.com/javafx" xmlns:fx="http://javafx.com/fxml"
          fx:controller="org.jabref.gui.preferences.autocompletion.AutoCompletionTab">
@@ -22,11 +22,11 @@
     <VBox spacing="10.0">
         <HBox spacing="4.0">
             <Label text="%Affected fields" disable="${!enableAutoComplete.selected}"/>
-            <TextField fx:id="autoCompleteFields" HBox.hgrow="ALWAYS" disable="${!enableAutoComplete.selected}">
+            <TagsField fx:id="autoCompleteFields" HBox.hgrow="ALWAYS" disable="${!enableAutoComplete.selected}">
                 <HBox.margin>
                     <Insets top="-4.0"/>
                 </HBox.margin>
-            </TextField>
+            </TagsField>
         </HBox>
         <Label text="%Name format" disable="${!enableAutoComplete.selected}"/>
         <RadioButton fx:id="autoCompleteFirstLast" text="%Autocomplete names in 'Firstname Lastname' format only"
diff --git a/src/main/java/org/jabref/gui/preferences/autocompletion/AutoCompletionTab.java b/src/main/java/org/jabref/gui/preferences/autocompletion/AutoCompletionTab.java
index 119930370f4..a279b86bc61 100644
--- a/src/main/java/org/jabref/gui/preferences/autocompletion/AutoCompletionTab.java
+++ b/src/main/java/org/jabref/gui/preferences/autocompletion/AutoCompletionTab.java
@@ -1,20 +1,26 @@
 package org.jabref.gui.preferences.autocompletion;
 
 import javafx.fxml.FXML;
+import javafx.scene.Node;
 import javafx.scene.control.CheckBox;
+import javafx.scene.control.ContentDisplay;
+import javafx.scene.control.Label;
 import javafx.scene.control.RadioButton;
-import javafx.scene.control.TextField;
 
+import org.jabref.gui.icon.IconTheme;
 import org.jabref.gui.preferences.AbstractPreferenceTabView;
 import org.jabref.gui.preferences.PreferencesTab;
+import org.jabref.gui.util.ViewModelListCellFactory;
 import org.jabref.logic.l10n.Localization;
+import org.jabref.model.entry.field.Field;
 
 import com.airhacks.afterburner.views.ViewLoader;
+import com.dlsc.gemsfx.TagsField;
 
 public class AutoCompletionTab extends AbstractPreferenceTabView<AutoCompletionTabViewModel> implements PreferencesTab {
 
     @FXML private CheckBox enableAutoComplete;
-    @FXML private TextField autoCompleteFields;
+    @FXML private TagsField<Field> autoCompleteFields;
     @FXML private RadioButton autoCompleteFirstLast;
     @FXML private RadioButton autoCompleteLastFirst;
     @FXML private RadioButton autoCompleteBoth;
@@ -35,9 +41,8 @@ public String getTabName() {
 
     public void initialize() {
         viewModel = new AutoCompletionTabViewModel(preferencesService.getAutoCompletePreferences());
-
+        setupTagsFiled();
         enableAutoComplete.selectedProperty().bindBidirectional(viewModel.enableAutoCompleteProperty());
-        autoCompleteFields.textProperty().bindBidirectional(viewModel.autoCompleteFieldsProperty());
         autoCompleteFirstLast.selectedProperty().bindBidirectional(viewModel.autoCompleteFirstLastProperty());
         autoCompleteLastFirst.selectedProperty().bindBidirectional(viewModel.autoCompleteLastFirstProperty());
         autoCompleteBoth.selectedProperty().bindBidirectional(viewModel.autoCompleteBothProperty());
@@ -45,4 +50,24 @@ public void initialize() {
         firstNameModeFull.selectedProperty().bindBidirectional(viewModel.firstNameModeFullProperty());
         firstNameModeBoth.selectedProperty().bindBidirectional(viewModel.firstNameModeBothProperty());
     }
+
+    private void setupTagsFiled() {
+        autoCompleteFields.setCellFactory(new ViewModelListCellFactory<Field>().withText(Field::getDisplayName));
+        autoCompleteFields.setSuggestionProvider(request -> viewModel.getSuggestions(request.getUserText()));
+        autoCompleteFields.tagsProperty().bindBidirectional(viewModel.autoCompleteFieldsProperty());
+        autoCompleteFields.setConverter(viewModel.getFieldStringConverter());
+        autoCompleteFields.setTagViewFactory(this::createTag);
+        autoCompleteFields.setShowSearchIcon(false);
+        autoCompleteFields.getEditor().getStyleClass().clear();
+        autoCompleteFields.getEditor().getStyleClass().add("tags-field-editor");
+    }
+
+    private Node createTag(Field field) {
+        Label tagLabel = new Label();
+        tagLabel.setText(field.getDisplayName());
+        tagLabel.setGraphic(IconTheme.JabRefIcons.REMOVE_TAGS.getGraphicNode());
+        tagLabel.getGraphic().setOnMouseClicked(event -> autoCompleteFields.removeTags(field));
+        tagLabel.setContentDisplay(ContentDisplay.RIGHT);
+        return tagLabel;
+    }
 }
diff --git a/src/main/java/org/jabref/gui/preferences/autocompletion/AutoCompletionTabViewModel.java b/src/main/java/org/jabref/gui/preferences/autocompletion/AutoCompletionTabViewModel.java
index 8b9b6633f6e..52b5c77bd7d 100644
--- a/src/main/java/org/jabref/gui/preferences/autocompletion/AutoCompletionTabViewModel.java
+++ b/src/main/java/org/jabref/gui/preferences/autocompletion/AutoCompletionTabViewModel.java
@@ -2,22 +2,26 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.stream.Collectors;
 
 import javafx.beans.property.BooleanProperty;
+import javafx.beans.property.ListProperty;
 import javafx.beans.property.SimpleBooleanProperty;
-import javafx.beans.property.SimpleStringProperty;
-import javafx.beans.property.StringProperty;
+import javafx.beans.property.SimpleListProperty;
+import javafx.collections.FXCollections;
+import javafx.util.StringConverter;
 
 import org.jabref.gui.autocompleter.AutoCompleteFirstNameMode;
 import org.jabref.gui.autocompleter.AutoCompletePreferences;
 import org.jabref.gui.preferences.PreferenceTabViewModel;
 import org.jabref.logic.l10n.Localization;
+import org.jabref.model.entry.field.Field;
 import org.jabref.model.entry.field.FieldFactory;
 
 public class AutoCompletionTabViewModel implements PreferenceTabViewModel {
 
     private final BooleanProperty enableAutoCompleteProperty = new SimpleBooleanProperty();
-    private final StringProperty autoCompleteFieldsProperty = new SimpleStringProperty();
+    private final ListProperty<Field> autoCompleteFieldsProperty = new SimpleListProperty<>(FXCollections.observableArrayList());
     private final BooleanProperty autoCompleteFirstLastProperty = new SimpleBooleanProperty();
     private final BooleanProperty autoCompleteLastFirstProperty = new SimpleBooleanProperty();
     private final BooleanProperty autoCompleteBothProperty = new SimpleBooleanProperty();
@@ -36,8 +40,7 @@ public AutoCompletionTabViewModel(AutoCompletePreferences autoCompletePreference
     @Override
     public void setValues() {
         enableAutoCompleteProperty.setValue(autoCompletePreferences.shouldAutoComplete());
-        autoCompleteFieldsProperty.setValue(autoCompletePreferences.getCompleteNamesAsString());
-
+        autoCompleteFieldsProperty.setValue(FXCollections.observableArrayList(autoCompletePreferences.getCompleteFields()));
         if (autoCompletePreferences.getNameFormat() == AutoCompletePreferences.NameFormat.FIRST_LAST) {
             autoCompleteFirstLastProperty.setValue(true);
         } else if (autoCompletePreferences.getNameFormat() == AutoCompletePreferences.NameFormat.LAST_FIRST) {
@@ -82,7 +85,7 @@ public void storeSettings() {
         }
 
         autoCompletePreferences.getCompleteFields().clear();
-        autoCompletePreferences.getCompleteFields().addAll(FieldFactory.parseFieldList(autoCompleteFieldsProperty.getValue()));
+        autoCompletePreferences.getCompleteFields().addAll(autoCompleteFieldsProperty.getValue());
     }
 
     @Override
@@ -94,7 +97,7 @@ public BooleanProperty enableAutoCompleteProperty() {
         return enableAutoCompleteProperty;
     }
 
-    public StringProperty autoCompleteFieldsProperty() {
+    public ListProperty<Field> autoCompleteFieldsProperty() {
         return autoCompleteFieldsProperty;
     }
 
@@ -121,4 +124,24 @@ public BooleanProperty firstNameModeFullProperty() {
     public BooleanProperty firstNameModeBothProperty() {
         return firstNameModeBothProperty;
     }
+
+    public StringConverter<Field> getFieldStringConverter() {
+        return new StringConverter<>() {
+            @Override
+            public String toString(Field field) {
+                return field.getDisplayName();
+            }
+
+            @Override
+            public Field fromString(String string) {
+                return FieldFactory.parseField(string);
+            }
+        };
+    }
+
+    public List<Field> getSuggestions(String request) {
+        return FieldFactory.getAllFieldsWithOutInternal().stream()
+                           .filter(field -> field.getDisplayName().toLowerCase().contains(request.toLowerCase()))
+                           .collect(Collectors.toList());
+    }
 }