The now playing plugin now allows you to reorder media sources

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

src/com/dmdirc/addons/nowplaying/plugin/ConfigPanel.java

@@ -22,7 +22,6 @@
 
 package com.dmdirc.addons.nowplaying.plugin;
 
-import com.dmdirc.addons.nowplaying.MediaSource;
 import com.dmdirc.ui.swing.components.reorderablelist.ReorderableJList;
 import static com.dmdirc.ui.swing.UIUtilities.SMALL_BORDER;
 
@@ -51,13 +50,13 @@ public class ConfigPanel extends JPanel {
     private ReorderableJList list;
     
     /** Media sources. */
-    private final List<MediaSource> sources;
+    private final List<String> sources;
     
     /** Creates a new instance of ConfigPanel. */
-    public ConfigPanel(List<MediaSource> sources) {
+    public ConfigPanel(final List<String> sources) {
         super();
         
-        this.sources = new LinkedList<MediaSource>(sources);
+        this.sources = new LinkedList<String>(sources);
         
         initComponents();
     }
@@ -65,9 +64,8 @@ public class ConfigPanel extends JPanel {
     /** Initialises the components. */
     private void initComponents() {
         list = new ReorderableJList();
-        list.setCellRenderer(new MediaSourceListRenderer());
         
-        for (MediaSource source: sources) {
+        for (String source : sources) {
             list.getModel().addElement(source);
         }
         
@@ -77,13 +75,13 @@ public class ConfigPanel extends JPanel {
         add(new JScrollPane(list), BorderLayout.CENTER);
     }
     
-    public List<MediaSource> getSources() {
-        final List<MediaSource> newSources = new LinkedList<MediaSource>();
+    public List<String> getSources() {
+        final List<String> newSources = new LinkedList<String>();
         
         final Enumeration<?> values = list.getModel().elements();
         
         while (values.hasMoreElements()) {
-            newSources.add((MediaSource) values.nextElement());
+            newSources.add((String) values.nextElement());
         }
         
         return newSources;

src/com/dmdirc/addons/nowplaying/plugin/MediaSourceListRenderer.java → src/com/dmdirc/addons/nowplaying/plugin/MediaSourceComparator.java

@@ -24,37 +24,46 @@ package com.dmdirc.addons.nowplaying.plugin;
 
 import com.dmdirc.addons.nowplaying.MediaSource;
 
-import java.awt.Component;
-
-import javax.swing.DefaultListCellRenderer;
-import javax.swing.JList;
+import java.util.Comparator;
+import java.util.List;
 
 /**
- * Displays Media sources in a list.
+ * Sorts media sources according to an ordered list of their names.
+ *
+ * @author chris
  */
-public final class MediaSourceListRenderer extends DefaultListCellRenderer {
+public class MediaSourceComparator implements Comparator<MediaSource> {
+    
+    /** The order that the sources should be checked. */
+    private final List<String> order;
     
     /**
-     * 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).
+     * Creates a new instance of MediaSourceComparator.
+     * NB: The order list may be altered during comparisons.
+     *
+     * @param order An ordered list of media source names
      */
-    private static final long serialVersionUID = 1;
-    
-    /** Creates a new instance of MediaSourceListRenderer. */
-    public MediaSourceListRenderer() {
-        super();
+    public MediaSourceComparator(final List<String> order) {
+        this.order = order;
+    }
+
+    /** {@inheritDoc} */
+    public int compare(final MediaSource o1, final MediaSource o2) {
+        return getPosition(o1) - getPosition(o2);
     }
     
-    /** @{inheritDoc} */
-    public Component getListCellRendererComponent(final JList list,
-            final Object value, final int index, final boolean isSelected,
-            final boolean cellHasFocus) {
-        super.getListCellRendererComponent(list, value, index, isSelected, 
-                cellHasFocus);
-        setText(((MediaSource) value).getName());
+    /**
+     * Retrieves the position of the source within the order list.
+     * If the source is not present it is appended to the list.
+     *
+     * @param source The media source to be tested
+     */
+    private int getPosition(final MediaSource source) {
+        if (!order.contains(source.getName())) {
+            order.add(source.getName());
+        }
         
-        return this;
+        return order.indexOf(source.getName());
     }
     
 }

src/com/dmdirc/addons/nowplaying/plugin/NowPlayingPlugin.java

@@ -34,9 +34,9 @@ import com.dmdirc.plugins.Plugin;
 import com.dmdirc.plugins.PluginManager;
 import com.dmdirc.ui.interfaces.PreferencesInterface;
 import com.dmdirc.ui.interfaces.PreferencesPanel;
-import java.util.ArrayList;
 
-import java.util.LinkedList;
+import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.Properties;
 
@@ -55,6 +55,9 @@ public class NowPlayingPlugin extends Plugin implements EventPlugin,
     /** Config panel. */
     private ConfigPanel configPanel;
     
+    /** The user's preferred order for source usage. */
+    private List<String> order;
+    
     public NowPlayingPlugin() {
         super();
         
@@ -71,6 +74,8 @@ public class NowPlayingPlugin extends Plugin implements EventPlugin,
     protected void onActivate() {
         sources.clear();
         
+        loadSettings();
+        
         for (Plugin target : PluginManager.getPluginManager().getPlugins()) {
             if (target.isActive()) {
                 addPlugin(target);
@@ -78,7 +83,6 @@ public class NowPlayingPlugin extends Plugin implements EventPlugin,
         }
         
         command = new NowPlayingCommand(this);
-        loadSettings();
     }
     
     /** {@inheritDoc} */
@@ -110,12 +114,15 @@ public class NowPlayingPlugin extends Plugin implements EventPlugin,
     }
     
     /** {@inheritDoc} */
-    public boolean isConfigurable() { return true; }
+    public boolean isConfigurable() {
+        return true;
+    }
     
     /** {@inheritDoc} */
     public void showConfig() {
         final PreferencesPanel preferencesPanel = Main.getUI().getPreferencesPanel(this, "Now playing Plugin - Config");
-        configPanel = new ConfigPanel(sources);
+        
+        configPanel = new ConfigPanel(order);
         
         preferencesPanel.addCategory("General", "General options for the plugin.");
         
@@ -126,8 +133,8 @@ public class NowPlayingPlugin extends Plugin implements EventPlugin,
     
     /** {@inheritDoc} */
     public void configClosed(final Properties properties) {
-        //save settings
-        sources = configPanel.getSources();
+        order = configPanel.getSources();
+        
         saveSettings();
     }
     
@@ -138,16 +145,16 @@ public class NowPlayingPlugin extends Plugin implements EventPlugin,
     
     /** Saves the plugins settings. */
     private void saveSettings() {
-        final List<String> values = new LinkedList<String>();
-        for (final MediaSource source : sources) {
-            values.add(source.getName());
-        }
-        Config.setOption(DOMAIN, "sourceOrder", values);
+        Config.setOption(DOMAIN, "sourceOrder", order);
     }
     
     /** Loads the plugins settings. */
     private void loadSettings() {
-        final List<String> values = Config.getOptionList(DOMAIN, "sourceOrder");
+        if (Config.hasOption(DOMAIN, "sourceOrder")) {
+            order = Config.getOptionList(DOMAIN, "sourceOrder");
+        } else {
+            order = new ArrayList<String>();
+        }
     }
     
     /** {@inheritDoc} */
@@ -169,10 +176,27 @@ public class NowPlayingPlugin extends Plugin implements EventPlugin,
     private void addPlugin(final Plugin target) {
         if (target instanceof MediaSource) {
             sources.add((MediaSource) target);
+            addSourceToOrder((MediaSource) target);
         }
         
         if (target instanceof MediaSourceManager) {
             sources.addAll(((MediaSourceManager) target).getSources());
+            
+            for (MediaSource source : ((MediaSourceManager) target).getSources()) {
+                addSourceToOrder(source);
+            }
+        }
+    }
+    
+    /**
+     * Checks to see if the specified media source needs to be added to our
+     * order list, and adds it if neccessary.
+     *
+     * @param source The media source to be tested
+     */
+    private void addSourceToOrder(final MediaSource source) {
+        if (!order.contains(source.getName())) {
+            order.add(source.getName());
         }
     }
     
@@ -219,6 +243,8 @@ public class NowPlayingPlugin extends Plugin implements EventPlugin,
     public MediaSource getBestSource() {
         MediaSource paused = null;
         
+        Collections.sort(sources, new MediaSourceComparator(order));
+        
         for (final MediaSource source : sources) {
             if (source.isRunning()) {
                 if (source.isPlaying()) {