[WIP] Convert Exporter Customization Dialog to javafx

src/main/java/org/jabref/gui/exporter/CreateModifyExporterDialogViewModel.java

@@ -0,0 +1,89 @@
+package org.jabref.gui.exporter;
+
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Optional;
+
+import javafx.beans.property.SimpleStringProperty;
+
+import org.jabref.gui.AbstractViewModel;
+import org.jabref.gui.DialogService;
+import org.jabref.gui.util.FileDialogConfiguration;
+import org.jabref.logic.exporter.SavePreferences;
+import org.jabref.logic.exporter.TemplateExporter;
+import org.jabref.logic.l10n.Localization;
+import org.jabref.logic.layout.LayoutFormatterPreferences;
+import org.jabref.logic.util.FileType;
+import org.jabref.logic.util.StandardFileType;
+import org.jabref.preferences.JabRefPreferences; //will be removed with writing of new method
+import org.jabref.preferences.PreferencesService;
+
+public class CreateModifyExporterDialogViewModel extends AbstractViewModel {
+
+    //This could be separated into two dialogs, one for adding exporters and one for modifying them.
+    //See the two constructors for the view
+
+    //The view will return a TemplateExporter
+    //You will have to look at Swing class CustomExportDialog when you write the View
+
+    //Cancel to be implemented in View, not here
+
+    private final TemplateExporter exporter;
+    private final DialogService dialogService;
+    private final PreferencesService preferences;
+
+    private final SimpleStringProperty name; //prevent saveExporter from saving this if it's null
+    private final SimpleStringProperty layoutFile;
+    private final SimpleStringProperty extension;
+
+
+    public CreateModifyExporterDialogViewModel(TemplateExporter exporter, DialogService dialogService, PreferencesService preferences) {
+        this.exporter = exporter;
+        this.dialogService = dialogService;
+        this.preferences = preferences;
+        //Set text of each of the boxes
+
+    }
+
+    public TemplateExporter saveExporter() {//void?
+        Path layoutFileDir = Paths.get(layoutFile.get()).getParent();
+        if (layoutFileDir != null) {
+            preferences.put(JabRefPreferences.EXPORT_WORKING_DIRECTORY, layoutFileDir.toString()); //fix to work with PreferencesService
+
+        }
+        preferences.saveExportWorkingDirectory(layoutFileDir.toString()); //See Swing class CustomExportDialog for more on how implement this
+        // Create a new exporter to be returned to ExportCustomizationDialog, which requested it
+        LayoutFormatterPreferences layoutPreferences = preferences.getLayoutFormatterPreferences();
+        SavePreferences savePreferences = preferences.LoadForExportFromPreferences();
+        String filename = layoutFile.get(); //change var name?
+        String extensionString = extension.get(); //change var name?
+        String lfFileName;
+        //You might want to move the next few lines into logic because it also appears in JabRefPreferences
+        if (filename.endsWith(".layout")) {
+            lfFileName = filename.substring(0, filename.length() - ".layout".length());
+        } else {
+            lfFileName = filename;
+        }
+        if (extensionString.contains(".")) {
+            extension.set(extensionString.substring(extensionString.indexOf('.') + 1, extensionString.length()));
+        }
+        FileType fileType = StandardFileType.newFileType(extensionString);
+        TemplateExporter format = new TemplateExporter(name.get(), name.get(), lfFileName, null, fileType, layoutPreferences,
+                                                       savePreferences);
+        format.setCustomExport(true);
+        return format;
+    }
+
+    public String getExportWorkingDirectory() {//i.e. layout dir
+        return preferences.getExportWorkingDirectory();
+    }
+
+    public void browse() {
+        FileDialogConfiguration fileDialogConfiguration = new FileDialogConfiguration.Builder()
+            .addExtensionFilter(Localization.lang("Custom layout file"), StandardFileType.LAYOUT)
+            .withDefaultExtension(Localization.lang("Custom layout file"), StandardFileType.LAYOUT)
+            .withInitialDirectory(getExportWorkingDirectory()).build();
+        dialogService.showFileOpenDialog(fileDialogConfiguration).ifPresent(f -> setText(f.toAbsolutePath().toString())); //implement setting the text
+    }
+
+}

src/main/java/org/jabref/gui/exporter/ExportCustomizationDialogViewModel.java

@@ -0,0 +1,91 @@
+package org.jabref.gui.exporter;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import javafx.beans.property.SimpleListProperty;
+import javafx.collections.FXCollections;
+
+import org.jabref.gui.AbstractViewModel;
+import org.jabref.gui.DialogService;
+import org.jabref.logic.exporter.TemplateExporter;
+import org.jabref.logic.journals.JournalAbbreviationLoader;
+import org.jabref.preferences.PreferencesService;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class ExportCustomizationDialogViewModel extends AbstractViewModel {
+
+    //The class vars might need to be reordered
+
+    //exporters should probably be a JavaFX SortedList instead of SimpleListPreperty,
+    //but not yet sure how to make SortedList into a property
+    private final SimpleListProperty<ExporterViewModel> exporters = new SimpleListProperty<>(FXCollections.observableArrayList());
+
+    private final int size; //final?  Or you don't need this and just use a a while loop
+
+    //Indices within which export format information is stored within JabRefPreferences
+    private static final int EXPORTER_NAME_INDEX = 0;
+    private static final int EXPORTER_FILENAME_INDEX = 1;
+    private static final int EXPORTER_EXTENSION_INDEX = 2;
+
+    private final PreferencesService preferences;
+    private final DialogService dialogService;
+    private final JournalAbbreviationLoader loader;
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(CustomExportList.class);
+
+    //Other variable declarations here
+
+    //Also write tests for all of this if necessary
+
+    public ExportCustomizationDialogViewModel(DialogService dialogService, JournalAbbreviationLoader loader) {
+        this.dialogService = dialogService;
+        this.loader = loader;
+        init();
+
+        //ExporterViewModel is organized as a singular version of what now is CustomExportDialog, which
+        //currently stores all the exporters in a class var.  Each ExporterViewModel wraps an exporter, and
+        //the class var exporters is a list of the ExporterViewModels
+
+    }
+
+    public void loadExporters() {
+        List<TemplateExporter> exportersLogic = preferences.getCustomExportFormats(loader); //Var may need more descriptive name
+        for (TemplateExporter exporter : exportersLogic) {
+            exporters.add(new ExporterViewModel(exporter));
+        }
+    }
+
+    //The following method will have to be implemented to get information from the JavaFX analogue of Swing CustomExportDialog
+    public void addExporter() {
+        // open add Exporter dialog, set vars as dialogResult or analogous
+        TemplateExporter exporter = new CreateModifyExporterDialogView().show(); //Not sure if this is right
+        exporters.add(new ExporterViewModel(exporter));//var might have to be renamed
+
+    }
+
+    public void modifyExporter(int row) {
+        // open modify Exporter dialog, which may be the same as add Exporter dialog, and set that into exporters.
+        exporters.set(row, new ExporterViewModel(dialogResult)); //result must come from dialog
+    }
+
+    public void removeExporters(int[] rows) {
+        if (rows.length == 0) { // Is this check necessary?  Probably not
+            return;
+        }
+        for (int i = 0; i < rows.length; i++) {
+            exporters.remove(rows[i]);
+        }
+    }
+
+    public void saveToPrefs() {
+        List<TemplateExporter> exportersLogic;
+        exporters.forEach(exporter -> exportersLogic.add(exporter.getLogic()));
+        preferences.storeCustomExportFormats(exportersLogic);
+    }
+    public void init() {
+        loadExporters();
+    }
+}

src/main/java/org/jabref/gui/exporter/ExporterViewModel.java

@@ -0,0 +1,17 @@
+package org.jabref.gui.exporter;
+
+import org.jabref.logic.exporter.TemplateExporter;
+
+public class ExporterViewModel {
+
+    TemplateExporter exporter;
+
+    public ExporterViewModel(TemplateExporter exporter) {
+        this.exporter = exporter;
+    }
+
+    public TemplateExporter getLogic() {
+        return this.exporter;
+    }
+
+}

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

@@ -79,7 +79,9 @@
 import org.jabref.logic.protectedterms.ProtectedTermsPreferences;
 import org.jabref.logic.remote.RemotePreferences;
 import org.jabref.logic.shared.prefs.SharedDatabasePreferences;
+import org.jabref.logic.util.FileType;
 import org.jabref.logic.util.OS;
+import org.jabref.logic.util.StandardFileType;
 import org.jabref.logic.util.UpdateFieldPreferences;
 import org.jabref.logic.util.Version;
 import org.jabref.logic.util.io.AutoLinkPreferences;
@@ -2012,4 +2014,68 @@ public Map<String, SortType> getMainTableColumnSortTypes() {
         }
         return map;
     }
+
+    @Override
+    public List<TemplateExporter> getCustomExportFormats(JournalAbbreviationLoader loader) {
+        int i = 0;
+        List<TemplateExporter> formats = null;
+        String exporterName;
+        String filename;
+        String extension;
+        String lfFileName;
+        LayoutFormatterPreferences layoutPreferences = getLayoutFormatterPreferences(loader);
+        SavePreferences savePreferences = loadForExportFromPreferences();
+        List<String> s;
+        // possibly check if CUSTOM_EXPORT_FORMAT + 0 is empty too and throw error
+        while (!((s = getStringList(CUSTOM_EXPORT_FORMAT + i)).isEmpty())) {
+            exporterName = s.get(0);
+            filename = s.get(1); // 0, 1, 2 were originally static vars
+            extension = s.get(2);
+            //You might want to put the following few lines in logic because it also appears in CreateModifyExporterDialogViewModel
+            if (filename.endsWith(".layout")) {
+                lfFileName = filename.substring(0, filename.length() - ".layout".length());
+            } else {
+                lfFileName = filename;
+            }
+            if (extension.contains(".")) {
+                extension = extension.substring(extension.indexOf('.') + 1, extension.length());
+            }
+            FileType fileType = StandardFileType.newFileType(extension);
+            Optional<TemplateExporter> format = Optional.of(new TemplateExporter(exporterName, exporterName, lfFileName,
+                                                                                 null, fileType, layoutPreferences,
+                                                                                 savePreferences));
+            format.get().setCustomExport(true); //Taken out of orig CustomExporerList
+            if (format.isPresent()) {
+                formats.add(format.get());
+            } else {
+                String customExportFormat = get(JabRefPreferences.CUSTOM_EXPORT_FORMAT + i);
+                LOGGER.error("Error initializing custom export format from string " + customExportFormat);
+            }
+            i++;
+        }
+        return formats;
+    }
+
+    @Override
+    public void storeCustomExportFormats(List<TemplateExporter> exporters) {
+        if (exporters.isEmpty()) {
+            purgeCustomExportFormats(0);
+        } else {
+            for (int i = 0; i < exporters.size(); i++) {
+                List<String> exporterData = new ArrayList<>();
+                exporterData.add(exporters.get(i).getName());
+                exporterData.add(exporters.get(i).getId());
+                putStringList(CUSTOM_EXPORT_FORMAT + i, exporterData);
+            }
+            purgeCustomExportFormats(exporters.size());
+        }
+    }
+
+    private void purgeCustomExportFormats(int from) {
+        int i = from;
+        while (!getStringList(CUSTOM_EXPORT_FORMAT + i).isEmpty()) {
+            remove(CUSTOM_EXPORT_FORMAT + i);
+            i++;
+        }
+    }
 }

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

@@ -5,7 +5,11 @@
 import java.util.Map;
 
 import org.jabref.gui.keyboard.KeyBindingRepository;
+import org.jabref.logic.exporter.SavePreferences;
+import org.jabref.logic.exporter.TemplateExporter;
+import org.jabref.logic.journals.JournalAbbreviationLoader;
 import org.jabref.logic.journals.JournalAbbreviationPreferences;
+import org.jabref.logic.layout.LayoutFormatterPreferences;
 import org.jabref.model.metadata.FilePreferences;
 
 public interface PreferencesService {
@@ -35,4 +39,11 @@ public interface PreferencesService {
 
     public void updateEntryEditorTabList();
 
+    List<TemplateExporter> getCustomExportFormats(JournalAbbreviationLoader loader);
+
+    void storeCustomExportFormats(List<TemplateExporter> exporters);
+
+    LayoutFormatterPreferences getLayoutFormatterPreferences();
+
+    SavePreferences LoadForExportFromPreferences();
 }