Completed General Fields Customizer conversion to JavaFX

CHANGELOG.md

@@ -11,6 +11,7 @@ We refer to [GitHub issues](https://github.com/JabRef/jabref/issues) by using `#
 ## [Unreleased]
 
 ### Changed
+- We updated the dialog for setting up general fields.
 - URL field formatting is updated. All whitespace chars, located at the beginning/ending of the url, are trimmed automatically
 - We changed the behavior of the field formatting dialog such that the `bibtexkey` is not changed when formatting all fields or all text fields.
 - We added a "Move file to file directory and rename file" option for simultaneously moving and renaming of document file. [#4166](https://github.com/JabRef/jabref/issues/4166)

src/main/java/org/jabref/gui/JabRefFrame.java

@@ -927,7 +927,7 @@ private MenuBar createMenu() {
 
                 new SeparatorMenuItem(),
 
-                factory.createMenuItem(StandardActions.SETUP_GENERAL_FIELDS, new SetupGeneralFieldsAction(this)),
+                                  factory.createMenuItem(StandardActions.SETUP_GENERAL_FIELDS, new SetupGeneralFieldsAction()),
                 factory.createMenuItem(StandardActions.MANAGE_CUSTOM_IMPORTS, new ManageCustomImportsAction(this)),
                 factory.createMenuItem(StandardActions.MANAGE_CUSTOM_EXPORTS, new ManageCustomExportsAction(this)),
                 factory.createMenuItem(StandardActions.MANAGE_EXTERNAL_FILETYPES, new EditExternalFileTypesAction()),

src/main/java/org/jabref/gui/actions/SetupGeneralFieldsAction.java

@@ -1,20 +1,12 @@
 package org.jabref.gui.actions;
 
-import org.jabref.gui.GenFieldsCustomizer;
-import org.jabref.gui.JabRefFrame;
+import org.jabref.gui.genfields.GenFieldsCustomizerDialogView;
 
 public class SetupGeneralFieldsAction extends SimpleCommand {
 
-    private final JabRefFrame jabRefFrame;
-
-    public SetupGeneralFieldsAction(JabRefFrame jabRefFrame) {
-        this.jabRefFrame = jabRefFrame;
-    }
-
     @Override
     public void execute() {
-        GenFieldsCustomizer gf = new GenFieldsCustomizer(jabRefFrame);
-        gf.setVisible(true);
+        new GenFieldsCustomizerDialogView().show();
 
     }
 

src/main/java/org/jabref/gui/genfields/GenFieldsCustomizerDialog.fxml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<?import javafx.scene.control.ButtonType?>
+<?import javafx.scene.control.DialogPane?>
+<?import javafx.scene.control.Label?>
+<?import javafx.scene.control.TextArea?>
+<?import javafx.scene.layout.VBox?>
+<DialogPane xmlns="http://javafx.com/javafx/8.0.171" xmlns:fx="http://javafx.com/fxml/1"
+            fx:controller="org.jabref.gui.genfields.GenFieldsCustomizerDialogView">
+    <content>
+        <VBox prefHeight="300.0" prefWidth="650.0">
+            <children>
+                <Label text="%General Fields" />
+                <Label text="%Create custom fields for each BibTeX entry" />
+                <TextArea fx:id="fieldsTextArea" minHeight="200.0" minWidth="628.0" />
+                <Label text="%Format: Tab:field;field;... (e.g. General:url;pdf;note...)" />
+            </children>
+        </VBox>
+    </content>
+    <ButtonType fx:id="okButton" fx:constant="OK" />
+    <ButtonType fx:id="resetButton" buttonData="LEFT" text="%Default" />
+    <ButtonType fx:id="helpButton" text="%Help" />
+    <ButtonType fx:constant="CANCEL" />
+</DialogPane>

src/main/java/org/jabref/gui/genfields/GenFieldsCustomizerDialogView.java

@@ -0,0 +1,72 @@
+package org.jabref.gui.genfields;
+
+import javax.inject.Inject;
+
+import javafx.fxml.FXML;
+import javafx.scene.control.ButtonType;
+import javafx.scene.control.TextArea;
+
+import org.jabref.gui.DialogService;
+import org.jabref.gui.help.HelpAction;
+import org.jabref.gui.util.BaseDialog;
+import org.jabref.gui.util.ControlHelper;
+import org.jabref.logic.help.HelpFile;
+import org.jabref.logic.l10n.Localization;
+import org.jabref.preferences.PreferencesService;
+
+import com.airhacks.afterburner.views.ViewLoader;
+
+public class GenFieldsCustomizerDialogView extends BaseDialog<Void> {
+
+    @FXML private ButtonType resetButton;
+    @FXML private ButtonType helpButton;
+    @FXML private ButtonType okButton;
+    @FXML private ButtonType cancelButton;
+    @FXML private TextArea fieldsTextArea;
+
+    @Inject private DialogService dialogService;
+    @Inject private PreferencesService preferences;
+    private GenFieldsCustomizerDialogViewModel viewModel;
+
+    public GenFieldsCustomizerDialogView() {
+        this.setTitle(Localization.lang("Set General Fields"));
+        this.setResizable(true);
+        this.getDialogPane().setPrefSize(300, 650);
+
+        ViewLoader.view(this)
+                  .load()
+                  .setAsDialogPane(this);
+
+        HelpAction helpCommand = new HelpAction(HelpFile.GENERAL_FIELDS);
+        //HelpAction is written with Swing, not JavaFX, so runCommand() cannot be used normally.  Here I am reaching into
+        //the command and running execute.  When HelpAction is converted to JavaFX,
+        //the following will need to be changed.
+        ControlHelper.setAction(helpButton, getDialogPane(), event -> helpCommand.getCommand().execute());
+        ControlHelper.setAction(resetButton, getDialogPane(), event -> resetFields());
+        ControlHelper.setAction(okButton, getDialogPane(), event -> saveFieldsAndCloseDialog());
+
+    }
+
+    @FXML
+    private void initialize() {
+        viewModel = new GenFieldsCustomizerDialogViewModel(dialogService, preferences);
+        fieldsTextArea.textProperty().bindBidirectional(viewModel.fieldsTextProperty());
+
+    }
+
+    @FXML
+    private void closeDialog() {
+        close();
+    }
+
+    @FXML
+    private void saveFieldsAndCloseDialog() {
+        viewModel.saveFields();
+        closeDialog();
+    }
+
+    private void resetFields() {
+        viewModel.resetFields();
+    }
+
+}

src/main/java/org/jabref/gui/genfields/GenFieldsCustomizerDialogViewModel.java

@@ -0,0 +1,88 @@
+package org.jabref.gui.genfields;
+
+import java.util.List;
+import java.util.Map;
+
+import javafx.beans.property.SimpleStringProperty;
+import javafx.beans.property.StringProperty;
+
+import org.jabref.gui.DialogService;
+import org.jabref.logic.bibtexkeypattern.BibtexKeyGenerator;
+import org.jabref.logic.l10n.Localization;
+import org.jabref.preferences.JabRefPreferences;
+import org.jabref.preferences.PreferencesService;
+
+public class GenFieldsCustomizerDialogViewModel {
+
+    private final DialogService dialogService;
+    private final PreferencesService preferences;
+    private final StringProperty fieldsText = new SimpleStringProperty("");
+
+    public GenFieldsCustomizerDialogViewModel(DialogService dialogService, PreferencesService preferences) {
+        this.dialogService = dialogService;
+        this.preferences = preferences;
+        setInitialFieldsText();
+    }
+
+    private void setInitialFieldsText() {
+        StringBuilder sb = new StringBuilder();
+
+        for (Map.Entry<String, List<String>> tab : preferences.getEntryEditorTabList().entrySet()) {
+            sb.append(tab.getKey());
+            sb.append(':');
+            sb.append(String.join(";", tab.getValue()));
+            sb.append('\n');
+        }
+
+        fieldsText.set(sb.toString());
+    }
+
+    public StringProperty fieldsTextProperty() {
+        return fieldsText;
+    }
+
+    public void saveFields() {
+        String[] lines = fieldsText.get().split("\n");
+        int i = 0;
+        for (; i < lines.length; i++) {
+            String[] parts = lines[i].split(":");
+            if (parts.length != 2) {
+                // Report error and exit.
+                String field = Localization.lang("field");
+                String title = Localization.lang("Error");
+                String content = Localization.lang("Each line must be of the following form") + " '" +
+                                 Localization.lang("Tabname") + ':' + field + "1;" + field + "2;...;" + field + "N'";
+                dialogService.showInformationDialogAndWait(title, content);
+                return;
+            }
+
+            String testString = BibtexKeyGenerator.cleanKey(parts[1], preferences.getEnforceLegalKeys());
+            if (!testString.equals(parts[1]) || (parts[1].indexOf('&') >= 0)) {
+                String title = Localization.lang("Error");
+                String content = Localization.lang("Field names are not allowed to contain white space or the following "
+                                                   + "characters")
+                                 + ": # { } ~ , ^ &";
+                dialogService.showInformationDialogAndWait(title, content);
+                return;
+            }
+            preferences.setCustomTabsNameAndFields(parts[0], parts[1], i);
+
+        }
+        preferences.purgeSeries(JabRefPreferences.CUSTOM_TAB_NAME, i);
+        preferences.purgeSeries(JabRefPreferences.CUSTOM_TAB_FIELDS, i);
+        preferences.updateEntryEditorTabList();
+    }
+
+    public void resetFields() {
+
+        StringBuilder sb = new StringBuilder();
+        Map<String,String> customTabNamesFields = preferences.getCustomTabsNamesAndFields();
+        for (Map.Entry<String,String>entry : customTabNamesFields.entrySet()) {
+            sb.append(entry.getKey());
+            sb.append(':');
+            sb.append(entry.getValue());
+            sb.append('\n');
+        fieldsText.set(sb.toString());
+        }
+    }
+}

src/main/java/org/jabref/preferences/JabRefPreferences.java

@@ -935,6 +935,40 @@ public String getUser() {
         }
     }
 
+    /**
+     * Get a Map of default tab names to deafult tab fields.
+     * The fields are returned as a String with fields separated by ;
+     * They are combined into one string in order to feed into GenFieldsCustomizerDialogViewModel.resetFields()
+     * so that they do not have to be parsed in order to fit there
+     *
+     * @return A map of keys with tab names and values as a string containing
+     * fields for the given name separated by ;
+     */
+    @Override
+    public Map<String, String> getCustomTabsNamesAndFields() {
+        Map<String, String> customTabsMap = new HashMap<>();
+
+        int defNumber = 0;
+        while (true) {
+            //Saved as CUSTOMTABNAME_def{number} and ; separated
+            String name = (String) defaults.get(CUSTOM_TAB_NAME + "_def" + defNumber);
+            String fields = (String) defaults.get(CUSTOM_TAB_FIELDS + "_def" + defNumber);
+
+            if (StringUtil.isNullOrEmpty(name) || StringUtil.isNullOrEmpty(fields)) {
+                break;
+            }
+            customTabsMap.put(name, fields);
+            defNumber++;
+        }
+        return customTabsMap;
+    }
+
+    @Override
+    public void setCustomTabsNameAndFields(String name, String fields, int defNumber) {
+        prefs.put(CUSTOM_TAB_NAME + defNumber, name);
+        prefs.put(CUSTOM_TAB_FIELDS + defNumber, fields);
+    }
+
     public List<String> getCustomTabFieldNames() {
         List<String> customFields = new ArrayList<>();
 
@@ -943,7 +977,7 @@ public List<String> getCustomTabFieldNames() {
             // saved as CUSTOMTABNAME_def{number} and ; separated
             String fields = (String) defaults.get(CUSTOM_TAB_FIELDS + "_def" + defNumber);
 
-            if ((fields == null) || fields.isEmpty()) {
+            if (StringUtil.isNullOrEmpty(fields)) {
                 break;
             }
 
@@ -1295,6 +1329,7 @@ private Object getObject(String key) {
      *
      * @param number or higher.
      */
+    @Override
     public void purgeSeries(String prefix, int number) {
         int n = number;
         while (get(prefix + n) != null) {
@@ -1303,13 +1338,20 @@ public void purgeSeries(String prefix, int number) {
         }
     }
 
+    @Override
     public Map<String, List<String>> getEntryEditorTabList() {
         if (tabList == null) {
             updateEntryEditorTabList();
         }
         return tabList;
     }
 
+    @Override
+    public Boolean getEnforceLegalKeys() {
+        return getBoolean(ENFORCE_LEGAL_BIBTEX_KEY);
+    }
+
+    @Override
     public void updateEntryEditorTabList() {
         tabList = EntryEditorTabList.create(this);
     }

src/main/java/org/jabref/preferences/PreferencesService.java

@@ -1,6 +1,8 @@
 package org.jabref.preferences;
 
 import java.nio.file.Path;
+import java.util.List;
+import java.util.Map;
 
 import org.jabref.gui.keyboard.KeyBindingRepository;
 import org.jabref.logic.journals.JournalAbbreviationPreferences;
@@ -21,4 +23,16 @@ public interface PreferencesService {
 
     void setWorkingDir(Path dir);
 
+    Map<String, List<String>> getEntryEditorTabList();
+
+    Boolean getEnforceLegalKeys();
+
+    Map<String, String> getCustomTabsNamesAndFields();
+
+    void setCustomTabsNameAndFields(String name, String fields, int defNumber);
+
+    public void purgeSeries(String prefix, int number);
+
+    public void updateEntryEditorTabList();
+
 }