Adds some window arrangement options for MDI mode.

Fixes issue CLIENT-20

Change-Id: Ib36a2434ccee62e44894e7f6c6e49917247fcdb8
Reviewed-on: http://gerrit.dmdirc.com/1536
Reviewed-by: Chris Smith <chris@dmdirc.com>
Automatic-Compile: Greg Holmes <greg@dmdirc.com>

src/com/dmdirc/addons/ui_swing/MainFrame.java

@@ -259,7 +259,7 @@ public final class MainFrame extends JFrame implements WindowListener,
      *
      * @return JDesktopPane for the frame
      */
-    public JDesktopPane getDesktopPane() {
+    public DMDircDesktopPane getDesktopPane() {
         return desktopPane;
     }
 

src/com/dmdirc/addons/ui_swing/components/desktopPane/DMDircDesktopPane.java

@@ -23,6 +23,7 @@
 package com.dmdirc.addons.ui_swing.components.desktopPane;
 
 import com.dmdirc.FrameContainer;
+import com.dmdirc.FrameContainerComparator;
 import com.dmdirc.addons.ui_swing.BackgroundOption;
 import com.dmdirc.addons.ui_swing.MainFrame;
 import com.dmdirc.addons.ui_swing.SwingController;
@@ -33,6 +34,7 @@ import com.dmdirc.addons.ui_swing.components.frames.InputTextFrame;
 import com.dmdirc.addons.ui_swing.components.frames.TextFrame;
 import com.dmdirc.addons.ui_swing.framemanager.tree.TreeViewModel;
 import com.dmdirc.addons.ui_swing.framemanager.tree.TreeViewNode;
+import com.dmdirc.addons.ui_swing.framemanager.windowmenu.JInternalFrameComparator;
 import com.dmdirc.config.IdentityManager;
 import com.dmdirc.interfaces.ConfigChangeListener;
 import com.dmdirc.interfaces.SelectionListener;
@@ -200,6 +202,74 @@ public class DMDircDesktopPane extends JDesktopPane implements
         yOffset += FRAME_OPENING_OFFSET;
     }
 
+    /**
+     * Arranges the windows in the specified number of rows and columns.
+     *
+     * @param windows Windows to arranges
+     * @param columns Number of columns to use
+     * @param rows Number of rows to use
+     */
+    private void tileWindows(final JInternalFrame[] windows, final int columns,
+            final int rows) {
+        ((TextFrame) windows[0]).restore();
+        final int total = windows.length;
+        final int windowWidth = getWidth() / columns;
+        final int windowHeight = getHeight() / rows;
+
+        int column = 0;
+        int x = 0;
+        int y = 0;
+        for (int i = 0; i < total; i++) {
+            windows[i].setBounds(x, y, windowWidth, windowHeight);
+            column++;
+            x += windowWidth;
+            if (column >= columns) {
+                column = 0;
+                x = 0;
+                y += windowHeight;
+            }
+        }
+    }
+
+    /**
+     * Arranges the windows to be equal size in a grid.
+     */
+    public void tileWindows() {
+        if (getAllFrames().length == 0) {
+            return;
+        }
+        final JInternalFrame[] windows = getAllFrames();
+        Arrays.sort(windows, new JInternalFrameComparator());
+        final int total = windows.length;
+        final int columns = (int) Math.floor(Math.sqrt(total));
+        final int rows = (int) (Math.ceil(((double) total) / columns));
+        tileWindows(windows, columns, rows);
+    }
+
+    /**
+     * Arranges the windows to be equal size in a horizontal row.
+     */
+    public void tileHorizontally() {
+        if (getAllFrames().length == 0) {
+            return;
+        }
+        final JInternalFrame[] windows = getAllFrames();
+        Arrays.sort(windows, new JInternalFrameComparator());
+        tileWindows(windows, 1, windows.length);
+    }
+
+    /**
+     * Arranges the windows to be equal size in a vertical row.
+     */
+    public void tileVertically() {
+        if (getAllFrames().length == 0) {
+            return;
+        }
+        final JInternalFrame[] windows = getAllFrames();
+        Arrays.sort(windows, new JInternalFrameComparator());
+        tileWindows(windows, windows.length, 1);
+    }
+
     /**
      * Returns the select window.
      *

src/com/dmdirc/addons/ui_swing/framemanager/windowmenu/ArrangeWindows.java

@@ -0,0 +1,99 @@
+/*
+ * 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.ui_swing.framemanager.windowmenu;
+
+import com.dmdirc.addons.ui_swing.SwingController;
+import com.dmdirc.ui.IconManager;
+
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+
+import javax.swing.JMenu;
+import javax.swing.JMenuItem;
+
+/**
+ * Menu to add window arrangement options.
+ */
+public class ArrangeWindows extends JMenu implements ActionListener {
+    /**
+     * 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;
+    /** Menu items for tiling grid, vertical, horizontal. */
+    private final JMenuItem grid, vertical, horizontal;
+    /** Desktop pane. */
+    private SwingController controller;
+
+    /**
+     * Creates a new arrange windows menu.  Provides options to arrange windows
+     * in a grid, tile vertically and tile horizontally.
+     *
+     * @param controller Swing controller to request mainframe/desktop pane.
+     */
+    public ArrangeWindows(final SwingController controller) {
+        super();
+
+        this.controller = controller;
+
+        setIcon(IconManager.getIconManager().getIcon("dmdirc"));
+        setMnemonic('a');
+        setText("Arrange Windows");
+
+        grid = new JMenuItem(IconManager.getIconManager().getIcon("dmdirc"));
+        grid.setMnemonic('g');
+        grid.setText("Arrange in grid");
+        grid.setActionCommand("grid");
+        grid.addActionListener(this);
+        add(grid);
+
+        horizontal = new JMenuItem(IconManager.getIconManager().getIcon(
+                "dmdirc"));
+        horizontal.setMnemonic('h');
+        horizontal.setText("Arrange horizontally");
+        horizontal.setActionCommand("horizontal");
+        horizontal.addActionListener(this);
+        add(horizontal);
+
+        vertical = new JMenuItem(IconManager.getIconManager().getIcon(
+                "dmdirc"));
+        vertical.setMnemonic('v');
+        vertical.setText("Arrange vertically");
+        vertical.setActionCommand("vertical");
+        vertical.addActionListener(this);
+        add(vertical);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void actionPerformed(final ActionEvent e) {
+        if (e.getActionCommand().equals("grid")) {
+            controller.getMainFrame().getDesktopPane().tileWindows();
+        } else if (e.getActionCommand().equals("horizontally")) {
+            controller.getMainFrame().getDesktopPane().tileHorizontally();
+        } else if (e.getActionCommand().equals("verticallt")) {
+            controller.getMainFrame().getDesktopPane().tileVertically();
+        }
+    }
+}

src/com/dmdirc/addons/ui_swing/framemanager/windowmenu/JInternalFrameComparator.java

@@ -0,0 +1,66 @@
+/*
+ * 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.ui_swing.framemanager.windowmenu;
+
+import com.dmdirc.FrameContainerComparator;
+import com.dmdirc.addons.ui_swing.components.frames.TextFrame;
+
+import java.io.Serializable;
+import java.util.Comparator;
+
+import javax.swing.JInternalFrame;
+
+/**
+ * A comparator that proxies JInternalFrame arrays to a Frame container
+ * comparator if appropriate.
+ */
+public class JInternalFrameComparator implements Comparator<JInternalFrame>,
+        Serializable {
+
+    /**
+     * 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;
+    /** Comparator to proxy compares to. */
+    private final FrameContainerComparator comparator =
+            new FrameContainerComparator();
+
+    /**
+     * Compares two frame containers names.
+     *
+     * @param item1 The first container to compare
+     * @param item2 The second container to compare
+     * @return -1 if item1 is before item2, 0 if they're equal,
+     * +1 if item1 is after item2.
+     */
+    @Override
+    public int compare(final JInternalFrame item1, final JInternalFrame item2) {
+        if (!(item1 instanceof TextFrame) || (!(item2 instanceof TextFrame))) {
+            return 0;
+        }
+        return comparator.compare(((TextFrame) item1).getContainer(),
+                ((TextFrame) item2).getContainer());
+    }
+}

src/com/dmdirc/addons/ui_swing/framemanager/windowmenu/WindowMenuFrameManager.java

@@ -69,7 +69,8 @@ public final class WindowMenuFrameManager extends JMenu implements
     /** Non frame container menu count. */
     private final int itemCount;
     /** Menu items for toggling, closing and minimising. */
-    private final JMenuItem toggleStateMenuItem, closeMenuItem, minimiseMenuItem;
+    private final JMenuItem toggleStateMenuItem, closeMenuItem,
+            minimiseMenuItem;
     /** Seperator. */
     private final JSeparator separator;
     /** Active window. */
@@ -83,7 +84,7 @@ public final class WindowMenuFrameManager extends JMenu implements
     private final Map<FrameContainer, FrameContainerMenuItem> items;
     private final Map<FrameContainer, FrameContainerMenuItem> menuItems;
 
-    /** 
+    /**
      * Creates a new instance of WindowMenuFrameManager.
      *
      * @param controller Swing controller
@@ -128,17 +129,19 @@ public final class WindowMenuFrameManager extends JMenu implements
         closeMenuItem.addActionListener(this);
         add(closeMenuItem);
 
+        add(new ArrangeWindows(controller));
+
         separator = new JPopupMenu.Separator();
         add(separator);
 
         itemCount = getMenuComponentCount();
         checkToggleState();
 
-        new WindowMenuScroller(this, controller.getDomain(), 4);
+        new WindowMenuScroller(this, controller.getDomain(), itemCount);
     }
 
     /**
-     * Checks the number of components in the menu and enables menus items 
+     * Checks the number of components in the menu and enables menus items
      * appropriately.
      */
     private void checkMenuItems() {
@@ -306,9 +309,9 @@ public final class WindowMenuFrameManager extends JMenu implements
         items.put(item.getFrame(), item);
     }
 
-    /** 
+    /**
      * {@inheritDoc}
-     * 
+     *
      * @param e Action event
      */
     @Override