Use RTextArea.getActon for some actions

Previously, custom Actions and ActionHandlers were used to handle undo,
redo, cut, copy, paste and select all. However, RTextArea.getAction()
exposes action objects for these things already. This commit makes use
of them.

This allows slightly shrinking buildEditMenu(), but the real gain is
that RTextArea automatically takes care of keeping the state these
actions correct (based on the most recently focused RTextArea), which
allows removing some custom event handlers and other overhead. In
particular, this helps to removes the Arduino-specific changes for
RSyntaxTextArea later.

As a side effect, this breaks these actions when the text area is not in
focus. This will be fixed in a subsequent commit.

Author: matthijskooijman

app/src/processing/app/Editor.java

@@ -44,9 +44,9 @@
 import javax.swing.*;
 import javax.swing.event.*;
 import javax.swing.text.BadLocationException;
-import javax.swing.undo.CannotRedoException;
-import javax.swing.undo.CannotUndoException;
-import javax.swing.undo.UndoManager;
+import org.fife.ui.rtextarea.RTextArea;
+import org.fife.ui.rtextarea.RecordableTextAction;
+
 import java.awt.*;
 import java.awt.datatransfer.DataFlavor;
 import java.awt.datatransfer.Transferable;
@@ -182,12 +182,6 @@ public boolean test(SketchController sketch) {
   //boolean presenting;
   private boolean uploading;
 
-  // undo fellers
-  private JMenuItem undoItem;
-  private JMenuItem redoItem;
-  protected UndoAction undoAction;
-  protected RedoAction redoAction;
-
   private FindReplace find;
 
   Runnable runHandler;
@@ -1265,43 +1259,40 @@ public void actionPerformed(ActionEvent e) {
     return menu;
   }
 
-
   private JMenu buildEditMenu() {
     JMenu menu = new JMenu(tr("Edit"));
     menu.setName("menuEdit");
     menu.setMnemonic(KeyEvent.VK_E);
 
-    undoItem = newJMenuItem(tr("Undo"), 'Z');
+    // Create a dummy RTextArea, to force it to create the static list
+    // of actions accessible through RTextArea.getAction().
+    new RTextArea();
+
+    RecordableTextAction undoAction = RTextArea.getAction(RTextArea.UNDO_ACTION);
+    JMenuItem undoItem = new JMenuItem(undoAction);
     undoItem.setName("menuEditUndo");
-    undoItem.addActionListener(undoAction = new UndoAction());
     menu.add(undoItem);
 
-    if (!OSUtils.isMacOS()) {
-        redoItem = newJMenuItem(tr("Redo"), 'Y');
-    } else {
-        redoItem = newJMenuItemShift(tr("Redo"), 'Z');
-    }
+    RecordableTextAction redoAction = RTextArea.getAction(RTextArea.REDO_ACTION);
+    JMenuItem redoItem = new JMenuItem(redoAction);
     redoItem.setName("menuEditRedo");
-    redoItem.addActionListener(redoAction = new RedoAction());
     menu.add(redoItem);
 
+    // RSTA defaults to Ctrl-Y for redo, but convention on OSX is Ctrl-Shift-Z
+    // This might not be the best place, but it works.
+    if (OSUtils.isMacOS()) {
+      int mods = SHORTCUT_KEY_MASK | ActionEvent.SHIFT_MASK;
+      redoAction.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_Z, mods));
+    }
+
     menu.addSeparator();
 
-    JMenuItem cutItem = newJMenuItem(tr("Cut"), 'X');
-    cutItem.addActionListener(new ActionListener() {
-        public void actionPerformed(ActionEvent e) {
-          getCurrentTab().handleCut();
-        }
-      });
-    menu.add(cutItem);
+    RecordableTextAction cutAction = RTextArea.getAction(RTextArea.CUT_ACTION);
+    menu.add(new JMenuItem(cutAction));
+
+    RecordableTextAction copyAction = RTextArea.getAction(RTextArea.COPY_ACTION);
+    menu.add(new JMenuItem(copyAction));
 
-    JMenuItem copyItem = newJMenuItem(tr("Copy"), 'C');
-    copyItem.addActionListener(new ActionListener() {
-        public void actionPerformed(ActionEvent e) {
-          getCurrentTab().getTextArea().copy();
-        }
-      });
-    menu.add(copyItem);
 
     JMenuItem copyForumItem = newJMenuItemShift(tr("Copy for Forum"), 'C');
     copyForumItem.addActionListener(new ActionListener() {
@@ -1319,21 +1310,11 @@ public void actionPerformed(ActionEvent e) {
       });
     menu.add(copyHTMLItem);
 
-    JMenuItem pasteItem = newJMenuItem(tr("Paste"), 'V');
-    pasteItem.addActionListener(new ActionListener() {
-        public void actionPerformed(ActionEvent e) {
-          getCurrentTab().handlePaste();
-        }
-      });
-    menu.add(pasteItem);
+    RecordableTextAction pasteAction = RTextArea.getAction(RTextArea.PASTE_ACTION);
+    menu.add(new JMenuItem(pasteAction));
 
-    JMenuItem selectAllItem = newJMenuItem(tr("Select All"), 'A');
-    selectAllItem.addActionListener(new ActionListener() {
-        public void actionPerformed(ActionEvent e) {
-          getCurrentTab().handleSelectAll();
-        }
-      });
-    menu.add(selectAllItem);
+    RecordableTextAction selectAllAction = RTextArea.getAction(RTextArea.SELECT_ALL_ACTION);
+    menu.add(new JMenuItem(selectAllAction));
 
     JMenuItem gotoLine = newJMenuItem(tr("Go to line..."), 'L');
     gotoLine.addActionListener(e -> {
@@ -1422,21 +1403,6 @@ public void actionPerformed(ActionEvent e) {
       menu.add(useSelectionForFindItem);
     }
 
-    menu.addMenuListener(new MenuListener() {
-      @Override
-      public void menuSelected(MenuEvent e) {
-        boolean enabled = getCurrentTab().getSelectedText() != null;
-        cutItem.setEnabled(enabled);
-        copyItem.setEnabled(enabled);
-      }
-
-      @Override
-      public void menuDeselected(MenuEvent e) {}
-
-      @Override
-      public void menuCanceled(MenuEvent e) {}
-    });
-
     return menu;
   }
 
@@ -1474,75 +1440,6 @@ private static JMenuItem newJMenuItemAlt(String title, int what) {
     return menuItem;
   }
 
-
-  // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
-
-
-  class UndoAction extends AbstractAction {
-    public UndoAction() {
-      super("Undo");
-      this.setEnabled(false);
-    }
-
-    public void actionPerformed(ActionEvent e) {
-      try {
-        getCurrentTab().handleUndo();
-      } catch (CannotUndoException ex) {
-        //System.out.println("Unable to undo: " + ex);
-        //ex.printStackTrace();
-      }
-    }
-
-    protected void updateUndoState() {
-      UndoManager undo = getCurrentTab().getUndoManager();
-
-      if (undo.canUndo()) {
-        this.setEnabled(true);
-        undoItem.setEnabled(true);
-        undoItem.setText(undo.getUndoPresentationName());
-        putValue(Action.NAME, undo.getUndoPresentationName());
-      } else {
-        this.setEnabled(false);
-        undoItem.setEnabled(false);
-        undoItem.setText(tr("Undo"));
-        putValue(Action.NAME, "Undo");
-      }
-    }
-  }
-
-
-  class RedoAction extends AbstractAction {
-    public RedoAction() {
-      super("Redo");
-      this.setEnabled(false);
-    }
-
-    public void actionPerformed(ActionEvent e) {
-      try {
-        getCurrentTab().handleRedo();
-      } catch (CannotRedoException ex) {
-        //System.out.println("Unable to redo: " + ex);
-        //ex.printStackTrace();
-      }
-    }
-
-    protected void updateRedoState() {
-      UndoManager undo = getCurrentTab().getUndoManager();
-
-      if (undo.canRedo()) {
-        redoItem.setEnabled(true);
-        redoItem.setText(undo.getRedoPresentationName());
-        putValue(Action.NAME, undo.getRedoPresentationName());
-      } else {
-        this.setEnabled(false);
-        redoItem.setEnabled(false);
-        redoItem.setText(tr("Redo"));
-        putValue(Action.NAME, "Redo");
-      }
-    }
-  }
-
-
   // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
 
 
@@ -1610,8 +1507,6 @@ public List<EditorTab> getTabs() {
    */
   public void selectTab(final int index) {
     currentTabIndex = index;
-    undoAction.updateUndoState();
-    redoAction.updateRedoState();
     updateTitle();
     header.rebuild();
     getCurrentTab().activated();

app/src/processing/app/LastUndoableEditAwareUndoManager.java

@@ -29,9 +29,5 @@ public synchronized void redo() throws CannotRedoException {
   @Override
   public void updateActions() {
     super.updateActions();
-    editor.undoAction.updateUndoState();
-    editor.redoAction.updateRedoState();
   }
-
-
 }