Merge lp:~tapaal-contributor/tapaal/add-undo-batch-export-1938790 into lp:tapaal

[Lena Ernstsen]

Added undo/redo feature in export batch dialog

It is possible to undo/redo adding models, removing models, and clearing the entire list of models.

[Kenneth Yrke Jørgensen (yrke)]

review: Approve (code)

[Jiri Srba (srba)]

Tested and works.

review: Approve

=== added file 'src/dk/aau/cs/gui/undo/AddFileExportBatchCommand.java'
--- src/dk/aau/cs/gui/undo/AddFileExportBatchCommand.java	1970-01-01 00:00:00 +0000
+++ src/dk/aau/cs/gui/undo/AddFileExportBatchCommand.java	2021-08-04 11:51:12 +0000
@@ -0,0 +1,36 @@
+package dk.aau.cs.gui.undo;
+
+import dk.aau.cs.gui.BatchProcessingDialog;
+import pipe.gui.ExportBatchDialog;
+
+import javax.swing.*;
+import java.io.File;
+import java.util.List;
+
+public class AddFileExportBatchCommand extends Command{
+    private final DefaultListModel<File> listModel;
+    final List<File> files;
+    final File file;
+    private final ExportBatchDialog dialog;
+
+    public AddFileExportBatchCommand(DefaultListModel<File> listModel, File file, List<File> files, ExportBatchDialog dialog){
+        this.listModel = listModel;
+        this.file = file;
+        this.files = files;
+        this.dialog = dialog;
+    }
+
+    @Override
+    public void redo() {
+        files.add(file);
+        listModel.addElement(file);
+        dialog.enableButtons();
+    }
+
+    @Override
+    public void undo() {
+        files.remove(file);
+        listModel.removeElement(file);
+        dialog.enableButtons();
+    }
+}

=== added file 'src/dk/aau/cs/gui/undo/RemoveFileExportBatchCommand.java'
--- src/dk/aau/cs/gui/undo/RemoveFileExportBatchCommand.java	1970-01-01 00:00:00 +0000
+++ src/dk/aau/cs/gui/undo/RemoveFileExportBatchCommand.java	2021-08-04 11:51:12 +0000
@@ -0,0 +1,36 @@
+package dk.aau.cs.gui.undo;
+
+import dk.aau.cs.gui.BatchProcessingDialog;
+import pipe.gui.ExportBatchDialog;
+
+import javax.swing.*;
+import java.io.File;
+import java.util.List;
+
+public class RemoveFileExportBatchCommand extends Command {
+    private final DefaultListModel<File> listModel;
+    final List<File> files;
+    final File file;
+    private final ExportBatchDialog dialog;
+
+    public RemoveFileExportBatchCommand(DefaultListModel<File> listModel, File file, List<File> files, ExportBatchDialog dialog){
+        this.listModel = listModel;
+        this.file = file;
+        this.files = files;
+        this.dialog = dialog;
+    }
+
+    @Override
+    public void redo() {
+        files.remove(file);
+        listModel.removeElement(file);
+        dialog.enableButtons();
+    }
+
+    @Override
+    public void undo() {
+        files.add(file);
+        listModel.addElement(file);
+        dialog.enableButtons();
+    }
+}

=== modified file 'src/pipe/gui/ExportBatchDialog.java'
--- src/pipe/gui/ExportBatchDialog.java	2020-12-14 17:13:30 +0000
+++ src/pipe/gui/ExportBatchDialog.java	2021-08-04 11:51:12 +0000
@@ -1,16 +1,7 @@
 package pipe.gui;
 
-import java.awt.BorderLayout;
-import java.awt.Color;
-import java.awt.Component;
-import java.awt.Dimension;
-import java.awt.FlowLayout;
-import java.awt.Frame;
-import java.awt.GridBagConstraints;
-import java.awt.GridBagLayout;
-import java.awt.Insets;
-import java.awt.Point;
-import java.awt.Rectangle;
+import java.awt.*;
+import java.awt.event.ActionEvent;
 import java.awt.event.KeyAdapter;
 import java.awt.event.KeyEvent;
 import java.awt.event.MouseEvent;
@@ -35,6 +26,7 @@
 import javax.xml.transform.TransformerConfigurationException;
 import javax.xml.transform.TransformerException;
 
+import dk.aau.cs.gui.undo.*;
 import org.w3c.dom.DOMException;
 import dk.aau.cs.gui.FileNameCellRenderer;
 import dk.aau.cs.gui.components.ExportBatchResultTableModel;
@@ -45,6 +37,7 @@
 import dk.aau.cs.util.StringComparator;
 import pipe.dataLayer.DataLayer;
 import pipe.dataLayer.TAPNQuery;
+import pipe.gui.undo.UndoManager;
 import pipe.gui.widgets.filebrowser.FileBrowser;
 
 public class ExportBatchDialog extends JDialog {
@@ -60,8 +53,7 @@
 	private final static String NAME_FailStringFolderExists = "Failed as the subfolder already exists";
 	private final static String NAME_FailStringParseError = "Failed due to net/query parsing error";
 
-	
-	private JPanel filesButtonsPanel;
+    private JPanel filesButtonsPanel;
 	private JPanel mainPanel;
 	private JButton addFilesButton;
 	private JButton clearFilesButton;
@@ -84,7 +76,9 @@
 	private JDialog progressBarContainer;
 	static boolean noOrphanTransitions = false;
 
-	static ExportBatchDialog exportBatchDialog;
+    private final UndoManager undoManager = new UndoManager();
+
+    static ExportBatchDialog exportBatchDialog;
 	ModelLoader loader = new ModelLoader();
 	
 	public static boolean isDialogVisible() {
@@ -114,7 +108,8 @@
 	private ExportBatchDialog(Frame frame, String title, boolean modal) {
 		super(frame, title, modal);
 		initComponents();
-	}
+        makeShortcuts();
+    }
 	
 	private void initComponents() {
 		setLayout(new FlowLayout());
@@ -412,28 +407,29 @@
 		
 		File[] filesArray = browser.openFiles();
 		if (filesArray.length>0) {
-			for (File file : filesArray) {
+            undoManager.newEdit();
+            for (File file : filesArray) {
 				lastSelectPath = file.getParent();
-				if (!files.contains(file)) {
-					files.add(file);
-					listModel.addElement(file);
-				}
+                if (!files.contains(file)) {
+                    Command c = new AddFileExportBatchCommand(listModel, file, files, this);
+                    c.redo();
+                    undoManager.addEdit(c);
+                }
 			}
-
-			enableButtons();
 		}
 	}
 
 	private void removeSelectedFiles() {
-		for (Object o : fileList.getSelectedValuesList()) {
-			File file = (File) o;
-			files.remove(file);
-			listModel.removeElement(file);
-		}
-		enableButtons();
+        undoManager.newEdit();
+        for (Object o : fileList.getSelectedValuesList()) {
+            File file = (File) o;
+            Command c = new RemoveFileExportBatchCommand(listModel, file, files, this);
+            c.redo();
+            undoManager.addEdit(c);
+        }
 	}
 	
-	private void enableButtons() {
+	public void enableButtons() {
 		fileList.setEnabled(true);
 		uniqueQueryNames.setEnabled(true);
 		addFilesButton.setEnabled(true);
@@ -450,11 +446,17 @@
 		}
 		else
 			exportFilesButton.setEnabled(false);
+	}
 
-	}
 	private void clearFiles() {
-		files.clear();
-		listModel.removeAllElements();
+        undoManager.newEdit();
+
+        for (Object o : listModel.toArray()) {
+            File file = (File)o;
+            Command c = new RemoveFileExportBatchCommand(listModel, file, files, this);
+            c.redo();
+            undoManager.addEdit(c);
+        }
 	}
 	
 	private void selectDestinationPath() {
@@ -643,6 +645,26 @@
             return result[1];
 		}
 	}
+
+    private void makeShortcuts(){
+        int shortcutkey = Toolkit.getDefaultToolkit().getMenuShortcutKeyMask();
+        ActionMap am = mainPanel.getActionMap();
+        am.put("undo", new AbstractAction() {
+            @Override
+            public void actionPerformed(ActionEvent e) {
+                undoManager.undo();
+            }
+        });
+        am.put("redo", new AbstractAction() {
+            @Override
+            public void actionPerformed(ActionEvent e) {
+                undoManager.redo();
+            }
+        });
+        InputMap im = mainPanel.getInputMap(JPanel.WHEN_IN_FOCUSED_WINDOW);
+        im.put(KeyStroke.getKeyStroke('Z', shortcutkey), "undo");
+        im.put(KeyStroke.getKeyStroke('Y', shortcutkey), "redo");
+    }
 }