Add a status bar popup panel that is toggled by clicking not mouseover.

Change-Id: I08c81b81908d4b5af623da90ad7816e5c3668d7a
Reviewed-on: http://gerrit.dmdirc.com/1881
Reviewed-by: Greg Holmes <greg@dmdirc.com>
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>

src/com/dmdirc/addons/lagdisplay/LagDisplayPanel.java

@@ -27,8 +27,6 @@ import com.dmdirc.addons.ui_swing.components.statusbar.StatusbarPopupWindow;
 /**
  * Shows the user's lag in the status bar, and reveals details of all servers
  * when the user hovers over it.
- * 
- * @author chris
  */
 public class LagDisplayPanel extends StatusbarPopupPanel {
 
@@ -38,9 +36,8 @@ public class LagDisplayPanel extends StatusbarPopupPanel {
      * objects being unserialized with the new class).
      */
     private static final long serialVersionUID = 2;
-
     /** Lag display plugin. */
-    private LagDisplayPlugin plugin;
+    private final LagDisplayPlugin plugin;
 
     /**
      * Creates a new {@link LagDisplayPanel} for the specified plugin.
@@ -58,6 +55,4 @@ public class LagDisplayPanel extends StatusbarPopupPanel {
     protected StatusbarPopupWindow getWindow() {
         return new ServerInfoDialog(plugin, this);
     }
-    
-  
-}
+}

src/com/dmdirc/addons/lagdisplay/ServerInfoDialog.java

@@ -26,7 +26,7 @@ import com.dmdirc.Server;
 import com.dmdirc.ServerManager;
 import com.dmdirc.ServerState;
 import com.dmdirc.addons.ui_swing.SwingController;
-import com.dmdirc.addons.ui_swing.components.statusbar.StatusbarPopupPanel;
+import com.dmdirc.addons.ui_swing.components.statusbar.StatusbarPanel;
 import com.dmdirc.addons.ui_swing.components.statusbar.StatusbarPopupWindow;
 import com.dmdirc.plugins.PluginManager;
 
@@ -60,7 +60,7 @@ public class ServerInfoDialog extends StatusbarPopupWindow {
      * @param ldp The {@link LagDisplayPlugin} we're using for info
      * @param parent The {@link JPanel} to use for positioning
      */
-    public ServerInfoDialog(final LagDisplayPlugin ldp, final StatusbarPopupPanel parent) {
+    public ServerInfoDialog(final LagDisplayPlugin ldp, final StatusbarPanel parent) {
         super(parent, ((SwingController) PluginManager.getPluginManager()
                 .getPluginInfoByName("ui_swing").getPlugin()).getMainFrame());
 

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

@@ -0,0 +1,157 @@
+/*
+ * 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.addons.ui_swing.UIUtilities;
+import com.dmdirc.ui.interfaces.StatusBarComponent;
+
+import java.awt.event.MouseListener;
+
+import javax.swing.BorderFactory;
+import javax.swing.JLabel;
+import javax.swing.JPanel;
+
+import net.miginfocom.swing.MigLayout;
+
+/**
+ * A panel shown in the status bar which displays a {@link StatusbarPopupWindow}
+ * when the user mouses over it.
+ *
+ * @since 0.6.3m1
+ */
+public abstract class StatusbarPanel extends JPanel
+        implements StatusBarComponent, MouseListener {
+
+    /** The label we use to show information. */
+    protected final JLabel label;
+    /**
+     * A version number for this class. It should be changed whenever the class
+     * structure is changed (or anything else that would prevent serialized
+     * objects being unserialized with the new class).
+     */
+    private static final long serialVersionUID = 2;
+    /** The popup window we're using to show extra info. */
+    private StatusbarPopupWindow dialog;
+
+    /**
+     * Creates a new {@link StatusbarPanel}, using a default text label.
+     */
+    public StatusbarPanel() {
+        this(new JLabel("Unknown"));
+    }
+
+    /**
+     * Creates a new {@link StatusbarPanel}, using the specified label.
+     *
+     * @param label The label to be displayed in the status bar
+     */
+    public StatusbarPanel(final JLabel label) {
+        super();
+
+        this.label = label;
+
+        setBorder(BorderFactory.createEtchedBorder());
+        setLayout(new MigLayout("ins 0 rel 0 rel, aligny center"));
+        add(label);
+
+        addMouseListener(this);
+    }
+
+    /**
+     * Closes and reopens the dialog to update information and border positions.
+     */
+    public final void refreshDialog() {
+        UIUtilities.invokeLater(new Runnable() {
+            @Override
+            public void run() {
+                synchronized (StatusbarPanel.this) {
+                    if (dialog != null) {
+                        closeDialog();
+                        openDialog();
+                    }
+                }
+            }
+        });
+    }
+
+    /**
+     * Opens the information dialog.
+     */
+    protected final void openDialog() {
+        synchronized (StatusbarPanel.this) {
+            dialog = getWindow();
+            dialog.setVisible(true);
+        }
+    }
+
+    /**
+     * Closes the information dialog.
+     */
+    protected final void closeDialog() {
+        synchronized (StatusbarPanel.this) {
+            if (dialog != null) {
+                dialog.setVisible(false);
+                dialog.dispose();
+                dialog = null;
+            }
+        }
+    }
+
+    /**
+     * Checks if this dialog is open.
+     *
+     * @return is the dialog open
+     */
+    protected final boolean isDialogOpen() {
+        synchronized (StatusbarPanel.this) {
+            if (dialog != null) {
+                return dialog.isVisible();
+            }
+            return false;
+        }
+    }
+
+    /**
+     * Sets the text for this label.
+     *
+     * @param text New text
+     */
+    public void setText(final String text) {
+        UIUtilities.invokeLater(new Runnable() {
+
+            /** {@inheritDoc} */
+            @Override
+            public void run() {
+                label.setText(text);
+            }
+        });
+    }
+
+    /**
+     * Retrieves the implementation of {@link StatusbarPopupWindow} that should
+     * be shown by this panel when the user mouses over it.
+     *
+     * @return A concrete {@link StatusbarPopupWindow} implementation to use
+     */
+    protected abstract StatusbarPopupWindow getWindow();
+}

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

@@ -19,34 +19,22 @@
  * 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.addons.ui_swing.UIUtilities;
-import com.dmdirc.ui.interfaces.StatusBarComponent;
+package com.dmdirc.addons.ui_swing.components.statusbar;
 
-import java.awt.Color;
-import java.awt.Component;
-import java.awt.Graphics;
 import java.awt.event.MouseEvent;
-import java.awt.event.MouseListener;
-import javax.swing.BorderFactory;
-import javax.swing.JLabel;
-import javax.swing.JPanel;
 
+import javax.swing.JLabel;
 import javax.swing.UIManager;
 import javax.swing.border.EtchedBorder;
 
-import net.miginfocom.swing.MigLayout;
-
 /**
  * A panel shown in the status bar which displays a {@link StatusbarPopupWindow}
  * when the user mouses over it.
  *
  * @since 0.6.3m1
- * @author chris
  */
-public abstract class StatusbarPopupPanel extends JPanel
-        implements StatusBarComponent, MouseListener {
+public abstract class StatusbarPopupPanel extends StatusbarPanel {
 
     /**
      * A version number for this class. It should be changed whenever the class
@@ -54,12 +42,6 @@ public abstract class StatusbarPopupPanel extends JPanel
      * objects being unserialized with the new class).
      */
     private static final long serialVersionUID = 2;
-    
-    /** The label we use to show information. */
-    protected final JLabel label;
-
-    /** The popup window we're using to show extra info. */
-    private StatusbarPopupWindow dialog;
 
     /**
      * Creates a new {@link StatusbarPopupPanel}, using a default text label.
@@ -74,84 +56,12 @@ public abstract class StatusbarPopupPanel extends JPanel
      * @param label The label to be displayed in the status bar
      */
     public StatusbarPopupPanel(final JLabel label) {
-        super();
-
-        this.label = label;
-
-        setBorder(BorderFactory.createEtchedBorder());
-        setLayout(new MigLayout("ins 0 rel 0 rel, aligny center"));
-        add(label);
-        
-        addMouseListener(this);
-    }
-    
-    /**
-     * Closes and reopens the dialog to update information and border positions.
-     */
-    public final void refreshDialog() {
-        UIUtilities.invokeLater(new Runnable() {
-            @Override
-            public void run() {
-                synchronized (StatusbarPopupPanel.this) {
-                    if (dialog != null) {
-                        closeDialog();
-                        openDialog();
-                    }
-                }
-            }
-        });
-    }
-
-    /**
-     * Opens the information dialog.
-     */
-    protected final void openDialog() {
-        synchronized (StatusbarPopupPanel.this) {
-            dialog = getWindow();
-            dialog.setVisible(true);
-        }
-    }
-
-    /**
-     * Closes the information dialog.
-     */
-    protected final void closeDialog() {
-        synchronized (StatusbarPopupPanel.this) {
-            if (dialog != null) {
-                dialog.setVisible(false);
-                dialog.dispose();
-                dialog = null;
-            }
-        }
-    }
-    
-    /**
-     * Sets the text for this label.
-     * 
-     * @param text New text
-     */
-    public void setText(final String text) {
-        UIUtilities.invokeLater(new Runnable() {
-
-            /** {@inheritDoc} */
-            @Override
-            public void run() {
-                label.setText(text);
-            }
-        });
+        super(label);
     }
 
     /**
-     * Retrieves the implementation of {@link StatusbarPopupWindow} that should
-     * be shown by this panel when the user mouses over it.
-     *
-     * @return A concrete {@link StatusbarPopupWindow} implementation to use
-     */
-    protected abstract StatusbarPopupWindow getWindow();
-    
-    /** 
      * {@inheritDoc}
-     * 
+     *
      * @param e Mouse event
      */
     @Override
@@ -159,9 +69,9 @@ public abstract class StatusbarPopupPanel extends JPanel
         // Don't care
     }
 
-    /** 
+    /**
      * {@inheritDoc}
-     * 
+     *
      * @param e Mouse event
      */
     @Override
@@ -169,9 +79,9 @@ public abstract class StatusbarPopupPanel extends JPanel
         // Don't care
     }
 
-    /** 
+    /**
      * {@inheritDoc}
-     * 
+     *
      * @param e Mouse event
      */
     @Override
@@ -179,9 +89,9 @@ public abstract class StatusbarPopupPanel extends JPanel
         // Don't care
     }
 
-    /** 
+    /**
      * {@inheritDoc}
-     * 
+     *
      * @param e Mouse event
      */
     @Override
@@ -189,13 +99,12 @@ public abstract class StatusbarPopupPanel extends JPanel
         setBackground(UIManager.getColor("ToolTip.background"));
         setForeground(UIManager.getColor("ToolTip.foreground"));
         setBorder(new ToplessEtchedBorder());
-
         openDialog();
     }
 
-    /** 
+    /**
      * {@inheritDoc}
-     * 
+     *
      * @param e Mouse event
      */
     @Override
@@ -203,42 +112,6 @@ public abstract class StatusbarPopupPanel extends JPanel
         setBackground(null);
         setForeground(null);
         setBorder(new EtchedBorder());
-
         closeDialog();
     }
-    
-    /**
-     * An {@link EtchedBorder} with no top.
-     */
-    private static class ToplessEtchedBorder extends EtchedBorder {
-
-        /**
-         * A version number for this class. It should be changed whenever the class
-         * structure is changed (or anything else that would prevent serialized
-         * objects being unserialized with the new class).
-         */
-        private static final long serialVersionUID = 1;
-
-        /** {@inheritDoc} */
-        @Override
-        public void paintBorder(final Component c, final Graphics g,
-                final int x, final int y, final int width, final int height) {
-            int w = width;
-            int h = height;
-
-            g.translate(x, y);
-
-            g.setColor(etchType == LOWERED? getShadowColor(c) : getHighlightColor(c));
-            g.drawLine(0, h-2, w, h-2);
-            g.drawLine(0, 0, 0, h-1);
-            g.drawLine(w-2, 0, w-2, h-1);
-
-            g.setColor(Color.WHITE);
-            g.drawLine(0, h-1, w, h-1);
-            g.drawLine(w-1, 0, w-1, h-1);
-
-            g.translate(-x, -y);
-        }
-
-    }
-}
+}

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

@@ -0,0 +1,150 @@
+/*
+ * 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.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;
+
+/**
+ * A panel shown in the status bar which displays a {@link StatusbarPopupWindow}
+ * when the clicks it.
+ *
+ * @since 0.6.6
+ */
+public abstract class StatusbarTogglePanel extends StatusbarPanel
+        implements ComponentListener {
+
+    /**
+     * A version number for this class. It should be changed whenever the class
+     * structure is changed (or anything else that would prevent serialized
+     * objects being unserialized with the new class).
+     */
+    private static final long serialVersionUID = 2;
+
+    /**
+     * Creates a new {@link StatusbarTogglePanel}, using a default text label.
+     */
+    public StatusbarTogglePanel() {
+        this(new JLabel("Unknown"));
+    }
+
+    /**
+     * Creates a new {@link StatusbarTogglePanel}, using the specified label.
+     *
+     * @param label The label to be displayed in the status bar
+     */
+    public StatusbarTogglePanel(final JLabel label) {
+        super(label);
+
+        addComponentListener(this);
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @param e Mouse event
+     */
+    @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 ToplessEtchedBorder());
+            openDialog();
+        }
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @param e Mouse event
+     */
+    @Override
+    public void mousePressed(final MouseEvent e) {
+        // Don't care
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @param e Mouse event
+     */
+    @Override
+    public void mouseReleased(final MouseEvent e) {
+        // Don't care
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @param e Mouse event
+     */
+    @Override
+    public void mouseEntered(final MouseEvent e) {
+        // Don't care
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @param e Mouse event
+     */
+    @Override
+    public void mouseExited(final MouseEvent e) {
+        // Don't care
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void componentResized(final ComponentEvent e) {
+        refreshDialog();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void componentMoved(final ComponentEvent e) {
+        refreshDialog();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void componentShown(final ComponentEvent e) {
+        // Don't care
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void componentHidden(final ComponentEvent e) {
+        // Don't care
+    }
+}

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

@@ -0,0 +1,57 @@
+/*
+ * 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.awt.Color;
+import java.awt.Component;
+import java.awt.Graphics;
+
+import javax.swing.border.EtchedBorder;
+
+/**
+ * An {@link EtchedBorder} with no top.
+ */
+class ToplessEtchedBorder extends EtchedBorder {
+
+    /**
+     * A version number for this class. It should be changed whenever the class
+     * structure is changed (or anything else that would prevent serialized
+     * objects being unserialized with the new class).
+     */
+    private static final long serialVersionUID = 1;
+
+    /** {@inheritDoc} */
+    @Override
+    public void paintBorder(final Component c, final Graphics g, final int x,
+            final int y, final int width, final int height) {
+        g.translate(x, y);
+        g.setColor(etchType == LOWERED ? getShadowColor(c) : getHighlightColor(c));
+        g.drawLine(0, height - 2, width, height - 2);
+        g.drawLine(0, 0, 0, height - 1);
+        g.drawLine(width - 2, 0, width - 2, height - 1);
+        g.setColor(Color.WHITE);
+        g.drawLine(0, height - 1, width, height - 1);
+        g.drawLine(width - 1, 0, width - 1, height - 1);
+        g.translate(-x, -y);
+    }
+}