Groundwork for OSD Queueing

Change-Id: Id65cc8eba2320a89a93619c77ad044829f3e0ceb
Reviewed-on: http://gerrit.dmdirc.com/611
Automatic-Compile: Gregory Holmes <greg@dmdirc.com>
Reviewed-by: Gregory Holmes <greg@dmdirc.com>

src/com/dmdirc/addons/osd/OsdCommand.java

@@ -28,7 +28,6 @@ import com.dmdirc.commandparser.commands.GlobalCommand;
 import com.dmdirc.commandparser.commands.IntelligentCommand;
 import com.dmdirc.ui.input.AdditionalTabTargets;
 import com.dmdirc.ui.interfaces.InputWindow;
-import com.dmdirc.ui.messages.Styliser;
 
 import java.util.List;
 
@@ -40,20 +39,23 @@ public final class OsdCommand extends GlobalCommand implements IntelligentComman
 
     /** The plugin that owns this command. */
     private final OsdPlugin plugin;
+
+    /** The OSDManager that this command should use. */
+    private final OsdManager osdManager;
     
     /**
      * Creates a new instance of OsdCommand.
      *
      * @param plugin The plugin that owns this command
      */
-    public OsdCommand(final OsdPlugin plugin) {
+    public OsdCommand(final OsdPlugin plugin, final OsdManager osdManager) {
         super();
 
+        this.osdManager = osdManager;
         this.plugin = plugin;
         
         CommandManager.registerCommand(this);
     }
-    
 
     /**
      * Used to show a notification using this plugin.
@@ -63,8 +65,8 @@ public final class OsdCommand extends GlobalCommand implements IntelligentComman
      * @return True if the notification was shown.
      */
     public boolean showOSD(final String title, final String message) {
-        new OsdWindow(Styliser.stipControlCodes(message), false, plugin);
-        return true;
+        osdManager.createOSDWindow(title, message);
+        return true;		
     }
 
     /** {@inheritDoc} */
@@ -73,7 +75,7 @@ public final class OsdCommand extends GlobalCommand implements IntelligentComman
             final CommandArguments args) {
         if (args.getArguments().length > 0
                 && "--close".equalsIgnoreCase(args.getArguments()[0])) {
-            OsdWindow.closeAll();
+            osdManager.destroyAllOSDWindows();
         } else {
             showOSD("", args.getArgumentsAsString());
         }

src/com/dmdirc/addons/osd/OsdManager.java

@@ -0,0 +1,134 @@
+/*
+ * Copyright (c) 2006-2010 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.osd;
+
+import com.dmdirc.config.IdentityManager;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Class to manage OSD Windows.
+ *
+ * @author Simon
+ */
+public class OsdManager {
+
+    /** The Plugin that owns this OSD Manager. */
+    private final OsdPlugin plugin;
+
+    /** List of OSD Windows. */
+    private List<OsdWindow> windowList = new ArrayList<OsdWindow>();
+
+    /** The spacing between the windows. */
+    private static final int WINDOW_GAP = 5;
+
+    /**
+     * Create a new OSD Manager.
+     *
+     * @param plugin The plugin that owns this OSD Manager
+     */
+    public OsdManager(final OsdPlugin plugin) {
+        //Constructor
+        this.plugin = plugin;
+    }
+
+    public void createOSDWindow(final String title, final String message) {
+        //Check some form of queue.
+        OsdWindow currentWindow = new OsdWindow(message, false,
+                IdentityManager.getGlobalConfig().getOptionInt(plugin.getDomain(),
+                "locationX"), getYPosition(), plugin, this);
+
+        windowList.add(currentWindow);
+    }
+
+    /**
+    * Destroy the given OSD Window.
+    *
+    * @param window The window that we are destroying.
+    */
+    public void destroyOSDWindow(OsdWindow window) {
+        windowList.remove(window);
+        window.dispose();
+    }
+
+    /**
+     * Destropy all OSD Windows
+     */
+    public void destroyAllOSDWindows() {
+        for (OsdWindow window : new ArrayList<OsdWindow>(windowList)) {
+            window.setVisible(false);
+            destroyOSDWindow(window);
+        }
+    }
+
+    /**
+    * Get the list of current OSDWindows.
+    *
+    * @return a List of all currently open OSDWindows
+    */
+    public List<OsdWindow> getWindowList() {
+        return new ArrayList<OsdWindow>(windowList);
+    }
+
+    /**
+    * Get the count of open windows.
+    *
+    * @return Current number of OSD Windows open.
+    */
+    public int getWindowCount() {
+        return windowList.size();
+    }
+
+    /**
+    * Get the Y position for the next window.
+    *
+    * @return the Y position for the next window.
+    */
+    public int getYPosition() {
+        final String policy = IdentityManager.getGlobalConfig()
+                .getOption(plugin.getDomain(), "newbehaviour");
+        int y = IdentityManager.getGlobalConfig().getOptionInt(plugin.getDomain(),
+                "locationY");
+
+        if ("down".equals(policy)) {
+            // Place our new window below old windows
+            for (OsdWindow window : new ArrayList<OsdWindow>(getWindowList())) {
+                if (window.isVisible()) {
+                    y = Math.max(y, window.getY() + window.getHeight() + WINDOW_GAP);
+                }
+            }
+        } else if ("up".equals(policy)) {
+            // Place our new window above old windows
+            for (OsdWindow window : new ArrayList<OsdWindow>(getWindowList())) {
+                if (window.isVisible()) {
+                    y = Math.min(y, window.getY() - window.getHeight() - WINDOW_GAP);
+                }
+            }
+        } else if ("close".equals(policy)) {
+            // Close existing windows and use their place
+            destroyAllOSDWindows();
+        }
+
+        return y;
+    }
+}

src/com/dmdirc/addons/osd/OsdPlugin.java

@@ -48,6 +48,9 @@ public final class OsdPlugin extends Plugin implements CategoryChangeListener,
     
     /** OSD Command. */
     private OsdCommand command;
+
+    /** The OSD Manager that this plugin is using. */
+    private OsdManager osdManager;
     
     /** X-axis position of OSD. */
     private int x;
@@ -55,9 +58,15 @@ public final class OsdPlugin extends Plugin implements CategoryChangeListener,
     /** Y-axis potion of OSD. */
     private int y;
     
-    /** Setting objects with registered change listeners. */
-    private PreferencesSetting fontSizeSetting, backgroundSetting, 
-            foregroundSetting, widthSetting;
+    /** Setting objects with registered change listeners.*/
+    /**
+     * Setting objects with registered change listeners.
+     * maxWindowSetting not used at present so comment out
+     */
+    //private PreferencesSetting fontSizeSetting, backgroundSetting,
+    //        foregroundSetting, widthSetting, timeoutSetting, maxWindowsSetting;
+    private PreferencesSetting fontSizeSetting, backgroundSetting,
+            foregroundSetting, widthSetting, timeoutSetting;
     
     /**
      * Creates a new instance of OsdPlugin.
@@ -69,7 +78,8 @@ public final class OsdPlugin extends Plugin implements CategoryChangeListener,
     /** {@inheritDoc} */
     @Override
     public void onLoad() {
-        command = new OsdCommand(this);
+        osdManager = new OsdManager(this);
+        command = new OsdCommand(this, osdManager);
     }
     
     /** {@inheritDoc} */
@@ -100,14 +110,19 @@ public final class OsdPlugin extends Plugin implements CategoryChangeListener,
         widthSetting = new PreferencesSetting(PreferencesType.INTEGER,
                 getDomain(), "width", "OSD Width", "Width of the OSD Window").
                 registerChangeListener(this);
+        timeoutSetting = new PreferencesSetting(PreferencesType.INTEGER,
+                getDomain(), "timeout", "Timeout", "Length of time in " +
+                "seconds before the OSD window closes");
+        //maxWindowsSetting = new PreferencesSetting(PreferencesType.OPTIONALINTEGER,
+        //        getDomain(), "maxWindows", "Max display at once", "Maximum number of OSD " +
+        //        "windows that will be displayed at any given time");
                 
         category.addSetting(fontSizeSetting);
         category.addSetting(backgroundSetting);
         category.addSetting(foregroundSetting);
         category.addSetting(widthSetting);
-        category.addSetting(new PreferencesSetting(PreferencesType.INTEGER,
-                getDomain(), "timeout", "Timeout", "Length of time in " +
-                "seconds before the OSD window closes"));
+        category.addSetting(timeoutSetting);
+        //category.addSetting(maxWindowsSetting);
         
         final Map<String, String> posOptions = new HashMap<String, String>();
         posOptions.put("down", "Place new windows below old ones");
@@ -127,7 +142,7 @@ public final class OsdPlugin extends Plugin implements CategoryChangeListener,
     /** {@inheritDoc} */
     @Override
     public void categorySelected(final PreferencesCategory category) {
-        osdWindow = new OsdWindow("Please drag this OSD to position", true, x, y, this);
+        osdWindow = new OsdWindow("Please drag this OSD to position", true, x, y, this, osdManager);
         osdWindow.setBackgroundColour(backgroundSetting.getValue());
         osdWindow.setForegroundColour(foregroundSetting.getValue());
         osdWindow.setFontSize(Integer.parseInt(fontSizeSetting.getValue()));

src/com/dmdirc/addons/osd/OsdWindow.java

@@ -33,7 +33,6 @@ import java.awt.event.MouseEvent;
 import java.awt.event.MouseListener;
 import java.awt.event.MouseMotionListener;
 import java.util.ArrayList;
-import java.util.List;
 import java.util.Timer;
 import java.util.TimerTask;
 
@@ -61,14 +60,8 @@ public final class OsdWindow extends JDialog implements MouseListener,
      */
     private static final long serialVersionUID = 2;
     
-    /** Gap between vertically stacked windows. */
-    private static final int WINDOW_GAP = 5;
-    
-    /** A list of open OSD windows. */
-    private static List<OsdWindow> windows = new ArrayList<OsdWindow>();
-
-    /** Plugin this window belongs to. */
-    private final OsdPlugin plugin;
+    /** The OSD Manager that owns this window. */
+    private final OsdManager osdManager;
     
     /** OSD Label. */
     private final JLabel label;
@@ -82,19 +75,6 @@ public final class OsdWindow extends JDialog implements MouseListener,
     /** Is this a config instance? */
     private final boolean config;
 
-    /**
-     * Creates a new instance of OsdWindow.
-     * 
-     * @param text The text to be displayed in the OSD window
-     * @param config Is the window being configured (should it timeout and
-     * allow itself to be moved)
-     * @param plugin The plugin that owns this window
-     */    
-    public OsdWindow(final String text, final boolean config, final OsdPlugin plugin) {
-        this(text, config, IdentityManager.getGlobalConfig()
-                .getOptionInt(plugin.getDomain(), "locationX"), getYPosition(plugin), plugin);
-    }
-
     /**
      * Creates a new instance of OsdWindow.
      *
@@ -104,13 +84,14 @@ public final class OsdWindow extends JDialog implements MouseListener,
      * @param x The x-axis position for the OSD Window
      * @param y The y-axis position for the OSD window
      * @param plugin Parent OSD Plugin
+     * @param osdMAnager The manager that owns this OSD Window
      */
     public OsdWindow(final String text, final boolean config, final int x,
-            final int y, final OsdPlugin plugin) {
+            final int y, final OsdPlugin plugin, final OsdManager osdManager) {
         super((MainFrame) Main.getUI().getMainWindow(), false);
-
-        this.plugin = plugin;
+        
         this.config = config;
+        this.osdManager = osdManager;
 
         setFocusableWindowState(false);
         setAlwaysOnTop(true);
@@ -154,57 +135,14 @@ public final class OsdWindow extends JDialog implements MouseListener,
                 @Override
                 public void run() {
                     setVisible(false);
-                    dispose();
+                    osdManager.destroyOSDWindow(OsdWindow.this);
                 }
             }, IdentityManager.getGlobalConfig().getOptionInt(plugin.getDomain(),
                     "timeout") * 1000);
         }
     }
     
-    /**
-     * Retrieves the y-axis position for a new OSD window, based on the user's
-     * configured policy.
-     * 
-     * @return The y-axis position for a new OSD window.
-     */
-    private static int getYPosition(final OsdPlugin plugin) {
-        final String policy = IdentityManager.getGlobalConfig()
-                .getOption(plugin.getDomain(), "newbehaviour");
-        int y = IdentityManager.getGlobalConfig().getOptionInt(plugin.getDomain(),
-                "locationY");
-        
-        if ("down".equals(policy)) {
-            // Place our new window below old windows
-            for (OsdWindow window : new ArrayList<OsdWindow>(windows)) {
-                if (window.isVisible()) {
-                    y = Math.max(y, window.getY() + window.getHeight() + WINDOW_GAP);
-                }
-            }
-        } else if ("up".equals(policy)) {
-            // Place our new window above old windows
-            for (OsdWindow window : new ArrayList<OsdWindow>(windows)) {
-                if (window.isVisible()) {
-                    y = Math.min(y, window.getY() - window.getHeight() - WINDOW_GAP);
-                }
-            }            
-        } else if ("close".equals(policy)) {
-            // Close existing windows and use their place
-            closeAll();
-        }        
-        
-        return y;
-    }
-    
-    /**
-     * Closes all open OSD windows.
-     */
-    protected static void closeAll() {
-        for (OsdWindow window : new ArrayList<OsdWindow>(windows)) {
-            window.setVisible(false);
-            window.dispose();
-        }        
-    }
-    
+   
     /** 
      * {@inheritDoc}
      * 
@@ -214,7 +152,7 @@ public final class OsdWindow extends JDialog implements MouseListener,
     public void mouseClicked(final MouseEvent e) {
         if (!config) {
             setVisible(false);
-            dispose();
+            osdManager.destroyOSDWindow(this);
         }
     }
     
@@ -316,16 +254,7 @@ public final class OsdWindow extends JDialog implements MouseListener,
         super.setVisible(b);
         
         if (b) {
-            windows.add(this);
             transferFocusBackward();
         }
     }
-
-    /** {@inheritDoc} */
-    @Override
-    public void dispose() {
-        super.dispose();
-        
-        windows.remove(this);
-    }
 }

src/com/dmdirc/addons/osd/plugin.config

@@ -42,6 +42,7 @@ defaults:
   fontSize=20
   timeout=15
   width=500
+  maxWindows=false:5
 
 exports:
   showOSD in com.dmdirc.addons.osd.OsdCommand as showNotification