Make it easier to create FXML dialogs (#3880)

* Extract swing dialog display to dialog service

* Embed preference dialog in JavaFX window

* Use new version of afterburner

* Fix injection into controller classes

* Fix build and code cleanup

Author: tobiasdiez

build.gradle

@@ -85,6 +85,7 @@ configurations {
 }
 
 dependencies {
+    // Include all jar-files in the 'lib' folder as dependencies
     compile fileTree(dir: 'lib', includes: ['*.jar'])
 
     compile 'com.jgoodies:jgoodies-common:1.8.1'
@@ -123,7 +124,6 @@ dependencies {
     compile 'com.google.guava:guava:24.1-jre'
 
     // JavaFX stuff
-    compile 'com.airhacks:afterburner.fx:1.7.0'
     compile 'de.codecentric.centerdevice:javafxsvg:1.3.0'
     compile 'de.jensd:fontawesomefx-materialdesignfont:1.7.22-4'
     compile 'de.saxsys:mvvmfx-validation:1.7.0'
@@ -132,6 +132,7 @@ dependencies {
     compile 'org.fxmisc.flowless:flowless:0.6'
     compile 'org.fxmisc.richtext:richtextfx:0.8.2'
     compile 'com.sibvisions.external.jvxfx:dndtabpane:0.1'
+    compile 'javax.inject:javax.inject:1'
 
 
     // Cannot be updated to 9.*.* until Jabref works with Java 9

javafx/scene/control/annotations.xml

@@ -0,0 +1,5 @@
+<root>
+    <item name='javafx.scene.control.Dialog dialogPane'>
+        <annotation name='javafx.fxml.FXML'/>
+    </item>
+</root>

lib/afterburner.fx.jar

@@ -59,4 +59,14 @@ public <T> T instantiatePresenter(Class<T> clazz, Function<String, Object> injec
 
         return Injector.instantiatePresenter(clazz, injectionContext);
     }
+
+    @Override
+    public void injectMembers(Object instance, Function<String, Object> injectionContext) {
+        LOGGER.debug("Inject into " + instance.getClass().getName());
+
+        // Use our own method to construct dependencies
+        Injector.setInstanceSupplier(DefaultInjector::createDependency);
+
+        Injector.injectMembers(instance, injectionContext);
+    }
 }

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

@@ -4,16 +4,12 @@
 import java.util.Optional;
 
 import javax.swing.JOptionPane;
-import javax.swing.JScrollPane;
-
-import javafx.embed.swing.SwingNode;
-import javafx.scene.control.ButtonType;
-import javafx.scene.control.DialogPane;
 
 import org.jabref.Globals;
 import org.jabref.gui.BasePanel;
 import org.jabref.gui.DialogService;
 import org.jabref.gui.JabRefFrame;
+import org.jabref.gui.cleanup.CleanupDialog;
 import org.jabref.gui.cleanup.CleanupPresetPanel;
 import org.jabref.gui.undo.NamedCompound;
 import org.jabref.gui.undo.UndoableFieldChange;
@@ -67,27 +63,14 @@ public void run() {
         if (canceled) {
             return;
         }
-        CleanupPresetPanel presetPanel = new CleanupPresetPanel(panel.getBibDatabaseContext(),
-                CleanupPreset.loadFromPreferences(preferences));
-
-        SwingNode node = new SwingNode();
-        presetPanel.getScrollPane().setVisible(true);
-
-        JScrollPane scrollPane = presetPanel.getScrollPane();
-        node.setContent(scrollPane);
-        node.setVisible(true);
-
-        DialogPane pane = new DialogPane();
-        pane.setContent(node);
-        pane.setPrefSize(600, 600);
-
-        Optional<ButtonType> ok = dialogService.showCustomDialogAndWait(Localization.lang("Cleanup entries"), pane, ButtonType.OK, ButtonType.CANCEL);
+        CleanupDialog cleanupDialog = new CleanupDialog(panel.getBibDatabaseContext(), CleanupPreset.loadFromPreferences(preferences));
 
-        if (!ok.isPresent() || ((ok.isPresent() && (ok.get() == ButtonType.CANCEL)))) {
+        Optional<CleanupPreset> chosenPreset = cleanupDialog.showAndWait();
+        if (!chosenPreset.isPresent()) {
             canceled = true;
             return;
         }
-        CleanupPreset cleanupPreset = presetPanel.getCleanupPreset();
+        CleanupPreset cleanupPreset = chosenPreset.get();
         cleanupPreset.storeInPreferences(preferences);
 
         if (cleanupPreset.isRenamePDF() && Globals.prefs.getBoolean(JabRefPreferences.ASK_AUTO_NAMING_PDFS_AGAIN)) {

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

@@ -47,8 +47,8 @@ private void showDialog(List<CopyFilesResultItemViewModel> data) {
             dialogService.showInformationDialogAndWait(Localization.lang("Copy linked files to folder..."), Localization.lang("No linked files found for export."));
             return;
         }
-        CopyFilesDialogView dlg = new CopyFilesDialogView(databaseContext, new CopyFilesResultListDependency(data));
-        dlg.show();
+        CopyFilesDialogView dialog = new CopyFilesDialogView(databaseContext, new CopyFilesResultListDependency(data));
+        dialog.show();
     }
 
     @Override

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

@@ -14,17 +14,12 @@ public ShowPreferencesAction(JabRefFrame jabRefFrame) {
 
     @Override
     public void execute() {
-        // output(Localization.lang("Opening preferences..."));
         if (prefsDialog == null) {
             prefsDialog = new PreferencesDialog(jabRefFrame);
-            //prefsDialog.setLocationRelativeTo(JabRefFrame.this);
         } else {
             prefsDialog.setValues();
         }
 
-        prefsDialog.setVisible(true);
-        //output("");
-
+        prefsDialog.show();
     }
-
 }