Add support for a basic history popup

Issue CLIENT-211

Change-Id: I90ae92affc629dd0275c1a54cf63e692de696326
Reviewed-on: http://gerrit.dmdirc.com/1901
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/addons/ui_swing/components/statusbar/MessageLabel.java

@@ -29,6 +29,7 @@ import com.dmdirc.ui.StatusMessage;
 import com.dmdirc.ui.interfaces.StatusBarComponent;
 import com.dmdirc.ui.interfaces.StatusMessageNotifier;
 
+import java.awt.Window;
 import java.awt.event.MouseEvent;
 import java.awt.event.MouseListener;
 import java.util.Date;
@@ -37,14 +38,16 @@ import java.util.Queue;
 import java.util.Timer;
 import java.util.TimerTask;
 
-import javax.swing.BorderFactory;
 import javax.swing.JLabel;
+import javax.swing.JPanel;
 import javax.swing.SwingUtilities;
 
+import net.miginfocom.swing.MigLayout;
+
 /**
  * Message label handles showing messages in the status bar.
  */
-public class MessageLabel extends JLabel implements StatusBarComponent,
+public class MessageLabel extends JPanel implements StatusBarComponent,
         MouseListener {
 
     /**
@@ -57,6 +60,10 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
     private final StatusMessage defaultMessage;
     /** Message queue. */
     private final Queue<StatusMessage> queue;
+    /** Messsage label. */
+    private final JLabel label;
+    /** History label. */
+    private final MessagePopup historyLabel;
     /** Current status messsage. */
     private StatusMessage currentMessage;
     /** Timer to clear the message. */
@@ -65,15 +72,20 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
     /**
      * Instantiates a new message label.
      */
-    public MessageLabel() {
-        super();
+    public MessageLabel(final Window parentWindow) {
+        super(new MigLayout("fill, ins 0, gap 0  0"));
         queue = new LinkedList<StatusMessage>();
         defaultMessage = new StatusMessage(null, "Ready.", null, -1,
                 IdentityManager.getGlobalConfig());
         currentMessage = defaultMessage;
-        setText("Ready.");
-        setBorder(BorderFactory.createEtchedBorder());
-        addMouseListener(this);
+        label = new JLabel();
+        historyLabel = new MessagePopup(parentWindow);
+        label.setText("Ready.");
+        label.setBorder(new SidelessEtchedBorder(
+                SidelessEtchedBorder.Side.RIGHT));
+        label.addMouseListener(this);
+        add(label, "growx, pushx");
+        add(historyLabel, "gapleft 0");
     }
 
     /**
@@ -192,12 +204,12 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
             @Override
             public void run() {
                 if (currentMessage.getIconType() == null) {
-                    setIcon(null);
+                    label.setIcon(null);
                 } else {
-                    setIcon(IconManager.getIconManager().getIcon(
+                    label.setIcon(IconManager.getIconManager().getIcon(
                             currentMessage.getIconType()));
                 }
-                setText(UIUtilities.clipStringifNeeded(MessageLabel.this,
+                label.setText(UIUtilities.clipStringifNeeded(MessageLabel.this,
                         currentMessage.getMessage(), getWidth()));
                 if (messageTimer != null && (System.currentTimeMillis()
                         - messageTimer.scheduledExecutionTime()) <= 0) {
@@ -218,6 +230,7 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
      */
     public void clearMessage() {
         synchronized(queue) {
+            historyLabel.addMessage(currentMessage);
             if (queue.peek() == null) {
                 currentMessage = defaultMessage;
             } else {

src/com/dmdirc/addons/ui_swing/components/statusbar/MessagePopup.java

@@ -0,0 +1,131 @@
+/*
+ * Copyright (c) 2006-2011 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.ui_swing.components.statusbar;
+
+import com.dmdirc.ui.IconManager;
+import com.dmdirc.ui.StatusMessage;
+
+import java.awt.Window;
+import java.awt.event.MouseEvent;
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.swing.JLabel;
+import javax.swing.JPanel;
+import javax.swing.SwingConstants;
+import javax.swing.UIManager;
+
+/**
+ * Previous status bar messages popup.
+ */
+class MessagePopup extends StatusbarTogglePanel<JLabel> {
+
+    /** Parent window. */
+    private final Window parentWindow;
+    /** List of historical messages. */
+    private final List<StatusMessage> messages;
+
+    /**
+     * Creates a new message history popup.
+     *
+     * @param nonSelectedBorder Border when unselected
+     * @param selectedBorder Border when selected
+     * @param mainFrame Mainframe
+     */
+    public MessagePopup(final Window parentWindow) {
+        super(new JLabel("^"),
+                new SidelessEtchedBorder(SidelessEtchedBorder.Side.LEFT),
+                new SidelessEtchedBorder(SidelessEtchedBorder.Side.TOP));
+        this.parentWindow = parentWindow;
+        messages = new ArrayList<StatusMessage>();
+    }
+
+    /* {@inheritDoc} */
+    @Override
+    protected StatusbarPopupWindow getWindow() {
+        return new MessageHistoryPanel(this);
+    }
+
+    /* {@inheritDoc} */
+    @Override
+    public void mouseEntered(final MouseEvent e) {
+        super.mouseEntered(e);
+        if (!isDialogOpen()) {
+            setBorder(nonSelectedBorder);
+            setBackground(UIManager.getColor("ToolTip.background"));
+            setForeground(UIManager.getColor("ToolTip.foreground"));
+        }
+    }
+
+    /* {@inheritDoc} */
+    @Override
+    public void mouseExited(final MouseEvent e) {
+        super.mouseExited(e);
+        if (!isDialogOpen()) {
+            setBorder(new SidelessEtchedBorder(SidelessEtchedBorder.Side.LEFT));
+            setBackground(null);
+            setForeground(null);
+        }
+    }
+
+    /**
+     * Adds a message to this history window.
+     *
+     * @param message to add
+     */
+    public void addMessage(final StatusMessage message) {
+        synchronized(message) {
+            messages.add(message);
+        }
+    }
+
+    /** Message history status bar popup window. */
+    private class MessageHistoryPanel extends StatusbarPopupWindow {
+
+        /**
+         * Creates a new message history window.
+         *
+         * @param window Parent window
+         */
+        public MessageHistoryPanel(final JPanel parent) {
+            super(parent, parentWindow);
+        }
+
+        /* {@inheritDoc} */
+        @Override
+        protected void initContent(final JPanel panel) {
+            panel.removeAll();
+            if (messages.isEmpty()) {
+                panel.add(new JLabel("No previous messages."), "grow, push");
+                return;
+            }
+
+            for (StatusMessage message : messages) {
+                panel.add(new JLabel(message.getMessage(), message.getIconType()
+                        == null ? null : IconManager.getIconManager().getIcon(
+                        message.getIconType()), SwingConstants.LEFT),
+                        "grow, push, wrap");
+            }
+        }
+    }
+}

src/com/dmdirc/addons/ui_swing/components/statusbar/StatusbarPanel.java

@@ -27,9 +27,11 @@ import com.dmdirc.ui.interfaces.StatusBarComponent;
 
 import java.awt.event.MouseListener;
 
-import javax.swing.BorderFactory;
 import javax.swing.JComponent;
 import javax.swing.JPanel;
+import javax.swing.UIManager;
+import javax.swing.border.Border;
+import javax.swing.border.EtchedBorder;
 
 import net.miginfocom.swing.MigLayout;
 
@@ -52,18 +54,37 @@ public abstract class StatusbarPanel<T extends JComponent> extends JPanel
     private static final long serialVersionUID = 2;
     /** The popup window we're using to show extra info. */
     private StatusbarPopupWindow dialog;
+    /** Non selected border. */
+    protected final Border nonSelectedBorder;
+    /** Selected border. */
+    protected final Border selectedBorder;
 
     /**
      * Creates a new {@link StatusbarPanel}, using the specified label.
      *
-     * @param label The label to be displayed in the status bar
+     * @param label The component to be displayed in the status bar
      */
     public StatusbarPanel(final T label) {
+        this(label, new EtchedBorder(), new SidelessEtchedBorder(
+                SidelessEtchedBorder.Side.TOP));
+    }
+
+    /**
+     * Creates a new {@link StatusbarPanel}.
+     *
+     * @param label The component to be displayed in the status bar
+     * @param nonSelectedBorder The border for when the panel is unselected
+     * @param selectedBorder The border for when for the panel is selected
+     */
+    public StatusbarPanel(final T label, final Border nonSelectedBorder,
+            final Border selectedBorder) {
         super();
 
         this.label = label;
+        this.nonSelectedBorder = nonSelectedBorder;
+        this.selectedBorder = selectedBorder;
 
-        setBorder(BorderFactory.createEtchedBorder());
+        setBorder(nonSelectedBorder);
         setLayout(new MigLayout("ins 0 rel 0 rel, aligny center"));
         add(label);
 
@@ -101,6 +122,9 @@ public abstract class StatusbarPanel<T extends JComponent> extends JPanel
      */
     protected final void openDialog() {
         synchronized (StatusbarPanel.this) {
+            setBackground(UIManager.getColor("ToolTip.background"));
+            setForeground(UIManager.getColor("ToolTip.foreground"));
+            setBorder(selectedBorder);
             dialog = getWindow();
             dialog.setVisible(true);
         }
@@ -111,6 +135,9 @@ public abstract class StatusbarPanel<T extends JComponent> extends JPanel
      */
     protected final void closeDialog() {
         synchronized (StatusbarPanel.this) {
+            setBackground(null);
+            setForeground(null);
+            setBorder(nonSelectedBorder);
             if (dialog != null) {
                 dialog.setVisible(false);
                 dialog.dispose();

src/com/dmdirc/addons/ui_swing/components/statusbar/StatusbarPopupPanel.java

@@ -25,8 +25,6 @@ package com.dmdirc.addons.ui_swing.components.statusbar;
 import java.awt.event.MouseEvent;
 
 import javax.swing.JComponent;
-import javax.swing.UIManager;
-import javax.swing.border.EtchedBorder;
 
 /**
  * A panel shown in the status bar which displays a {@link StatusbarPopupWindow}
@@ -90,9 +88,6 @@ public abstract class StatusbarPopupPanel<T extends JComponent> extends
      */
     @Override
     public void mouseEntered(final MouseEvent e) {
-        setBackground(UIManager.getColor("ToolTip.background"));
-        setForeground(UIManager.getColor("ToolTip.foreground"));
-        setBorder(new SidelessEtchedBorder(SidelessEtchedBorder.Side.TOP));
         openDialog();
     }
 
@@ -103,9 +98,6 @@ public abstract class StatusbarPopupPanel<T extends JComponent> extends
      */
     @Override
     public void mouseExited(final MouseEvent e) {
-        setBackground(null);
-        setForeground(null);
-        setBorder(new EtchedBorder());
         closeDialog();
     }
 }

src/com/dmdirc/addons/ui_swing/components/statusbar/StatusbarTogglePanel.java

@@ -26,9 +26,8 @@ import java.awt.event.ComponentEvent;
 import java.awt.event.ComponentListener;
 import java.awt.event.MouseEvent;
 
-import javax.swing.JLabel;
-import javax.swing.UIManager;
-import javax.swing.border.EtchedBorder;
+import javax.swing.JComponent;
+import javax.swing.border.Border;
 
 /**
  * A panel shown in the status bar which displays a {@link StatusbarPopupWindow}
@@ -36,8 +35,8 @@ import javax.swing.border.EtchedBorder;
  *
  * @since 0.6.6
  */
-public abstract class StatusbarTogglePanel extends StatusbarPanel
-        implements ComponentListener {
+public abstract class StatusbarTogglePanel<T extends JComponent> extends
+        StatusbarPanel<T> implements ComponentListener {
 
     /**
      * A version number for this class. It should be changed whenever the class
@@ -47,21 +46,29 @@ public abstract class StatusbarTogglePanel extends StatusbarPanel
     private static final long serialVersionUID = 2;
 
     /**
-     * Creates a new {@link StatusbarTogglePanel}, using a default text label.
+     * Creates a new {@link StatusbarTogglePanel}, using the specified label.
+     *
+     * @param label The component to be displayed in the status bar
      */
-    public StatusbarTogglePanel() {
-        this(new JLabel("Unknown"));
+    public StatusbarTogglePanel(final T label) {
+        super(label);
+
+        addComponentListener(this);
     }
 
     /**
-     * Creates a new {@link StatusbarTogglePanel}, using the specified label.
+     * Creates a new {@link StatusbarPanel}.
      *
-     * @param label The label to be displayed in the status bar
+     * @param label The component to be displayed in the status bar
+     * @param nonSelectedBorder The border for when the panel is unselected
+     * @param selectedBorder The border for when for the panel is selected
      */
-    public StatusbarTogglePanel(final JLabel label) {
-        super(label);
+    public StatusbarTogglePanel(final T label, final Border nonSelectedBorder,
+            final Border selectedBorder) {
+        super(label, nonSelectedBorder, selectedBorder);
 
         addComponentListener(this);
+
     }
 
     /**
@@ -72,14 +79,8 @@ public abstract class StatusbarTogglePanel extends StatusbarPanel
     @Override
     public void mouseClicked(final MouseEvent e) {
         if (isDialogOpen()) {
-            setBackground(null);
-            setForeground(null);
-            setBorder(new EtchedBorder());
             closeDialog();
         } else {
-            setBackground(UIManager.getColor("ToolTip.background"));
-            setForeground(UIManager.getColor("ToolTip.foreground"));
-            setBorder(new SidelessEtchedBorder(SidelessEtchedBorder.Side.TOP));
             openDialog();
         }
     }

src/com/dmdirc/addons/ui_swing/components/statusbar/SwingStatusBar.java

@@ -70,7 +70,7 @@ public final class SwingStatusBar extends JPanel implements StatusBar {
             final MainFrame mainFrame) {
         super();
 
-        messageLabel = new MessageLabel();
+        messageLabel = new MessageLabel(mainFrame);
         errorPanel = new ErrorPanel(controller, mainFrame, this);
         updateLabel = new UpdaterLabel(mainFrame);
         inviteLabel = new InviteLabel(mainFrame);