Some more UI abstraction (server window)

git-svn-id: http://svn.dmdirc.com/trunk@1579 00569f92-eb28-0410-84fd-f71c24880f

src/com/dmdirc/Server.java

@@ -62,6 +62,7 @@ import com.dmdirc.ui.interfaces.InputWindow;
 import com.dmdirc.ui.MainFrame;
 import com.dmdirc.ui.ServerFrame;
 import com.dmdirc.ui.input.TabCompleter;
+import com.dmdirc.ui.interfaces.ServerWindow;
 import com.dmdirc.ui.interfaces.Window;
 import com.dmdirc.ui.messages.Formatter;
 
@@ -109,8 +110,8 @@ public final class Server extends WritableFrameContainer implements
     private IRCParser parser;
     /** The raw frame used for this server instance. */
     private Raw raw;
-    /** The ServerFrame corresponding to this server. */
-    private ServerFrame frame;
+    /** The ServerWindow corresponding to this server. */
+    private ServerWindow window;
     
     /** The name of the server we're connecting to. */
     private String server;
@@ -163,13 +164,16 @@ public final class Server extends WritableFrameContainer implements
         
         configManager = new ConfigManager("", "", server);
         
-        frame = new ServerFrame(this);
-        frame.setTitle(server + ":" + port);
-        frame.getInputHandler().setTabCompleter(tabCompleter);
-        frame.addInternalFrameListener(this);
-        MainFrame.getMainFrame().addChild(frame);
+        window = new ServerFrame(this);
         
-        frame.open();
+        window.setTitle(server + ":" + port);
+        
+        window.getInputHandler().setTabCompleter(tabCompleter);
+        
+        ((ServerFrame) window).addInternalFrameListener(this);
+        MainFrame.getMainFrame().addChild(window);
+        
+        window.open();
         
         tabCompleter.addEntries(CommandManager.getServerCommandNames());
         tabCompleter.addEntries(CommandManager.getGlobalCommandNames());
@@ -223,9 +227,10 @@ public final class Server extends WritableFrameContainer implements
             imageURL = cldr.getResource("com/dmdirc/res/server.png");
         }
         imageIcon = new ImageIcon(imageURL);
-        frame.setFrameIcon(imageIcon);
         
-        frame.addLine("serverConnecting", server, port);
+        window.setFrameIcon(imageIcon);
+        
+        window.addLine("serverConnecting", server, port);
         
         final MyInfo myInfo = new MyInfo();
         myInfo.setNickname(profile.getOption("profile", "nickname"));
@@ -262,7 +267,7 @@ public final class Server extends WritableFrameContainer implements
         
         away = false;
         awayMessage = null;
-        frame.setAway(false);
+        ((ServerFrame) window).setAway(false);
         
         try {
             new Thread(parser).start();
@@ -472,7 +477,7 @@ public final class Server extends WritableFrameContainer implements
     
     /** {@inheritDoc} */
     public InputWindow getFrame() {
-        return frame;
+        return window;
     }
     
     /** {@inheritDoc} */
@@ -494,9 +499,9 @@ public final class Server extends WritableFrameContainer implements
             parser.getCallbackManager().delAllCallback(this);
         }
         
-        if (frame != null) {
+        if (window != null) {
             // Unregister frame callbacks
-            frame.removeInternalFrameListener(this);
+            ((ServerFrame) window).removeInternalFrameListener(this);
         }
         
         // Disconnect from the server
@@ -512,13 +517,12 @@ public final class Server extends WritableFrameContainer implements
         // Unregister ourselves with the server manager
         ServerManager.getServerManager().unregisterServer(this);
         
-        if (frame != null) {
+        if (window != null) {
             SwingUtilities.invokeLater(new Runnable() {
                 public void run() {
-                    // Close our own window
-                    frame.setVisible(false);
-                    MainFrame.getMainFrame().delChild(frame);
-                    frame = null;
+                    window.setVisible(false);
+                    MainFrame.getMainFrame().delChild(window);
+                    window = null;
                 }
             });
         }
@@ -663,7 +667,7 @@ public final class Server extends WritableFrameContainer implements
     @Override
     public boolean ownsFrame(final Window target) {
         // Check if it's our server frame
-        if (frame != null && frame.equals(target)) { return true; }
+        if (window != null && window.equals(target)) { return true; }
         // Check if it's the raw frame
         if (raw != null && raw.ownsFrame(target)) { return true; }
         // Check if it's a channel frame
@@ -717,7 +721,7 @@ public final class Server extends WritableFrameContainer implements
             query.getFrame().addLine(messageType, args);
         }
         
-        frame.addLine(messageType, args);
+        window.addLine(messageType, args);
     }
     
     /**
@@ -859,17 +863,17 @@ public final class Server extends WritableFrameContainer implements
     
     /** {@inheritDoc} */
     public void onMOTDStart(final IRCParser tParser, final String sData) {
-        frame.addLine("motdStart", sData);
+        window.addLine("motdStart", sData);
     }
     
     /** {@inheritDoc} */
     public void onMOTDLine(final IRCParser tParser, final String sData) {
-        frame.addLine("motdLine", sData);
+        window.addLine("motdLine", sData);
     }
     
     /** {@inheritDoc} */
     public void onMOTDEnd(final IRCParser tParser, final boolean noMOTD) {
-        frame.addLine("motdEnd", "End of server's MOTD.");
+        window.addLine("motdEnd", "End of server's MOTD.");
     }
     
     /** {@inheritDoc} */
@@ -918,7 +922,7 @@ public final class Server extends WritableFrameContainer implements
         ActionManager.processEvent(CoreActionType.SERVER_USERMODES, format,
                 this, setter, sModes);
         
-        frame.addLine(format, setterParts[0], setterParts[1], setterParts[2],
+        window.addLine(format, setterParts[0], setterParts[1], setterParts[2],
                 sModes);
     }
     
@@ -937,7 +941,7 @@ public final class Server extends WritableFrameContainer implements
             ActionManager.processEvent(CoreActionType.SERVER_BACK, null, this);
         }
         
-        frame.setAway(away);
+        ((ServerFrame) window).setAway(away);
     }
     
     /** {@inheritDoc} */

src/com/dmdirc/ui/MainFrame.java

@@ -93,7 +93,7 @@ public final class MainFrame extends JFrame implements WindowListener,
      * structure is changed (or anything else that would prevent serialized
      * objects being unserialized with the new class).
      */
-    private static final long serialVersionUID = 5;
+    private static final long serialVersionUID = 6;
     
     /**
      * The number of pixels each new internal frame is offset by.
@@ -243,10 +243,13 @@ public final class MainFrame extends JFrame implements WindowListener,
     }
     
     /**
-     * Adds the specified InternalFrame as a child of the main frame.
-     * @param frame the frame to be added
+     * Adds the specified window as a child of the main frame.
+     * 
+     * @param window the window to be added
      */
-    public void addChild(final JInternalFrame frame) {
+    public void addChild(final Window window) {
+        final JInternalFrame frame = (JInternalFrame) window;
+        
         // Add the frame
         desktopPane.add(frame);
         
@@ -268,11 +271,12 @@ public final class MainFrame extends JFrame implements WindowListener,
     }
     
     /**
-     * Removes the specified InternalFrame from our desktop pane.
-     * @param frame The frame to be removed
+     * Removes the specified window from our desktop pane.
+     * 
+     * @param window The window to be removed
      */
-    public void delChild(final JInternalFrame frame) {
-        desktopPane.remove(frame);
+    public void delChild(final Window window) {
+        desktopPane.remove((JInternalFrame) window);
         if (desktopPane.getAllFrames().length == 0) {
             setTitle(getTitlePrefix());
         }

src/com/dmdirc/ui/ServerFrame.java

@@ -29,6 +29,7 @@ import com.dmdirc.commandparser.CommandParser;
 import com.dmdirc.commandparser.ServerCommandParser;
 import com.dmdirc.ui.input.InputHandler;
 import com.dmdirc.ui.components.InputFrame;
+import com.dmdirc.ui.interfaces.ServerWindow;
 
 import java.awt.GridBagConstraints;
 import java.awt.GridBagLayout;
@@ -37,7 +38,7 @@ import java.awt.Insets;
 /**
  * The ServerFrame is the MDI window that shows server messages to the user.
  */
-public final class ServerFrame extends InputFrame {
+public final class ServerFrame extends InputFrame implements ServerWindow {
     
     /**
      * A version number for this class. It should be changed whenever the class

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

@@ -23,18 +23,28 @@
 package com.dmdirc.ui.interfaces;
 
 import com.dmdirc.commandparser.CommandParser;
+import com.dmdirc.ui.input.InputHandler;
 
 /**
  * The Input Window interface specifies additional methods that windows should
  * implement if they have an input field.
+ * 
  * @author chris
  */
 public interface InputWindow extends Window {
     
     /**
-     * Retrieves the command Parser for this command window.
-     * @return This window's command Parser
+     * Retrieves the command Parser for this input window.
+     * 
+     * @return This window's command parser
      */
     CommandParser getCommandParser();
     
+    /**
+     * Retrieves the input handler for this input window.
+     * 
+     * @return This window's input handler
+     */
+    InputHandler getInputHandler();
+    
 }

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

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2006-2007 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.ui.interfaces;
+
+/**
+ * Lists the standard methods that should be implemented by any server window.
+ * 
+ * @author chris
+ */
+public interface ServerWindow extends InputWindow {
+    
+}

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

@@ -24,7 +24,9 @@ package com.dmdirc.ui.interfaces;
 
 import com.dmdirc.FrameContainer;
 import com.dmdirc.identities.ConfigManager;
+
 import java.beans.PropertyVetoException;
+import javax.swing.Icon;
 
 /**
  * The Window interface specifies common methods that should be implemented
@@ -70,12 +72,19 @@ public interface Window {
     FrameContainer getContainer();
     
     /**
-     * Determines if the current frame is visible.
+     * Determines if the current window is visible.
      *
      * @return boolean visibility
      */
     boolean isVisible();
     
+    /**
+     * Sets the visibility of this window.
+     * 
+     * @param isVisible Whether the window should be visible or not
+     */
+    void setVisible(boolean isVisible);
+    
     /**
      * Retrives the current title of this window.
      * 
@@ -97,4 +106,24 @@ public interface Window {
      * @throws PropertyVetoException if the change is vetoed
      */
     void setMaximum(boolean b) throws PropertyVetoException;
+    
+    /**
+     * Sets the title of this window.
+     * 
+     * @param title The new title to be used.
+     */
+    void setTitle(String title);
+    
+    /**
+     * Opens this window.
+     */
+    void open();
+    
+    /**
+     * Sets the icon used by this window, if the GUI supports icons.
+     * 
+     * @param icon The icon to be used
+     */
+    void setFrameIcon(Icon icon);
+    
 }