Improve Automatic Field Editor Dialog

src/main/java/org/jabref/gui/edit/automaticfiededitor/AbstractAutomaticFieldEditorTabViewModel.java

@@ -0,0 +1,58 @@
+package org.jabref.gui.edit.automaticfiededitor;
+
+import java.util.Collection;
+import java.util.Comparator;
+import java.util.EnumSet;
+import java.util.HashSet;
+import java.util.Objects;
+import java.util.Set;
+
+import javafx.collections.FXCollections;
+import javafx.collections.ObservableList;
+
+import org.jabref.gui.AbstractViewModel;
+import org.jabref.model.database.BibDatabase;
+import org.jabref.model.entry.field.Field;
+import org.jabref.model.entry.field.StandardField;
+
+import com.google.common.eventbus.EventBus;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public abstract class AbstractAutomaticFieldEditorTabViewModel extends AbstractViewModel {
+    public static final Logger LOGGER = LoggerFactory.getLogger(AbstractAutomaticFieldEditorTabViewModel.class);
+
+    protected final EventBus eventBus = new EventBus();
+    private final ObservableList<Field> allFields = FXCollections.observableArrayList();
+
+    public AbstractAutomaticFieldEditorTabViewModel(BibDatabase bibDatabase) {
+        Objects.requireNonNull(bibDatabase);
+        addFields(EnumSet.allOf(StandardField.class));
+        addFields(bibDatabase.getAllVisibleFields());
+        allFields.sort(Comparator.comparing(Field::getName));
+    }
+
+    public ObservableList<Field> getAllFields() {
+        return allFields;
+    }
+
+    private void addFields(Collection<? extends Field> fields) {
+        Set<Field> fieldsSet = new HashSet<>(allFields);
+        fieldsSet.addAll(fields);
+        allFields.setAll(fieldsSet);
+    }
+
+    public void registerListener(Object object) {
+        eventBus.register(object);
+    }
+
+    public void unregisterListener(Object listener) {
+        try {
+            eventBus.unregister(listener);
+        } catch (
+                IllegalArgumentException e) {
+            // occurs if the event source has not been registered, should not prevent shutdown
+            LOGGER.debug("Problem unregistering", e);
+        }
+    }
+}

src/main/java/org/jabref/gui/edit/automaticfiededitor/AutomaticFieldEditorAction.java

@@ -3,6 +3,7 @@
 import org.jabref.gui.DialogService;
 import org.jabref.gui.StateManager;
 import org.jabref.gui.actions.SimpleCommand;
+import org.jabref.model.database.BibDatabaseContext;
 
 import static org.jabref.gui.actions.ActionHelper.needsDatabase;
 import static org.jabref.gui.actions.ActionHelper.needsEntriesSelected;
@@ -21,6 +22,6 @@ public AutomaticFieldEditorAction(StateManager stateManager, DialogService dialo
     @Override
     public void execute() {
         dialogService.showCustomDialogAndWait(new AutomaticFieldEditorDialog(stateManager.getSelectedEntries(),
-                stateManager.getActiveDatabase().orElseThrow()));
+                stateManager.getActiveDatabase().map(BibDatabaseContext::getDatabase).orElseThrow()));
     }
 }

src/main/java/org/jabref/gui/edit/automaticfiededitor/AutomaticFieldEditorDialog.fxml

@@ -10,6 +10,5 @@
         <TabPane fx:id="tabPane" tabClosingPolicy="UNAVAILABLE"/>
     </content>
     <ButtonType fx:id="saveButton" text="Keep Modifications" buttonData="OK_DONE"/>
-    <ButtonType fx:id="cancelButton"
-                text="Revert" buttonData="CANCEL_CLOSE"/>
+    <ButtonType fx:constant="CANCEL"/>
 </DialogPane>

src/main/java/org/jabref/gui/edit/automaticfiededitor/AutomaticFieldEditorDialog.java

@@ -1,39 +1,39 @@
 package org.jabref.gui.edit.automaticfiededitor;
 
+import java.util.ArrayList;
 import java.util.List;
 
 import javax.swing.undo.UndoManager;
 
 import javafx.fxml.FXML;
 import javafx.scene.control.ButtonBar;
-import javafx.scene.control.ButtonType;
 import javafx.scene.control.Tab;
 import javafx.scene.control.TabPane;
 
 import org.jabref.gui.Globals;
 import org.jabref.gui.util.BaseDialog;
-import org.jabref.gui.util.ControlHelper;
 import org.jabref.logic.l10n.Localization;
-import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.database.BibDatabase;
 import org.jabref.model.entry.BibEntry;
 
 import com.airhacks.afterburner.views.ViewLoader;
+import com.google.common.eventbus.Subscribe;
 
-public class AutomaticFieldEditorDialog extends BaseDialog<Void> {
-    @FXML public ButtonType saveButton;
-    @FXML public ButtonType cancelButton;
+public class AutomaticFieldEditorDialog extends BaseDialog<String> {
     @FXML
     private TabPane tabPane;
 
     private final UndoManager undoManager;
 
-    private final BibDatabaseContext databaseContext;
+    private final BibDatabase database;
     private final List<BibEntry> selectedEntries;
     private AutomaticFieldEditorViewModel viewModel;
 
-    public AutomaticFieldEditorDialog(List<BibEntry> selectedEntries, BibDatabaseContext databaseContext) {
+    private List<NotificationPaneAdapter> notificationPanes = new ArrayList<>();
+
+    public AutomaticFieldEditorDialog(List<BibEntry> selectedEntries, BibDatabase database) {
         this.selectedEntries = selectedEntries;
-        this.databaseContext = databaseContext;
+        this.database = database;
         this.undoManager = Globals.undoManager;
 
         this.setTitle(Localization.lang("Automatic field editor"));
@@ -42,8 +42,14 @@ public AutomaticFieldEditorDialog(List<BibEntry> selectedEntries, BibDatabaseCon
                   .load()
                   .setAsDialogPane(this);
 
-        ControlHelper.setAction(saveButton, getDialogPane(), event -> saveChangesAndCloseDialog());
-        ControlHelper.setAction(cancelButton, getDialogPane(), event -> cancelChangesAndCloseDialog());
+        setResultConverter(buttonType -> {
+            if (buttonType != null && buttonType.getButtonData() == ButtonBar.ButtonData.OK_DONE) {
+                saveChanges();
+            } else {
+                cancelChanges();
+            }
+            return "";
+        });
 
         // This will prevent all dialog buttons from having the same size
         // Read more: https://stackoverflow.com/questions/45866249/javafx-8-alert-different-button-sizes
@@ -54,20 +60,30 @@ public AutomaticFieldEditorDialog(List<BibEntry> selectedEntries, BibDatabaseCon
 
     @FXML
     public void initialize() {
-        viewModel = new AutomaticFieldEditorViewModel(selectedEntries, databaseContext, undoManager);
+        viewModel = new AutomaticFieldEditorViewModel(selectedEntries, database, undoManager);
 
         for (AutomaticFieldEditorTab tabModel : viewModel.getFieldEditorTabs()) {
-            tabPane.getTabs().add(new Tab(tabModel.getTabName(), tabModel.getContent()));
+            NotificationPaneAdapter notificationPane = new NotificationPaneAdapter(tabModel.getContent());
+            notificationPanes.add(notificationPane);
+            tabModel.registerListener(this);
+            tabPane.getTabs().add(new Tab(tabModel.getTabName(), notificationPane));
         }
     }
 
-    private void saveChangesAndCloseDialog() {
+    @Subscribe
+    private void onEntriesUpdated(AutomaticFieldEditorEvent event) {
+        assert event.tabIndex() < notificationPanes.size() : "The tab index is not associated with any of the automatic field editor tabs.";
+        assert event.numberOfAffectedEntries() <= selectedEntries.size() : "The number of affected entries cannot exceed the number of selected entries.";
+
+        notificationPanes.get(event.tabIndex())
+                         .notify(event.numberOfAffectedEntries(), selectedEntries.size());
+    }
+
+    private void saveChanges() {
         viewModel.saveChanges();
-        close();
     }
 
-    private void cancelChangesAndCloseDialog() {
+    private void cancelChanges() {
         viewModel.cancelChanges();
-        close();
     }
 }

src/main/java/org/jabref/gui/edit/automaticfiededitor/AutomaticFieldEditorEvent.java

@@ -0,0 +1,6 @@
+package org.jabref.gui.edit.automaticfiededitor;
+
+public record AutomaticFieldEditorEvent(
+        int tabIndex,
+        int numberOfAffectedEntries) {
+}

src/main/java/org/jabref/gui/edit/automaticfiededitor/AutomaticFieldEditorTab.java

@@ -6,4 +6,8 @@ public interface AutomaticFieldEditorTab {
     Pane getContent();
 
     String getTabName();
+
+    void registerListener(Object object);
+
+    void unregisterListener(Object object);
 }

src/main/java/org/jabref/gui/edit/automaticfiededitor/AutomaticFieldEditorViewModel.java

@@ -8,28 +8,25 @@
 import javafx.collections.ObservableList;
 
 import org.jabref.gui.AbstractViewModel;
-import org.jabref.gui.edit.automaticfiededitor.editfieldvalue.EditFieldValueTabView;
+import org.jabref.gui.edit.automaticfiededitor.copyormovecontent.CopyOrMoveFieldContentTabView;
+import org.jabref.gui.edit.automaticfiededitor.editfieldcontent.EditFieldContentTabView;
 import org.jabref.gui.edit.automaticfiededitor.renamefield.RenameFieldTabView;
-import org.jabref.gui.edit.automaticfiededitor.twofields.TwoFieldsTabView;
 import org.jabref.gui.undo.NamedCompound;
-import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.database.BibDatabase;
 import org.jabref.model.entry.BibEntry;
 
 public class AutomaticFieldEditorViewModel extends AbstractViewModel {
     public static final String NAMED_COMPOUND_EDITS = "EDIT_FIELDS";
     private final ObservableList<AutomaticFieldEditorTab> fieldEditorTabs = FXCollections.observableArrayList();
     private final NamedCompound dialogEdits = new NamedCompound(NAMED_COMPOUND_EDITS);
-
-    private final BibDatabaseContext databaseContext;
     private final UndoManager undoManager;
 
-    public AutomaticFieldEditorViewModel(List<BibEntry> selectedEntries, BibDatabaseContext databaseContext, UndoManager undoManager) {
+    public AutomaticFieldEditorViewModel(List<BibEntry> selectedEntries, BibDatabase database, UndoManager undoManager) {
         fieldEditorTabs.addAll(
-                new EditFieldValueTabView(selectedEntries, databaseContext, dialogEdits),
-                new TwoFieldsTabView(selectedEntries, databaseContext, dialogEdits),
-                new RenameFieldTabView(selectedEntries, databaseContext, dialogEdits)
+                new EditFieldContentTabView(selectedEntries, database, dialogEdits),
+                new CopyOrMoveFieldContentTabView(selectedEntries, database, dialogEdits),
+                new RenameFieldTabView(selectedEntries, database, dialogEdits)
         );
-        this.databaseContext = databaseContext;
         this.undoManager = undoManager;
     }
 

src/main/java/org/jabref/gui/edit/automaticfiededitor/MoveFieldValueAction.java

@@ -16,27 +16,48 @@ public class MoveFieldValueAction extends SimpleCommand {
 
     private final NamedCompound edits;
 
-    public MoveFieldValueAction(Field fromField, Field toField, List<BibEntry> entries, NamedCompound edits) {
+    private int affectedEntriesCount;
+
+    private final boolean overwriteToFieldContent;
+
+    public MoveFieldValueAction(Field fromField, Field toField, List<BibEntry> entries, NamedCompound edits, boolean overwriteToFieldContent) {
         this.fromField = fromField;
         this.toField = toField;
         this.entries = entries;
         this.edits = edits;
+        this.overwriteToFieldContent = overwriteToFieldContent;
+    }
+
+    public MoveFieldValueAction(Field fromField, Field toField, List<BibEntry> entries, NamedCompound edits) {
+        this(fromField, toField, entries, edits, true);
     }
 
     @Override
     public void execute() {
+        affectedEntriesCount = 0;
         for (BibEntry entry : entries) {
             String fromFieldValue = entry.getField(fromField).orElse("");
             String toFieldValue = entry.getField(toField).orElse("");
-
             if (StringUtil.isNotBlank(fromFieldValue)) {
-                entry.setField(toField, fromFieldValue);
-                entry.setField(fromField, "");
-
-                edits.addEdit(new UndoableFieldChange(entry, fromField, fromFieldValue, null));
-                edits.addEdit(new UndoableFieldChange(entry, toField, toFieldValue, fromFieldValue));
+                if (overwriteToFieldContent || toFieldValue.isEmpty()) {
+                    entry.setField(toField, fromFieldValue);
+                    entry.setField(fromField, "");
+
+                    edits.addEdit(new UndoableFieldChange(entry, fromField, fromFieldValue, null));
+                    edits.addEdit(new UndoableFieldChange(entry, toField, toFieldValue, fromFieldValue));
+                    affectedEntriesCount++;
+                }
             }
         }
+
         edits.end();
     }
+
+    /**
+     * @return the number of affected entries
+     * */
+    public int executeAndGetAffectedEntriesCount() {
+        execute();
+        return affectedEntriesCount;
+    }
 }

src/main/java/org/jabref/gui/edit/automaticfiededitor/NotificationPaneAdapter.java

@@ -0,0 +1,23 @@
+package org.jabref.gui.edit.automaticfiededitor;
+
+import java.util.Collections;
+
+import javafx.scene.Node;
+import javafx.util.Duration;
+
+import org.jabref.gui.LibraryTab;
+import org.jabref.gui.icon.IconTheme;
+
+public class NotificationPaneAdapter extends LibraryTab.DatabaseNotification {
+
+    public NotificationPaneAdapter(Node content) {
+        super(content);
+    }
+
+    public void notify(int affectedEntries, int totalEntries) {
+        String notificationMessage = String.format("%d/%d affected entries", affectedEntries, totalEntries);
+        Node notificationGraphic = IconTheme.JabRefIcons.INTEGRITY_INFO.getGraphicNode();
+
+        notify(notificationGraphic, notificationMessage, Collections.emptyList(), Duration.seconds(2));
+    }
+}

src/main/java/org/jabref/gui/edit/automaticfiededitor/twofields/TwoFieldsTab.fxml → src/main/java/org/jabref/gui/edit/automaticfiededitor/copyormovecontent/CopyOrMoveFieldContentTab.fxml

@@ -11,7 +11,7 @@
 <?import javafx.scene.layout.HBox?>
 <?import javafx.scene.layout.RowConstraints?>
 
-<fx:root prefHeight="400.0" prefWidth="600.0" type="AnchorPane" xmlns="http://javafx.com/javafx/17" xmlns:fx="http://javafx.com/fxml/1" fx:controller="org.jabref.gui.edit.automaticfiededitor.twofields.TwoFieldsTabView">
+<fx:root prefHeight="400.0" prefWidth="600.0" type="AnchorPane" xmlns="http://javafx.com/javafx/17" xmlns:fx="http://javafx.com/fxml/1" fx:controller="org.jabref.gui.edit.automaticfiededitor.copyormovecontent.CopyOrMoveFieldContentTabView">
     <children>
           <GridPane hgap="8.0" layoutX="16.0" layoutY="246.0" minHeight="160.0" prefHeight="230.0" prefWidth="568.0" vgap="8.0" AnchorPane.leftAnchor="16.0" AnchorPane.rightAnchor="16.0" AnchorPane.topAnchor="8.0">
               <columnConstraints>
@@ -30,19 +30,23 @@
               <children>
                   <Label prefHeight="19.0" prefWidth="48.0" text="From" GridPane.rowIndex="2" />
                   <Label text="To" GridPane.rowIndex="3" />
-                  <ComboBox fx:id="fromFieldComboBox" minWidth="-Infinity" prefHeight="32.0" prefWidth="150.0" promptText="Author" GridPane.columnIndex="1" GridPane.hgrow="NEVER" GridPane.rowIndex="2" GridPane.vgrow="NEVER" />
-                  <ComboBox fx:id="toFieldComboBox" minWidth="-Infinity" prefHeight="32.0" prefWidth="150.0" promptText="Title" GridPane.columnIndex="1" GridPane.rowIndex="3" />
-                  <CheckBox fx:id="overwriteNonEmptyFields" mnemonicParsing="false" prefHeight="19.0" prefWidth="210.0" text="%Overwrite Non empty fields" GridPane.columnSpan="2147483647" GridPane.rowIndex="4" />
+                  <ComboBox fx:id="fromFieldComboBox" editable="true" minWidth="-Infinity" prefHeight="32.0" prefWidth="150.0" GridPane.columnIndex="1" GridPane.hgrow="NEVER" GridPane.rowIndex="2" GridPane.vgrow="NEVER" />
+                  <ComboBox fx:id="toFieldComboBox" editable="true" minWidth="-Infinity" prefHeight="32.0" prefWidth="150.0" GridPane.columnIndex="1" GridPane.rowIndex="3" />
+                  <CheckBox fx:id="overwriteFieldContentCheckBox"
+                            mnemonicParsing="false" prefHeight="19.0" prefWidth="210.0" text="%Overwrite field content" GridPane.columnSpan="2147483647" GridPane.rowIndex="4" />
                   <HBox maxHeight="1.7976931348623157E308" maxWidth="1.7976931348623157E308" spacing="8.0" GridPane.columnSpan="2147483647" GridPane.rowIndex="5">
                       <children>
-                          <Button fx:id="copyValueButton" mnemonicParsing="false" onAction="#copyValue" text="%Copy value" />
-                          <Button fx:id="moveValueButton" mnemonicParsing="false" onAction="#moveValue" text="%Move value" />
-                          <Button fx:id="swapValuesButton" mnemonicParsing="false" onAction="#swapValues" text="%Swap values" />
+                          <Button fx:id="copyContentButton"
+                                  mnemonicParsing="false" onAction="#copyContent" text="%Copy content" />
+                          <Button fx:id="moveContentButton"
+                                  mnemonicParsing="false" onAction="#moveContent" text="%Move content" />
+                          <Button fx:id="swapContentButton"
+                                  mnemonicParsing="false" onAction="#swapContent" text="%Swap content" />
                       </children>
                   </HBox>
             <HBox alignment="CENTER_LEFT" maxHeight="1.7976931348623157E308" maxWidth="1.7976931348623157E308" GridPane.columnSpan="3" GridPane.rowSpan="2">
                <children>
-                      <Label alignment="BOTTOM_LEFT" minHeight="-Infinity" minWidth="-Infinity" styleClass="sectionHeader" text="%Copy or move the value of one field to another">
+                      <Label alignment="BOTTOM_LEFT" minHeight="-Infinity" minWidth="-Infinity" styleClass="sectionHeader" text="%Copy or move the content of one field to another">
                      <HBox.margin>
                         <Insets bottom="10.0" />
                      </HBox.margin>