Added new Window interface

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

src/com/dmdirc/ui/MainFrame.java

@@ -52,7 +52,6 @@ import java.awt.Font;
 import java.awt.GraphicsConfiguration;
 import java.awt.GraphicsDevice;
 import java.awt.Insets;
-import java.awt.MenuBar;
 import java.awt.MouseInfo;
 import java.awt.PointerInfo;
 import java.awt.Rectangle;

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

@@ -22,45 +22,14 @@
 
 package com.dmdirc.ui.interfaces;
 
-import com.dmdirc.FrameContainer;
-import com.dmdirc.Server;
 import com.dmdirc.commandparser.CommandParser;
-import com.dmdirc.identities.ConfigManager;
 
 /**
- * A command window is a window that allows the user to input a command (that's
- * passed to a command parser). This interface includes methods that are required
- * to allow the commands to interact with the user via the window.
+ * The Input Window interface specifies additional methods that windows should
+ * implement if they have an input field.
  * @author chris
  */
-public interface InputWindow {
-    
-    /**
-     * Formats the arguments using the Formatter, then adds the result to the
-     * main text area.
-     * @param messageType The type of this message
-     * @param args The arguments for the message
-     */
-    void addLine(String messageType, Object... args);
-    
-    /**
-     * Formats the arguments using the Formatter, then adds the result to the
-     * main text area.
-     * @param messageType The type of this message
-     * @param args The arguments for the message
-     */
-    void addLine(StringBuffer messageType, Object... args);
-    
-    /**
-     * Clears the main text area of the command window.
-     */
-    void clear();
-    
-    /**
-     * Retrieves the config manager for this command window.
-     * @return This window's config manager
-     */
-    ConfigManager getConfigManager();
+public interface InputWindow extends Window {
     
     /**
      * Retrieves the command Parser for this command window.
@@ -68,27 +37,4 @@ public interface InputWindow {
      */
     CommandParser getCommandParser();
     
-    /**
-     * Retrieves the server associated with this command window.
-     * @return This window's associated server instance
-     * @deprecated No point proxying this - use getContainer().getServer()
-     */
-    @Deprecated
-    Server getServer();
-    
-    /**
-     * Retrieves the container that owns this command window.
-     * @return The container that owns this command window.
-     */
-    FrameContainer getContainer();
-    
-    /**
-     * Determines if the current frame is visible.
-     *
-     * @return boolean visibility
-     * @deprecated Visibility is of no concern to command windows
-     */
-    @Deprecated
-    boolean isVisible();
-    
 }

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

@@ -0,0 +1,87 @@
+/*
+ * 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;
+
+import com.dmdirc.FrameContainer;
+import com.dmdirc.Server;
+import com.dmdirc.identities.ConfigManager;
+
+/**
+ * The Window interface specifies common methods that should be implemented
+ * by all windows. It is assumed that all windows have a main text area.
+ */
+public interface Window {
+    
+    /**
+     * Formats the arguments using the Formatter, then adds the result to the
+     * main text area.
+     *
+     * @param messageType The type of this message
+     * @param args The arguments for the message
+     */
+    void addLine(String messageType, Object... args);
+    
+    /**
+     * Formats the arguments using the Formatter, then adds the result to the
+     * main text area.
+     *
+     * @param messageType The type of this message
+     * @param args The arguments for the message
+     */
+    void addLine(StringBuffer messageType, Object... args);
+    
+    /**
+     * Clears the main text area of the command window.
+     */
+    void clear();
+    
+    /**
+     * Retrieves the config manager for this command window.
+     *
+     * @return This window's config manager
+     */
+    ConfigManager getConfigManager();
+    
+    /**
+     * Retrieves the server associated with this command window.
+     *
+     * @return This window's associated server instance
+     * @deprecated No point proxying this - use getContainer().getServer()
+     */
+    @Deprecated
+    Server getServer();
+    
+    /**
+     * Retrieves the container that owns this command window.
+     *
+     * @return The container that owns this command window.
+     */
+    FrameContainer getContainer();
+    
+    /**
+     * Determines if the current frame is visible.
+     *
+     * @return boolean visibility
+     */
+    boolean isVisible();
+}