Create queueing for OSD windows.

Fixes issue 882

Change-Id: Ib1376b6b35072256a008b34ee93a1ff5f523be9a
Reviewed-on: http://gerrit.dmdirc.com/624
Automatic-Compile: Chris Smith <chris@dmdirc.com>
Reviewed-by: Chris Smith <chris@dmdirc.com>

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

@@ -65,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) {
-        osdManager.createOSDWindow(title, message);
-        return true;		
+        osdManager.showWindow(message);
+        return true;
     }
 
     /** {@inheritDoc} */
@@ -75,9 +75,9 @@ public final class OsdCommand extends GlobalCommand implements IntelligentComman
             final CommandArguments args) {
         if (args.getArguments().length > 0
                 && "--close".equalsIgnoreCase(args.getArguments()[0])) {
-            osdManager.destroyAllOSDWindows();
+            osdManager.closeAll();
         } else {
-            showOSD("", args.getArgumentsAsString());
+            showOSD(null, args.getArgumentsAsString());
         }
     }
     

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

@@ -24,12 +24,15 @@ package com.dmdirc.addons.osd;
 
 import com.dmdirc.config.IdentityManager;
 import java.util.ArrayList;
+import java.util.LinkedList;
 import java.util.List;
+import java.util.Queue;
 
 /**
  * Class to manage OSD Windows.
  *
  * @author Simon
+ * @since 0.6.3
  */
 public class OsdManager {
 
@@ -37,7 +40,10 @@ public class OsdManager {
     private final OsdPlugin plugin;
 
     /** List of OSD Windows. */
-    private List<OsdWindow> windowList = new ArrayList<OsdWindow>();
+    private final List<OsdWindow> windowList = new ArrayList<OsdWindow>();
+
+    /** List of messages to be queued. */
+    private final Queue<String> windowQueue = new LinkedList<String>();
 
     /** The spacing between the windows. */
     private static final int WINDOW_GAP = 5;
@@ -45,15 +51,43 @@ public class OsdManager {
     /**
      * Create a new OSD Manager.
      *
-     * @param plugin The plugin that owns this 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.
+    /**
+     * Add messages to the queue and call displayWindows.
+     *
+     * @param message Message to be displayed.
+     */
+    public void showWindow(final String message) {
+        windowQueue.add(message);
+        displayWindows();
+    }
+
+    /**
+     * Displays as many windows as appropriate.
+     */
+    private synchronized void displayWindows() {
+        final Integer maxWindows = IdentityManager.getGlobalConfig().getOptionInt(
+                plugin.getDomain(), "maxWindows");
+
+        String nextItem;
+
+        while ((maxWindows == null || getWindowCount() < maxWindows)
+                && (nextItem = windowQueue.poll()) != null) {
+            displayWindow(nextItem);
+        }
+    }
+
+    /**
+     * Create a new OSD window with "message".
+     *
+     * @param message Text to display in the OSD window.
+     */
+    private void displayWindow(final String message) {
         OsdWindow currentWindow = new OsdWindow(message, false,
                 IdentityManager.getGlobalConfig().getOptionInt(plugin.getDomain(),
                 "locationX"), getYPosition(), plugin, this);
@@ -62,29 +96,32 @@ public class OsdManager {
     }
 
     /**
-    * Destroy the given OSD Window.
+    * Destroy the given OSD Window and check if the Queue has items, if so
+    * Display them.
     *
     * @param window The window that we are destroying.
     */
-    public void destroyOSDWindow(OsdWindow window) {
+    public void closeWindow(final OsdWindow window) {
         windowList.remove(window);
         window.dispose();
+
+        displayWindows();
     }
 
     /**
-     * Destropy all OSD Windows
+     * Destroy all OSD Windows.
      */
-    public void destroyAllOSDWindows() {
+    public void closeAll() {
         for (OsdWindow window : new ArrayList<OsdWindow>(windowList)) {
             window.setVisible(false);
-            destroyOSDWindow(window);
+            closeWindow(window);
         }
     }
 
     /**
     * Get the list of current OSDWindows.
     *
-    * @return a List of all currently open OSDWindows
+    * @return a List of all currently open OSDWindows.
     */
     public List<OsdWindow> getWindowList() {
         return new ArrayList<OsdWindow>(windowList);
@@ -105,8 +142,8 @@ public class OsdManager {
     * @return the Y position for the next window.
     */
     public int getYPosition() {
-        final String policy = IdentityManager.getGlobalConfig()
-                .getOption(plugin.getDomain(), "newbehaviour");
+        final String policy = IdentityManager.getGlobalConfig().getOption(
+                plugin.getDomain(), "newbehaviour");
         int y = IdentityManager.getGlobalConfig().getOptionInt(plugin.getDomain(),
                 "locationY");
 
@@ -126,7 +163,7 @@ public class OsdManager {
             }
         } else if ("close".equals(policy)) {
             // Close existing windows and use their place
-            destroyAllOSDWindows();
+            closeAll();
         }
 
         return y;

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

@@ -32,6 +32,8 @@ import com.dmdirc.config.prefs.PreferencesManager;
 import com.dmdirc.config.prefs.PreferencesSetting;
 import com.dmdirc.config.prefs.PreferencesType;
 import com.dmdirc.config.prefs.SettingChangeListener;
+import com.dmdirc.config.prefs.validator.NumericalValidator;
+import com.dmdirc.config.prefs.validator.OptionalValidator;
 import com.dmdirc.plugins.Plugin;
 import java.util.HashMap;
 import java.util.Map;
@@ -63,11 +65,9 @@ public final class OsdPlugin extends Plugin implements CategoryChangeListener,
      * 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;
-    
+            foregroundSetting, widthSetting, timeoutSetting, maxWindowsSetting;
+
     /**
      * Creates a new instance of OsdPlugin.
      */
@@ -113,16 +113,17 @@ public final class OsdPlugin extends Plugin implements CategoryChangeListener,
         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");
+        maxWindowsSetting = new PreferencesSetting(PreferencesType.OPTIONALINTEGER,
+                new OptionalValidator(new NumericalValidator(1 ,Integer.MAX_VALUE)),
+                getDomain(), "maxWindows", "Maximum open windows", "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(timeoutSetting);
-        //category.addSetting(maxWindowsSetting);
+        category.addSetting(maxWindowsSetting);
         
         final Map<String, String> posOptions = new HashMap<String, String>();
         posOptions.put("down", "Place new windows below old ones");

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

@@ -134,7 +134,7 @@ public final class OsdWindow extends JDialog implements MouseListener,
                 @Override
                 public void run() {
                     setVisible(false);
-                    osdManager.destroyOSDWindow(OsdWindow.this);
+                    osdManager.closeWindow(OsdWindow.this);
                 }
             }, IdentityManager.getGlobalConfig().getOptionInt(plugin.getDomain(),
                     "timeout") * 1000);
@@ -151,7 +151,7 @@ public final class OsdWindow extends JDialog implements MouseListener,
     public void mouseClicked(final MouseEvent e) {
         if (!config) {
             setVisible(false);
-            osdManager.destroyOSDWindow(this);
+            osdManager.closeWindow(this);
         }
     }