Make ValidatingTextField extend JTextField

Change-Id: I30ca8bc84a18cc67a9bcb3700a9b15307e389bc2
Reviewed-on: http://gerrit.dmdirc.com/3066
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/addons/serverlistdialog/AddEntryInputDialog.java

@@ -122,7 +122,7 @@ public class AddEntryInputDialog extends StandardDialog {
     private void initComponents(final IconManager iconManager) {
         orderButtons(new JButton(), new JButton());
         entryName = new ValidatingJTextField(iconManager, entryValidator);
-        uri = new ValidatingJTextField(iconManager, new URIJTextField(), uriValidator);
+        uri = new URIJTextField(iconManager, "", uriValidator);
         blurb = new TextLabel(message);
         validateText();
     }

src/com/dmdirc/addons/serverlistdialog/URIJTextField.java

@@ -21,23 +21,24 @@
  */
 package com.dmdirc.addons.serverlistdialog;
 
-import javax.swing.JTextField;
+import com.dmdirc.addons.ui_swing.components.validating.ValidatingJTextField;
+import com.dmdirc.ui.IconManager;
+import com.dmdirc.util.validators.Validator;
 
 /**
  * Simple extention of JTextField to return an URI usable string (defaulting to
  * an irc scheme if none specified).
  */
-public class URIJTextField extends JTextField {
+public class URIJTextField extends ValidatingJTextField {
 
-    /**
-     * 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).
-     */
+    /** A version number for this class. */
     private static final long serialVersionUID = 1;
 
-    /** {@inheritDoc} */
+    public URIJTextField(final IconManager iconManager, final String text,
+            final Validator<String> validator) {
+        super(iconManager, text, validator);
+    }
+
     @Override
     public String getText() {
         final String hostname = super.getText();

src/com/dmdirc/addons/ui_swing/components/FileBrowser.java

@@ -34,7 +34,6 @@ import java.awt.event.KeyListener;
 import javax.swing.JButton;
 import javax.swing.JFileChooser;
 import javax.swing.JPanel;
-import javax.swing.JTextField;
 
 import net.miginfocom.swing.MigLayout;
 
@@ -45,11 +44,7 @@ import net.miginfocom.swing.MigLayout;
  */
 public class FileBrowser extends JPanel implements ActionListener {
 
-    /**
-     * 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).
-     */
+    /** A version number for this class. */
     private static final long serialVersionUID = 1;
     /** Text field to show path of chosen file. */
     private final ValidatingJTextField pathField;
@@ -74,8 +69,7 @@ public class FileBrowser extends JPanel implements ActionListener {
         final JButton browseButton = new JButton("Browse");
         browseButton.addActionListener(this);
 
-        pathField = new ValidatingJTextField(iconManager,
-                new JTextField(setting.getValue()), setting.getValidator());
+        pathField = new ValidatingJTextField(iconManager, setting.getValue(), setting.getValidator());
 
         setLayout(new MigLayout("ins 0, fill"));
         add(pathField, "growx, pushx, sgy all");

src/com/dmdirc/addons/ui_swing/components/JIconTextField.java

@@ -0,0 +1,87 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * 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.addons.ui_swing.components;
+
+import java.awt.Graphics;
+import java.awt.Insets;
+import java.awt.event.MouseEvent;
+
+import javax.swing.Icon;
+import javax.swing.JTextField;
+import javax.swing.ToolTipManager;
+import javax.swing.UIManager;
+
+/**
+ * JTextfield capable of displaying an icon and tooltip.
+ */
+public class JIconTextField extends JTextField {
+
+    /** Insets used by a normal text field. */
+    private final Insets dummyInsets;
+    /** Icon to show, or null. */
+    private Icon icon;
+    /** Message to show, or null. */
+    private String message;
+
+    public JIconTextField() {
+        super();
+        this.icon = null;
+        this.dummyInsets = UIManager.getBorder("TextField.border").getBorderInsets(new JTextField());
+        ToolTipManager.sharedInstance().registerComponent(this);
+    }
+
+    public void setIcon(final Icon icon) {
+        this.icon = icon;
+    }
+
+    public Icon getIcon() {
+        return icon;
+    }
+
+    public void setMessage(final String message) {
+        this.message = message;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    @Override
+    protected void paintComponent(final Graphics g) {
+        super.paintComponent(g);
+        if (this.icon != null) {
+            final int x = getWidth() - dummyInsets.right - icon.getIconWidth();
+            setMargin(new Insets(2, 2, 2, getWidth() - x));
+            icon.paintIcon(this, g, x, ((getHeight() - icon.getIconHeight()) / 2));
+        } else {
+            setMargin(new Insets(2, 2, 2, 2));
+        }
+    }
+
+    @Override
+    public String getToolTipText(final MouseEvent event) {
+        if (icon != null && (event.getX() >= getWidth() - dummyInsets.right - dummyInsets.right - icon.getIconWidth())) {
+            return message;
+        }
+        return super.getToolTipText(event);
+    }
+}

src/com/dmdirc/addons/ui_swing/components/SwingSearchBar.java

@@ -276,7 +276,7 @@ public final class SwingSearchBar extends JPanel implements ActionListener,
      * @return Search textfield
      */
     public JTextField getTextField() {
-        return searchBox.getTextField();
+        return searchBox;
     }
 
     /**
@@ -286,7 +286,7 @@ public final class SwingSearchBar extends JPanel implements ActionListener,
      */
     @Override
     public void keyPressed(final KeyEvent event) {
-        if (event.getSource() == searchBox.getTextField()) {
+        if (event.getSource() == searchBox) {
             if (event.getKeyCode() == KeyEvent.VK_ESCAPE) {
                 close();
             } else if (event.getKeyCode() == KeyEvent.VK_ENTER) {

src/com/dmdirc/addons/ui_swing/components/inputfields/ValidatingTextFieldInputField.java

@@ -31,7 +31,6 @@ import com.dmdirc.util.validators.Validator;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
 
-import javax.swing.JTextField;
 import javax.swing.text.BadLocationException;
 
 /**
@@ -55,7 +54,7 @@ public class ValidatingTextFieldInputField extends ValidatingJTextField
      */
     public ValidatingTextFieldInputField(final SwingController controller,
             final Validator<String> validator) {
-        this(controller, new JTextField(), validator);
+        this(controller, "", validator);
     }
 
     /**
@@ -63,11 +62,11 @@ public class ValidatingTextFieldInputField extends ValidatingJTextField
      *
      * @param controller Swing controller
      * @param validator Validator for this textfield
-     * @param textField Textfield to use as a base
+     * @param text Text to use
      */
     public ValidatingTextFieldInputField(final SwingController controller,
-            final JTextField textField, final Validator<String> validator) {
-        super(controller.getIconManager(), textField, validator);
+            final String text, final Validator<String> validator) {
+        super(controller.getIconManager(), text, validator);
         this.controller = controller;
     }
 
@@ -119,17 +118,4 @@ public class ValidatingTextFieldInputField extends ValidatingJTextField
             colourPicker = null;
         }
     }
-
-    /** {@inheritDoc} */
-    @Override
-    public int getCaretPosition() {
-        return getTextField().getCaretPosition();
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public void setCaretPosition(final int position) {
-        getTextField().setCaretPosition(position);
-    }
-
 }

src/com/dmdirc/addons/ui_swing/components/validating/ValidatingJTextField.java

@@ -22,45 +22,30 @@
 
 package com.dmdirc.addons.ui_swing.components.validating;
 
-import com.dmdirc.addons.ui_swing.UIUtilities;
+import com.dmdirc.addons.ui_swing.components.JIconTextField;
 import com.dmdirc.ui.IconManager;
 import com.dmdirc.util.validators.ValidationResponse;
 import com.dmdirc.util.validators.Validator;
 
-import java.awt.Color;
-import java.awt.Font;
-import java.awt.event.KeyListener;
-import java.awt.event.MouseListener;
+import java.awt.Image;
+import java.awt.Insets;
 
-import javax.swing.Icon;
-import javax.swing.JComponent;
-import javax.swing.JLabel;
-import javax.swing.JTextField;
-import javax.swing.TransferHandler;
+import javax.swing.ImageIcon;
 import javax.swing.event.DocumentEvent;
 import javax.swing.event.DocumentListener;
-import javax.swing.text.BadLocationException;
-import javax.swing.text.Document;
 
-import net.miginfocom.swing.MigLayout;
 
 /**
  * Validating Text field.
  */
-public class ValidatingJTextField extends JComponent implements DocumentListener {
+public class ValidatingJTextField extends JIconTextField implements DocumentListener {
 
-    /**
-     * 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;
-    /** TextField. */
-    private final JTextField textField;
+    /** A version number for this class. */
+    private static final long serialVersionUID = 2;
     /** Validator. */
     private Validator<String> validator;
-    /** Error icon. */
-    private final JLabel errorIcon;
+    /** Error image. */
+    private final ImageIcon errorIcon;
 
     /**
      * Instantiates a new Validating text field.
@@ -70,41 +55,39 @@ public class ValidatingJTextField extends JComponent implements DocumentListener
      */
     public ValidatingJTextField(final IconManager iconManager,
             final Validator<String> validator) {
-        this(iconManager, new JTextField(), validator);
+        this(iconManager.getImage("input-error"), "", validator);
     }
+
     /**
      * Instantiates a new Validating text field.
      *
      * @param iconManager Icon manager
-     * @param textField JTextField to wrap
+     * @param text Text to display in textfield
      * @param validator Validator instance
      */
-    public ValidatingJTextField(final IconManager iconManager,
-            final JTextField textField, final Validator<String> validator) {
-        this(iconManager.getIcon("input-error"), textField, validator);
+    public ValidatingJTextField(final IconManager iconManager, final String text,
+            final Validator<String> validator) {
+        this(iconManager.getImage("input-error"), text, validator);
     }
 
     /**
      * Instantiates a new Validating text field.
      *
      * @param icon Icon to show on error
-     * @param textField JTextField to wrap
+     * @param text Text to display in textfield
      * @param validator Validator instance
      */
-    public ValidatingJTextField(final Icon icon,
-            final JTextField textField, final Validator<String> validator) {
+    public ValidatingJTextField(final Image icon, final String text, final Validator<String> validator) {
         super();
-        this.textField = textField;
         this.validator = validator;
-        errorIcon = new JLabel(icon);
+        errorIcon = new ImageIcon(icon);
+        setText(text);
 
-        setLayout(new MigLayout("fill, ins 0, hidemode 3, gap 0"));
-        add(textField, "grow, pushx");
-        add(errorIcon);
+        setMargin(new Insets(0, 0, 0, errorIcon.getIconWidth()));
 
         checkError();
 
-        textField.getDocument().addDocumentListener(this);
+        getDocument().addDocumentListener(this);
     }
 
     /**
@@ -121,15 +104,19 @@ public class ValidatingJTextField extends JComponent implements DocumentListener
      * Checks the text for errors and sets the error state accordingly.
      */
     public void checkError() {
-        if (textField.isEnabled()) {
-            final ValidationResponse vr =
-                    validator.validate(textField.getText());
-            errorIcon.setToolTipText(vr.getFailureReason());
-            firePropertyChange("validationResult", !errorIcon.isVisible(), !vr.isFailure());
-            errorIcon.setVisible(vr.isFailure());
+        if (isEnabled()) {
+            final ValidationResponse vr = validator.validate(getText());
+            setMessage(vr.getFailureReason());
+            firePropertyChange("validationResult", getMessage() != null, !vr.isFailure());
+            if (vr.isFailure()) {
+                setIcon(errorIcon);
+            } else {
+                setIcon(null);
+            }
         } else {
-            firePropertyChange("validationResult", !errorIcon.isVisible(), true);
-            errorIcon.setVisible(false);
+            setIcon(null);
+            setMessage(null);
+            firePropertyChange("validationResult", !getMessage().isEmpty(), true);
         }
     }
 
@@ -141,7 +128,7 @@ public class ValidatingJTextField extends JComponent implements DocumentListener
      * @return true iif the text validates
      */
     public boolean validateText() {
-        if (textField.isEnabled()) {
+        if (isEnabled()) {
             return !validator.validate(getText()).isFailure();
         } else {
             return true;
@@ -165,351 +152,4 @@ public class ValidatingJTextField extends JComponent implements DocumentListener
     public void removeUpdate(final DocumentEvent e) {
         checkError();
     }
-
-    /** {@inheritDoc} */
-    @Override
-    public void setToolTipText(final String text) {
-        textField.setToolTipText(text);
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public void setEnabled(final boolean enabled) {
-        textField.setEnabled(enabled);
-        checkError();
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public void requestFocus() {
-        textField.requestFocus();
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public boolean requestFocusInWindow() {
-        return textField.requestFocusInWindow();
-    }
-
-    /**
-     * Sets the text in the textfield.
-     *
-     * @see javax.swing.JTextField#setText(String)
-     *
-     * @param t Text to set
-     */
-    public void setText(final String t) {
-        textField.setText(t);
-    }
-
-    /**
-     * Sets the selection start.
-     *
-     * @see javax.swing.JTextField#setSelectionStart(int)
-     *
-     * @param selectionStart Start of the selection
-     */
-    public void setSelectionStart(final int selectionStart) {
-        textField.setSelectionStart(selectionStart);
-    }
-
-    /**
-     * Sets the selection end.
-     *
-     * @see javax.swing.JTextField#setSelectionEnd(int)
-     *
-     * @param selectionEnd End of the selection
-     */
-    public void setSelectionEnd(final int selectionEnd) {
-        textField.setSelectionEnd(selectionEnd);
-    }
-
-    /**
-     * Sets whether the component is editable.
-     *
-     * @see javax.swing.JTextField#setEditable(boolean)
-     *
-     * @param b editable state for the component
-     */
-    public void setEditable(final boolean b) {
-        textField.setEditable(b);
-    }
-
-    /**
-     * Selects all text in the textfield.
-     *
-     * @see javax.swing.JTextField#selectAll()
-     */
-    public void selectAll() {
-        textField.selectAll();
-    }
-
-    /**
-     * Selects the specified text in the textfield.
-     *
-     * @see javax.swing.JTextField#select(int, int)
-     *
-     * @param selectionStart Selection start
-     * @param selectionEnd Selection end
-     */
-    public void select(final int selectionStart, final int selectionEnd) {
-        textField.select(selectionStart, selectionEnd);
-    }
-
-    /**
-     * Replaces the textfields selection with the specified content.
-     *
-     * @see javax.swing.JTextField#replaceSelection(String)
-     *
-     * @param content Text to replace selection with
-     */
-    public void replaceSelection(final String content) {
-        textField.replaceSelection(content);
-    }
-
-    /**
-     * Paste's the system clipboard into the textfield.
-     *
-     * @see javax.swing.JTextField#paste()
-     */
-    public void paste() {
-        textField.paste();
-    }
-
-    /**
-     * Checks if the textfield is editable.
-     *
-     * @see javax.swing.JTextField#isEditable()
-     *
-     * @return true iif the textfield is editable
-     */
-    public boolean isEditable() {
-        return textField.isEditable();
-    }
-
-    /**
-     * Returns the text in the textfield.
-     *
-     * @see javax.swing.JTextField#getText()
-     *
-     * @return Textfield content
-     */
-    public String getText() {
-        return textField.getText();
-    }
-
-    /**
-     * Returns the specified section of text in the textfield.
-     *
-     * @see javax.swing.JTextField#getText(int, int)
-     *
-     * @param offs Start offset
-     * @param len section length
-     *
-     * @return Specified textfield content
-     *
-     * @throws javax.swing.text.BadLocationException if the bounds are wrong
-     */
-    public String getText(final int offs, final int len) throws BadLocationException {
-        return textField.getText(offs, len);
-    }
-
-    /**
-     * Returns the start of the selection in the textfield.
-     *
-     * @see javax.swing.JTextField#getSelectionStart()
-     *
-     * @return Selection start
-     */
-    public int getSelectionStart() {
-        return textField.getSelectionStart();
-    }
-
-    /**
-     * Returns the end of the textfield selection.
-     *
-     * @see javax.swing.JTextField#getSelectionEnd()
-     *
-     * @return Selection end
-     */
-    public int getSelectionEnd() {
-        return textField.getSelectionEnd();
-    }
-
-    /**
-     * Returns the selected text in the textfield.
-     *
-     * @see javax.swing.JTextField#getSelectedText()
-     *
-     * @return Selected text
-     */
-    public String getSelectedText() {
-        return textField.getSelectedText();
-    }
-
-    /**
-     * Returns the textfield's document.
-     *
-     * @see javax.swing.JTextField#getDocument()
-     *
-     * @return Textfield's document
-     */
-    public Document getDocument() {
-        return textField.getDocument();
-    }
-
-    /**
-     * Cuts the selected text from the textfield into the clipboard.
-     *
-     * @see javax.swing.JTextField#cut()
-     */
-    public void cut() {
-        textField.cut();
-    }
-
-    /**
-     * Copies the selected text from the textfield into the clipboard.
-     *
-     * @see javax.swing.JTextField#copy()
-     */
-    public void copy() {
-        textField.copy();
-    }
-
-    /**
-     * Returns the font for the textfield.
-     *
-     * @see javax.swing.JTextField#copy()
-     */
-    @Override
-    public Font getFont() {
-        return textField.getFont();
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public synchronized void addKeyListener(final KeyListener l) {
-        textField.addKeyListener(l);
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public synchronized void removeKeyListener(final KeyListener l) {
-        textField.removeKeyListener(l);
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public synchronized void addMouseListener(final MouseListener l) {
-        textField.addMouseListener(l);
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public synchronized void removeMouseListener(final MouseListener l) {
-        textField.removeMouseListener(l);
-    }
-
-    /**
-     * Sets the drag enabled property on the textfield.
-     *
-     * @param enabled Enabled?
-     */
-    public void setDragEnabled(final boolean enabled) {
-        textField.setDragEnabled(enabled);
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public void setTransferHandler(final TransferHandler newHandler) {
-        textField.setTransferHandler(newHandler);
-    }
-
-    /**
-     * Returns the validator used by this text field.
-     *
-     * @since 0.6.3m1
-     *
-     * @return This field's validator
-     */
-    public Validator<String> getValidator() {
-        return validator;
-    }
-
-    /**
-     * Returns the text field used by this validating text field.
-     *
-     * @since 0.6.3m1
-     *
-     * @return This field's text field
-     */
-    public JTextField getTextField() {
-        return textField;
-    }
-
-    /**
-     * Sets the caret colour to the specified coloour.
-     *
-     * @param optionColour Colour for the caret
-     */
-    public void setCaretColor(final Color optionColour) {
-        UIUtilities.invokeLater(new Runnable() {
-
-            /** {@inheritDoc} */
-            @Override
-            public void run() {
-                textField.setCaretColor(optionColour);
-            }
-        });
-    }
-
-    /**
-     * Sets the foreground colour to the specified coloour.
-     *
-     * @param optionColour Colour for the foreground
-     */
-    @Override
-    public void setForeground(final Color optionColour) {
-        UIUtilities.invokeLater(new Runnable() {
-
-            /** {@inheritDoc} */
-            @Override
-            public void run() {
-                textField.setForeground(optionColour);
-            }
-        });
-    }
-
-    /**
-     * Sets the disabled text colour to the specified coloour.
-     *
-     * @param optionColour Colour for the disabled text
-     */
-    public void setDisabledTextColour(final Color optionColour) {
-        UIUtilities.invokeLater(new Runnable() {
-
-            /** {@inheritDoc} */
-            @Override
-            public void run() {
-                textField.setDisabledTextColor(optionColour);
-            }
-        });
-    }
-
-    /**
-     * Sets the background colour to the specified coloour.
-     *
-     * @param optionColour Colour for the caret
-     */
-    @Override
-    public void setBackground(final Color optionColour) {
-        UIUtilities.invokeLater(new Runnable() {
-
-            /** {@inheritDoc} */
-            @Override
-            public void run() {
-                textField.setBackground(optionColour);
-            }
-        });
-    }
 }

src/com/dmdirc/addons/ui_swing/dialogs/actioneditor/ActionNamePanel.java

@@ -122,7 +122,7 @@ public class ActionNamePanel extends JPanel implements PropertyChangeListener {
     @SuppressWarnings("unchecked")
     private void initComponents() {
         name = new ValidatingJTextField(iconManager,
-                new JTextField(existingName),
+                existingName,
                 new ValidatorChain<>(new FileNameValidator(),
                 new ActionNameValidator(group, existingName)));
     }