And the OSD plugin

osd/src/com/dmdirc/addons/osd/OsdManager.java

@@ -23,39 +23,80 @@
 package com.dmdirc.addons.osd;
 
 import com.dmdirc.addons.ui_swing.UIUtilities;
+import com.dmdirc.addons.ui_swing.injection.MainWindow;
+import com.dmdirc.config.prefs.CategoryChangeListener;
+import com.dmdirc.config.prefs.PluginPreferencesCategory;
+import com.dmdirc.config.prefs.PreferencesCategory;
+import com.dmdirc.config.prefs.PreferencesDialogModel;
+import com.dmdirc.config.prefs.PreferencesInterface;
+import com.dmdirc.config.prefs.PreferencesSetting;
+import com.dmdirc.config.prefs.PreferencesType;
+import com.dmdirc.config.prefs.SettingChangeListener;
+import com.dmdirc.events.ClientPrefsOpenedEvent;
 import com.dmdirc.interfaces.config.IdentityController;
+import com.dmdirc.plugins.PluginDomain;
 import com.dmdirc.plugins.PluginInfo;
 import com.dmdirc.ui.messages.ColourManager;
+import com.dmdirc.ui.messages.ColourManagerFactory;
+import com.dmdirc.util.validators.NumericalValidator;
+import com.dmdirc.util.validators.OptionalValidator;
 
 import java.awt.Window;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Map;
 import java.util.Queue;
 
+import javax.inject.Inject;
+
+import net.engio.mbassy.listener.Handler;
+
 /**
  * Class to manage OSD Windows.
  */
-public class OsdManager {
+public class OsdManager implements CategoryChangeListener, PreferencesInterface,
+        SettingChangeListener {
 
     /** The frame the OSD will be associated with. */
     private final Window mainFrame;
-    /** The controller to read/write settings with. */
-    private final IdentityController identityController;
-    /** The colour manager to use to parse colours. */
-    private final ColourManager colourManager;
     /** List of OSD Windows. */
     private final List<OsdWindow> windowList = new ArrayList<>();
     /** List of messages to be queued. */
     private final Queue<QueuedMessage> windowQueue = new LinkedList<>();
     /** This plugin's settings domain. */
     private final String domain;
+    /** Config OSD Window. */
+    private OsdWindow osdWindow;
+    /** X-axis position of OSD. */
+    private int x;
+    /** Y-axis potion of OSD. */
+    private int y;
+    /** Setting objects with registered change listeners. */
+    private PreferencesSetting fontSizeSetting;
+    private PreferencesSetting backgroundSetting;
+    private PreferencesSetting foregroundSetting;
+    private PreferencesSetting widthSetting;
+    private PreferencesSetting timeoutSetting;
+    private PreferencesSetting maxWindowsSetting;
+    /** This plugin's plugin info. */
+    private final PluginInfo pluginInfo;
+    /** The controller to read/write settings with. */
+    private final IdentityController identityController;
+    /** The manager to use to parse colours. */
+    private final ColourManager colourManager;
 
-    public OsdManager(final Window mainFrame, final IdentityController identityController,
-            final ColourManager colourManager, final PluginInfo pluginInfo) {
+    @Inject
+    public OsdManager(
+            @MainWindow final Window mainFrame,
+            final IdentityController identityController,
+            final ColourManagerFactory colourManagerFactory,
+            @PluginDomain(OsdPlugin.class) final PluginInfo pluginInfo) {
         this.mainFrame = mainFrame;
         this.identityController = identityController;
-        this.colourManager = colourManager;
+        this.colourManager = colourManagerFactory.getColourManager(identityController.getGlobalConfiguration());
+        this.pluginInfo = pluginInfo;
         this.domain = pluginInfo.getDomain();
     }
 
@@ -97,8 +138,9 @@ public class OsdManager {
      * @param message Text to display in the OSD window.
      */
     private synchronized void displayWindow(final int timeout, final String message) {
-        final OsdPolicy policy = OsdPolicy.valueOf(identityController.getGlobalConfiguration()
-                .getOption(domain, "newbehaviour").toUpperCase());
+        final OsdPolicy policy = OsdPolicy.valueOf(
+                identityController.getGlobalConfiguration().getOption(domain, "newbehaviour")
+                        .toUpperCase());
         final int startY = identityController.getGlobalConfiguration()
                 .getOptionInt(domain, "locationY");
 
@@ -167,4 +209,116 @@ public class OsdManager {
         return windowList.size();
     }
 
+    @Handler
+    public void showConfig(final ClientPrefsOpenedEvent event) {
+        final PreferencesDialogModel manager = event.getModel();
+        x = identityController.getGlobalConfiguration()
+                .getOptionInt(domain, "locationX");
+        y = identityController.getGlobalConfiguration()
+                .getOptionInt(domain, "locationY");
+
+        final PreferencesCategory category = new PluginPreferencesCategory(
+                pluginInfo, "OSD",
+                "General configuration for OSD plugin.", "category-osd");
+
+        fontSizeSetting = new PreferencesSetting(PreferencesType.INTEGER,
+                domain, "fontSize", "Font size", "Changes the font " + "size of the OSD",
+                manager.getConfigManager(),
+                manager.getIdentity()).registerChangeListener(this);
+        backgroundSetting = new PreferencesSetting(PreferencesType.COLOUR,
+                domain, "bgcolour", "Background colour",
+                "Background colour for the OSD", manager.getConfigManager(),
+                manager.getIdentity()).registerChangeListener(this);
+        foregroundSetting = new PreferencesSetting(PreferencesType.COLOUR,
+                domain, "fgcolour", "Foreground colour",
+                "Foreground colour for the OSD", manager.getConfigManager(),
+                manager.getIdentity()).registerChangeListener(this);
+        widthSetting = new PreferencesSetting(PreferencesType.INTEGER,
+                domain, "width", "OSD Width", "Width of the OSD Window",
+                manager.getConfigManager(), manager.getIdentity())
+                .registerChangeListener(this);
+        timeoutSetting = new PreferencesSetting(PreferencesType.OPTIONALINTEGER,
+                new OptionalValidator(new NumericalValidator(1, Integer.MAX_VALUE)),
+                domain, "timeout", "Timeout", "Length of time in "
+                + "seconds before the OSD window closes", manager.getConfigManager(),
+                manager.getIdentity());
+        maxWindowsSetting = new PreferencesSetting(PreferencesType.OPTIONALINTEGER,
+                new OptionalValidator(new NumericalValidator(1, Integer.MAX_VALUE)),
+                domain, "maxWindows", "Maximum open windows",
+                "Maximum number of OSD windows that will be displayed at any given time",
+                manager.getConfigManager(), manager.getIdentity());
+
+        category.addSetting(fontSizeSetting);
+        category.addSetting(backgroundSetting);
+        category.addSetting(foregroundSetting);
+        category.addSetting(widthSetting);
+        category.addSetting(timeoutSetting);
+        category.addSetting(maxWindowsSetting);
+
+        final Map<String, String> posOptions = new HashMap<>();
+
+        //Populate policy MULTICHOICE
+        for (OsdPolicy policy : OsdPolicy.values()) {
+            posOptions.put(policy.name(), policy.getDescription());
+        }
+
+        category.addSetting(new PreferencesSetting(domain, "newbehaviour",
+                "New window policy", "What to do when an OSD Window "
+                + "is opened when there are other, existing windows open",
+                posOptions, manager.getConfigManager(), manager.getIdentity()));
+
+        category.addChangeListener(this);
+        manager.getCategory("Plugins").addSubCategory(category);
+        manager.registerSaveListener(this);
+    }
+
+    @Override
+    public void categorySelected(final PreferencesCategory category) {
+        osdWindow = new OsdWindow(mainFrame, identityController, this, colourManager,
+                -1, "Please drag this OSD to position", true, x, y, domain);
+        osdWindow.setBackgroundColour(backgroundSetting.getValue());
+        osdWindow.setForegroundColour(foregroundSetting.getValue());
+        osdWindow.setFontSize(Integer.parseInt(fontSizeSetting.getValue()));
+    }
+
+    @Override
+    public void categoryDeselected(final PreferencesCategory category) {
+        x = osdWindow.getLocationOnScreen().x;
+        y = osdWindow.getLocationOnScreen().y;
+
+        osdWindow.dispose();
+        osdWindow = null;
+    }
+
+    @Override
+    public void save() {
+        identityController.getUserSettings().setOption(domain, "locationX", x);
+        identityController.getUserSettings().setOption(domain, "locationY", y);
+    }
+
+    @Override
+    public void settingChanged(final PreferencesSetting setting) {
+        if (osdWindow == null) {
+            // They've changed categories but are somehow poking settings.
+            // Ignore the request.
+            return;
+        }
+
+        if (setting.equals(fontSizeSetting)) {
+            osdWindow.setFontSize(Integer.parseInt(setting.getValue()));
+        } else if (setting.equals(backgroundSetting)) {
+            osdWindow.setBackgroundColour(setting.getValue());
+        } else if (setting.equals(foregroundSetting)) {
+            osdWindow.setForegroundColour(setting.getValue());
+        } else if (setting.equals(widthSetting)) {
+            int width = 500;
+            try {
+                width = Integer.parseInt(setting.getValue());
+            } catch (NumberFormatException e) {
+                //Ignore
+            }
+            osdWindow.setSize(width, osdWindow.getHeight());
+        }
+    }
+
 }

osd/src/com/dmdirc/addons/osd/OsdModule.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2006-2015 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.osd;
+
+import com.dmdirc.addons.ui_swing.injection.SwingModule;
+import com.dmdirc.plugins.PluginDomain;
+import com.dmdirc.plugins.PluginInfo;
+
+import dagger.Module;
+import dagger.Provides;
+
+/**
+ * Dependency injection module for the OSD plugin.
+ */
+@Module(injects = {OsdManager.class, OsdCommand.class}, addsTo = SwingModule.class)
+public class OsdModule {
+
+    private final PluginInfo pluginInfo;
+
+    public OsdModule(final PluginInfo pluginInfo) {
+        this.pluginInfo = pluginInfo;
+    }
+
+    @Provides
+    @PluginDomain(OsdPlugin.class)
+    public PluginInfo getPluginInfo() {
+        return pluginInfo;
+    }
+}

osd/src/com/dmdirc/addons/osd/OsdPlugin.java

@@ -22,193 +22,29 @@
 
 package com.dmdirc.addons.osd;
 
-import com.dmdirc.addons.ui_swing.SwingController;
-import com.dmdirc.config.prefs.CategoryChangeListener;
-import com.dmdirc.config.prefs.PluginPreferencesCategory;
-import com.dmdirc.config.prefs.PreferencesCategory;
-import com.dmdirc.config.prefs.PreferencesDialogModel;
-import com.dmdirc.config.prefs.PreferencesInterface;
-import com.dmdirc.config.prefs.PreferencesSetting;
-import com.dmdirc.config.prefs.PreferencesType;
-import com.dmdirc.config.prefs.SettingChangeListener;
-import com.dmdirc.interfaces.CommandController;
-import com.dmdirc.interfaces.config.IdentityController;
 import com.dmdirc.plugins.Exported;
 import com.dmdirc.plugins.PluginInfo;
 import com.dmdirc.plugins.implementations.BaseCommandPlugin;
-import com.dmdirc.ui.messages.ColourManager;
-import com.dmdirc.util.validators.NumericalValidator;
-import com.dmdirc.util.validators.OptionalValidator;
 
-import java.awt.Frame;
-import java.util.HashMap;
-import java.util.Map;
+import dagger.ObjectGraph;
 
 /**
  * Allows the user to display on-screen-display messages.
  */
-public class OsdPlugin extends BaseCommandPlugin implements
-        CategoryChangeListener, PreferencesInterface, SettingChangeListener {
+public class OsdPlugin extends BaseCommandPlugin {
 
-    /** Config OSD Window. */
-    private OsdWindow osdWindow;
-    /** The OSD Manager that this plugin is using. */
-    private final OsdManager osdManager;
-    /** X-axis position of OSD. */
-    private int x;
-    /** Y-axis potion of OSD. */
-    private int y;
-    /** Setting objects with registered change listeners. */
-    private PreferencesSetting fontSizeSetting;
-    private PreferencesSetting backgroundSetting;
-    private PreferencesSetting foregroundSetting;
-    private PreferencesSetting widthSetting;
-    private PreferencesSetting timeoutSetting;
-    private PreferencesSetting maxWindowsSetting;
-    /** This plugin's plugin info. */
-    private final PluginInfo pluginInfo;
-    /** The controller to read/write settings with. */
-    private final IdentityController identityController;
-    /** The manager to use to parse colours. */
-    private final ColourManager colourManager;
-    /** The frame that the OSDs will be associated with. */
-    private final Frame mainFrame;
-    /** This plugin's settings domain. */
-    private final String domain;
-
-    /**
-     * Creates a new instance of this plugin.
-     *
-     * @param swingController    The controller that owns this plugin.
-     * @param pluginInfo         This plugin's plugin info
-     * @param identityController The controller to use to read and write settings.
-     * @param commandController  Command controller to register commands
-     * @param colourManager      The manager to use to parse colours.
-     */
-    public OsdPlugin(
-            final SwingController swingController,
-            final PluginInfo pluginInfo,
-            final IdentityController identityController,
-            final CommandController commandController,
-            final ColourManager colourManager) {
-        this.pluginInfo = pluginInfo;
-        this.identityController = identityController;
-        this.colourManager = colourManager;
-        this.mainFrame = swingController.getMainFrame();
-        this.domain = pluginInfo.getDomain();
-        osdManager = new OsdManager(mainFrame, identityController, colourManager, pluginInfo);
-        registerCommand(new OsdCommand(commandController, osdManager), OsdCommand.INFO);
-    }
-
-    @Override
-    public void showConfig(final PreferencesDialogModel manager) {
-        x = identityController.getGlobalConfiguration()
-                .getOptionInt(domain, "locationX");
-        y = identityController.getGlobalConfiguration()
-                .getOptionInt(domain, "locationY");
-
-        final PreferencesCategory category = new PluginPreferencesCategory(
-                pluginInfo, "OSD",
-                "General configuration for OSD plugin.", "category-osd");
-
-        fontSizeSetting = new PreferencesSetting(PreferencesType.INTEGER,
-                domain, "fontSize", "Font size", "Changes the font " + "size of the OSD",
-                manager.getConfigManager(),
-                manager.getIdentity()).registerChangeListener(this);
-        backgroundSetting = new PreferencesSetting(PreferencesType.COLOUR,
-                domain, "bgcolour", "Background colour",
-                "Background colour for the OSD", manager.getConfigManager(),
-                manager.getIdentity()).registerChangeListener(this);
-        foregroundSetting = new PreferencesSetting(PreferencesType.COLOUR,
-                domain, "fgcolour", "Foreground colour",
-                "Foreground colour for the OSD", manager.getConfigManager(),
-                manager.getIdentity()).registerChangeListener(this);
-        widthSetting = new PreferencesSetting(PreferencesType.INTEGER,
-                domain, "width", "OSD Width", "Width of the OSD Window",
-                manager.getConfigManager(), manager.getIdentity())
-                .registerChangeListener(this);
-        timeoutSetting = new PreferencesSetting(PreferencesType.OPTIONALINTEGER,
-                new OptionalValidator(new NumericalValidator(1, Integer.MAX_VALUE)),
-                domain, "timeout", "Timeout", "Length of time in "
-                + "seconds before the OSD window closes", manager.getConfigManager(),
-                manager.getIdentity());
-        maxWindowsSetting = new PreferencesSetting(PreferencesType.OPTIONALINTEGER,
-                new OptionalValidator(new NumericalValidator(1, Integer.MAX_VALUE)),
-                domain, "maxWindows", "Maximum open windows",
-                "Maximum number of OSD windows that will be displayed at any given time",
-                manager.getConfigManager(), manager.getIdentity());
-
-        category.addSetting(fontSizeSetting);
-        category.addSetting(backgroundSetting);
-        category.addSetting(foregroundSetting);
-        category.addSetting(widthSetting);
-        category.addSetting(timeoutSetting);
-        category.addSetting(maxWindowsSetting);
-
-        final Map<String, String> posOptions = new HashMap<>();
-
-        //Populate policy MULTICHOICE
-        for (OsdPolicy policy : OsdPolicy.values()) {
-            posOptions.put(policy.name(), policy.getDescription());
-        }
 
-        category.addSetting(new PreferencesSetting(domain, "newbehaviour",
-                "New window policy", "What to do when an OSD Window "
-                + "is opened when there are other, existing windows open",
-                posOptions, manager.getConfigManager(), manager.getIdentity()));
-
-        category.addChangeListener(this);
-        manager.getCategory("Plugins").addSubCategory(category);
-        manager.registerSaveListener(this);
-    }
-
-    @Override
-    public void categorySelected(final PreferencesCategory category) {
-        osdWindow = new OsdWindow(mainFrame, identityController, osdManager, colourManager,
-                -1, "Please drag this OSD to position", true, x, y, domain);
-        osdWindow.setBackgroundColour(backgroundSetting.getValue());
-        osdWindow.setForegroundColour(foregroundSetting.getValue());
-        osdWindow.setFontSize(Integer.parseInt(fontSizeSetting.getValue()));
-    }
-
-    @Override
-    public void categoryDeselected(final PreferencesCategory category) {
-        x = osdWindow.getLocationOnScreen().x;
-        y = osdWindow.getLocationOnScreen().y;
-
-        osdWindow.dispose();
-        osdWindow = null;
-    }
+    /** The OSD Manager that this plugin is using. */
+    private OsdManager osdManager;
 
     @Override
-    public void save() {
-        identityController.getUserSettings().setOption(domain, "locationX", x);
-        identityController.getUserSettings().setOption(domain, "locationY", y);
-    }
+    public void load(final PluginInfo pluginInfo, final ObjectGraph graph) {
+        super.load(pluginInfo, graph);
 
-    @Override
-    public void settingChanged(final PreferencesSetting setting) {
-        if (osdWindow == null) {
-            // They've changed categories but are somehow poking settings.
-            // Ignore the request.
-            return;
-        }
+        setObjectGraph(graph.plus(new OsdModule(pluginInfo)));
+        osdManager = getObjectGraph().get(OsdManager.class);
 
-        if (setting.equals(fontSizeSetting)) {
-            osdWindow.setFontSize(Integer.parseInt(setting.getValue()));
-        } else if (setting.equals(backgroundSetting)) {
-            osdWindow.setBackgroundColour(setting.getValue());
-        } else if (setting.equals(foregroundSetting)) {
-            osdWindow.setForegroundColour(setting.getValue());
-        } else if (setting.equals(widthSetting)) {
-            int width = 500;
-            try {
-                width = Integer.parseInt(setting.getValue());
-            } catch (NumberFormatException e) {
-                //Ignore
-            }
-            osdWindow.setSize(width, osdWindow.getHeight());
-        }
+        registerCommand(OsdCommand.class, OsdCommand.INFO);
     }
 
     /**