Add interface for active frame management.

Change-Id: I9028e6f92a6e076a0d446ef2321898924d6faa39
Reviewed-on: http://gerrit.dmdirc.com/3322
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Chris Smith <chris@dmdirc.com>

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

@@ -32,6 +32,7 @@ import com.dmdirc.addons.ui_swing.dialogs.StandardQuestionDialog;
 import com.dmdirc.addons.ui_swing.framemanager.FrameManager;
 import com.dmdirc.addons.ui_swing.framemanager.FramemanagerPosition;
 import com.dmdirc.addons.ui_swing.framemanager.ctrltab.CtrlTabWindowManager;
+import com.dmdirc.addons.ui_swing.interfaces.ActiveFrameManager;
 import com.dmdirc.events.ClientFocusGainedEvent;
 import com.dmdirc.events.ClientFocusLostEvent;
 import com.dmdirc.events.ClientMinimisedEvent;
@@ -71,7 +72,7 @@ import static com.dmdirc.addons.ui_swing.SwingPreconditions.checkOnEDT;
  */
 public class MainFrame extends JFrame implements WindowListener,
         ConfigChangeListener, SwingWindowListener, FrameInfoListener,
-        NotificationListener {
+        NotificationListener, ActiveFrameManager {
 
     /** A version number for this class. */
     private static final long serialVersionUID = 9;
@@ -212,15 +213,6 @@ public class MainFrame extends JFrame implements WindowListener,
         }
     }
 
-    /**
-     * Returns the window that is currently active.
-     *
-     * @return The active window
-     */
-    public TextFrame getActiveFrame() {
-        return activeFrame;
-    }
-
     @Override
     public MenuBar getJMenuBar() {
         return (MenuBar) super.getJMenuBar();
@@ -565,11 +557,12 @@ public class MainFrame extends JFrame implements WindowListener,
         }
     }
 
-    /**
-     * Changes the visible frame.
-     *
-     * @param activeFrame The frame to be activated, or null to show none
-     */
+    @Override
+    public TextFrame getActiveFrame() {
+        return activeFrame;
+    }
+
+    @Override
     public void setActiveFrame(final TextFrame activeFrame) {
         UIUtilities.invokeLater(new Runnable() {
 
@@ -611,26 +604,12 @@ public class MainFrame extends JFrame implements WindowListener,
         });
     }
 
-    /**
-     * Registers a new selection listener with this frame. The listener will be notified whenever
-     * the currently selected frame is changed.
-     *
-     * @param listener The listener to be added
-     *
-     * @see #setActiveFrame(com.dmdirc.addons.ui_swing.components.frames.TextFrame)
-     * @see #getActiveFrame()
-     */
+    @Override
     public void addSelectionListener(final SelectionListener listener) {
         listeners.add(SelectionListener.class, listener);
     }
 
-    /**
-     * Removes a previously registered selection listener.
-     *
-     * @param listener The listener to be removed
-     *
-     * @see #addSelectionListener(com.dmdirc.addons.ui_swing.SelectionListener)
-     */
+    @Override
     public void removeSelectionListener(final SelectionListener listener) {
         listeners.remove(SelectionListener.class, listener);
     }

src/com/dmdirc/addons/ui_swing/interfaces/ActiveFrameManager.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * 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.interfaces;
+
+import com.dmdirc.addons.ui_swing.SelectionListener;
+import com.dmdirc.addons.ui_swing.components.frames.TextFrame;
+
+/**
+ * Interface to the management of the active window in the swing ui.
+ */
+public interface ActiveFrameManager {
+
+    /**
+     * Returns the window that is currently active.
+     *
+     * @return The active window
+     */
+    TextFrame getActiveFrame();
+
+    /**
+     * Changes the visible frame.
+     *
+     * @param activeFrame The frame to be activated, or null to show none
+     */
+    void setActiveFrame(TextFrame activeFrame);
+
+    /**
+     * Registers a new selection listener with this frame. The listener will be notified whenever
+     * the currently selected frame is changed.
+     *
+     * @param listener The listener to be added
+     *
+     * @see #setActiveFrame(com.dmdirc.addons.ui_swing.components.frames.TextFrame)
+     * @see #getActiveFrame()
+     */
+    void addSelectionListener(SelectionListener listener);
+
+    /**
+     * Removes a previously registered selection listener.
+     *
+     * @param listener The listener to be removed
+     *
+     * @see #addSelectionListener(com.dmdirc.addons.ui_swing.SelectionListener)
+     */
+    void removeSelectionListener(SelectionListener listener);
+
+}