Conversion of preferences/exportsorting, import, maintable and entrye…

…ditor to mvvm (#5315) * Initial, Fix double list, setValues to Background, Templates and ExportSort * Fixes in ExportSorting * Fixes, Cleanups, EntryEditorTab, TableTab * Added ImportTab * Fixes wrong encoding * Reverse encoding fix * Checkstyle * Checkstyle * Fixed l10n, fixes checkstyle-config * Fixes after review * Cleanup missed superflous viewModel-casts and lambda-bodies * Don't set values using background task
JabRef · Sep 17, 2019 · a01ea20 · a01ea20
1 parent 1bec5ef
commit a01ea20
Show file tree

Hide file tree

Showing 55 changed files with 1,403 additions and 1,363 deletions.
diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <!DOCTYPE module PUBLIC
         "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
-        "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
+        "http://www.checkstyle.org/dtds/configuration_1_3.dtd">
 
 <module name="Checker">
     <module name="Header">

diff --git a/config/checkstyle/suppressions.xml b/config/checkstyle/suppressions.xml
@@ -2,7 +2,7 @@
 
 <!DOCTYPE suppressions PUBLIC
         "-//Puppy Crawl//DTD Suppressions 1.1//EN"
-        "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
+        "http://www.checkstyle.org/dtds/suppressions_1_1.dtd">
 
 <suppressions>
     <suppress checks="[a-zA-Z0-9]*" files="[\\/]gen[\\/]" />

diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java
@@ -62,4 +62,7 @@
     requires antlr.runtime;
     requires commons.lang3;
     requires xmpbox;
+    requires de.saxsys.mvvmfx.validation;
+    requires richtextfx;
+    requires unirest.java;
 }
diff --git a/src/main/java/org/jabref/gui/SaveOrderConfigDisplay.fxml b/src/main/java/org/jabref/gui/SaveOrderConfigDisplay.fxml
@@ -8,35 +8,53 @@
 <?import javafx.scene.layout.ColumnConstraints?>
 <?import javafx.scene.layout.GridPane?>
 <?import javafx.scene.layout.RowConstraints?>
-<fx:root prefHeight="200.0" prefWidth="600.0" type="javafx.scene.layout.GridPane" xmlns="http://javafx.com/javafx/8.0.171" xmlns:fx="http://javafx.com/fxml/1" fx:controller="org.jabref.gui.SaveOrderConfigDisplayView">
-    <columnConstraints>
-        <ColumnConstraints hgrow="SOMETIMES" minWidth="-Infinity" prefWidth="100.0" />
-        <ColumnConstraints hgrow="SOMETIMES" minWidth="10.0" prefWidth="100.0" />
-        <ColumnConstraints hgrow="SOMETIMES" minWidth="10.0" prefWidth="100.0" />
-    </columnConstraints>
-    <rowConstraints>
-        <RowConstraints prefHeight="30.0" />
-        <RowConstraints prefHeight="30.0" />
-        <RowConstraints prefHeight="30.0" />
-        <RowConstraints prefHeight="30.0" />
-        <RowConstraints prefHeight="30.0" />
-        <RowConstraints prefHeight="30.0" />
-    </rowConstraints>
+<?import javafx.scene.layout.VBox?>
+
+<fx:root prefWidth="650.0" spacing="10.0" type="VBox"
+         xmlns="http://javafx.com/javafx/8.0.212" xmlns:fx="http://javafx.com/fxml/1"
+         fx:controller="org.jabref.gui.SaveOrderConfigDisplayView">
     <fx:define>
-        <ToggleGroup fx:id="saveOrderToggleGroup" />
+        <ToggleGroup fx:id="saveOrderToggleGroup"/>
     </fx:define>
-    <children>
-        <ComboBox fx:id="savePriSort" editable="true" GridPane.columnIndex="1" GridPane.rowIndex="3" />
-        <ComboBox fx:id="saveSecSort" editable="true" GridPane.columnIndex="1" GridPane.rowIndex="4" />
-        <ComboBox fx:id="saveTerSort" editable="true" GridPane.columnIndex="1" GridPane.rowIndex="5" />
-        <RadioButton fx:id="exportInSpecifiedOrder" mnemonicParsing="false" prefHeight="5.0" prefWidth="206.0" text="%Export entries ordered as specified" toggleGroup="$saveOrderToggleGroup" GridPane.columnSpan="3" GridPane.rowIndex="2" />
-        <RadioButton fx:id="exportInTableOrder" mnemonicParsing="false" text="%Export in current table sort order" toggleGroup="$saveOrderToggleGroup" GridPane.columnSpan="3" GridPane.rowIndex="1" />
-        <RadioButton fx:id="exportInOriginalOrder" mnemonicParsing="false" text="%Export entries in their original order" toggleGroup="$saveOrderToggleGroup" GridPane.columnSpan="3" />
-        <CheckBox fx:id="savePriDesc" disable="${!exportInSpecifiedOrder.selected}" mnemonicParsing="false" text="%Descending" GridPane.columnIndex="2" GridPane.rowIndex="3" />
-        <CheckBox fx:id="saveSecDesc" disable="${!exportInSpecifiedOrder.selected}" mnemonicParsing="false" text="%Descending" GridPane.columnIndex="2" GridPane.rowIndex="4" />
-        <CheckBox fx:id="saveTerDesc" disable="${!exportInSpecifiedOrder.selected}" mnemonicParsing="false" text="%Descending" GridPane.columnIndex="2" GridPane.rowIndex="5" />
-        <Label disabled="${!exportInSpecifiedOrder.selected}" text="%Primary sort criterion" GridPane.rowIndex="3" />
-        <Label disabled="${!exportInSpecifiedOrder.selected}" text="%Secondary sort criterion" GridPane.rowIndex="4" />
-        <Label disabled="${!exportInSpecifiedOrder.selected}" text="%Tertiary sort criterion" GridPane.rowIndex="5" />
-    </children>
+
+    <RadioButton fx:id="exportInOriginalOrder" text="%Export entries in their original order"
+                 toggleGroup="$saveOrderToggleGroup"/>
+    <RadioButton fx:id="exportInTableOrder" text="%Export in current table sort order"
+                 toggleGroup="$saveOrderToggleGroup"/>
+    <RadioButton fx:id="exportInSpecifiedOrder"
+                 text="%Export entries ordered as specified" toggleGroup="$saveOrderToggleGroup"/>
+
+    <GridPane alignment="CENTER_LEFT" hgap="10.0">
+        <columnConstraints>
+            <ColumnConstraints hgrow="SOMETIMES" minWidth="-Infinity" prefWidth="100.0"/>
+            <ColumnConstraints hgrow="SOMETIMES" minWidth="10.0" prefWidth="100.0"/>
+            <ColumnConstraints hgrow="SOMETIMES" minWidth="10.0" prefWidth="100.0"/>
+        </columnConstraints>
+        <rowConstraints>
+            <RowConstraints prefHeight="30.0"/>
+            <RowConstraints prefHeight="30.0"/>
+            <RowConstraints prefHeight="30.0"/>
+            <RowConstraints prefHeight="30.0"/>
+            <RowConstraints prefHeight="30.0"/>
+            <RowConstraints prefHeight="30.0"/>
+        </rowConstraints>
+
+        <Label disable="${!exportInSpecifiedOrder.selected}" text="%Primary sort criterion" GridPane.rowIndex="0"/>
+        <Label disable="${!exportInSpecifiedOrder.selected}" text="%Secondary sort criterion" GridPane.rowIndex="1"/>
+        <Label disable="${!exportInSpecifiedOrder.selected}" text="%Tertiary sort criterion" GridPane.rowIndex="2"/>
+
+        <ComboBox fx:id="savePriSort" editable="true" GridPane.columnIndex="1" GridPane.rowIndex="0"
+                  disable="${!exportInSpecifiedOrder.selected}"/>
+        <ComboBox fx:id="saveSecSort" editable="true" GridPane.columnIndex="1" GridPane.rowIndex="1"
+                  disable="${!exportInSpecifiedOrder.selected}"/>
+        <ComboBox fx:id="saveTerSort" editable="true" GridPane.columnIndex="1" GridPane.rowIndex="2"
+                  disable="${!exportInSpecifiedOrder.selected}"/>
+
+        <CheckBox fx:id="savePriDesc" disable="${!exportInSpecifiedOrder.selected}" mnemonicParsing="false"
+                  text="%Descending" GridPane.columnIndex="2" GridPane.rowIndex="0"/>
+        <CheckBox fx:id="saveSecDesc" disable="${!exportInSpecifiedOrder.selected}" mnemonicParsing="false"
+                  text="%Descending" GridPane.columnIndex="2" GridPane.rowIndex="1"/>
+        <CheckBox fx:id="saveTerDesc" disable="${!exportInSpecifiedOrder.selected}" mnemonicParsing="false"
+                  text="%Descending" GridPane.columnIndex="2" GridPane.rowIndex="2"/>
+    </GridPane>
 </fx:root>
diff --git a/src/main/java/org/jabref/gui/SaveOrderConfigDisplayView.java b/src/main/java/org/jabref/gui/SaveOrderConfigDisplayView.java
@@ -7,36 +7,34 @@
 import javafx.scene.control.ComboBox;
 import javafx.scene.control.RadioButton;
 import javafx.scene.control.ToggleGroup;
-import javafx.scene.layout.GridPane;
+import javafx.scene.layout.VBox;
 
+import org.jabref.gui.util.FieldsUtil;
+import org.jabref.gui.util.ViewModelListCellFactory;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.entry.field.Field;
 import org.jabref.model.metadata.SaveOrderConfig;
 import org.jabref.preferences.PreferencesService;
 
 import com.airhacks.afterburner.views.ViewLoader;
 
-public class SaveOrderConfigDisplayView extends GridPane {
-
-    private final SaveOrderConfig config;
+public class SaveOrderConfigDisplayView extends VBox {
 
     @FXML private ToggleGroup saveOrderToggleGroup;
-    @FXML private ComboBox<Field> savePriSort;
-    @FXML private ComboBox<Field> saveSecSort;
-    @FXML private ComboBox<Field> saveTerSort;
     @FXML private RadioButton exportInSpecifiedOrder;
     @FXML private RadioButton exportInTableOrder;
     @FXML private RadioButton exportInOriginalOrder;
+    @FXML private ComboBox<Field> savePriSort;
+    @FXML private ComboBox<Field> saveSecSort;
+    @FXML private ComboBox<Field> saveTerSort;
     @FXML private CheckBox savePriDesc;
     @FXML private CheckBox saveSecDesc;
     @FXML private CheckBox saveTerDesc;
     @Inject private PreferencesService preferencesService;
 
     private SaveOrderConfigDisplayViewModel viewModel;
 
-    public SaveOrderConfigDisplayView(SaveOrderConfig config) {
-        this.config = config;
-
+    public SaveOrderConfigDisplayView() {
         ViewLoader.view(this)
                   .root(this)
                   .load();
@@ -45,26 +43,43 @@ public SaveOrderConfigDisplayView(SaveOrderConfig config) {
     @FXML
     private void initialize() {
 
-        viewModel = new SaveOrderConfigDisplayViewModel(config, preferencesService);
+        viewModel = new SaveOrderConfigDisplayViewModel(preferencesService);
 
-        exportInSpecifiedOrder.selectedProperty().bindBidirectional(viewModel.saveInSpecifiedOrderProperty());
-        exportInTableOrder.selectedProperty().bindBidirectional(viewModel.saveInTableOrderProperty());
         exportInOriginalOrder.selectedProperty().bindBidirectional(viewModel.saveInOriginalProperty());
+        exportInTableOrder.selectedProperty().bindBidirectional(viewModel.saveInTableOrderProperty());
+        exportInSpecifiedOrder.selectedProperty().bindBidirectional(viewModel.saveInSpecifiedOrderProperty());
 
+        new ViewModelListCellFactory<Field>()
+                .withText(FieldsUtil::getNameWithType)
+                .install(savePriSort);
         savePriSort.itemsProperty().bindBidirectional(viewModel.priSortFieldsProperty());
-        saveSecSort.itemsProperty().bindBidirectional(viewModel.secSortFieldsProperty());
-        saveTerSort.itemsProperty().bindBidirectional(viewModel.terSortFieldsProperty());
-
         savePriSort.valueProperty().bindBidirectional(viewModel.savePriSortSelectedValueProperty());
+        savePriSort.setConverter(FieldsUtil.fieldStringConverter);
+
+        new ViewModelListCellFactory<Field>()
+                .withText(FieldsUtil::getNameWithType)
+                .install(saveSecSort);
+        saveSecSort.itemsProperty().bindBidirectional(viewModel.secSortFieldsProperty());
         saveSecSort.valueProperty().bindBidirectional(viewModel.saveSecSortSelectedValueProperty());
+        saveSecSort.setConverter(FieldsUtil.fieldStringConverter);
+
+        new ViewModelListCellFactory<Field>()
+                .withText(FieldsUtil::getNameWithType)
+                .install(saveTerSort);
+        saveTerSort.itemsProperty().bindBidirectional(viewModel.terSortFieldsProperty());
         saveTerSort.valueProperty().bindBidirectional(viewModel.saveTerSortSelectedValueProperty());
+        saveTerSort.setConverter(FieldsUtil.fieldStringConverter);
 
         savePriDesc.selectedProperty().bindBidirectional(viewModel.savePriDescPropertySelected());
         saveSecDesc.selectedProperty().bindBidirectional(viewModel.saveSecDescPropertySelected());
         saveTerDesc.selectedProperty().bindBidirectional(viewModel.saveTerDescPropertySelected());
 
     }
 
+    public void setValues(SaveOrderConfig config) {
+        viewModel.setSaveOrderConfig(config);
+    }
+
     public void changeExportDescriptionToSave() {
         exportInOriginalOrder.setText(Localization.lang("Save entries in their original order"));
         exportInSpecifiedOrder.setText(Localization.lang("Save entries ordered as specified"));

diff --git a/src/main/java/org/jabref/gui/SaveOrderConfigDisplayViewModel.java b/src/main/java/org/jabref/gui/SaveOrderConfigDisplayViewModel.java
@@ -37,15 +37,13 @@ public class SaveOrderConfigDisplayViewModel {
 
     private final PreferencesService prefs;
 
-    public SaveOrderConfigDisplayViewModel(SaveOrderConfig config, PreferencesService prefs) {
+    public SaveOrderConfigDisplayViewModel(PreferencesService prefs) {
         this.prefs = prefs;
 
         Set<Field> fieldNames = FieldFactory.getCommonFields();
         priSortFieldsProperty.addAll(fieldNames);
         secSortFieldsProperty.addAll(fieldNames);
         terSortFieldsProperty.addAll(fieldNames);
-
-        setSaveOrderConfig(config);
     }
 
     public ListProperty<Field> priSortFieldsProperty() {

diff --git a/src/main/java/org/jabref/gui/icon/IconTheme.java b/src/main/java/org/jabref/gui/icon/IconTheme.java
@@ -271,6 +271,10 @@ public enum JabRefIcons implements JabRefIcon {
         PREVIOUS_UP(MaterialDesignIcon.CHEVRON_UP),
         NEXT_RIGHT(MaterialDesignIcon.CHEVRON_RIGHT),
         NEXT_DOWN(MaterialDesignIcon.CHEVRON_DOWN),
+        LIST_MOVE_LEFT(MaterialDesignIcon.CHEVRON_LEFT),
+        LIST_MOVE_UP(MaterialDesignIcon.CHEVRON_UP),
+        LIST_MOVE_RIGHT(MaterialDesignIcon.CHEVRON_RIGHT),
+        LIST_MOVE_DOWN(MaterialDesignIcon.CHEVRON_DOWN),
         FIT_WIDTH(MaterialDesignIcon.ARROW_EXPAND_ALL),
         FIT_SINGLE_PAGE(MaterialDesignIcon.NOTE),
         ZOOM_OUT(MaterialDesignIcon.MAGNIFY_MINUS),

diff --git a/src/main/java/org/jabref/gui/libraryproperties/LibraryPropertiesDialogView.java b/src/main/java/org/jabref/gui/libraryproperties/LibraryPropertiesDialogView.java
@@ -79,14 +79,9 @@ private void initialize() {
         encoding.disableProperty().bind(viewModel.encodingDisableProperty());
         protect.disableProperty().bind(viewModel.protectDisableProperty());
 
+        saveOrderConfigDisplayView = new SaveOrderConfigDisplayView();
         Optional<SaveOrderConfig> storedSaveOrderConfig = panel.getBibDatabaseContext().getMetaData().getSaveOrderConfig();
-        if (storedSaveOrderConfig.isPresent()) {
-            saveOrderConfigDisplayView = new SaveOrderConfigDisplayView(storedSaveOrderConfig.get());
-            oldSaveOrderConfig = storedSaveOrderConfig.get();
-        } else {
-            oldSaveOrderConfig = preferencesService.loadExportSaveOrder();
-            saveOrderConfigDisplayView = new SaveOrderConfigDisplayView(preferencesService.loadExportSaveOrder());
-        }
+        oldSaveOrderConfig = storedSaveOrderConfig.orElseGet(preferencesService::loadExportSaveOrder);
 
         saveOrderConfigDisplayView.changeExportDescriptionToSave();
         fieldFormatterCleanupsPanel = new FieldFormatterCleanupsPanel(Localization.lang("Enable save actions"),
@@ -103,6 +98,7 @@ private void initialize() {
 
     private void setValues() {
         fieldFormatterCleanupsPanel.setValues(panel.getBibDatabaseContext().getMetaData());
+        saveOrderConfigDisplayView.setValues(oldSaveOrderConfig);
     }
 
     @FXML

diff --git a/src/main/java/org/jabref/gui/preferences/AbstractPreferenceTabView.java b/src/main/java/org/jabref/gui/preferences/AbstractPreferenceTabView.java
@@ -11,12 +11,12 @@
 import org.jabref.gui.util.TaskExecutor;
 import org.jabref.preferences.JabRefPreferences;
 
-public abstract class AbstractPreferenceTabView extends VBox implements PreferencesTab {
+public abstract class AbstractPreferenceTabView<T extends PreferenceTabViewModel> extends VBox implements PreferencesTab {
 
     @Inject protected TaskExecutor taskExecutor;
     @Inject protected DialogService dialogService;
 
-    protected PreferenceTabViewModel viewModel;
+    protected T viewModel;
 
     protected JabRefPreferences preferences;