Implement task progress indicator (and dialog) in the toolbar

src/main/java/org/jabref/gui/Base.css

@@ -387,6 +387,21 @@
     -fx-padding: -0.1em 0.5em 0.5em 0.5em;
 }
 
+.progress-indicator {
+    -fx-progress-color: -jr-theme;
+    -fx-border-width: 0px;
+    -fx-background-color: -jr-icon-background;
+    -fx-padding: 0.5em;
+}
+
+.progress-indicator .percentage {
+    -fx-fill:null;
+}
+
+.progress-indicator:hover {
+    -fx-background-color: -jr-icon-background-active;
+}
+
 .check-box {
     -fx-label-padding: 0.0em 0.0em 0.0em 0.75em;
     -fx-text-fill: -fx-text-background-color;

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

@@ -12,9 +12,15 @@
 import java.util.TimerTask;
 
 import javafx.application.Platform;
+import javafx.beans.property.ObjectProperty;
 import javafx.beans.value.ChangeListener;
 import javafx.beans.value.ObservableValue;
+import javafx.collections.ListChangeListener;
+import javafx.collections.ObservableList;
+import javafx.concurrent.Task;
+import javafx.event.EventHandler;
 import javafx.geometry.Orientation;
+import javafx.scene.Group;
 import javafx.scene.Node;
 import javafx.scene.control.Alert;
 import javafx.scene.control.Button;
@@ -23,6 +29,7 @@
 import javafx.scene.control.Menu;
 import javafx.scene.control.MenuBar;
 import javafx.scene.control.MenuItem;
+import javafx.scene.control.ProgressIndicator;
 import javafx.scene.control.Separator;
 import javafx.scene.control.SeparatorMenuItem;
 import javafx.scene.control.SplitPane;
@@ -32,14 +39,19 @@
 import javafx.scene.control.Tooltip;
 import javafx.scene.control.skin.TabPaneSkin;
 import javafx.scene.input.KeyEvent;
+import javafx.scene.input.MouseEvent;
 import javafx.scene.input.TransferMode;
 import javafx.scene.layout.BorderPane;
 import javafx.scene.layout.HBox;
 import javafx.scene.layout.Pane;
 import javafx.scene.layout.Priority;
 import javafx.scene.layout.VBox;
+import javafx.scene.shape.Rectangle;
 import javafx.stage.Stage;
 
+import javafx.stage.Window;
+import org.controlsfx.control.PopOver;
+import org.controlsfx.control.TaskProgressView;
 import org.jabref.Globals;
 import org.jabref.JabRefExecutorService;
 import org.jabref.gui.actions.ActionFactory;
@@ -517,7 +529,9 @@ private Node createToolbar() {
                 new Separator(Orientation.VERTICAL),
                 factory.createIconButton(StandardActions.OPEN_GITHUB, new OpenBrowserAction("https://github.com/JabRef/jabref")),
                 factory.createIconButton(StandardActions.OPEN_FACEBOOK, new OpenBrowserAction("https://www.facebook.com/JabRef/")),
-                factory.createIconButton(StandardActions.OPEN_TWITTER, new OpenBrowserAction("https://twitter.com/jabref_org"))
+                factory.createIconButton(StandardActions.OPEN_TWITTER, new OpenBrowserAction("https://twitter.com/jabref_org")),
+                new Separator(Orientation.VERTICAL),
+                createTaskIndicator()
         );
 
         HBox.setHgrow(globalSearchBar, Priority.ALWAYS);
@@ -921,6 +935,40 @@ private MenuBar createMenu() {
         return menu;
     }
 
+    private Group createTaskIndicator() {
+        ProgressIndicator indicator = new ProgressIndicator();
+        indicator.getStyleClass().setAll("progress-indicator");
+        indicator.progressProperty().bind(stateManager.tasksProgressBinding);
+
+        /*
+        The label of the indicator cannot be removed with styling. Therefore,
+        hide it and clip it to a square of (width x width) each time width is updated.
+         */
+        indicator.widthProperty().addListener((observable, oldValue, newValue) -> {
+            if(newValue.doubleValue()>0){
+                Rectangle clip=new Rectangle(newValue.doubleValue(),newValue.doubleValue());
+                indicator.setClip(clip);
+            }
+        });
+
+
+        indicator.setOnMouseClicked(event -> {
+
+            TaskProgressView taskProgressView = new TaskProgressView();
+            ObservableList<Task<?>> tasks = EasyBind.map(stateManager.getBackgroundTasks(), ObjectProperty<Task<?>>::<Task<?>>get);
+            EasyBind.listBind(taskProgressView.getTasks(), tasks);
+            taskProgressView.setRetainTasks(true);
+
+            PopOver progressViewPopOver = new PopOver(taskProgressView);
+            progressViewPopOver.setTitle(Localization.lang("Background Tasks"));
+            progressViewPopOver.setArrowLocation(PopOver.ArrowLocation.RIGHT_TOP);
+
+            progressViewPopOver.show(indicator);
+        });
+
+        return new Group(indicator);
+    }
+
     public void addParserResult(ParserResult parserResult, boolean focusPanel) {
         if (parserResult.toOpenTab()) {
             // Add the entries to the open tab.

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

@@ -5,18 +5,25 @@
 import java.util.Optional;
 import java.util.stream.Collectors;
 
+import javafx.beans.binding.Binding;
 import javafx.beans.binding.Bindings;
+import javafx.beans.binding.BooleanBinding;
+import javafx.beans.binding.DoubleBinding;
 import javafx.beans.property.IntegerProperty;
+import javafx.beans.property.ObjectProperty;
 import javafx.beans.property.ReadOnlyListProperty;
 import javafx.beans.property.ReadOnlyListWrapper;
 import javafx.beans.property.SimpleIntegerProperty;
 import javafx.collections.FXCollections;
 import javafx.collections.ObservableList;
 import javafx.collections.ObservableMap;
+import javafx.concurrent.Task;
 import javafx.scene.Node;
 
+import org.fxmisc.easybind.EasyBind;
 import org.jabref.gui.util.CustomLocalDragboard;
 import org.jabref.gui.util.OptionalObjectProperty;
+import org.jabref.gui.util.uithreadaware.UiThreadObservableList;
 import org.jabref.logic.search.SearchQuery;
 import org.jabref.model.database.BibDatabaseContext;
 import org.jabref.model.entry.BibEntry;
@@ -41,6 +48,7 @@ public class StateManager {
     private final OptionalObjectProperty<SearchQuery> activeSearchQuery = OptionalObjectProperty.empty();
     private final ObservableMap<BibDatabaseContext, IntegerProperty> searchResultMap = FXCollections.observableHashMap();
     private final OptionalObjectProperty<Node> focusOwner = OptionalObjectProperty.empty();
+    private final UiThreadObservableList<ObjectProperty<Task<?>>> backgroundTasks = new UiThreadObservableList(FXCollections.observableArrayList());
 
     public StateManager() {
         activeGroups.bind(Bindings.valueAt(selectedGroups, activeDatabase.orElse(null)));
@@ -112,4 +120,24 @@ public void setSearchQuery(SearchQuery searchQuery) {
     public OptionalObjectProperty<Node> focusOwnerProperty() { return focusOwner; }
 
     public Optional<Node> getFocusOwner() { return focusOwner.get(); }
+
+    public UiThreadObservableList<ObjectProperty<Task<?>>> getBackgroundTasks() {
+        return backgroundTasks;
+    }
+
+    public void addBackgroundTask(ObjectProperty<Task<?>> backgroundTask) {
+        this.backgroundTasks.add(0, backgroundTask);
+    }
+
+    Binding<Boolean> anyTaskRunningBinding = EasyBind.<Task<?>, Boolean>combine(
+            backgroundTasks,
+            tStream -> tStream.anyMatch(Task::isRunning)
+    );
+
+    public Binding<Double> tasksProgressBinding = EasyBind.<Task<?>, Double>combine(
+            backgroundTasks,
+            stream -> stream.<Task<?>>filter(Task::isRunning).mapToDouble(Task::getProgress)
+                    .average().orElse(1)
+    );
+
 }

src/main/java/org/jabref/gui/externalfiles/DownloadFullTextAction.java

@@ -166,6 +166,10 @@ private void addLinkedFileFromURL(BibDatabaseContext databaseContext, URL url, B
                     dialogService.notify(Localization.lang("Finished downloading full text document for entry %0.",
                             entry.getCiteKeyOptional().orElse(Localization.lang("undefined"))));
                 });
+                downloadTask.titleProperty().set(Localization.lang("Downloading"));
+                downloadTask.messageProperty().set(
+                        Localization.lang("Fulltext for") + ": " + entry.getCiteKeyOptional().orElse(Localization.lang("New entry")));
+                downloadTask.showToUser(true);
                 Globals.TASK_EXECUTOR.execute(downloadTask);
             } catch (MalformedURLException exception) {
                 dialogService.showErrorDialogAndWait(Localization.lang("Invalid URL"), exception);

src/main/java/org/jabref/gui/fieldeditors/LinkedFileViewModel.java

@@ -417,6 +417,10 @@ public void download() {
                 entry.addFile(0, newLinkedFile);
             });
             downloadProgress.bind(downloadTask.workDonePercentageProperty());
+            downloadTask.titleProperty().set(Localization.lang("Downloading"));
+            downloadTask.messageProperty().set(
+                    Localization.lang("Fulltext for") + ": " + entry.getCiteKeyOptional().orElse(Localization.lang("New entry")));
+            downloadTask.showToUser(true);
             taskExecutor.execute(downloadTask);
         } catch (MalformedURLException exception) {
             dialogService.showErrorDialogAndWait(Localization.lang("Invalid URL"), exception);

src/main/java/org/jabref/gui/util/BackgroundTask.java

@@ -34,7 +34,9 @@ public abstract class BackgroundTask<V> {
     private BooleanProperty isCanceled = new SimpleBooleanProperty(false);
     private ObjectProperty<BackgroundProgress> progress = new SimpleObjectProperty<>(new BackgroundProgress(0, 0));
     private StringProperty message = new SimpleStringProperty("");
+    private StringProperty title = new SimpleStringProperty(this.getClass().getSimpleName());
     private DoubleProperty workDonePercentage = new SimpleDoubleProperty(0);
+    private BooleanProperty showToUser = new SimpleBooleanProperty(false);
 
     public BackgroundTask() {
         workDonePercentage.bind(EasyBind.map(progress, BackgroundTask.BackgroundProgress::getWorkDonePercentage));
@@ -90,6 +92,10 @@ public StringProperty messageProperty() {
         return message;
     }
 
+    public StringProperty titleProperty() {
+        return title;
+    }
+
     public double getWorkDonePercentage() {
         return workDonePercentage.get();
     }
@@ -106,6 +112,14 @@ public ObjectProperty<BackgroundProgress> progressProperty() {
         return progress;
     }
 
+    public boolean showToUser() {
+        return showToUser.get();
+    }
+
+    public void showToUser(boolean show) {
+        showToUser.set(show);
+    }
+
     /**
      * Sets the {@link Runnable} that is invoked after the task is started.
      */

src/main/java/org/jabref/gui/util/DefaultTaskExecutor.java

@@ -14,8 +14,11 @@
 import java.util.function.Consumer;
 
 import javafx.application.Platform;
+import javafx.beans.property.SimpleObjectProperty;
 import javafx.concurrent.Task;
 
+import org.jabref.Globals;
+import org.jabref.gui.StateManager;
 import org.jabref.logic.util.DelayTaskThrottler;
 
 import org.slf4j.Logger;
@@ -96,7 +99,11 @@ public static void runInJavaFXThread(Runnable runnable) {
 
     @Override
     public <V> Future<V> execute(BackgroundTask<V> task) {
-        return execute(getJavaFXTask(task));
+        Task<V> javafxTask = getJavaFXTask(task);
+        if (task.showToUser()) {
+            Globals.stateManager.addBackgroundTask(new SimpleObjectProperty<Task<?>>(javafxTask));
+        }
+        return execute(javafxTask);
     }
 
     @Override
@@ -128,8 +135,11 @@ private <V> Task<V> getJavaFXTask(BackgroundTask<V> task) {
         Task<V> javaTask = new Task<V>() {
 
             {
+                this.updateMessage(task.messageProperty().get());
+                this.updateTitle(task.titleProperty().get());
                 BindingsHelper.subscribeFuture(task.progressProperty(), progress -> updateProgress(progress.getWorkDone(), progress.getMax()));
                 BindingsHelper.subscribeFuture(task.messageProperty(), this::updateMessage);
+                BindingsHelper.subscribeFuture(task.titleProperty(), this::updateTitle);
                 BindingsHelper.subscribeFuture(task.isCanceledProperty(), cancelled -> {
                     if (cancelled) {
                         cancel();

src/main/resources/l10n/JabRef_en.properties

@@ -92,6 +92,8 @@ Available\ import\ formats=Available import formats
 
 %0\ source=%0 source
 
+Background\ Tasks=Background Tasks
+
 Browse=Browse
 
 by=by
@@ -209,6 +211,8 @@ Default\ encoding=Default encoding
 
 Default\ grouping\ field=Default grouping field
 
+Downloading=Downloading
+
 Execute\ default\ action\ in\ dialog=Execute default action in dialog
 
 Delete=Delete
@@ -368,6 +372,8 @@ Formatter\ name=Formatter name
 
 found\ in\ AUX\ file=found in AUX file
 
+Fulltext\ for=Fulltext for
+
 Further\ information\ about\ Mr.\ DLib\ for\ JabRef\ users.=Further information about Mr. DLib for JabRef users.
 
 General=General