EventBus logging for undo/redo actions

Change-Id: I3b9863cd1004af7c507c3b27594967546ec26bcc
Reviewed-on: http://gerrit.dmdirc.com/3724
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/addons/ui_swing/UIUtilities.java

@@ -27,6 +27,8 @@ import com.dmdirc.addons.ui_swing.actions.UndoAction;
 import com.dmdirc.addons.ui_swing.components.DMDircUndoableEditListener;
 import com.dmdirc.ui.Colour;
 
+import com.google.common.eventbus.EventBus;
+
 import java.awt.Color;
 import java.awt.Font;
 import java.awt.FontMetrics;
@@ -88,7 +90,7 @@ public final class UIUtilities {
      *
      * @param component component Text component to add an undo manager to
      */
-    public static void addUndoManager(final JTextComponent component) {
+    public static void addUndoManager(final EventBus eventBus, final JTextComponent component) {
         final UndoManager undoManager = new UndoManager();
 
         // Listen for undo and redo events
@@ -96,13 +98,13 @@ public final class UIUtilities {
                 new DMDircUndoableEditListener(undoManager));
 
         // Create an undo action and add it to the text component
-        component.getActionMap().put("Undo", new UndoAction(undoManager));
+        component.getActionMap().put("Undo", new UndoAction(eventBus, undoManager));
 
         // Bind the undo action to ctl-Z
         component.getInputMap().put(KeyStroke.getKeyStroke("control Z"), "Undo");
 
         // Create a redo action and add it to the text component
-        component.getActionMap().put("Redo", new RedoAction(undoManager));
+        component.getActionMap().put("Redo", new RedoAction(eventBus, undoManager));
 
         // Bind the redo action to ctl-Y
         component.getInputMap().put(KeyStroke.getKeyStroke("control Y"), "Redo");

src/com/dmdirc/addons/ui_swing/actions/RedoAction.java

@@ -22,8 +22,10 @@
 
 package com.dmdirc.addons.ui_swing.actions;
 
+import com.dmdirc.events.UserErrorEvent;
 import com.dmdirc.logger.ErrorLevel;
-import com.dmdirc.logger.Logger;
+
+import com.google.common.eventbus.EventBus;
 
 import java.awt.event.ActionEvent;
 
@@ -40,23 +42,22 @@ public final class RedoAction extends AbstractAction {
     private static final long serialVersionUID = 1;
     /** Undo manager. */
     private final UndoManager undoManager;
+    /** The event bus to post errors to. */
+    private final EventBus eventBus;
 
     /**
      * Creates a new instance of RedoAction.
      *
+     * @param eventBus    The event bus to post errors to
      * @param undoManager UndoManager to use for this redo action
      */
-    public RedoAction(final UndoManager undoManager) {
+    public RedoAction(final EventBus eventBus, final UndoManager undoManager) {
         super("Undo");
 
         this.undoManager = undoManager;
+        this.eventBus = eventBus;
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * @param evt Action event
-     */
     @Override
     public void actionPerformed(final ActionEvent evt) {
         try {
@@ -64,7 +65,7 @@ public final class RedoAction extends AbstractAction {
                 undoManager.redo();
             }
         } catch (CannotUndoException ex) {
-            Logger.userError(ErrorLevel.LOW, "Unable to redo");
+            eventBus.post(new UserErrorEvent(ErrorLevel.LOW, ex, "Unable to redo", ""));
         }
     }
 

src/com/dmdirc/addons/ui_swing/actions/ReplacePasteAction.java

@@ -22,8 +22,10 @@
 
 package com.dmdirc.addons.ui_swing.actions;
 
+import com.dmdirc.events.UserErrorEvent;
 import com.dmdirc.logger.ErrorLevel;
-import com.dmdirc.logger.Logger;
+
+import com.google.common.eventbus.EventBus;
 
 import java.awt.datatransfer.Clipboard;
 import java.awt.datatransfer.DataFlavor;
@@ -47,32 +49,31 @@ public final class ReplacePasteAction extends AbstractAction {
     private final String replacementRegex;
     /** Replacement string. */
     private final String replacementString;
+    /** The event bus to post errors to. */
+    private final EventBus eventBus;
 
     /**
      * Creates a new instance of regex replacement paste action.
      *
-     * @param clipboard Clipboard to handle pasting
+     * @param eventBus          The event bus to post errors to
+     * @param clipboard         Clipboard to handle pasting
      * @param replacementRegex  Regex to match for replacement
      * @param replacementString Replacement string
      */
-    public ReplacePasteAction(final Clipboard clipboard, final String replacementRegex,
-            final String replacementString) {
+    public ReplacePasteAction(final EventBus eventBus, final Clipboard clipboard,
+            final String replacementRegex, final String replacementString) {
         super("NoSpacesPasteAction");
 
+        this.eventBus = eventBus;
         this.clipboard = clipboard;
         this.replacementRegex = replacementRegex;
         this.replacementString = replacementString;
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * @param e Action event
-     */
     @Override
     public void actionPerformed(final ActionEvent e) {
-        if (!(e.getSource() instanceof JTextComponent)
-                || !clipboard.isDataFlavorAvailable(DataFlavor.stringFlavor)) {
+        if (!(e.getSource() instanceof JTextComponent) ||
+                !clipboard.isDataFlavorAvailable(DataFlavor.stringFlavor)) {
             return;
         }
 
@@ -82,13 +83,13 @@ public final class ReplacePasteAction extends AbstractAction {
             //Replace the current selection with the contents of the clipboard
             ((JTextComponent) e.getSource()).replaceSelection(
                     ((String) clipboard.getData(DataFlavor.stringFlavor))
-                    .replaceAll(replacementRegex, replacementString));
+                            .replaceAll(replacementRegex, replacementString));
         } catch (IOException ex) {
-            Logger.userError(ErrorLevel.LOW, "Unable to get clipboard "
-                    + "contents: " + ex.getMessage());
+            eventBus.post(new UserErrorEvent(ErrorLevel.LOW, ex,
+                    "Unable to get clipboard contents: " + ex.getMessage(), ""));
         } catch (UnsupportedFlavorException ex) {
-            Logger.appError(ErrorLevel.LOW, "Unable to get clipboard "
-                    + "contents", ex);
+            eventBus.post(new UserErrorEvent(ErrorLevel.LOW, ex,
+                    "Unable to get clipboard contents", ""));
         }
     }
 

src/com/dmdirc/addons/ui_swing/actions/UndoAction.java

@@ -22,8 +22,10 @@
 
 package com.dmdirc.addons.ui_swing.actions;
 
+import com.dmdirc.events.UserErrorEvent;
 import com.dmdirc.logger.ErrorLevel;
-import com.dmdirc.logger.Logger;
+
+import com.google.common.eventbus.EventBus;
 
 import java.awt.event.ActionEvent;
 
@@ -40,23 +42,22 @@ public final class UndoAction extends AbstractAction {
     private static final long serialVersionUID = 1;
     /** Undo manager. */
     private final UndoManager undoManager;
+    /** The event bus to post errors to. */
+    private final EventBus eventBus;
 
     /**
      * Creates a new instance of UndoAction.
      *
+     * @param eventBus    The event bus to post errors to
      * @param undoManager UndoManager to use for this redo action
      */
-    public UndoAction(final UndoManager undoManager) {
+    public UndoAction(final EventBus eventBus, final UndoManager undoManager) {
         super("Undo");
 
         this.undoManager = undoManager;
+        this.eventBus = eventBus;
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * @param evt Action event
-     */
     @Override
     public void actionPerformed(final ActionEvent evt) {
         try {
@@ -64,7 +65,7 @@ public final class UndoAction extends AbstractAction {
                 undoManager.undo();
             }
         } catch (CannotUndoException ex) {
-            Logger.userError(ErrorLevel.LOW, "Unable to undo");
+            eventBus.post(new UserErrorEvent(ErrorLevel.LOW, ex, "Unable to undo", ""));
         }
     }
 

src/com/dmdirc/addons/ui_swing/components/TopicBar.java

@@ -40,6 +40,7 @@ import com.dmdirc.ui.messages.ColourManager;
 import com.dmdirc.ui.messages.Styliser;
 
 import com.google.common.base.Optional;
+import com.google.common.eventbus.EventBus;
 
 import java.awt.Color;
 import java.awt.Window;
@@ -117,6 +118,7 @@ public class TopicBar extends JComponent implements ActionListener, ConfigChange
      * @param channel           The channel that this topic bar is for.
      * @param window            The window this topic bar is for.
      * @param iconManager       The icon manager to use for this bar's icons.
+     * @param eventBus          The event bus to post errors to
      */
     public TopicBar(
             final Window parentWindow,
@@ -128,7 +130,8 @@ public class TopicBar extends JComponent implements ActionListener, ConfigChange
             final CommandController commandController,
             final Channel channel,
             final ChannelFrame window,
-            final IconManager iconManager) {
+            final IconManager iconManager,
+            final EventBus eventBus) {
         this.channel = channel;
         this.domain = domain;
         this.colourManager = colourManager;
@@ -142,7 +145,7 @@ public class TopicBar extends JComponent implements ActionListener, ConfigChange
                 new NewlinesDocumentFilter());
 
         topicText.getActionMap().put("paste-from-clipboard",
-                new ReplacePasteAction(clipboard, "(\r\n|\n|\r)", " "));
+                new ReplacePasteAction(eventBus, clipboard, "(\r\n|\n|\r)", " "));
         topicEdit = new ImageButton<>("edit",
                 iconManager.getIcon("edit-inactive"),
                 iconManager.getIcon("edit"));

src/com/dmdirc/addons/ui_swing/components/TopicBarFactory.java

@@ -33,6 +33,8 @@ import com.dmdirc.plugins.PluginManager;
 import com.dmdirc.ui.IconManager;
 import com.dmdirc.ui.messages.ColourManager;
 
+import com.google.common.eventbus.EventBus;
+
 import java.awt.Window;
 import java.awt.datatransfer.Clipboard;
 
@@ -55,6 +57,7 @@ public class TopicBarFactory {
     private final PluginManager pluginManager;
     private final Clipboard clipboard;
     private final CommandController commandController;
+    private final EventBus eventBus;
 
     @Inject
     public TopicBarFactory(
@@ -64,7 +67,8 @@ public class TopicBarFactory {
             final ColourManager colourManager,
             final PluginManager pluginManager,
             final Clipboard clipboard,
-            final CommandController commandController) {
+            final CommandController commandController,
+            final EventBus eventBus) {
         this.parentWindow = parentWindow;
         this.globalConfig = globalConfig;
         this.domain = domain;
@@ -72,6 +76,7 @@ public class TopicBarFactory {
         this.pluginManager = pluginManager;
         this.clipboard = clipboard;
         this.commandController = commandController;
+        this.eventBus = eventBus;
     }
 
     public TopicBar getTopicBar(
@@ -79,7 +84,7 @@ public class TopicBarFactory {
             final ChannelFrame window,
             final IconManager iconManager) {
         return new TopicBar(parentWindow.get(), globalConfig, domain, colourManager, pluginManager,
-                clipboard, commandController, channel, window, iconManager);
+                clipboard, commandController, channel, window, iconManager, eventBus);
     }
 
 }

src/com/dmdirc/addons/ui_swing/components/frames/InputTextFrame.java

@@ -204,7 +204,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
      * Initialises the input field.
      */
     private void initInputField() {
-        UIUtilities.addUndoManager(getInputField().getTextField());
+        UIUtilities.addUndoManager(eventBus, getInputField().getTextField());
 
         getInputField().getActionMap().put("paste",
                 new InputTextFramePasteAction(clipboard, this));

src/com/dmdirc/addons/ui_swing/dialogs/aliases/AliasManagerDialog.java

@@ -33,6 +33,8 @@ import com.dmdirc.interfaces.ui.AliasDialogModel;
 import com.dmdirc.ui.IconManager;
 import com.dmdirc.util.validators.NotEmptyValidator;
 
+import com.google.common.eventbus.EventBus;
+
 import java.awt.Dimension;
 import java.awt.Window;
 
@@ -56,7 +58,7 @@ public class AliasManagerDialog extends StandardDialog {
 
     @Inject
     public AliasManagerDialog(@MainWindow final Window mainFrame, final AliasDialogModel model,
-            @GlobalConfig final IconManager iconManager) {
+            @GlobalConfig final IconManager iconManager, final EventBus eventBus) {
         super(mainFrame, ModalityType.DOCUMENT_MODAL);
         final AliasManagerLinker linker = new AliasManagerLinker(model, this, iconManager);
         setTitle("Alias Manager");
@@ -93,7 +95,7 @@ public class AliasManagerDialog extends StandardDialog {
         add(getLeftButton(), "flowx, split 3, right, sg button");
         add(getRightButton(), "sg button");
 
-        UIUtilities.addUndoManager(response);
+        UIUtilities.addUndoManager(eventBus, response);
 
         linker.bindCommandList(aliasList);
         linker.bindCommand(command);

src/com/dmdirc/addons/ui_swing/dialogs/channelsetting/ChannelSettingsDialog.java

@@ -36,6 +36,8 @@ import com.dmdirc.interfaces.config.IdentityFactory;
 import com.dmdirc.interfaces.ui.InputWindow;
 import com.dmdirc.plugins.ServiceManager;
 
+import com.google.common.eventbus.EventBus;
+
 import java.awt.Window;
 import java.awt.datatransfer.Clipboard;
 import java.awt.event.ActionEvent;
@@ -85,6 +87,8 @@ public class ChannelSettingsDialog extends StandardDialog implements ActionListe
     private final Clipboard clipboard;
     /** The controller to use to retrieve command information. */
     private final CommandController commandController;
+    /** The event bus to post errors to. */
+    private final EventBus eventBus;
 
     /**
      * Creates a new instance of ChannelSettingsDialog.
@@ -110,7 +114,8 @@ public class ChannelSettingsDialog extends StandardDialog implements ActionListe
             final Channel channel,
             final Window parentWindow,
             final Clipboard clipboard,
-            final CommandController commandController) {
+            final CommandController commandController,
+            final EventBus eventBus) {
         super(parentWindow, ModalityType.MODELESS);
 
         this.userConfig = checkNotNull(userConfig);
@@ -120,10 +125,11 @@ public class ChannelSettingsDialog extends StandardDialog implements ActionListe
         this.channel = checkNotNull(channel);
         this.clipboard = clipboard;
         this.commandController = checkNotNull(commandController);
+        this.eventBus = eventBus;
 
-        this.identity = identityFactory.createChannelConfig(channel.getConnection().getNetwork(),
+        identity = identityFactory.createChannelConfig(channel.getConnection().getNetwork(),
                 channel.getChannelInfo().getName());
-        this.channelWindow = (InputWindow) windowFactory.getSwingWindow(channel);
+        channelWindow = (InputWindow) windowFactory.getSwingWindow(channel);
 
         initComponents();
         initListeners();
@@ -161,7 +167,7 @@ public class ChannelSettingsDialog extends StandardDialog implements ActionListe
     private void initTopicTab() {
         topicModesPane = new TopicPane(channel, channel.getIconManager(),
                 commandController, serviceManager,
-                this, channelWindow, clipboard);
+                this, channelWindow, clipboard, eventBus);
         tabbedPane.addTab("Topic", topicModesPane);
     }
 

src/com/dmdirc/addons/ui_swing/dialogs/channelsetting/TopicDisplayPane.java

@@ -37,6 +37,7 @@ import com.dmdirc.plugins.ServiceManager;
 import com.dmdirc.ui.IconManager;
 
 import com.google.common.base.Optional;
+import com.google.common.eventbus.EventBus;
 
 import java.awt.Color;
 import java.awt.datatransfer.Clipboard;
@@ -69,6 +70,8 @@ public class TopicDisplayPane extends JPanel implements DocumentListener {
     private final int topicLengthMax;
     /** Clipboard to copy and paste from. */
     private final Clipboard clipboard;
+    /** The event bus to post errors to. */
+    private final EventBus eventBus;
     /** label showing the number of characters left in a topic. */
     private JLabel topicLengthLabel;
     /** Topic text entry text area. */
@@ -87,16 +90,18 @@ public class TopicDisplayPane extends JPanel implements DocumentListener {
      * @param channelWindow     Channel window
      * @param clipboard         Clipboard to copy and paste
      * @param commandController The controller to use to retrieve command information.
+     * @param eventBus          The event bus to post errors to.
      */
     public TopicDisplayPane(final Channel channel, final IconManager iconManager,
             final ServiceManager serviceManager, final ChannelSettingsDialog parent,
             final InputWindow channelWindow, final Clipboard clipboard,
-            final CommandController commandController) {
+            final CommandController commandController, final EventBus eventBus) {
         this.clipboard = clipboard;
         this.channel = channel;
         this.parent = parent;
         topicLengthMax = channel.getConnection().getParser().getMaxTopicLength();
         this.channelWindow = channelWindow;
+        this.eventBus = eventBus;
 
         initComponents(iconManager, channel.getConfigManager(), serviceManager, commandController);
         addListeners();
@@ -126,13 +131,13 @@ public class TopicDisplayPane extends JPanel implements DocumentListener {
         handler.setTabCompleter(channel.getTabCompleter());
 
         topicText.getActionMap().put("paste-from-clipboard",
-                new ReplacePasteAction(clipboard, "(\r\n|\n|\r)", " "));
+                new ReplacePasteAction(eventBus, clipboard, "(\r\n|\n|\r)", " "));
         topicText.getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER,
                 0), new TopicEnterAction(parent));
         topicText.getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER,
                 UIUtilities.getCtrlDownMask()), new TopicEnterAction(parent));
 
-        UIUtilities.addUndoManager(topicText);
+        UIUtilities.addUndoManager(eventBus, topicText);
     }
 
     /** Adds listeners to the components. */
@@ -194,19 +199,16 @@ public class TopicDisplayPane extends JPanel implements DocumentListener {
         }
     }
 
-    /** {@inheritDoc}. */
     @Override
     public void insertUpdate(final DocumentEvent e) {
         topicChanged();
     }
 
-    /** {@inheritDoc}. */
     @Override
     public void removeUpdate(final DocumentEvent e) {
         topicChanged();
     }
 
-    /** {@inheritDoc}. */
     @Override
     public void changedUpdate(final DocumentEvent e) {
         //Ignore

src/com/dmdirc/addons/ui_swing/dialogs/channelsetting/TopicPane.java

@@ -30,6 +30,7 @@ import com.dmdirc.plugins.ServiceManager;
 import com.dmdirc.ui.IconManager;
 
 import com.google.common.base.Optional;
+import com.google.common.eventbus.EventBus;
 
 import java.awt.datatransfer.Clipboard;
 import java.awt.event.ActionEvent;
@@ -67,14 +68,14 @@ public class TopicPane extends JPanel implements ActionListener {
      * @param parent            Parent dialog
      * @param channelWindow     Channel window
      * @param clipboard         Clipboard to copy and paste with
+     * @param eventBus          The event bus to post errors to
      */
     public TopicPane(final Channel channel, final IconManager iconManager,
             final CommandController commandController,
             final ServiceManager serviceManager, final ChannelSettingsDialog parent,
-            final InputWindow channelWindow, final Clipboard clipboard) {
-        super();
-
-        this.setOpaque(UIUtilities.getTabbedPaneOpaque());
+            final InputWindow channelWindow, final Clipboard clipboard,
+            final EventBus eventBus) {
+        setOpaque(UIUtilities.getTabbedPaneOpaque());
         this.channel = channel;
         this.parent = parent;
         this.channelWindow = channelWindow;
@@ -83,7 +84,7 @@ public class TopicPane extends JPanel implements ActionListener {
         setVisible(false);
 
         removeAll();
-        initTopicsPanel(iconManager, serviceManager, commandController);
+        initTopicsPanel(iconManager, serviceManager, commandController, eventBus);
         layoutComponents();
 
         topicHistoryPane.addActionListener(this);
@@ -94,9 +95,10 @@ public class TopicPane extends JPanel implements ActionListener {
     private void initTopicsPanel(
             final IconManager iconManager,
             final ServiceManager serviceManager,
-            final CommandController commandController) {
+            final CommandController commandController,
+            final EventBus eventBus) {
         topicDisplayPane = new TopicDisplayPane(channel, iconManager, serviceManager, parent,
-                channelWindow, clipboard, commandController);
+                channelWindow, clipboard, commandController, eventBus);
         topicHistoryPane = new TopicHistoryPane(channel);
     }
 

src/com/dmdirc/addons/ui_swing/dialogs/paste/PasteDialog.java

@@ -79,8 +79,6 @@ public final class PasteDialog extends StandardDialog implements ActionListener,
     private final AggregateConfigProvider config;
     /** The controller to use to retrieve command information. */
     private final CommandController commandController;
-    /** The bus to dispatch events on. */
-    private final EventBus eventBus;
 
     /**
      * Creates a new instance of PreferencesDialog.
@@ -111,9 +109,8 @@ public final class PasteDialog extends StandardDialog implements ActionListener,
         this.config = config;
         this.pluginManager = pluginManager;
         this.commandController = commandController;
-        this.eventBus = eventBus;
 
-        initComponents(text);
+        initComponents(eventBus, text);
         initListeners();
 
         setFocusTraversalPolicy(new PasteDialogFocusTraversalPolicy(
@@ -129,13 +126,13 @@ public final class PasteDialog extends StandardDialog implements ActionListener,
      *
      * @param text text to show in the dialog
      */
-    private void initComponents(final String text) {
+    private void initComponents(final EventBus eventBus, final String text) {
         scrollPane = new JScrollPane();
         textField = new TextAreaInputField(iconManager, config, text);
         editButton = new JButton("Edit");
         infoLabel = new TextLabel();
 
-        UIUtilities.addUndoManager(textField);
+        UIUtilities.addUndoManager(eventBus, textField);
 
         orderButtons(new JButton(), new JButton());
         getOkButton().setText("Send");
@@ -207,11 +204,6 @@ public final class PasteDialog extends StandardDialog implements ActionListener,
                 KeyStroke.getKeyStroke(KeyEvent.VK_LEFT, 0), "leftArrowAction");
     }
 
-    /**
-     * Handles the actions for the dialog.
-     *
-     * @param actionEvent Action event
-     */
     @Override
     public void actionPerformed(final ActionEvent actionEvent) {
         if (getOkButton().equals(actionEvent.getSource())) {
@@ -246,11 +238,6 @@ public final class PasteDialog extends StandardDialog implements ActionListener,
         }
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * @param e Key event
-     */
     @Override
     public void keyTyped(final KeyEvent e) {
         infoLabel.setText("This will be sent as "

src/com/dmdirc/addons/ui_swing/injection/DialogModule.java

@@ -55,6 +55,8 @@ import com.dmdirc.ui.core.aliases.CoreAliasDialogModel;
 import com.dmdirc.ui.core.feedback.CoreFeedbackDialogModel;
 import com.dmdirc.ui.core.newserver.CoreNewServerDialogModel;
 
+import com.google.common.eventbus.EventBus;
+
 import java.awt.Window;
 import java.awt.datatransfer.Clipboard;
 
@@ -176,13 +178,14 @@ public class DialogModule {
             final PrefsComponentFactory compFactory,
             @MainWindow final Window parentWindow,
             final Clipboard clipboard,
-            final CommandController commandController) {
+            final CommandController commandController,
+            final EventBus eventBus) {
         return new KeyedDialogProvider<Channel, ChannelSettingsDialog>() {
             @Override
             protected ChannelSettingsDialog getInstance(final Channel key) {
                 return new ChannelSettingsDialog(identityFactory, windowFactory,
                         userConfig, serviceManager, preferencesManager,
-                        compFactory, key, parentWindow, clipboard, commandController);
+                        compFactory, key, parentWindow, clipboard, commandController, eventBus);
             }
         };
     }