Renamed CommandWindow to InputWindow and moved to UI

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

src/com/dmdirc/Channel.java

@@ -25,7 +25,6 @@ package com.dmdirc;
 import com.dmdirc.actions.ActionManager;
 import com.dmdirc.actions.CoreActionType;
 import com.dmdirc.commandparser.CommandManager;
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.identities.ConfigManager;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
@@ -49,6 +48,7 @@ import com.dmdirc.parser.callbacks.interfaces.IChannelQuit;
 import com.dmdirc.parser.callbacks.interfaces.IChannelTopic;
 import com.dmdirc.parser.callbacks.interfaces.IChannelUserModeChanged;
 import com.dmdirc.ui.ChannelFrame;
+import com.dmdirc.ui.InputWindow;
 import com.dmdirc.ui.MainFrame;
 import com.dmdirc.ui.input.TabCompleter;
 import com.dmdirc.ui.messages.ColourManager;
@@ -262,7 +262,7 @@ public final class Channel extends FrameContainer implements IChannelMessage,
      * Returns the internal frame belonging to this object.
      * @return This object's internal frame
      */
-    public CommandWindow getFrame() {
+    public InputWindow getFrame() {
         return frame;
     }
     

src/com/dmdirc/FrameContainer.java

@@ -22,10 +22,10 @@
 
 package com.dmdirc;
 
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.identities.ConfigManager;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
+import com.dmdirc.ui.InputWindow;
 import com.dmdirc.ui.MainFrame;
 
 import java.awt.Color;
@@ -53,7 +53,7 @@ public abstract class FrameContainer implements InternalFrameListener {
      * Returns the internal frame associated with this object.
      * @return The internal frame associated with this object
      */
-    public abstract CommandWindow getFrame();
+    public abstract InputWindow getFrame();
     
     /**
      * Returns a string identifier for this object/its frame.

src/com/dmdirc/Query.java

@@ -25,7 +25,6 @@ package com.dmdirc;
 import com.dmdirc.actions.ActionManager;
 import com.dmdirc.actions.CoreActionType;
 import com.dmdirc.commandparser.CommandManager;
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
 import com.dmdirc.parser.ClientInfo;
@@ -35,6 +34,7 @@ import com.dmdirc.parser.callbacks.CallbackNotFound;
 import com.dmdirc.parser.callbacks.interfaces.INickChanged;
 import com.dmdirc.parser.callbacks.interfaces.IPrivateAction;
 import com.dmdirc.parser.callbacks.interfaces.IPrivateMessage;
+import com.dmdirc.ui.InputWindow;
 import com.dmdirc.ui.MainFrame;
 import com.dmdirc.ui.QueryFrame;
 import com.dmdirc.ui.input.TabCompleter;
@@ -113,7 +113,7 @@ public final class Query extends FrameContainer implements IPrivateAction,
      * 
      * @return This object's internal frame
      */
-    public CommandWindow getFrame() {
+    public InputWindow getFrame() {
         return frame;
     }
     

src/com/dmdirc/Raw.java

@@ -22,13 +22,13 @@
 
 package com.dmdirc;
 
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
 import com.dmdirc.parser.IRCParser;
 import com.dmdirc.parser.callbacks.CallbackNotFound;
 import com.dmdirc.parser.callbacks.interfaces.IDataIn;
 import com.dmdirc.parser.callbacks.interfaces.IDataOut;
+import com.dmdirc.ui.InputWindow;
 import com.dmdirc.ui.MainFrame;
 import com.dmdirc.ui.ServerFrame;
 
@@ -101,7 +101,7 @@ public final class Raw extends FrameContainer implements IDataIn, IDataOut {
     }
     
     /** {@inheritDoc} */
-    public CommandWindow getFrame() {
+    public InputWindow getFrame() {
         return frame;
     }
     

src/com/dmdirc/Server.java

@@ -25,7 +25,6 @@ package com.dmdirc;
 import com.dmdirc.actions.ActionManager;
 import com.dmdirc.actions.CoreActionType;
 import com.dmdirc.commandparser.CommandManager;
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.identities.ConfigManager;
 import com.dmdirc.identities.ConfigSource;
 import com.dmdirc.logger.ErrorLevel;
@@ -59,6 +58,7 @@ import com.dmdirc.parser.callbacks.interfaces.IPrivateMessage;
 import com.dmdirc.parser.callbacks.interfaces.IPrivateNotice;
 import com.dmdirc.parser.callbacks.interfaces.ISocketClosed;
 import com.dmdirc.parser.callbacks.interfaces.IUserModeChanged;
+import com.dmdirc.ui.InputWindow;
 import com.dmdirc.ui.MainFrame;
 import com.dmdirc.ui.ServerFrame;
 import com.dmdirc.ui.input.TabCompleter;
@@ -460,7 +460,7 @@ public final class Server extends FrameContainer implements IChannelSelfJoin,
     }
     
     /** {@inheritDoc} */
-    public CommandWindow getFrame() {
+    public InputWindow getFrame() {
         return frame;
     }
     

src/com/dmdirc/actions/Action.java

@@ -25,10 +25,10 @@ package com.dmdirc.actions;
 import com.dmdirc.FrameContainer;
 import com.dmdirc.ServerManager;
 import com.dmdirc.commandparser.CommandParser;
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.commandparser.GlobalCommandParser;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
+import com.dmdirc.ui.InputWindow;
 import com.dmdirc.ui.MainFrame;
 
 import java.io.File;
@@ -444,13 +444,13 @@ public class Action {
             }
         }
         
-        CommandWindow cw;
+        InputWindow cw;
         CommandParser cp = null;
         
         if (arguments.length > 0 && arguments[0] instanceof FrameContainer) {
             cw = ((FrameContainer) arguments[0]).getFrame();
         } else if (MainFrame.getMainFrame().getActiveFrame() != null) {
-            cw = (CommandWindow) MainFrame.getMainFrame().getActiveFrame();
+            cw = (InputWindow) MainFrame.getMainFrame().getActiveFrame();
         } else if (ServerManager.getServerManager().numServers() > 0) {
             cw = ServerManager.getServerManager().getServers().get(0).getFrame();
         } else {

src/com/dmdirc/addons/dcop/DcopCommand.java

@@ -24,10 +24,10 @@ package com.dmdirc.addons.dcop;
 
 import com.dmdirc.Server;
 import com.dmdirc.commandparser.CommandManager;
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.commandparser.ServerCommand;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
+import com.dmdirc.ui.InputWindow;
 
 import java.io.IOException;
 import java.util.List;
@@ -54,7 +54,7 @@ public final class DcopCommand extends ServerCommand {
      * @param isSilent Whether this command is silenced or not
      * @param args The user supplied arguments
      */
-    public void execute(final CommandWindow origin, final Server server,
+    public void execute(final InputWindow origin, final Server server,
             final boolean isSilent, final String... args) {
         try {
             final List<String> res = DcopPlugin.getDcopResult("dcop " + implodeArgs(args));

src/com/dmdirc/addons/dcop/NowPlayingCommand.java

@@ -26,9 +26,9 @@ import com.dmdirc.Channel;
 import com.dmdirc.Server;
 import com.dmdirc.commandparser.ChannelCommand;
 import com.dmdirc.commandparser.CommandManager;
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
+import com.dmdirc.ui.InputWindow;
 
 import java.io.IOException;
 import java.util.List;
@@ -57,7 +57,7 @@ public final class NowPlayingCommand extends ChannelCommand {
      * @param isSilent Whether this command is silenced or not
      * @param args The user supplied arguments
      */    
-    public void execute(final CommandWindow origin, final Server server, 
+    public void execute(final InputWindow origin, final Server server, 
             final Channel channel, final boolean isSilent, final String... args) {
         try {
             

src/com/dmdirc/addons/logging/LoggingCommand.java

@@ -25,10 +25,10 @@ package com.dmdirc.addons.logging;
 import com.dmdirc.Config;
 import com.dmdirc.Server;
 import com.dmdirc.commandparser.CommandManager;
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.commandparser.ServerCommand;
 import com.dmdirc.plugins.Plugin;
 import com.dmdirc.plugins.PluginManager;
+import com.dmdirc.ui.InputWindow;
 
 import java.util.Enumeration;
 import java.util.Properties;
@@ -56,7 +56,7 @@ public final class LoggingCommand extends ServerCommand {
          * @param isSilent Whether this command is silenced or not
 	 * @param args The user supplied arguments
 	 */
-	public void execute(final CommandWindow origin, final Server server, final boolean isSilent, final String... args) {
+	public void execute(final InputWindow origin, final Server server, final boolean isSilent, final String... args) {
 		final Plugin gotPlugin = PluginManager.getPluginManager().getPlugin("com.dmdirc.addons.logging.LoggingPlugin");
 		
 		if (gotPlugin == null || !(gotPlugin instanceof LoggingPlugin)) {

src/com/dmdirc/addons/osdplugin/OsdCommand.java

@@ -23,8 +23,8 @@
 package com.dmdirc.addons.osdplugin;
 
 import com.dmdirc.commandparser.CommandManager;
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.commandparser.GlobalCommand;
+import com.dmdirc.ui.InputWindow;
 
 /**
  * The osd command shows an on screen message.
@@ -42,7 +42,7 @@ public final class OsdCommand extends GlobalCommand {
     }
     
     /** {@inheritDoc} */
-    public void execute(final CommandWindow origin, final boolean isSilent,
+    public void execute(final InputWindow origin, final boolean isSilent,
             final String... args) {
         new OsdWindow(implodeArgs(args), false);
     }

src/com/dmdirc/addons/systray/PopupCommand.java

@@ -24,8 +24,8 @@ package com.dmdirc.addons.systray;
 
 import com.dmdirc.Server;
 import com.dmdirc.commandparser.CommandManager;
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.commandparser.ServerCommand;
+import com.dmdirc.ui.InputWindow;
 
 /**
  * The /popup command allows the user to show a popup message from the system
@@ -50,7 +50,7 @@ public final class PopupCommand extends ServerCommand {
     }
 
     /** {@inheritDoc} */
-    public void execute(final CommandWindow origin, final Server server,
+    public void execute(final InputWindow origin, final Server server,
             final boolean isSilent, final String ... args) {
         parent.notify("DMDirc", implodeArgs(args));
     }

src/com/dmdirc/addons/timeplugin/TimedCommand.java

@@ -23,8 +23,8 @@
 package com.dmdirc.addons.timeplugin;
 
 import com.dmdirc.commandparser.CommandParser;
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.commandparser.GlobalCommandParser;
+import com.dmdirc.ui.InputWindow;
 
 import java.util.Timer;
 import java.util.TimerTask;
@@ -41,7 +41,7 @@ public final class TimedCommand extends TimerTask {
     private final String command;
     
     /** The window to use for executing commands. */
-    private final CommandWindow origin;
+    private final InputWindow origin;
     
     /** The timer we're using for scheduling this command. */
     private final Timer timer;
@@ -54,7 +54,7 @@ public final class TimedCommand extends TimerTask {
      * @param origin The command window to use for the execution
      */
     public TimedCommand(final int repetitions, final int delay,
-            final String command, final CommandWindow origin) {
+            final String command, final InputWindow origin) {
         this.repetitions = repetitions;
         this.command = command;
         this.origin = origin;

src/com/dmdirc/addons/timeplugin/TimerCommand.java

@@ -24,8 +24,8 @@ package com.dmdirc.addons.timeplugin;
 
 import com.dmdirc.Config;
 import com.dmdirc.commandparser.CommandManager;
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.commandparser.GlobalCommand;
+import com.dmdirc.ui.InputWindow;
 
 /**
  * The timer command allows users to schedule commands to occur after a certain
@@ -42,7 +42,7 @@ public final class TimerCommand extends GlobalCommand {
     }
     
     /** {@inheritDoc} */
-    public void execute(final CommandWindow origin, final boolean isSilent, 
+    public void execute(final InputWindow origin, final boolean isSilent, 
             final String... args) {
         if (args.length < 3) {
             doUsage(origin, isSilent);
@@ -69,7 +69,7 @@ public final class TimerCommand extends GlobalCommand {
      * @param origin The window that the command was entered in
      * @param isSilent Whether this command is being silenced or not
      */
-    private void doUsage(final CommandWindow origin, final boolean isSilent) {
+    private void doUsage(final InputWindow origin, final boolean isSilent) {
         sendLine(origin, isSilent, "commandUsage", Config.getCommandChar(),
                 "timer", "<repetitions> <interval> <command>");
     }

src/com/dmdirc/addons/windowstatus/WindowStatusPlugin.java

@@ -23,7 +23,6 @@
 package com.dmdirc.addons.windowstatus;
 
 import java.awt.BorderLayout;
-import java.awt.Dimension;
 import java.util.Hashtable;
 import java.util.Properties;
 
@@ -38,7 +37,6 @@ import com.dmdirc.Config;
 import com.dmdirc.FrameContainer;
 import com.dmdirc.Query;
 import com.dmdirc.Server;
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.actions.ActionType;
 import com.dmdirc.actions.CoreActionType;
 import com.dmdirc.parser.ChannelClientInfo;
@@ -46,10 +44,8 @@ import com.dmdirc.parser.ChannelInfo;
 import com.dmdirc.parser.ClientInfo;
 import com.dmdirc.plugins.Plugin;
 import com.dmdirc.plugins.EventPlugin;
-import com.dmdirc.ui.ChannelFrame;
+import com.dmdirc.ui.InputWindow;
 import com.dmdirc.ui.MainFrame;
-import com.dmdirc.ui.QueryFrame;
-import com.dmdirc.ui.ServerFrame;
 import com.dmdirc.ui.components.PreferencesInterface;
 import com.dmdirc.ui.components.PreferencesPanel;
 
@@ -163,8 +159,8 @@ public final class WindowStatusPlugin extends Plugin implements EventPlugin, Pre
 	 */
 	public void updateStatus() {
 		JInternalFrame active = MainFrame.getMainFrame().getActiveFrame();
-		if (active instanceof CommandWindow) {
-			FrameContainer activeFrame = ((CommandWindow)active).getContainer();
+		if (active instanceof InputWindow) {
+			FrameContainer activeFrame = ((InputWindow)active).getContainer();
 			updateStatus(activeFrame);
 		}
 	}

src/com/dmdirc/ui/InputWindow.java

@@ -0,0 +1,94 @@
+/*
+ * 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;
+
+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.
+ * @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();
+    
+    /**
+     * Retrieves the command Parser for this command window.
+     * @return This window's command Parser
+     */
+    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/MainFrame.java

@@ -28,7 +28,6 @@ import com.dmdirc.Main;
 import com.dmdirc.ServerManager;
 import com.dmdirc.actions.ActionManager;
 import com.dmdirc.actions.CoreActionType;
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
 import com.dmdirc.ui.components.Frame;
@@ -302,7 +301,7 @@ public final class MainFrame extends JFrame implements WindowListener,
             setTitle(getTitlePrefix() + " - " + frame.getTitle());
         }
         
-        ActionManager.processEvent(CoreActionType.CLIENT_FRAME_CHANGED, null, ((CommandWindow) frame).getContainer());
+        ActionManager.processEvent(CoreActionType.CLIENT_FRAME_CHANGED, null, ((InputWindow) frame).getContainer());
     }
     
     /**

src/com/dmdirc/ui/components/Frame.java

@@ -26,10 +26,10 @@ import com.dmdirc.BrowserLauncher;
 import com.dmdirc.Config;
 import com.dmdirc.FrameContainer;
 import com.dmdirc.Server;
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.identities.ConfigManager;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
+import com.dmdirc.ui.InputWindow;
 import com.dmdirc.ui.MainFrame;
 import com.dmdirc.ui.dialogs.PasteDialog;
 import com.dmdirc.ui.input.InputHandler;
@@ -89,7 +89,7 @@ import javax.swing.undo.UndoManager;
 /**
  * Implements a generic (internal) frame.
  */
-public abstract class Frame extends JInternalFrame implements CommandWindow,
+public abstract class Frame extends JInternalFrame implements InputWindow,
         PropertyChangeListener, InternalFrameListener,
         MouseListener, ActionListener, KeyListener, TextPaneListener {
     

src/com/dmdirc/ui/input/InputHandler.java

@@ -26,8 +26,8 @@ import com.dmdirc.Config;
 import com.dmdirc.commandparser.Command;
 import com.dmdirc.commandparser.CommandManager;
 import com.dmdirc.commandparser.CommandParser;
-import com.dmdirc.commandparser.CommandWindow;
 import com.dmdirc.commandparser.IntelligentCommand;
+import com.dmdirc.ui.InputWindow;
 import com.dmdirc.ui.components.ColourPickerDialog;
 import com.dmdirc.ui.messages.Styliser;
 
@@ -99,7 +99,7 @@ public final class InputHandler implements KeyListener, ActionListener {
     /**
      * The frame that we belong to.
      */
-    private final CommandWindow parentWindow;
+    private final InputWindow parentWindow;
     
     /** Colour picker dialog. */
     private ColourPickerDialog colourPicker;
@@ -113,7 +113,7 @@ public final class InputHandler implements KeyListener, ActionListener {
      */
     public InputHandler(final JTextField thisTarget,
             final CommandParser thisCommandParser,
-            final CommandWindow thisParentWindow) {
+            final InputWindow thisParentWindow) {
         
         bufferSize = thisParentWindow.getConfigManager().getOptionInt("ui", "inputbuffersize", 50);