Created OsdPolicies Enum

Fixes issue 3630
Change-Id: I3880b3201932d914e11a6cefbcef81f788c0f60d
Reviewed-on: http://gerrit.dmdirc.com/758
Reviewed-by: Chris Smith <chris@dmdirc.com>
Automatic-Compile: Chris Smith <chris@dmdirc.com>

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

@@ -44,8 +44,6 @@ public class OsdManager {
     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;
 
     /**
      * Create a new OSD Manager.
@@ -85,13 +83,20 @@ public class OsdManager {
      * Create a new OSD window with "message".
      * <p>
      * This method needs to be synchronised to ensure that the window list is
-     * not modified in between the invocation of {@link #getYPosition()} and
-     * the point at which the {@link OSDWindow} is added to the windowList.
+     * not modified in between the invocation of
+     * {@link OsdPolicy#getYPosition(com.dmdirc.addons.osd.OsdManager, int)} 
+     * and the point at which the {@link OsdWindow} is added to the windowList.
      *
-     * @see #getYPosition()
+     * @see OsdPolicy#getYPosition(com.dmdirc.addons.osd.OsdManager, int)
      * @param message Text to display in the OSD window.
      */
     private synchronized void displayWindow(final String message) {
+        final OsdPolicy policy = OsdPolicy.valueOf(IdentityManager.
+                getGlobalConfig().getOption(plugin.getDomain(), "newbehaviour").
+                toUpperCase());
+        final int startY = IdentityManager.getGlobalConfig().getOptionInt(
+                plugin.getDomain(), "locationY");
+
         windowList.add(UIUtilities.invokeAndWait(
                 new ReturnableThread<OsdWindow>() {
 
@@ -100,8 +105,8 @@ public class OsdManager {
             public void run() {
                 setObject(new OsdWindow(message, false,
                         IdentityManager.getGlobalConfig().getOptionInt(
-                        plugin.getDomain(), "locationX"), getYPosition(),
-                        plugin, OsdManager.this));
+                        plugin.getDomain(), "locationX"), policy.getYPosition(
+                        OsdManager.this, startY), plugin, OsdManager.this));
             }
         }));
     }
@@ -113,8 +118,9 @@ public class OsdManager {
      * @param window The window that we are destroying.
      */
     public synchronized void closeWindow(final OsdWindow window) {
-        final String policy = IdentityManager.getGlobalConfig().getOption(
-                plugin.getDomain(), "newbehaviour");
+        final OsdPolicy policy = OsdPolicy.valueOf(IdentityManager.
+                getGlobalConfig().getOption(plugin.getDomain(), "newbehaviour").
+                toUpperCase());
 
         int oldY = window.getDesiredY();
         final int closedIndex = windowList.indexOf(window);
@@ -136,13 +142,11 @@ public class OsdManager {
         final List<OsdWindow> newList = getWindowList();
         for (OsdWindow otherWindow : newList.subList(closedIndex, newList.size())) {
             final int currentY = otherWindow.getDesiredY();
-
-            if ("down".equals(policy) || "up".equals(policy)) {
+            if (policy.changesPosition()) {
                 otherWindow.setDesiredLocation(otherWindow.getDesiredX(), oldY);
                 oldY = currentY;
             }
         }
-
         displayWindows();
     }
 
@@ -172,44 +176,4 @@ public class OsdManager {
     public int getWindowCount() {
         return windowList.size();
     }
-
-    /**
-     * Get the Y position for the next window.
-     * <p>
-     * In order to ensure that windows are displayed at the correct position,
-     * the calling party MUST ensure that the window list is not altered between
-     * this method's invocation and the time at which the window is displayed.
-     * If the window list is altered, multiple windows may appear on top of
-     * each other instead of stacking correctly, or there may be gaps in up/down
-     * policy layouts.
-     *
-     * @return the Y position for the next window.
-     */
-    private 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 : 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 : 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
-            closeAll();
-        }
-
-        return y;
-    }
 }

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

@@ -126,10 +126,11 @@ public final class OsdPlugin extends Plugin implements CategoryChangeListener,
         category.addSetting(maxWindowsSetting);
         
         final Map<String, String> posOptions = new HashMap<String, String>();
-        posOptions.put("down", "Place new windows below old ones");
-        posOptions.put("up", "Place new windows above old ones");
-        posOptions.put("close", "Close existing windows");
-        posOptions.put("ontop", "Place new windows on top of existing window");
+
+        //Populate policy MULTICHOICE
+        for (OsdPolicy policy : OsdPolicy.values()) {
+            posOptions.put(policy.name(), policy.getDescription());
+        }
         
         category.addSetting(new PreferencesSetting(getDomain(), "newbehaviour",
                 "New window policy", "What to do when an OSD Window "

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

@@ -0,0 +1,132 @@
+/*
+ * Copyright (c) 2006-2010 Chris Smith, Shane Mc Cormack, Gregory Holmes,
+ * Simon Mott
+ *
+ * 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;
+
+/**
+ * Enumerates OSD Policies.
+ *
+ * @author simon
+ * @since 0.6.3
+ */
+public enum OsdPolicy {
+
+    /** Spawn new windows below old ones. */
+    DOWN ("Place new windows below old ones", true) {
+        /** {@inheritDoc} */
+        @Override
+        public int getYPosition(final OsdManager osdManager, final int startY) {
+            int y = startY;
+            for (OsdWindow window : osdManager.getWindowList()) {
+                if (window.isVisible()) {
+                    y = Math.max(y, window.getY() + window.getHeight() + WINDOW_GAP);
+                }
+            }
+            return y;
+        }
+    },
+    /** Spawn new windows above old ones. */
+    UP ("Place new windows above old ones", true) {
+        /** {@inheritDoc} */
+        @Override
+        public int getYPosition(final OsdManager osdManager, final int startY) {
+            int y = startY;
+            for (OsdWindow window : osdManager.getWindowList()) {
+                if (window.isVisible()) {
+                    y = Math.min(y, window.getY() - window.getHeight() - WINDOW_GAP);
+                }
+            }
+            return y;
+        }
+    },
+    /** Close old OSD windows and display the new windows. */
+    CLOSE ("Close existing windows", false) {
+        /** {@inheritDoc} */
+        @Override
+        public int getYPosition(final OsdManager osdManager, final int startY) {
+            osdManager.closeAll();
+            return startY;
+        }
+    },
+    /** Place new windows on top of old windows. */
+    ONTOP ("Place new windows on top of existing windows", false) {
+        /** {@inheritDoc} */
+        @Override
+        public int getYPosition(final OsdManager osdManager, final int startY) {
+            return startY;
+        }
+    };
+
+    /** The spacing between the windows. */
+    private static final int WINDOW_GAP = 5;
+
+    /** Description of policy. */
+    private final String description;
+
+    /** Does policy need to change window location */
+    private final boolean changesPosition;
+
+    /**
+     * Creates a new instance of OsdPolicies.
+     *
+     * @param description Description of the behaviour of the enum value
+     */
+    OsdPolicy(final String description, final boolean changesPosition) {
+        this.description = description;
+        this.changesPosition = changesPosition;
+    }
+
+    /**
+     * Calculates the Y position for new windows according to this policy.
+     * <p>
+     * In order to ensure that windows are displayed at the correct position,
+     * the calling party MUST ensure that the window list is not altered between
+     * this method's invocation and the time at which the window is displayed.
+     * If the window list is altered, multiple windows may appear on top of
+     * each other instead of stacking correctly, or there may be gaps in up/down
+     * policy layouts.
+     *
+     * @param osdManager OSD Manager we are using
+     * @param startY Value of startY from the main config
+     *
+     * @return returns Y Value to use for new windows
+     */
+    public abstract int getYPosition(final OsdManager osdManager, final int startY);
+
+    /**
+     * See if this behaviour changes window position
+     *
+     * @return true or false depending on window behaviour
+     */
+    public boolean changesPosition() {
+        return changesPosition;
+    };
+
+    /**
+     * Return a description of what each policy does.
+     *
+     * @return Description of policies behaviour
+     */
+    public String getDescription() {
+        return description;
+    }
+}