Add FileBrowser component to PrefsComponentFactory

Fixes issue 1279

Change-Id: I5a0241e72db64a39b571fb76d2eee96b8a017ed1
Reviewed-on: http://gerrit.dmdirc.com/869
Reviewed-by: Gregory Holmes <greg@dmdirc.com>
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>

src/com/dmdirc/addons/ui_swing/PrefsComponentFactory.java

@@ -22,6 +22,7 @@
 
 package com.dmdirc.addons.ui_swing;
 
+import com.dmdirc.addons.ui_swing.components.FileBrowser;
 import com.dmdirc.config.prefs.PreferencesSetting;
 import com.dmdirc.config.prefs.validator.NumericalValidator;
 import com.dmdirc.addons.ui_swing.components.colours.ColourChooser;
@@ -46,6 +47,7 @@ import java.util.Map;
 import javax.swing.JCheckBox;
 import javax.swing.JComboBox;
 import javax.swing.JComponent;
+import javax.swing.JFileChooser;
 import javax.swing.JSpinner;
 import javax.swing.JTextField;
 import javax.swing.SpinnerNumberModel;
@@ -105,6 +107,15 @@ public final class PrefsComponentFactory {
             case FONT:
                 option = getFontOption(setting);
                 break;
+            case FILE:
+                option = getFileBrowseOption(setting, JFileChooser.FILES_ONLY);
+                break;
+            case DIRECTORY:
+                option = getFileBrowseOption(setting, JFileChooser.DIRECTORIES_ONLY);
+                break;
+            case FILES_AND_DIRECTORIES:
+                option = getFileBrowseOption(setting, JFileChooser.FILES_AND_DIRECTORIES);
+                break;
             default:
                 throw new IllegalArgumentException(setting.getType()
                         + " is not a valid option type");
@@ -146,7 +157,7 @@ public final class PrefsComponentFactory {
         final JCheckBox option = new JCheckBox();
         option.setSelected(Boolean.parseBoolean(setting.getValue()));
         option.addChangeListener(new ChangeListener() {
-            
+
             /** {@inheritDoc} */
             @Override
             public void stateChanged(final ChangeEvent e) {
@@ -176,7 +187,7 @@ public final class PrefsComponentFactory {
         }
 
         option.addActionListener(new ActionListener() {
-            
+
             /** {@inheritDoc} */
             @Override
             public void actionPerformed(final ActionEvent e) {
@@ -238,7 +249,7 @@ public final class PrefsComponentFactory {
                 && !setting.getValue().startsWith("false:");
         final String integer = setting.getValue() == null ? "0" : setting.getValue().
                 substring(1 + setting.getValue().indexOf(':'));
-        
+
         OptionalJSpinner option;
         Validator optionalValidator = setting.getValidator();
         Validator numericalValidator = null;
@@ -296,7 +307,7 @@ public final class PrefsComponentFactory {
         }
 
         option.addDurationListener(new DurationListener() {
-            
+
             /** {@inheritDoc} */
             @Override
             public void durationUpdated(final int newDuration) {
@@ -317,7 +328,7 @@ public final class PrefsComponentFactory {
         final ColourChooser option = new ColourChooser(setting.getValue(), true, true);
 
         option.addActionListener(new ActionListener() {
-            
+
             /** {@inheritDoc} */
             @Override
             public void actionPerformed(final ActionEvent e) {
@@ -343,7 +354,7 @@ public final class PrefsComponentFactory {
         final OptionalColourChooser option = new OptionalColourChooser(colour, state, true, true);
 
         option.addActionListener(new ActionListener() {
-            
+
             /** {@inheritDoc} */
             @Override
             public void actionPerformed(final ActionEvent e) {
@@ -355,7 +366,7 @@ public final class PrefsComponentFactory {
 
         return option;
     }
-    
+
     /**
      * Initialises and returns an Font Chooser for the specified setting.
      *
@@ -366,7 +377,7 @@ public final class PrefsComponentFactory {
         final String value = setting.getValue();
 
         final FontPicker option = new FontPicker(value);
-        
+
         option.addActionListener(new ActionListener() {
 
             /** {@inheritDoc} */
@@ -379,8 +390,39 @@ public final class PrefsComponentFactory {
                     setting.setValue(null);
                 }
             }
-        });        
-        
+        });
+
+        return option;
+    }
+
+    /**
+     * Initialises and returns a FileBrowser for the specified setting.
+     *
+     * @param setting The setting to create the component for
+     * @param type The type of filechooser we want (Files/Directories/Both)
+     *
+     * @return A JComponent descendent for the specified setting
+     */
+    private static JComponent getFileBrowseOption(final PreferencesSetting setting,
+            final int type) {
+        final FileBrowser option = new FileBrowser(setting, type);
+
+        option.addActionListener(new ActionListener() {
+            /** {@inheritDoc} */
+            @Override
+            public void actionPerformed(final ActionEvent e) {
+                setting.setValue(option.getPath());
+            }
+        });
+
+        option.addKeyListener(new KeyAdapter() {
+            /** {@inheritDoc} */
+            @Override
+            public void keyReleased(final KeyEvent e) {
+                setting.setValue(((JTextField) e.getSource()).getText());
+            }
+        });
+
         return option;
     }
 

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

@@ -0,0 +1,137 @@
+/*
+ * Copyright (c) 2006-2010 Chris Smith, Shane Mc Cormack, Gregory Holmes,
+ * Simon Mott
+ *
+ * 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 com.dmdirc.addons.ui_swing.components.validating.ValidatingJTextField;
+import com.dmdirc.config.prefs.PreferencesSetting;
+import com.dmdirc.util.ListenerList;
+
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+
+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;
+
+/**
+ * File browser component.
+ *
+ * @author Simon Mott
+ * @since 0.6.3
+ */
+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).
+     */
+    private static final long serialVersionUID = 1;
+
+    /** Browse button. */
+    private JButton browseButton;
+    /** Text field to show path of chosen file. */
+    private ValidatingJTextField pathField;
+    /** File browsing window. */
+    private JFileChooser fileChooser = new JFileChooser();
+    /** Our listeners. */
+    private final ListenerList listeners = new ListenerList();
+
+    /**
+     * Creates a new File Browser.
+     *
+     * @param setting The setting to create the component for
+     * @param type The type of filechooser we want (Files/Directories/Both)
+     */
+    public FileBrowser(final PreferencesSetting setting, final int type) {
+        fileChooser.setFileSelectionMode(type);
+        
+        browseButton = new JButton("Browse");
+        browseButton.addActionListener(this);
+
+        pathField = new ValidatingJTextField(new JTextField(setting.getValue()),
+                setting.getValidator());
+
+        setLayout(new MigLayout("ins 0, fill"));
+        add(pathField, "growx, pushx, sgy all");
+        add(browseButton, "sgy all");
+    }
+
+    /**
+     * {@inheritDoc}.
+     *
+     * @param e Action event
+     */
+    @Override
+    public void actionPerformed(ActionEvent e) {
+        fileChooser.showOpenDialog(this);
+
+        if (fileChooser.getSelectedFile() != null) {
+            pathField.setText(fileChooser.getSelectedFile().getAbsolutePath());
+        }
+        fireActionEvent();
+    }
+
+    /**
+     * Adds an action listener to this file browser. Action
+     * listeners are notified whenever the path changes.
+     *
+     * @param l The listener to be added
+     */
+    public void addActionListener(final ActionListener l) {
+        listeners.add(ActionListener.class, l);
+    }
+
+    /**
+     * {@inheritDoc}.
+     *
+     * @param l The listener to be added
+     */
+    @Override
+    public void addKeyListener(final KeyListener l) {
+        pathField.addKeyListener(l);
+    }
+
+    /**
+     * Returns the current path selected by this file browser.
+     *
+     * @return Path selected by this filebrowser
+     */
+    public String getPath() {
+        return pathField.getText();
+    }
+
+    /**
+     * Informs all action listeners that an action has occured.
+     */
+    protected void fireActionEvent() {
+        for (ActionListener listener : listeners.get(ActionListener.class)) {
+            listener.actionPerformed(new ActionEvent(this, 1, getPath()));
+        }
+    }
+}