[WIP] Convert Exporter Customization Dialog to javafx #4394
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,12 @@ | ||
| package org.jabref.gui.actions; | ||
|
|
||
| import org.jabref.gui.exporter.ExportCustomizationDialogView; | ||
|
|
||
| public class ManageCustomExportsAction extends SimpleCommand { | ||
|
|
||
| @Override | ||
| public void execute() { | ||
| new ExportCustomizationDialogView().show(); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
|
|
||
| <?import javafx.geometry.Insets?> | ||
| <?import javafx.scene.control.Button?> | ||
| <?import javafx.scene.control.ButtonType?> | ||
| <?import javafx.scene.control.DialogPane?> | ||
| <?import javafx.scene.control.Label?> | ||
| <?import javafx.scene.control.TextField?> | ||
| <?import javafx.scene.layout.AnchorPane?> | ||
| <?import javafx.scene.layout.ColumnConstraints?> | ||
| <?import javafx.scene.layout.GridPane?> | ||
| <?import javafx.scene.layout.RowConstraints?> | ||
|
|
||
| <DialogPane maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="300.0" prefWidth="480.0" xmlns="http://javafx.com/javafx/8.0.171" xmlns:fx="http://javafx.com/fxml/1" fx:controller="org.jabref.gui.exporter.CreateModifyExporterDialogView"> | ||
| <content> | ||
| <AnchorPane minHeight="0.0" minWidth="0.0" prefHeight="200.0" prefWidth="320.0"> | ||
| <children> | ||
| <GridPane prefWidth="480.0" scaleShape="false"> | ||
| <columnConstraints> | ||
| <ColumnConstraints hgrow="SOMETIMES" minWidth="10.0" prefWidth="100.0" /> | ||
| </columnConstraints> | ||
| <rowConstraints> | ||
| <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="SOMETIMES" /> | ||
| <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="SOMETIMES" /> | ||
| <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="SOMETIMES" /> | ||
| <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="SOMETIMES" /> | ||
| <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="SOMETIMES" /> | ||
| <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="SOMETIMES" /> | ||
| <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="SOMETIMES" /> | ||
| </rowConstraints> | ||
| <children> | ||
| <TextField fx:id="name" GridPane.rowIndex="1" /> | ||
| <Label text="%Main layout file:" GridPane.rowIndex="2" /> | ||
| <TextField fx:id="fileName" GridPane.rowIndex="3" /> | ||
| <TextField fx:id="extension" GridPane.rowIndex="6" /> | ||
| <Label alignment="TOP_LEFT" text="%Export format name:"> | ||
| <GridPane.margin> | ||
| <Insets /> | ||
| </GridPane.margin> | ||
| </Label> | ||
| <Label text="%File extension:" GridPane.rowIndex="5" /> | ||
| <Button fx:id="browseButton" text="%Browse" onAction="#browse" GridPane.rowIndex="4" /> | ||
| </children> | ||
| <padding> | ||
| <Insets bottom="30.0" left="30.0" right="30.0" top="30.0" /> | ||
| </padding> | ||
| </GridPane> | ||
| </children></AnchorPane> | ||
| </content> | ||
| <ButtonType fx:id="saveExporter" text="%Save exporter" /> | ||
| <ButtonType fx:constant="CANCEL" /> | ||
| </DialogPane> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| package org.jabref.gui.exporter; | ||
|
|
||
| import javax.inject.Inject; | ||
|
|
||
| import javafx.event.ActionEvent; | ||
| import javafx.fxml.FXML; | ||
| import javafx.scene.control.Button; | ||
| import javafx.scene.control.ButtonType; | ||
| import javafx.scene.control.TextField; | ||
|
|
||
| import org.jabref.gui.DialogService; | ||
| import org.jabref.gui.util.BaseDialog; | ||
| import org.jabref.logic.journals.JournalAbbreviationLoader; | ||
| import org.jabref.logic.l10n.Localization; | ||
| import org.jabref.preferences.PreferencesService; | ||
|
|
||
| import com.airhacks.afterburner.views.ViewLoader; | ||
|
|
||
| public class CreateModifyExporterDialogView extends BaseDialog<ExporterViewModel> { | ||
|
|
||
| //Browse must be a Button because ButtonTypes must be on the buttom, not next to the filename field | ||
| @FXML private Button browseButton; | ||
| @FXML private TextField name; | ||
| @FXML private TextField fileName; | ||
| @FXML private TextField extension; | ||
| @FXML private ButtonType saveExporter; | ||
|
|
||
| @Inject private DialogService dialogService; | ||
| @Inject private PreferencesService preferences; | ||
| @Inject private final JournalAbbreviationLoader loader; | ||
| private CreateModifyExporterDialogViewModel viewModel; | ||
|
|
||
| private final ExporterViewModel exporter; | ||
|
|
||
| public CreateModifyExporterDialogView(ExporterViewModel exporter, DialogService dialogService, | ||
| PreferencesService preferences, JournalAbbreviationLoader loader) { //should the latter three have been injected as in the main dialog rather than passed as a param? | ||
|
There was a problem hiding this comment. Yes it is slightly better to use There was a problem hiding this comment. Done. I have also injected |
||
| this.setTitle(Localization.lang("Customize Export Formats")); | ||
| this.exporter = exporter; | ||
| this.loader = loader; | ||
| this.dialogService = dialogService; | ||
| this.preferences = preferences; | ||
|
|
||
| ViewLoader.view(this) | ||
| .load() | ||
| .setAsDialogPane(this); | ||
|
|
||
| this.setResultConverter(button -> { | ||
| if (button == saveExporter) { | ||
| return viewModel.saveExporter(); | ||
| } else { | ||
| return null; | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| @FXML | ||
| private void initialize() { | ||
| viewModel = new CreateModifyExporterDialogViewModel(exporter, dialogService, preferences, loader); | ||
| name.textProperty().bindBidirectional(viewModel.getName()); | ||
| fileName.textProperty().bindBidirectional(viewModel.getLayoutFileName()); | ||
| extension.textProperty().bindBidirectional(viewModel.getExtension()); | ||
| } | ||
|
|
||
| @FXML | ||
| private void browse(ActionEvent event) { | ||
| viewModel.browse(); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| package org.jabref.gui.exporter; | ||
|
|
||
| import java.nio.file.Path; | ||
| import java.nio.file.Paths; | ||
|
|
||
| import javafx.beans.property.SimpleStringProperty; | ||
| import javafx.beans.property.StringProperty; | ||
|
|
||
| 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.journals.JournalAbbreviationLoader; | ||
| import org.jabref.logic.l10n.Localization; | ||
| import org.jabref.logic.layout.LayoutFormatterPreferences; | ||
| import org.jabref.logic.util.StandardFileType; | ||
| import org.jabref.preferences.PreferencesService; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * | ||
| * This view model can be used both for "add exporter" and "modify exporter" functionalities. | ||
| * It takes an optional exporter which is empty for "add exporter," and takes the selected exporter | ||
| * for "modify exporter." It returns an optional exporter which empty if an invalid or no exporter is | ||
| * created, and otherwise contains the exporter to be added or that is modified. | ||
| * | ||
| */ | ||
|
|
||
| public class CreateModifyExporterDialogViewModel extends AbstractViewModel { | ||
|
|
||
| private static final Logger LOGGER = LoggerFactory.getLogger(CreateModifyExporterDialogViewModel.class); | ||
|
|
||
| private final DialogService dialogService; | ||
| private final PreferencesService preferences; | ||
|
|
||
| private final StringProperty name = new SimpleStringProperty(""); | ||
| private final StringProperty layoutFile = new SimpleStringProperty(""); | ||
| private final StringProperty extension = new SimpleStringProperty(""); | ||
|
|
||
| private final JournalAbbreviationLoader loader; | ||
|
|
||
|
|
||
| public CreateModifyExporterDialogViewModel(ExporterViewModel exporter, DialogService dialogService, PreferencesService preferences, | ||
| JournalAbbreviationLoader loader) { | ||
| this.dialogService = dialogService; | ||
| this.preferences = preferences; | ||
| this.loader = loader; | ||
|
|
||
| //Set text of each of the boxes | ||
| if (exporter != null) { | ||
| name.setValue(exporter.name().get()); | ||
| layoutFile.setValue(exporter.layoutFileName().get()); | ||
| extension.setValue(exporter.extension().get()); | ||
| } | ||
| } | ||
|
|
||
| public ExporterViewModel saveExporter() { | ||
| Path layoutFileDir = Paths.get(layoutFile.get()).getParent(); | ||
| if (layoutFileDir != null) { | ||
| String layoutFileDirString = layoutFileDir.toString(); | ||
| preferences.setExportWorkingDirectory(layoutFileDirString); | ||
| } | ||
|
|
||
| // Check that there are no empty strings. | ||
| if (layoutFile.get().isEmpty() || name.get().isEmpty() || extension.get().isEmpty() | ||
| || !layoutFile.get().endsWith(".layout")) { | ||
|
|
||
| LOGGER.info("One of the fields is empty or invalid!"); | ||
| // Return empty exporter to the main exporter customization dialog | ||
| return null; | ||
| } | ||
|
|
||
| // Create a new exporter to be returned to ExportCustomizationDialogViewModel, which requested it | ||
| LayoutFormatterPreferences layoutPreferences = preferences.getLayoutFormatterPreferences(loader); | ||
| SavePreferences savePreferences = preferences.loadForExportFromPreferences(); | ||
| TemplateExporter format = new TemplateExporter(name.get(), layoutFile.get(), extension.get(), | ||
| layoutPreferences, savePreferences); | ||
| format.setCustomExport(true); | ||
| return new ExporterViewModel(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 -> layoutFile.set(f.toAbsolutePath().toString())); //implement setting the text | ||
|
There was a problem hiding this comment. The call There was a problem hiding this comment. I put it in both, since saving the exporter might also indicate where the working directory should be. However, now it won't set the directory as before. Since this fix isn't working I am pushing this into a separate branch There was a problem hiding this comment. The call There was a problem hiding this comment. Right now it's called in as part of |
||
| } | ||
|
|
||
| public StringProperty getName() { | ||
| return name; | ||
| } | ||
|
|
||
| public StringProperty getLayoutFileName() { | ||
| return layoutFile; | ||
| } | ||
|
|
||
| public StringProperty getExtension() { | ||
| return extension; | ||
| } | ||
|
|
||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There should probably be a
Cancelbutton as well (if the user decides to abort his editing).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This hasn't worked despite my adding
<ButtonType fx:constant="CANCEL" />to the FXML, and I'm not sure why. The button does not appear in the dialog.