Rework how window closing works

Fixes CLIENT-82

Change-Id: I4ea9fbf6c939a5b16f15ade230255b948e210c2c
Depends-On: I97f44a9269288f876a7a71b412302cec4238d9d4
Reviewed-on: http://gerrit.dmdirc.com/1600
Reviewed-by: Greg Holmes <greg@dmdirc.com>
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>

src/com/dmdirc/Channel.java

@@ -327,11 +327,6 @@ public class Channel extends MessageTarget<ChannelWindow> implements ConfigChang
     /** {@inheritDoc} */
     @Override
     public void windowClosing() {
-        // 1: Make the window non-visible
-        for (ChannelWindow window : getWindows()) {
-            window.setVisible(false);
-        }
-
         // 2: Remove any callbacks or listeners
         eventHandler.unregisterCallbacks();
 
@@ -349,9 +344,6 @@ public class Channel extends MessageTarget<ChannelWindow> implements ConfigChang
 
         // 5: Inform any parents that the window is closing
         server.delChannel(channelInfo.getName());
-
-        // 6: Remove the window from the window manager
-        WindowManager.removeWindow(this);
     }
 
     /** {@inheritDoc} */

src/com/dmdirc/CustomWindow.java

@@ -62,18 +62,10 @@ public class CustomWindow extends FrameContainer<Window> {
     /** {@inheritDoc} */
     @Override
     public void windowClosing() {
-        // 1: Make the window non-visible
-        for (Window window : getWindows()) {
-            window.setVisible(false);
-        }
-
         // 2: Remove any callbacks or listeners
         // 3: Trigger any actions neccessary
         // 4: Trigger action for the window closing
         // 5: Inform any parents that the window is closing
-
-        // 6: Remove the window from the window manager
-        WindowManager.removeWindow(this);
     }
 
     /** {@inheritDoc} */

src/com/dmdirc/FrameContainer.java

@@ -26,6 +26,7 @@ import com.dmdirc.actions.ActionManager;
 import com.dmdirc.actions.CoreActionType;
 import com.dmdirc.config.ConfigManager;
 import com.dmdirc.interfaces.ConfigChangeListener;
+import com.dmdirc.interfaces.FrameCloseListener;
 import com.dmdirc.interfaces.FrameInfoListener;
 import com.dmdirc.interfaces.NotificationListener;
 import com.dmdirc.interfaces.SelectionListener;
@@ -89,10 +90,10 @@ public abstract class FrameContainer<T extends Window> {
 
     /** The transcoder to use for this container. */
     private final StringTranscoder transcoder;
-    
+
     /** The config manager for this container. */
     private final ConfigManager config;
-    
+
     /** The IconChanger for this container. */
     private final IconChanger changer = new IconChanger();
 
@@ -101,7 +102,7 @@ public abstract class FrameContainer<T extends Window> {
 
     /**
      * Instantiate new frame container.
-     * 
+     *
      * @param icon The icon to use for this container
      * @param name The name of this container
      * @param title The title of this container
@@ -129,7 +130,7 @@ public abstract class FrameContainer<T extends Window> {
             tempTranscoder = new StringTranscoder(Charset.forName("UTF-8"));
         }
         transcoder = tempTranscoder;
-        
+
         setIcon(icon);
     }
 
@@ -317,18 +318,18 @@ public abstract class FrameContainer<T extends Window> {
 
     /**
      * Sets the icon to be used by this frame container.
-     * 
+     *
      * @param icon The new icon to be used
      */
     public final void setIcon(final String icon) {
         this.icon = icon;
-        
+
         iconUpdated();
-        
+
         config.removeListener(changer);
         config.addChangeListener("icon", icon, changer);
     }
-    
+
     /**
      * Called when this container's icon is updated.
      */
@@ -454,6 +455,12 @@ public abstract class FrameContainer<T extends Window> {
      *      {@link WindowManager#removeWindow(com.dmdirc.ui.interfaces.Window)}</li>
      * </ol>
      * <p>
+     * <strong>NB:</strong> As of DMDirc 0.6.5, points 1 and 6 (making windows
+     * non-visible and removing the window from the window manager) are handled
+     * by the caller of this method, and should <strong>not</strong> be
+     * implemented by subclasses.
+     * </p>
+     * <p>
      * While resources may be relinquished in step three, references MUST NOT
      * be removed yet. That is, if a window holds a resource, the resource may
      * be closed, but the relevant object MUST still be available for
@@ -464,7 +471,21 @@ public abstract class FrameContainer<T extends Window> {
      * on its frame, parser, etc. The resources should be completely freed in
      * the {@link #windowClosed()} method.
      */
-    public abstract void windowClosing();
+    protected abstract void windowClosing();
+
+    /**
+     * Handles the closing of this container. This should be called by UI
+     * components when the user is attempting to close a corresponding window.
+     */
+    public void handleWindowClosing() {
+        for (FrameCloseListener listener : listeners.get(FrameCloseListener.class)) {
+            listener.windowClosing(this);
+        }
+
+        windowClosing();
+
+        WindowManager.removeWindow(this);
+    }
 
     /**
      * Invoked when our window has been closed.
@@ -614,6 +635,26 @@ public abstract class FrameContainer<T extends Window> {
         listeners.remove(NotificationListener.class, listener);
     }
 
+    /**
+     * Adds a close listener for this frame container.
+     *
+     * @since 0.6.5
+     * @param listener The listener to be added
+     */
+    public void addCloseListener(final FrameCloseListener listener) {
+        listeners.add(FrameCloseListener.class, listener);
+    }
+
+    /**
+     * Removes a close listener from this frame container.
+     *
+     * @since 0.6.5
+     * @param listener The listener to be removed
+     */
+    public void removeCloseListener(final FrameCloseListener listener) {
+        listeners.remove(FrameCloseListener.class, listener);
+    }
+
     /**
      * Adds a selection listener for this frame container.
      *
@@ -701,6 +742,6 @@ public abstract class FrameContainer<T extends Window> {
         public void configChanged(final String domain, final String key) {
             iconUpdated();
         }
-        
+
     }
 }

src/com/dmdirc/GlobalWindow.java

@@ -64,18 +64,10 @@ public class GlobalWindow extends WritableFrameContainer<InputWindow> {
     /** {@inheritDoc} */
     @Override
     public void windowClosing() {
-        // 1: Make the window non-visible
-        for (InputWindow window : getWindows()) {
-            window.setVisible(false);
-        }
-
         // 2: Remove any callbacks or listeners
         // 3: Trigger any actions neccessary
         // 4: Trigger action for the window closing
         // 5: Inform any parents that the window is closing
-
-        // 6: Remove the window from the window manager
-        WindowManager.removeWindow(this);
     }
 
     /** {@inheritDoc} */

src/com/dmdirc/Query.java

@@ -300,11 +300,6 @@ public class Query extends MessageTarget<QueryWindow> implements PrivateActionLi
     /** {@inheritDoc} */
     @Override
     public void windowClosing() {
-        // 1: Make the window non-visible
-        for (QueryWindow window : getWindows()) {
-            window.setVisible(false);
-        }
-
         // 2: Remove any callbacks or listeners
         if (server != null && server.getParser() != null) {
             server.getParser().getCallbackManager().delAllCallback(this);
@@ -319,9 +314,6 @@ public class Query extends MessageTarget<QueryWindow> implements PrivateActionLi
         if (server != null) {
             server.delQuery(this);
         }
-
-        // 6: Remove the window from the window manager
-        WindowManager.removeWindow(this);
     }
 
     /** {@inheritDoc} */

src/com/dmdirc/Raw.java

@@ -77,11 +77,6 @@ public final class Raw extends WritableFrameContainer<InputWindow>
     /** {@inheritDoc} */
     @Override
     public void windowClosing() {
-        // 1: Make the window non-visible
-        for (InputWindow window : getWindows()) {
-            window.setVisible(false);
-        }
-
         // 2: Remove any callbacks or listeners
         if (server.getParser() != null) {
             server.getParser().getCallbackManager().delAllCallback(this);
@@ -92,9 +87,6 @@ public final class Raw extends WritableFrameContainer<InputWindow>
 
         // 5: Inform any parents that the window is closing
         server.delRaw();
-
-        // 6: Remove the window from the window manager
-        WindowManager.removeWindow(this);
     }
 
     /** {@inheritDoc} */

src/com/dmdirc/Server.java

@@ -1167,11 +1167,6 @@ public class Server extends WritableFrameContainer<ServerWindow> implements Conf
     @Override
     public void windowClosing() {
         synchronized (myStateLock) {
-            // 1: Make the window non-visible
-            for (Window window : getWindows()) {
-                window.setVisible(false);
-            }
-
             // 2: Remove any callbacks or listeners
             eventHandler.unregisterCallbacks();
 
@@ -1192,9 +1187,6 @@ public class Server extends WritableFrameContainer<ServerWindow> implements Conf
         // 4: Trigger action for the window closing
         // 5: Inform any parents that the window is closing
         ServerManager.getServerManager().unregisterServer(this);
-
-        // 6: Remove the window from the window manager
-        WindowManager.removeWindow(this);
     }
 
     /** {@inheritDoc} */

src/com/dmdirc/interfaces/FrameCloseListener.java

@@ -0,0 +1,44 @@
+/*
+ * 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.interfaces;
+
+import com.dmdirc.FrameContainer;
+
+/**
+ * Defines methods that should be implemented by objects interested in the
+ * frame closing lifecycle of a {@link FrameContainer}.
+ *
+ * @since 0.6.5
+ * @author chris
+ */
+public interface FrameCloseListener {
+
+    /**
+     * Called when a window is starting the closing process and should be
+     * hidden from users.
+     *
+     * @param window The window which is being closed
+     */
+    void windowClosing(final FrameContainer<?> window);
+
+}

src/com/dmdirc/ui/interfaces/Window.java

@@ -93,6 +93,7 @@ public interface Window {
      *
      * @return boolean visibility
      */
+    @Deprecated
     boolean isVisible();
 
     /**
@@ -100,6 +101,7 @@ public interface Window {
      *
      * @param isVisible Whether the window should be visible or not
      */
+    @Deprecated
     void setVisible(boolean isVisible);
 
     /**

test/com/dmdirc/harness/TestWritableFrameContainer.java

@@ -59,7 +59,6 @@ public class TestWritableFrameContainer<T extends InputWindow> extends WritableF
     @Override
     public void windowClosing() {
         System.out.println("windowClosing");
-        WindowManager.removeWindow(this);
     }
 
     @Override