Abstracted JTextField mainly for InputHandler

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

src/com/dmdirc/ui/dummy/DummyChannelWindow.java

@@ -38,7 +38,6 @@ import java.util.Arrays;
 import java.util.List;
 
 import javax.swing.Icon;
-import javax.swing.JTextField;
 
 /**
  * Dummy channel window, used for testing.
@@ -89,7 +88,7 @@ public final class DummyChannelWindow implements ChannelWindow {
 
     /** {@inheritDoc} */
     public InputHandler getInputHandler() {
-        return new InputHandler(new JTextField(), getCommandParser(), this);
+        return new InputHandler(new DummyInputField(), getCommandParser(), this);
     }
 
     /** {@inheritDoc} */

src/com/dmdirc/ui/dummy/DummyInputField.java

@@ -0,0 +1,113 @@
+/*
+ * 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.dummy;
+
+import com.dmdirc.ui.interfaces.InputField;
+
+import java.awt.Color;
+import java.awt.event.ActionListener;
+import java.awt.event.KeyListener;
+
+/**
+ * Dummy input field.
+ */
+public class DummyInputField implements InputField {
+
+    /** {@inheritDoc} */
+    @Override
+    public void addActionListener(ActionListener listener) {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void addKeyListener(KeyListener listener) {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void removeActionListener(ActionListener listener) {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void removeKeyListener(KeyListener listener) {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getSelectedText() {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public int getSelectionEnd() {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public int getSelectionStart() {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getText() {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void setText(String text) {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public int getCaretPosition() {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void setCaretPosition(int position) {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void showColourPicker(boolean irc, boolean hex) {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void hideColourPicker() {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+}

src/com/dmdirc/ui/dummy/DummyInputWindow.java

@@ -36,7 +36,6 @@ import java.nio.charset.Charset;
 import java.util.Arrays;
 
 import javax.swing.Icon;
-import javax.swing.JTextField;
 
 /**
  * Dummy input window, used for testing.
@@ -70,7 +69,7 @@ public final class DummyInputWindow implements InputWindow {
     
     /** {@inheritDoc} */
     public InputHandler getInputHandler() {
-        return new InputHandler(new JTextField(), null, this);
+        return new InputHandler(new DummyInputField(), null, this);
     }
     
     /** {@inheritDoc} */

src/com/dmdirc/ui/dummy/DummyServerWindow.java

@@ -36,7 +36,6 @@ import java.nio.charset.Charset;
 import java.util.Arrays;
 
 import javax.swing.Icon;
-import javax.swing.JTextField;
 
 /**
  * Dummy server window, used for testing.
@@ -71,7 +70,7 @@ public final class DummyServerWindow implements ServerWindow {
     
     /** {@inheritDoc} */
     public InputHandler getInputHandler() {
-        return new InputHandler(new JTextField(), null, this);
+        return new InputHandler(new DummyInputField(), null, this);
     }
     
     /** {@inheritDoc} */

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

@@ -29,14 +29,13 @@ import com.dmdirc.commandparser.CommandManager;
 import com.dmdirc.commandparser.parsers.CommandParser;
 import com.dmdirc.commandparser.commands.IntelligentCommand;
 import com.dmdirc.interfaces.ConfigChangeListener;
-import com.dmdirc.config.IdentityManager;
 import com.dmdirc.ui.input.tabstyles.BashStyle;
 import com.dmdirc.ui.input.tabstyles.MircStyle;
 import com.dmdirc.ui.input.tabstyles.TabCompletionResult;
 import com.dmdirc.ui.input.tabstyles.TabCompletionStyle;
+import com.dmdirc.ui.interfaces.InputField;
 import com.dmdirc.ui.interfaces.InputWindow;
 import com.dmdirc.ui.messages.Styliser;
-import com.dmdirc.ui.swing.components.ColourPickerDialog;
 import com.dmdirc.util.RollingList;
 
 import java.awt.Toolkit;
@@ -47,8 +46,6 @@ import java.awt.event.KeyEvent;
 import java.util.ArrayList;
 import java.util.List;
 
-import javax.swing.JTextField;
-
 /**
  * Handles events generated by a user typing into a textfield. Allows the user
  * to use shortcut keys for control characters (ctrl+b, etc), to tab complete
@@ -76,7 +73,7 @@ public final class InputHandler extends KeyAdapter implements ActionListener,
     private RollingList<String> buffer;
     
     /** The textfield that we're handling input for. */
-    private final JTextField target;
+    private final InputField target;
     
     /** The TabCompleter to use for tab completion. */
     private TabCompleter tabCompleter;
@@ -87,9 +84,6 @@ public final class InputHandler extends KeyAdapter implements ActionListener,
     /** The frame that we belong to. */
     private final InputWindow parentWindow;
     
-    /** Colour picker dialog. */
-    private ColourPickerDialog colourPicker;
-    
     /** The tab completion style. */
     private TabCompletionStyle style;
     
@@ -101,7 +95,7 @@ public final class InputHandler extends KeyAdapter implements ActionListener,
      * @param thisCommandParser The command parser to use for this text field.
      * @param thisParentWindow The window that owns this input handler
      */
-    public InputHandler(final JTextField thisTarget,
+    public InputHandler(final InputField thisTarget,
             final CommandParser thisCommandParser,
             final InputWindow thisParentWindow) {
         
@@ -117,7 +111,6 @@ public final class InputHandler extends KeyAdapter implements ActionListener,
         
         target.addKeyListener(this);
         target.addActionListener(this);
-        target.setFocusTraversalKeysEnabled(false);
         
         parentWindow.getConfigManager().addChangeListener("tabcompletion", "style", this);
     }
@@ -153,10 +146,7 @@ public final class InputHandler extends KeyAdapter implements ActionListener,
      */
     @Override
     public void keyPressed(final KeyEvent keyEvent) {
-        if (colourPicker != null) {
-            colourPicker.dispose();
-            colourPicker = null;
-        }
+        target.hideColourPicker();
         
         // Formatting codes
         if ((keyEvent.getModifiers() & KeyEvent.CTRL_MASK) != 0) {
@@ -210,10 +200,10 @@ public final class InputHandler extends KeyAdapter implements ActionListener,
         case KeyEvent.VK_K:
             if ((keyEvent.getModifiers() & KeyEvent.SHIFT_MASK) == 0) {
                 addControlCode(Styliser.CODE_COLOUR, POSITION_START);
-                showColourPicker(true, false);
+                target.showColourPicker(true, false);
             } else {
                 addControlCode(Styliser.CODE_HEXCOLOUR, POSITION_START);
-                showColourPicker(false, true);
+                target.showColourPicker(false, true);
             }
             break;
             
@@ -420,28 +410,6 @@ public final class InputHandler extends KeyAdapter implements ActionListener,
         target.setText("");
     }
     
-    /**
-     * Displays a colour picker for the target.
-     *
-     * @param irc show irc colours in the colour picker
-     * @param hex show hex colours in the colour picker
-     */
-    private void showColourPicker(final boolean irc, final boolean hex) {
-        if (IdentityManager.getGlobalConfig().getOptionBool("general", "showcolourdialog", false)) {
-            colourPicker = new ColourPickerDialog(irc, hex);
-            colourPicker.addActionListener(new ActionListener() {
-                @Override
-                public void actionPerformed(final ActionEvent actionEvent) {
-                    target.setText(target.getText() + actionEvent.getActionCommand());
-                    colourPicker.dispose();
-                    colourPicker = null;
-                } });
-                colourPicker.setLocation((int) target.getLocationOnScreen().getX(),
-                        (int) target.getLocationOnScreen().getY() - colourPicker.getHeight());
-                colourPicker.setVisible(true);
-        }
-    }
-    
     /** {@inheritDoc} */
     @Override
     public void configChanged(final String domain, final String key) {

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

@@ -0,0 +1,122 @@
+/*
+ * 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 java.awt.event.ActionListener;
+import java.awt.event.KeyListener;
+
+/**
+ * Input field interface.
+ */
+public interface InputField {
+
+    /**
+     * Adds an action listener to this input field.
+     * 
+     * @param listener ActionListener to add
+     */
+    public void addActionListener(final ActionListener listener);
+
+    /**
+     * Adds a keylistener to this input field.
+     * 
+     * @param listener KeyListener to add
+     */
+    public void addKeyListener(final KeyListener listener);
+    
+    /**
+     * Removes an action listener to this input field.
+     * 
+     * @param listener ActionListener to remove
+     */
+    public void removeActionListener(final ActionListener listener);
+
+    /**
+     * Removes a keylistener to this input field.
+     * 
+     * @param listener KeyListener to remove
+     */
+    public void removeKeyListener(final KeyListener listener);
+
+    /**
+     * Returns the selected text in the input field.
+     * 
+     * @return Selected text
+     */
+    public String getSelectedText();
+
+    /**
+     * Returns the end of the selection.
+     * 
+     * @return Selection end
+     */
+    public int getSelectionEnd();
+
+    /**
+     * Returns the start of the selection.
+     * 
+     * @return Selection start
+     */
+    public int getSelectionStart();
+
+    /**
+     * Returns the text in the input field.
+     * 
+     * @return Input field text
+     */
+    public String getText();
+
+    /**
+     * Sets the text in the input field to the specified text.
+     * 
+     * @param text New text for the input field
+     */
+    public void setText(final String text);
+
+    /**
+     * Returns the caret position.
+     * 
+     * @return Caret position
+     */
+    public int getCaretPosition();
+
+    /**
+     * Sets the caret position.
+     * 
+     * @param position Caret position
+     */
+    public void setCaretPosition(final int position);
+
+    /**
+     * Shows a colour picker for this input field.
+     * 
+     * @param irc Show irc colours?
+     * @param hex Show hex colours?
+     */
+    public void showColourPicker(final boolean irc, final boolean hex);
+
+    /**
+     * Hides the colour picker for this input field.
+     */
+    public void hideColourPicker();
+}

src/com/dmdirc/ui/swing/components/InputTextFrame.java

@@ -62,7 +62,6 @@ import javax.swing.JLabel;
 import javax.swing.JMenuItem;
 import javax.swing.JPanel;
 import javax.swing.JPopupMenu;
-import javax.swing.JTextField;
 import javax.swing.KeyStroke;
 import javax.swing.event.InternalFrameEvent;
 import javax.swing.event.InternalFrameListener;
@@ -94,7 +93,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     private InputHandler inputHandler;
     
     /** Frame input field. */
-    private JTextField inputField;
+    private SwingInputField inputField;
     
     /** Popupmenu for this frame. */
     private JPopupMenu inputFieldPopup;
@@ -140,6 +139,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     }
     
     /** {@inheritDoc} */
+    @Override
     public void open() {
         if (getConfigManager().getOptionBool("ui", "awayindicator", false)
                 && getContainer().getServer() != null) {
@@ -154,7 +154,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
      * Initialises the components for this frame.
      */
     private void initComponents() {
-        setInputField(new JTextField());
+        setInputField(new SwingInputField());
         getInputField().setBorder(
                 BorderFactory.createCompoundBorder(
                 getInputField().getBorder(),
@@ -216,6 +216,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
      *
      * @return Input handlers for this frame
      */
+    @Override
     public final InputHandler getInputHandler() {
         return inputHandler;
     }
@@ -232,9 +233,9 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     /**
      * Returns the input field for this frame.
      *
-     * @return JTextField input field for the frame.
+     * @return SwingInputField input field for the frame.
      */
-    public final JTextField getInputField() {
+    public final SwingInputField getInputField() {
         return inputField;
     }
     
@@ -243,7 +244,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
      *
      * @param newInputField new input field to use
      */
-    protected final void setInputField(final JTextField newInputField) {
+    protected final void setInputField(final SwingInputField newInputField) {
         this.inputField = newInputField;
     }
     
@@ -279,6 +280,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     /**
      * Not needed for this class. {@inheritDoc}
      */
+    @Override
     public void internalFrameOpened(final InternalFrameEvent event) {
         super.internalFrameOpened(event);
     }
@@ -286,6 +288,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     /**
      * Not needed for this class. {@inheritDoc}
      */
+    @Override
     public void internalFrameClosing(final InternalFrameEvent event) {
         super.internalFrameClosing(event);
     }
@@ -293,6 +296,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     /**
      * Not needed for this class. {@inheritDoc}
      */
+    @Override
     public void internalFrameClosed(final InternalFrameEvent event) {
         super.internalFrameClosed(event);
     }
@@ -300,6 +304,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     /**
      * Makes the internal frame invisible. {@inheritDoc}
      */
+    @Override
     public void internalFrameIconified(final InternalFrameEvent event) {
         super.internalFrameIconified(event);
     }
@@ -307,6 +312,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     /**
      * Not needed for this class. {@inheritDoc}
      */
+    @Override
     public void internalFrameDeiconified(final InternalFrameEvent event) {
         super.internalFrameDeiconified(event);
     }
@@ -314,6 +320,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     /**
      * Activates the input field on frame focus. {@inheritDoc}
      */
+    @Override
     public void internalFrameActivated(final InternalFrameEvent event) {
         super.internalFrameActivated(event);
     }
@@ -321,17 +328,20 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     /**
      * Not needed for this class. {@inheritDoc}
      */
+    @Override
     public void internalFrameDeactivated(final InternalFrameEvent event) {
         super.internalFrameDeactivated(event);
     }
     
     /** {@inheritDoc} */
+    @Override
     public void keyTyped(final KeyEvent event) {
         //Ignore.
         super.keyTyped(event);
     }
     
     /** {@inheritDoc} */
+    @Override
     public void keyPressed(final KeyEvent event) {
         if (event.getSource() == getTextPane()
         && (getConfigManager().getOptionBool("ui", "quickCopy", false)
@@ -349,6 +359,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     }
     
     /** {@inheritDoc} */
+    @Override
     public void keyReleased(final KeyEvent event) {
         //Ignore.
         super.keyReleased(event);
@@ -357,6 +368,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     /**
      * Checks for url's, channels and nicknames. {@inheritDoc}
      */
+    @Override
     public void mouseClicked(final MouseEvent mouseEvent) {
         if (mouseEvent.getSource() == getTextPane()) {
             processMouseEvent(mouseEvent);
@@ -367,6 +379,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     /**
      * Not needed for this class. {@inheritDoc}
      */
+    @Override
     public void mousePressed(final MouseEvent mouseEvent) {
         processMouseEvent(mouseEvent);
         super.mousePressed(mouseEvent);
@@ -375,6 +388,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     /**
      * Not needed for this class. {@inheritDoc}
      */
+    @Override
     public void mouseReleased(final MouseEvent mouseEvent) {
         processMouseEvent(mouseEvent);
         super.mouseReleased(mouseEvent);
@@ -383,6 +397,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     /**
      * Not needed for this class. {@inheritDoc}
      */
+    @Override
     public void mouseEntered(final MouseEvent mouseEvent) {
         //Ignore.
     }
@@ -390,6 +405,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     /**
      * Not needed for this class. {@inheritDoc}
      */
+    @Override
     public void mouseExited(final MouseEvent mouseEvent) {
         //Ignore.
     }
@@ -489,6 +505,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     }
     
     /** {@inheritDoc} */
+    @Override
     public void nickNameClicked(final String nickname, final MouseEvent e) {
         if (e.isPopupTrigger()) {
             final Point point = getMousePosition();

src/com/dmdirc/ui/swing/components/SwingInputField.java

@@ -0,0 +1,82 @@
+/*
+ * 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.swing.components;
+
+import com.dmdirc.config.IdentityManager;
+import com.dmdirc.ui.interfaces.InputField;
+
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+
+import javax.swing.JTextField;
+
+/** Swing input field. */
+public class SwingInputField extends JTextField implements InputField {
+
+    /**
+     * A version number for this class. It should be changed whenever the class
+     * structure is changed (or anything else that would prevent serialized
+     * objects being unserialized with the new class).
+     */
+    private static final long serialVersionUID = 1;
+    /** Colour picker. */
+    private ColourPickerDialog colourPicker;
+
+    /**
+     * Instantiates a new swing input field.
+     */
+    public SwingInputField() {
+        setFocusTraversalKeysEnabled(false);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void showColourPicker(boolean irc, boolean hex) {
+        if (IdentityManager.getGlobalConfig().getOptionBool("general",
+                "showcolourdialog", false)) {
+            colourPicker = new ColourPickerDialog(irc, hex);
+            colourPicker.addActionListener(new ActionListener() {
+
+                @Override
+                public void actionPerformed(final ActionEvent actionEvent) {
+                    setText(getText() + actionEvent.getActionCommand());
+                    colourPicker.dispose();
+                    colourPicker = null;
+                }
+            });
+            colourPicker.setLocation((int) getLocationOnScreen().getX(),
+                    (int) getLocationOnScreen().getY() -
+                    colourPicker.getHeight());
+            colourPicker.setVisible(true);
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void hideColourPicker() {
+        if (colourPicker != null) {
+            colourPicker.dispose();
+            colourPicker = null;
+        }
+    }
+}