Added auto-key-generation task to task-progress

CHANGELOG.md

@@ -24,6 +24,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 - We added a feature that allows the user to choose whether to trust the target site when unable to find a valid certification path from the file download site. [#7616](https://github.com/JabRef/jabref/issues/7616)
 - We added a feature that allows the user to open all linked files of multiple selected entries by "Open file" option. [#6966](https://github.com/JabRef/jabref/issues/6966)
 - We added a keybinding preset for new entries. [#7705](https://github.com/JabRef/jabref/issues/7705)
+- We added auto-key-generation progress to the background task list. [#7267](https://github.com/JabRef/jabref/issues/7267)
 
 ### Changed
 

src/main/java/org/jabref/gui/citationkeypattern/GenerateCitationKeyAction.java

@@ -1,6 +1,7 @@
 package org.jabref.gui.citationkeypattern;
 
 import java.util.List;
+import java.util.function.Consumer;
 
 import org.jabref.gui.DialogService;
 import org.jabref.gui.Globals;
@@ -11,6 +12,7 @@
 import org.jabref.gui.undo.NamedCompound;
 import org.jabref.gui.undo.UndoableKeyChange;
 import org.jabref.gui.util.BackgroundTask;
+import org.jabref.gui.util.DefaultTaskExecutor;
 import org.jabref.logic.citationkeypattern.CitationKeyGenerator;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.entry.BibEntry;
@@ -45,8 +47,14 @@ public void execute() {
 
         checkOverwriteKeysChosen();
 
-        BackgroundTask.wrap(this::generateKeys)
-                      .executeWith(Globals.TASK_EXECUTOR);
+        if (!this.isCanceled) {
+            BackgroundTask backgroundTask = this.generateKeysInBackground();
+            backgroundTask.showToUser(true);
+            backgroundTask.titleProperty().set(Localization.lang("Autogenerate citation keys"));
+            backgroundTask.messageProperty().set(entries.size() + " " + Localization.lang("entries"));
+
+            backgroundTask.executeWith(Globals.TASK_EXECUTOR);
+        }
     }
 
     public static boolean confirmOverwriteKeys(DialogService dialogService) {
@@ -80,30 +88,52 @@ private void checkOverwriteKeysChosen() {
         }
     }
 
-    private void generateKeys() {
-        if (isCanceled) {
-            return;
-        }
-
-        stateManager.getActiveDatabase().ifPresent(databaseContext -> {
-            // generate the new citation keys for each entry
-            final NamedCompound compound = new NamedCompound(Localization.lang("Autogenerate citation keys"));
-            CitationKeyGenerator keyGenerator =
-                    new CitationKeyGenerator(databaseContext, Globals.prefs.getCitationKeyPatternPreferences());
-            for (BibEntry entry : entries) {
-                keyGenerator.generateAndSetKey(entry)
-                            .ifPresent(fieldChange -> compound.addEdit(new UndoableKeyChange(fieldChange)));
+    private BackgroundTask generateKeysInBackground() {
+        return new BackgroundTask<Void>() {
+
+            private NamedCompound compound;
+
+            @Override
+            protected Void call() {
+                    if (isCanceled) {
+                        return null;
+                    }
+                    DefaultTaskExecutor.runInJavaFXThread(() -> {
+                        updateProgress(0, entries.size());
+                    });
+                    stateManager.getActiveDatabase().ifPresent(databaseContext -> {
+                        // generate the new citation keys for each entry
+                        compound = new NamedCompound(Localization.lang("Autogenerate citation keys"));
+                        CitationKeyGenerator keyGenerator =
+                                new CitationKeyGenerator(databaseContext, Globals.prefs.getCitationKeyPatternPreferences());
+                        int entriesDone = 0;
+                        for (BibEntry entry : entries) {
+                            keyGenerator.generateAndSetKey(entry)
+                                        .ifPresent(fieldChange -> compound.addEdit(new UndoableKeyChange(fieldChange)));
+                            entriesDone++;
+                            int finalEntriesDone = entriesDone;
+                            DefaultTaskExecutor.runInJavaFXThread(() -> {
+                                updateProgress(finalEntriesDone, entries.size());
+                            });
+                        }
+                        compound.end();
+                    });
+                    return null;
             }
-            compound.end();
 
-            // register the undo event only if new citation keys were generated
-            if (compound.hasEdits()) {
-                frame.getUndoManager().addEdit(compound);
+            @Override
+            public BackgroundTask<Void> onSuccess(Consumer<Void> onSuccess) {
+                // register the undo event only if new citation keys were generated
+                if (compound.hasEdits()) {
+                    frame.getUndoManager().addEdit(compound);
+                }
+
+                frame.getCurrentLibraryTab().markBaseChanged();
+                dialogService.notify(formatOutputMessage(Localization.lang("Generated citation key for"), entries.size()));
+                return super.onSuccess(onSuccess);
             }
+        };
 
-            frame.getCurrentLibraryTab().markBaseChanged();
-            dialogService.notify(formatOutputMessage(Localization.lang("Generated citation key for"), entries.size()));
-        });
     }
 
     private String formatOutputMessage(String start, int count) {

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

@@ -261,7 +261,7 @@ public static Node getIcon(Task<?> task) {
         return BackgroundTask.iconMap.getOrDefault(task.getTitle(), null);
     }
 
-    static class BackgroundProgress {
+    public static class BackgroundProgress {
 
         private final double workDone;
         private final double max;