Journal abbreviations dialog ported to JavaFX

CHANGELOG.md

@@ -14,7 +14,10 @@ We refer to [GitHub issues](https://github.com/JabRef/jabref/issues) by using `#
 ## JavaFX Changes
 (to be moved to `##Changed` as soon as JavaFX is integrated in the main branch)
 - Add tab which shows the MathSciNet review website if the `MRNumber` field is present.
-- Partly switched to new UI technology (JavaFX). Redesigned key bindings dialog.
+- Partly switched to new UI technology (JavaFX).
+    - Redesigned about dialog.
+    - Redesigned key bindings dialog.
+    - Redesigned journal abbreviations dialog.
 
 
 ### Changed
@@ -148,7 +151,6 @@ We refer to [GitHub issues](https://github.com/JabRef/jabref/issues) by using `#
 - Added support for several Biblatex-fields through drop-down lists with valid alternatives
 - Added integrity checker for an odd number of unescaped '#'
 - Implemented [feature request 384](https://sourceforge.net/p/jabref/features/384): The merge entries dialog now show all text and colored differences between the fields
-- Partly switched to new UI technology (JavaFX). Redesigned about dialog.
 - Implemented [#1233](https://github.com/JabRef/jabref/issues/1233): Group side pane now takes up all the remaining space
 - Added integrity check detecting HTML-encoded characters
 - Added missing help files

src/main/java/net/sf/jabref/gui/IconTheme.java

@@ -37,6 +37,9 @@
 import javax.swing.Icon;
 import javax.swing.ImageIcon;
 
+import javafx.scene.Node;
+import javafx.scene.text.Text;
+
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
@@ -198,6 +201,12 @@ public FontBasedIcon getSmallIcon() {
             return new FontBasedIcon(this.code, this.color, IconTheme.SMALL_SIZE);
         }
 
+        public Node getGraphicNode() {
+            Text graphic = new Text(this.code);
+            graphic.getStyleClass().add("icon");
+            return graphic;
+        }
+
         public String getCode() {
             return this.code;
         }

src/main/java/net/sf/jabref/gui/JabRefFrame.java

@@ -416,7 +416,7 @@ public void actionPerformed(ActionEvent e) {
             Localization.menuTitle("Unabbreviate journal names"),
             Localization.lang("Unabbreviate journal names of the selected entries"),
             Globals.getKeyPrefs().getKey(KeyBinding.UNABBREVIATE));
-    private final AbstractAction manageJournals = new ManageJournalsAction(this);
+    private final AbstractAction manageJournals = new ManageJournalsAction();
     private final AbstractAction databaseProperties = new DatabasePropertiesAction();
     private final AbstractAction bibtexKeyPattern = new BibtexKeyPatternAction();
     private final AbstractAction errorConsole = new ErrorConsoleAction(this, Globals.getStreamEavesdropper(), GuiAppender.CACHE);

src/main/java/net/sf/jabref/gui/journals/AbbreviationViewModel.java

@@ -0,0 +1,100 @@
+/*  Copyright (C) 2016 JabRef contributors.
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+package net.sf.jabref.gui.journals;
+
+import java.util.Objects;
+
+import javafx.beans.property.BooleanProperty;
+import javafx.beans.property.SimpleBooleanProperty;
+import javafx.beans.property.SimpleStringProperty;
+import javafx.beans.property.StringProperty;
+
+import net.sf.jabref.logic.journals.Abbreviation;
+
+/**
+ * This class provides a view model for abbreviation objects which can also
+ * define placeholder objects of abbreviations. This is indicated by using the
+ * {@code pseudoAbbreviation} property.
+ */
+public class AbbreviationViewModel {
+
+    private final Abbreviation abbreviationObject;
+    private final StringProperty name = new SimpleStringProperty("");
+    private final StringProperty abbreviation = new SimpleStringProperty("");
+    private final BooleanProperty pseudoAbbreviation = new SimpleBooleanProperty();
+
+
+    public AbbreviationViewModel(Abbreviation abbreviation) {
+        this.abbreviationObject = abbreviation;
+        pseudoAbbreviation.set(this.abbreviationObject == null);
+        if (this.abbreviationObject != null) {
+            this.name.bindBidirectional(this.abbreviationObject.nameProperty());
+            this.abbreviation.bindBidirectional(this.abbreviationObject.abbreviationProperty());
+        } else {
+            this.name.set("Add new Abbreviation");
+        }
+    }
+
+    public Abbreviation getAbbreviationObject() {
+        return this.abbreviationObject;
+    }
+
+    public void setName(String name) {
+        this.name.set(name);
+    }
+
+    public void setAbbreviation(String abbreviation) {
+        this.abbreviation.set(abbreviation);
+    }
+
+    public String getName() {
+        return this.name.get();
+    }
+
+    public String getAbbreviation() {
+        return this.abbreviation.get();
+    }
+
+    public boolean isPseudoAbbreviation() {
+        return this.pseudoAbbreviation.get();
+    }
+
+    public StringProperty nameProperty() {
+        return this.name;
+    }
+
+    public StringProperty abbreviationProperty() {
+        return this.abbreviation;
+    }
+
+    public BooleanProperty isPseudoAbbreviationProperty() {
+        return this.pseudoAbbreviation;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(abbreviationObject);
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (obj instanceof AbbreviationViewModel) {
+            return Objects.equals(this.abbreviationObject, ((AbbreviationViewModel) obj).abbreviationObject);
+        } else {
+            return false;
+        }
+    }
+}

src/main/java/net/sf/jabref/gui/journals/AbbreviationsFileViewModel.java

@@ -0,0 +1,136 @@
+/*  Copyright (C) 2016 JabRef contributors.
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+package net.sf.jabref.gui.journals;
+
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+
+import javafx.beans.property.ReadOnlyBooleanProperty;
+import javafx.beans.property.SimpleBooleanProperty;
+import javafx.beans.property.SimpleListProperty;
+import javafx.collections.FXCollections;
+
+import net.sf.jabref.logic.journals.Abbreviation;
+import net.sf.jabref.logic.journals.AbbreviationWriter;
+import net.sf.jabref.logic.journals.JournalAbbreviationLoader;
+
+import com.google.common.collect.Lists;
+
+/**
+ * This class provides a model for abbreviation files.
+ * It actually doesn't save the files as objects but rather saves
+ * their paths. This also allows to specify pseudo files as placeholder objects.
+ */
+public class AbbreviationsFileViewModel {
+
+    private final SimpleListProperty<AbbreviationViewModel> abbreviations = new SimpleListProperty<>(
+            FXCollections.observableArrayList());
+    private final ReadOnlyBooleanProperty isBuiltInList;
+    private final String name;
+    private final Optional<Path> path;
+
+
+    public AbbreviationsFileViewModel(String filePath) {
+        this.path = Optional.ofNullable(Paths.get(filePath));
+        this.name = path.get().toAbsolutePath().toString();
+        this.isBuiltInList = new SimpleBooleanProperty(false);
+        this.abbreviations.add(new AbbreviationViewModel(null));
+    }
+
+    /**
+     * This constructor should only be called to create a pseudo abbreviation file for built in lists.
+     * This means it is a placeholder and it's path will be null meaning it has no place on the filesystem.
+     * It's isPseudoFile property will therefore be set to true.
+     */
+    public AbbreviationsFileViewModel(List<AbbreviationViewModel> abbreviations, String name) {
+        this.abbreviations.addAll(abbreviations);
+        this.name = name;
+        this.path = Optional.empty();
+        this.isBuiltInList = new SimpleBooleanProperty(true);
+    }
+
+    public void readAbbreviations() throws FileNotFoundException {
+        if (path.isPresent()) {
+            List<Abbreviation> abbreviationList = JournalAbbreviationLoader
+                    .readJournalListFromFile(path.get().toFile());
+            abbreviationList.forEach(abbreviation -> abbreviations.addAll(new AbbreviationViewModel(abbreviation)));
+        } else {
+            throw new FileNotFoundException();
+        }
+    }
+
+    /**
+     * This method will write all abbreviations of this abbreviation file to the file on the file system.
+     * It essentially will check if the current file is a built in list and if not it will call
+     * {@link AbbreviationWriter#writeOrCreate()}.
+     *
+     * @throws IOException
+     */
+    public void writeOrCreate() throws IOException {
+        if (!isBuiltInList.get()) {
+            List<Abbreviation> actualAbbreviations = Lists.newArrayList();
+            abbreviations.forEach(abb -> {
+                if (!abb.isPseudoAbbreviation()) {
+                    actualAbbreviations.add(abb.getAbbreviationObject());
+                }
+            });
+            AbbreviationWriter.writeOrCreate(path.get(), actualAbbreviations, StandardCharsets.UTF_8);
+        }
+    }
+
+    public SimpleListProperty<AbbreviationViewModel> abbreviationsProperty() {
+        return this.abbreviations;
+    }
+
+    public boolean exists() {
+        return path.isPresent() && Files.exists(path.get());
+    }
+
+    public String getAbsolutePath() {
+        return path.get().toAbsolutePath().toString();
+    }
+
+    public ReadOnlyBooleanProperty isBuiltInListProperty() {
+        return this.isBuiltInList;
+    }
+
+    @Override
+    public String toString() {
+        return this.name;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(name);
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (obj instanceof AbbreviationsFileViewModel) {
+            return Objects.equals(this.name, ((AbbreviationsFileViewModel) obj).name);
+        } else {
+            return false;
+        }
+    }
+
+}