Prefs stuff. Issue 444.

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

src/com/dmdirc/config/prefs/CategoryChangeListener.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2006-2008 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.config.prefs;
+
+/**
+ * Defines methods that should be implemented by objects who wish to be
+ * notified about category changes.
+ * 
+ * @author chris
+ */
+public interface CategoryChangeListener {
+
+    /**
+     * Called when a category has been selected.
+     * 
+     * @param category The category that was selected
+     */
+    void CategorySelected(final PreferencesCategory category);
+    
+    /**
+     * Called when a category has been deselected.
+     * 
+     * @param category The category that was deselected
+     */
+    void CategoryDeselected(final PreferencesCategory category);
+}

src/com/dmdirc/config/prefs/PreferencesCategory.java

@@ -21,6 +21,8 @@
  */
 package com.dmdirc.config.prefs;
 
+import com.dmdirc.util.ListenerList;
+
 import java.util.ArrayList;
 import java.util.List;
 
@@ -47,6 +49,9 @@ public class PreferencesCategory {
     
     /** The replacement object to use for this category. */
     private final PreferencesInterface object;
+    
+    /** A list of listeners who are interested in this category. */
+    private final ListenerList listeners = new ListenerList();
 
     /**
      * Creates a new preferences category that contains settings.
@@ -150,5 +155,41 @@ public class PreferencesCategory {
     public PreferencesInterface getObject() {
         return object;
     }
+    
+    /**
+     * Registers a change listener for this category.
+     * 
+     * @param listener The listener to be added
+     */
+    public void addChangeListener(final CategoryChangeListener listener) {
+        listeners.add(CategoryChangeListener.class, listener);
+    }
+    
+    /**
+     * Removes a change listener from this category.
+     * 
+     * @param listener The listener to be added
+     */
+    public void removeChangeListener(final CategoryChangeListener listener) {
+        listeners.remove(CategoryChangeListener.class, listener);
+    }
+    
+    /**
+     * Informs all registered listeners that this category has been selected.
+     */
+    public void fireCategorySelected() {
+        for (CategoryChangeListener listener : listeners.get(CategoryChangeListener.class)) {
+            listener.CategorySelected(this);
+        }
+    }
+    
+    /**
+     * Informs all registered listeners that this category has been deselected.
+     */
+    public void fireCategoryDeselected() {
+        for (CategoryChangeListener listener : listeners.get(CategoryChangeListener.class)) {
+            listener.CategorySelected(this);
+        }
+    }    
 
 }

src/com/dmdirc/ui/swing/dialogs/prefs/SwingPreferencesDialog.java

@@ -32,6 +32,7 @@ import com.dmdirc.config.prefs.PreferencesSetting;
 import com.dmdirc.config.prefs.validator.NumericalValidator;
 import com.dmdirc.ui.swing.MainFrame;
 import com.dmdirc.ui.swing.components.validating.ValidatingJTextField;
+import com.dmdirc.util.DoubleMap;
 import static com.dmdirc.ui.swing.UIUtilities.LARGE_BORDER;
 import static com.dmdirc.ui.swing.UIUtilities.SMALL_BORDER;
 import static com.dmdirc.ui.swing.UIUtilities.layoutGrid;
@@ -95,7 +96,7 @@ public final class SwingPreferencesDialog extends StandardDialog implements
     private final Map<PreferencesSetting, JComponent> components;
 
     /** Categories in the dialog. */
-    private final Map<PreferencesCategory, JPanel> categories;
+    private final DoubleMap<PreferencesCategory, JPanel> categories;
 
     /** Custom panels, not to be laid out automatically. */
     private final List<JPanel> panels;
@@ -123,7 +124,7 @@ public final class SwingPreferencesDialog extends StandardDialog implements
         
         manager = new PreferencesManager();
 
-        categories = new HashMap<PreferencesCategory, JPanel>();
+        categories = new DoubleMap<PreferencesCategory, JPanel>();
         components = new HashMap<PreferencesSetting, JComponent>();
 
         panels = new ArrayList<JPanel>();
@@ -231,10 +232,10 @@ public final class SwingPreferencesDialog extends StandardDialog implements
         final JLabel label = getLabel(setting);
         final JComponent option = getComponent(setting);
 
-        ((JPanel) categories.get(category).getComponent(1)).add(label);
+        ((JPanel) categories.getValue(category).getComponent(1)).add(label);
 
         label.setLabelFor(option);
-        ((JPanel) categories.get(category).getComponent(1)).add(option);
+        ((JPanel) categories.getValue(category).getComponent(1)).add(option);
     }
 
     /**
@@ -421,7 +422,7 @@ public final class SwingPreferencesDialog extends StandardDialog implements
             }
 
             panels.add((JPanel) category.getObject());
-            categories.get(category).add((JPanel) category.getObject(), 1);
+            categories.getValue(category).add((JPanel) category.getObject(), 1);
 
             return;
         }
@@ -494,7 +495,7 @@ public final class SwingPreferencesDialog extends StandardDialog implements
 
     /** {@inheritDoc} */
     public void display() {
-        for (JPanel panel : categories.values()) {
+        for (JPanel panel : categories.valueSet()) {
             if (!panels.contains(panel.getComponent(1))) {
                 layoutGrid((JPanel) panel.getComponent(1), ((JPanel) panel
                         .getComponent(1)).getComponentCount() / 2, 2, SMALL_BORDER,

src/com/dmdirc/util/DoubleMap.java

@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2006-2008 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.util;
+
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+/**
+ * An object that maps keys to values, and values back to keys. Currently
+ * does no checking for duplicates. Does not allow null values.
+ * 
+ * @param <A> The first type of data to be mapped
+ * @param <B> The second type of data to be mapped 
+ * @author chris
+ */
+public class DoubleMap<A,B> {
+    
+    /** The keys in this map. */
+    protected final List<A> keys = new ArrayList<A>();
+    /** The values in this map. */
+    protected final List<B> values = new ArrayList<B>();
+    
+    /**
+     * Adds the specified pair to this map.
+     * 
+     * @param key The key for the map
+     * @param value The value for the map
+     */
+    public void put(final A key, final B value) {
+        if (key == null || value == null) {
+            throw new NullPointerException();
+        }
+        
+        keys.add(key);
+        values.add(value);
+    }
+    
+    /**
+     * Retrieves the value associated with the specified key.
+     * 
+     * @param key The key to search for 
+     * @return The value of the specified key
+     */
+    public B getValue(final A key) {
+        return values.get(keys.indexOf(key));
+    }
+    
+    /**
+     * Retrieves the key associated with the specified value.
+     * 
+     * @param value The value to search for
+     * @return The key of the specified value
+     */
+    public A getKey(final B value) {
+        return keys.get(values.indexOf(value));
+    }
+    
+    /**
+     * Retrieves the set of keys in this double map.
+     * 
+     * @return This map's key set
+     */
+    public Set<A> keySet() {
+        return new HashSet<A>(keys);
+    }
+    
+    /**
+     * Retrieves the set of values in this double map.
+     * 
+     * @return This map's value set
+     */
+    public Set<B> valueSet() {
+        return new HashSet<B>(values);
+    }
+
+}