Move default timeout logic to StatusMessage.

Change-Id: I332549e037d94849a5af18e94e186cf65d3a033c
Depends-On: I7f8e95c440482310d1818cc50f389d9e7ec8dfa6
Reviewed-on: http://gerrit.dmdirc.com/1863
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

@@ -24,7 +24,6 @@ package com.dmdirc.addons.ui_swing.components.statusbar;
 
 import com.dmdirc.addons.ui_swing.UIUtilities;
 import com.dmdirc.config.IdentityManager;
-import com.dmdirc.interfaces.ConfigChangeListener;
 import com.dmdirc.ui.IconManager;
 import com.dmdirc.ui.StatusMessage;
 import com.dmdirc.ui.interfaces.StatusBarComponent;
@@ -32,7 +31,9 @@ import com.dmdirc.ui.interfaces.StatusMessageNotifier;
 
 import java.awt.event.MouseEvent;
 import java.awt.event.MouseListener;
+import java.util.ArrayList;
 import java.util.Date;
+import java.util.List;
 import java.util.Timer;
 import java.util.TimerTask;
 import java.util.concurrent.Semaphore;
@@ -44,8 +45,8 @@ import javax.swing.SwingUtilities;
 /**
  * Message label handles showing messages in the status bar.
  */
-public class MessageLabel extends JLabel implements StatusBarComponent, 
-        MouseListener, ConfigChangeListener {
+public class MessageLabel extends JLabel implements StatusBarComponent,
+        MouseListener {
 
     /**
      * A version number for this class. It should be changed whenever the class
@@ -55,12 +56,12 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
     private static final long serialVersionUID = 1;
     /** Default status bar message. */
     private final StatusMessage defaultMessage;
-    /** current status bar message notifier. */
-    private transient StatusMessageNotifier messageNotifier;
+    /** Message queue. */
+    private final List<StatusMessage> messages;
+    /** Current status messsage. */
+    private int currentMessage;
     /** Timer to clear the message. */
     private transient TimerTask messageTimer;
-    /** Message timeout. */
-    private int timeout;
     /** Set message synchronisation. */
     private final Semaphore semaphore;
 
@@ -69,14 +70,14 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
      */
     public MessageLabel() {
         super();
-        defaultMessage = new StatusMessage(null, "Ready.", null, -1);
+        currentMessage = -1;
+        messages = new ArrayList<StatusMessage>();
+        defaultMessage = new StatusMessage(null, "Ready.", null, -1,
+                IdentityManager.getGlobalConfig());
         semaphore = new Semaphore(1);
         setText("Ready.");
         setBorder(BorderFactory.createEtchedBorder());
         addMouseListener(this);
-        setCachedSettings();
-        IdentityManager.getGlobalConfig().addChangeListener("ui",
-                "awayindicator", this);
     }
 
     /**
@@ -88,7 +89,8 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
      */
     @Deprecated
     public void setMessage(final String newMessage) {
-        setMessage(new StatusMessage(null, newMessage, null, timeout));
+        setMessage(new StatusMessage(null, newMessage, null, -1,
+                IdentityManager.getGlobalConfig()));
     }
 
     /**
@@ -102,7 +104,8 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
     @Deprecated
     public void setMessage(final String newMessage,
             final StatusMessageNotifier newNotifier) {
-        setMessage(new StatusMessage(null, newMessage, newNotifier, timeout));
+        setMessage(new StatusMessage(null, newMessage, newNotifier, -1,
+                IdentityManager.getGlobalConfig()));
     }
 
     /**
@@ -115,7 +118,8 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
      */
     @Deprecated
     public void setMessage(final String iconType, final String newMessage) {
-        setMessage(new StatusMessage(iconType, newMessage, null, timeout));
+        setMessage(new StatusMessage(iconType, newMessage, null, -1,
+                IdentityManager.getGlobalConfig()));
     }
 
     /**
@@ -130,8 +134,8 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
     @Deprecated
     public void setMessage(final String iconType, final String newMessage,
             final StatusMessageNotifier newNotifier) {
-        setMessage(new StatusMessage(iconType, newMessage, newNotifier,
-                timeout));
+        setMessage(new StatusMessage(iconType, newMessage, newNotifier, -1,
+                IdentityManager.getGlobalConfig()));
     }
 
     /**
@@ -146,7 +150,8 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
     @Deprecated
     public void setMessage(final String newMessage,
             final StatusMessageNotifier newNotifier, final int timeout) {
-        setMessage(new StatusMessage(null, newMessage, newNotifier, timeout));
+        setMessage(new StatusMessage(null, newMessage, newNotifier, timeout,
+                IdentityManager.getGlobalConfig()));
     }
 
     /**
@@ -160,10 +165,10 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
      * @deprecated Should use {@link setMessage(StatusMessage)} instead
      */
     @Deprecated
-    public void setMessage(final String iconType, final String newMessage, 
+    public void setMessage(final String iconType, final String newMessage,
             final StatusMessageNotifier newNotifier, final int timeout) {
         setMessage(new StatusMessage(iconType, newMessage, newNotifier,
-                timeout));
+                timeout, IdentityManager.getGlobalConfig()));
     }
 
     /**
@@ -173,14 +178,15 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
      */
     public void setMessage(final StatusMessage message) {
         semaphore.acquireUninterruptibly();
-        this.messageNotifier = message.getMessageNotifier();
         SwingUtilities.invokeLater(new Runnable() {
 
             /** {@inheritDoc} */
             @Override
             public void run() {
                 try {
-                   if (message.getIconType() == null) {
+                    messages.add(message);
+                    currentMessage = messages.indexOf(message);
+                    if (message.getIconType() == null) {
                         setIcon(null);
                     } else {
                         setIcon(IconManager.getIconManager().getIcon(
@@ -188,25 +194,18 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
                     }
                     setText(UIUtilities.clipStringifNeeded(MessageLabel.this,
                             message.getMessage(), getWidth()));
-                    messageNotifier = message.getMessageNotifier();
 
-                    if (messageTimer != null && (System.currentTimeMillis() -
-                            messageTimer.scheduledExecutionTime()) <= 0) {
+                    if (messageTimer != null && (System.currentTimeMillis()
+                            - messageTimer.scheduledExecutionTime()) <= 0) {
                         messageTimer.cancel();
                     }
 
                     if (!defaultMessage.equals(message)) {
-                        messageTimer = new TimerTask() {
-
-                            /** {@inheritDoc} */
-                            @Override
-                            public void run() {
-                                clearMessage();
-                            }
-                        };
+                        messageTimer = new MessageTimerTask(MessageLabel.this);
                         new Timer("SwingStatusBar messageTimer").schedule(
-                                messageTimer, new Date(System.currentTimeMillis()
-                                + 250 + timeout * 1000L));
+                                messageTimer, new Date(
+                                System.currentTimeMillis() + 250
+                                + message.getTimeout() * 1000L));
                     }
                 } finally {
                     semaphore.release();
@@ -229,8 +228,10 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
      */
     @Override
     public void mouseClicked(final MouseEvent e) {
-        if (messageNotifier != null) {
-            messageNotifier.clickReceived(e.getButton(), e.getClickCount());
+        if (currentMessage != -1 && messages.size() > currentMessage
+                && messages.get(currentMessage).getMessageNotifier() != null) {
+            messages.get(currentMessage).getMessageNotifier().clickReceived(
+                    e.getButton(), e.getClickCount());
         }
     }
 
@@ -273,16 +274,4 @@ public class MessageLabel extends JLabel implements StatusBarComponent,
     public void mouseExited(final MouseEvent e) {
         //Ignore
     }
-
-    /** Set cached options. */
-    private void setCachedSettings() {
-        timeout = IdentityManager.getGlobalConfig().getOptionInt("statusBar",
-                "messageDisplayLength");
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public void configChanged(final String domain, final String key) {
-        setCachedSettings();
-    }
 }

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

@@ -0,0 +1,51 @@
+/*
+ * 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 java.util.TimerTask;
+
+/**
+ * Timer task that clears a message label on completion.
+ */
+public class MessageTimerTask extends TimerTask {
+
+    /** Message label. */
+    private final MessageLabel messageLabel;
+
+    /**
+     * Creates a new message timer task that clears a message label on
+     * completion.
+     *
+     * @param messageLabel Message label to clear on completion
+     */
+    public MessageTimerTask(final MessageLabel messageLabel) {
+        super();
+        this.messageLabel = messageLabel;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void run() {
+        messageLabel.clearMessage();
+    }
+}

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

@@ -39,7 +39,7 @@ import javax.swing.SwingUtilities;
 
 import net.miginfocom.swing.MigLayout;
 
-/** Status bar, shows message and info on the gui. */
+/** Status bar, shows message and info on the GUI. */
 public final class SwingStatusBar extends JPanel implements StatusBar {
 
     /**
@@ -48,6 +48,9 @@ public final class SwingStatusBar extends JPanel implements StatusBar {
      * objects being unserialized with the new class).
      */
     private static final long serialVersionUID = 5;
+    /** Mig layout component restraints. */
+    private static final String COMPONENT_CONSTRAINTS
+            = "sgy components, hmax 20, hmin 20, wmin 20, shrink 0";
     /** message label. */
     private final MessageLabel messageLabel;
     /** error panel. */
@@ -63,7 +66,8 @@ public final class SwingStatusBar extends JPanel implements StatusBar {
      * @param controller Swing controller
      * @param mainFrame Main frame
      */
-    public SwingStatusBar(final SwingController controller, final MainFrame mainFrame) {
+    public SwingStatusBar(final SwingController controller,
+            final MainFrame mainFrame) {
         super();
 
         messageLabel = new MessageLabel();
@@ -74,9 +78,9 @@ public final class SwingStatusBar extends JPanel implements StatusBar {
         setLayout(new MigLayout("fill, ins 0, hidemode 3"));
 
         add(messageLabel, "growx, pushx, sgy components, hmax 20, hmin 20");
-        add(updateLabel, "sgy components, hmax 20, hmin 20, wmin 20, shrink 0");
-        add(errorPanel, "sgy components, hmax 20, hmin 20, wmin 20, shrink 0");
-        add(inviteLabel, "sgy components, hmax 20, hmin 20, wmin 20, shrink 0");
+        add(updateLabel, COMPONENT_CONSTRAINTS);
+        add(errorPanel, COMPONENT_CONSTRAINTS);
+        add(inviteLabel, COMPONENT_CONSTRAINTS);
     }
 
     /** {@inheritDoc}
@@ -165,7 +169,7 @@ public final class SwingStatusBar extends JPanel implements StatusBar {
                     "instance of java.awt.component"));
             return;
         }
-        if (!Arrays.asList(getComponents()).contains(component)) {
+        if (!Arrays.asList(getComponents()).contains((Component) component)) {
             SwingUtilities.invokeLater(new Runnable() {
 
                 /** {@inheritDoc} */
@@ -174,14 +178,10 @@ public final class SwingStatusBar extends JPanel implements StatusBar {
                     remove(updateLabel);
                     remove(errorPanel);
                     remove(inviteLabel);
-                    add((Component) component,
-                            "sgy components, hmax 20, hmin 20, wmin 20, shrink 0");
-                    add(updateLabel,
-                            "sgy components, hmax 20, hmin 20, wmin 20, shrink 0");
-                    add(inviteLabel,
-                            "sgy components, hmax 20, hmin 20, wmin 20, shrink 0");
-                    add(errorPanel,
-                            "sgy components, hmax 20, hmin 20, wmin 20, shrink 0");
+                    add((Component) component, COMPONENT_CONSTRAINTS);
+                    add(updateLabel, COMPONENT_CONSTRAINTS);
+                    add(inviteLabel, COMPONENT_CONSTRAINTS);
+                    add(errorPanel, COMPONENT_CONSTRAINTS);
                     validate();
                 }
             });
@@ -192,9 +192,9 @@ public final class SwingStatusBar extends JPanel implements StatusBar {
     @Override
     public void removeComponent(final StatusBarComponent component) {
         if (!(component instanceof Component)) {
-            Logger.appError(ErrorLevel.HIGH, "Error adding status bar component", 
-                    new IllegalArgumentException("Component must be an " +
-                    "instance of java.awt.component"));
+            Logger.appError(ErrorLevel.HIGH, "Error removing status bar "
+                    + "component", new IllegalArgumentException("Component "
+                    + "must be an instance of java.awt.component"));
             return;
         }
         SwingUtilities.invokeLater(new Runnable() {
@@ -209,8 +209,9 @@ public final class SwingStatusBar extends JPanel implements StatusBar {
     }
 
     /**
-     * Returns the message label for this status bar. This is intended to be used
-     * for advanced plugins that wish to do compliated things with messages.
+     * Returns the message label for this status bar. This is intended to be 
+     * used for advanced plugins that wish to do compliated things with
+     * messages.
      *
      * @return Message label component
      */