Start injecting TextPane dependencies.

Bundle them up in a static class to avoid having to pass a million deps
around in each and every subclass.

Change-Id: I581e39f9da6f7a4b79ab69d043de4c81111e9b52
Reviewed-on: http://gerrit.dmdirc.com/3064
Reviewed-by: Greg Holmes <greg@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

src/com/dmdirc/addons/ui_swing/components/frames/ChannelFrame.java

@@ -78,12 +78,12 @@ public final class ChannelFrame extends InputTextFrame implements ActionListener
      * Creates a new instance of ChannelFrame. Sets up callbacks and handlers,
      * and default options for the form.
      *
+     * @param deps The dependencies required by text frames.
      * @param owner The Channel object that owns this frame
-     * @param controller Swing controller
      */
-    public ChannelFrame(final SwingController controller, @Unbound final Channel owner) {
-        super(controller, owner);
-        this.controller = controller;
+    public ChannelFrame(final TextFrameDependencies deps, @Unbound final Channel owner) {
+        super(deps, owner);
+        this.controller = getController();
 
         initComponents();
 

src/com/dmdirc/addons/ui_swing/components/frames/ComponentFrame.java

@@ -52,14 +52,14 @@ public class ComponentFrame extends TextFrame {
     /**
      * Creates a new instance of CustomFrame.
      *
+     * @param deps The dependencies required by text frames.
      * @param owner The frame container that owns this frame
-     * @param controller Swing controller
      */
     public ComponentFrame(
-            final SwingController controller,
+            final TextFrameDependencies deps,
             @Unbound final FrameContainer owner) {
-        super(owner, controller);
-        this.controller = controller;
+        super(owner, deps);
+        this.controller = getController();
         this.owner = owner;
         initComponents();
     }

src/com/dmdirc/addons/ui_swing/components/frames/ComponentInputFrame.java

@@ -52,13 +52,13 @@ public class ComponentInputFrame extends InputTextFrame {
     /**
      * Creates a new instance of CustomInputFrame.
      *
+     * @param deps The dependencies required by text frames.
      * @param owner The frame container that owns this frame
-     * @param controller Swing controller
      */
-    public ComponentInputFrame(final SwingController controller,
+    public ComponentInputFrame(final TextFrameDependencies deps,
             final WritableFrameContainer owner) {
-        super(controller, owner);
-        this.controller = controller;
+        super(deps, owner);
+        this.controller = getController();
         this.owner = owner;
         initComponents();
     }

src/com/dmdirc/addons/ui_swing/components/frames/CustomFrame.java

@@ -22,7 +22,6 @@
 package com.dmdirc.addons.ui_swing.components.frames;
 
 import com.dmdirc.FrameContainer;
-import com.dmdirc.addons.ui_swing.SwingController;
 import com.dmdirc.commandparser.PopupType;
 import com.dmdirc.util.annotations.factory.Factory;
 import com.dmdirc.util.annotations.factory.Unbound;
@@ -47,13 +46,13 @@ public class CustomFrame extends TextFrame {
     /**
      * Creates a new instance of CustomFrame.
      *
+     * @param deps The dependencies required by text frames.
      * @param owner The frame container that owns this frame
-     * @param controller Swing controller
      */
     public CustomFrame(
-            final SwingController controller,
+            final TextFrameDependencies deps,
             @Unbound final FrameContainer owner) {
-        super(owner, controller);
+        super(owner, deps);
 
         initComponents();
     }

src/com/dmdirc/addons/ui_swing/components/frames/CustomInputFrame.java

@@ -23,7 +23,6 @@
 package com.dmdirc.addons.ui_swing.components.frames;
 
 import com.dmdirc.WritableFrameContainer;
-import com.dmdirc.addons.ui_swing.SwingController;
 import com.dmdirc.commandparser.PopupType;
 import com.dmdirc.util.annotations.factory.Factory;
 import com.dmdirc.util.annotations.factory.Unbound;
@@ -49,13 +48,13 @@ public class CustomInputFrame extends InputTextFrame {
     /**
      * Creates a new instance of CustomInputFrame.
      *
+     * @param deps The dependencies required by text frames.
      * @param owner The frame container that owns this frame
-     * @param controller Swing controller
      */
     public CustomInputFrame(
-            final SwingController controller,
+            final TextFrameDependencies deps,
             @Unbound final WritableFrameContainer owner) {
-        super(controller, owner);
+        super(deps, owner);
 
         initComponents();
     }

src/com/dmdirc/addons/ui_swing/components/frames/InputTextFrame.java

@@ -84,14 +84,15 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     /**
      * Creates a new instance of InputFrame.
      *
-     * @param controller Swing controller
+     * @param deps The dependencies required by text frames.
      * @param owner WritableFrameContainer owning this frame.
      */
-    public InputTextFrame(final SwingController controller,
+    public InputTextFrame(
+            final TextFrameDependencies deps,
             final WritableFrameContainer owner) {
-        super(owner, controller);
+        super(owner, deps);
 
-        this.controller = controller;
+        this.controller = getController();
         initComponents();
 
         final AggregateConfigProvider config = owner.getConfigManager();

src/com/dmdirc/addons/ui_swing/components/frames/ServerFrame.java

@@ -65,13 +65,13 @@ public final class ServerFrame extends InputTextFrame implements
     /**
      * Creates a new ServerFrame.
      *
+     * @param deps The dependencies required by text frames.
      * @param owner Parent Frame container
-     * @param controller Swing controller
      */
-    public ServerFrame(final SwingController controller, @Unbound final Server owner) {
-        super(controller, owner);
+    public ServerFrame(final TextFrameDependencies deps, @Unbound final Server owner) {
+        super(deps, owner);
 
-        this.controller = controller;
+        this.controller = getController();
         initComponents();
 
         owner.addCertificateProblemListener(this);

src/com/dmdirc/addons/ui_swing/components/frames/TextFrame.java

@@ -25,6 +25,7 @@ package com.dmdirc.addons.ui_swing.components.frames;
 import com.dmdirc.FrameContainer;
 import com.dmdirc.actions.ActionManager;
 import com.dmdirc.actions.CoreActionType;
+import com.dmdirc.addons.ui_swing.MainFrame;
 import com.dmdirc.addons.ui_swing.SwingController;
 import com.dmdirc.addons.ui_swing.UIUtilities;
 import com.dmdirc.addons.ui_swing.actions.ChannelCopyAction;
@@ -40,6 +41,7 @@ import com.dmdirc.addons.ui_swing.textpane.TextPane;
 import com.dmdirc.addons.ui_swing.textpane.TextPaneControlCodeCopyAction;
 import com.dmdirc.addons.ui_swing.textpane.TextPaneCopyAction;
 import com.dmdirc.addons.ui_swing.textpane.TextPaneEndAction;
+import com.dmdirc.addons.ui_swing.textpane.TextPaneFactory;
 import com.dmdirc.addons.ui_swing.textpane.TextPaneHomeAction;
 import com.dmdirc.addons.ui_swing.textpane.TextPaneListener;
 import com.dmdirc.addons.ui_swing.textpane.TextPanePageDownAction;
@@ -50,6 +52,7 @@ import com.dmdirc.commandparser.PopupMenuItem;
 import com.dmdirc.commandparser.PopupType;
 import com.dmdirc.commandparser.parsers.CommandParser;
 import com.dmdirc.commandparser.parsers.GlobalCommandParser;
+import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.interfaces.FrameCloseListener;
 import com.dmdirc.interfaces.config.AggregateConfigProvider;
 import com.dmdirc.interfaces.config.ConfigChangeListener;
@@ -57,11 +60,15 @@ import com.dmdirc.interfaces.ui.InputWindow;
 import com.dmdirc.interfaces.ui.Window;
 import com.dmdirc.parser.common.ChannelJoinRequest;
 import com.dmdirc.ui.IconManager;
+import com.dmdirc.ui.core.util.URLHandler;
+import com.dmdirc.util.URLBuilder;
 
 import java.awt.Point;
 import java.awt.event.KeyEvent;
 import java.awt.event.MouseEvent;
 
+import javax.inject.Inject;
+import javax.inject.Provider;
 import javax.swing.JComponent;
 import javax.swing.JMenu;
 import javax.swing.JMenuItem;
@@ -95,6 +102,16 @@ public abstract class TextFrame extends JPanel implements Window,
     private final CommandParser commandParser;
     /** Swing controller. */
     private final SwingController controller;
+    /** Main frame to use to activate/deactivate windows. */
+    private final Provider<MainFrame> mainFrame;
+    /** Manager to use for building popups. */
+    private final PopupManager popupManager;
+    /** Handler to use to open URLs. */
+    private final URLHandler urlHandler;
+    /** Builder to use to construct URLs. */
+    private final URLBuilder urlBuilder;
+    /** Controller to use for commands. */
+    private final CommandController commandController;
     /** Boolean to determine if this frame should be popped out of main client. */
     private boolean popout;
     /**
@@ -109,13 +126,20 @@ public abstract class TextFrame extends JPanel implements Window,
      * Creates a new instance of Frame.
      *
      * @param owner FrameContainer owning this frame.
-     * @param controller Swing controller
+     * @param deps Collection of TextPane dependencies.
      */
-    public TextFrame(final FrameContainer owner,
-            final SwingController controller) {
+    public TextFrame(
+            final FrameContainer owner,
+            final TextFrameDependencies deps) {
         super();
-        this.controller = controller;
-        frameParent = owner;
+
+        this.controller = deps.controller;
+        this.mainFrame = deps.mainFrame;
+        this.popupManager = deps.popupManager;
+        this.urlBuilder = deps.urlBuilder;
+        this.urlHandler = deps.urlHandler;
+        this.commandController = deps.commandController;
+        this.frameParent = owner;
 
         final AggregateConfigProvider config = owner.getConfigManager();
 
@@ -124,7 +148,7 @@ public abstract class TextFrame extends JPanel implements Window,
 
         commandParser = findCommandParser();
 
-        initComponents();
+        initComponents(deps.textPaneFactory);
         setFocusable(true);
 
         getTextPane().addTextPaneListener(this);
@@ -157,7 +181,7 @@ public abstract class TextFrame extends JPanel implements Window,
 
         if (localParser == null) {
             localParser = new GlobalCommandParser(frameParent.getConfigManager(),
-                    controller.getCommandController());
+                    commandController);
         }
 
         return localParser;
@@ -177,18 +201,16 @@ public abstract class TextFrame extends JPanel implements Window,
         this.popout = popout;
         if (popout) {
             popoutPlaceholder = new DesktopPlaceHolderFrame();
-            popoutFrame = new DesktopWindowFrame(this)  ;
+            popoutFrame = new DesktopWindowFrame(this);
             popoutFrame.display();
         } else if (popoutFrame != null) {
             popoutPlaceholder = null;
             popoutFrame.dispose();
             popoutFrame = null;
         }
-        // Call setActiveFrame again so the contents of the frame manager
-        // are updated.
-        if (equals(controller.getMainFrame()
-                .getActiveFrame())) {
-            controller.getMainFrame().setActiveFrame(this);
+        // Call setActiveFrame again so the contents of the frame manager are updated.
+        if (equals(mainFrame.get().getActiveFrame())) {
+            mainFrame.get().setActiveFrame(this);
         }
     }
 
@@ -233,8 +255,8 @@ public abstract class TextFrame extends JPanel implements Window,
     /**
      * Initialises the components for this frame.
      */
-    private void initComponents() {
-        setTextPane(new TextPane(getController().getDomain(), getController().getUrlBuilder(), this));
+    private void initComponents(final TextPaneFactory textPaneFactory) {
+        setTextPane(textPaneFactory.getTextPane(this));
 
         searchBar = new SwingSearchBar(this);
         searchBar.setVisible(false);
@@ -347,7 +369,7 @@ public abstract class TextFrame extends JPanel implements Window,
                 if (ActionManager.getActionManager().triggerEvent(
                         CoreActionType.LINK_URL_CLICKED, null, this,
                         clickType.getValue())) {
-                    controller.getUrlHandler().launchApp(clickType.getValue());
+                    urlHandler.launchApp(clickType.getValue());
                 }
                 break;
             case NICKNAME:
@@ -482,8 +504,7 @@ public abstract class TextFrame extends JPanel implements Window,
 
         if (type != null) {
             popupMenu = (JPopupMenu) populatePopupMenu(popupMenu,
-                    new PopupManager(controller.getCommandController()).getMenu(type, getContainer()
-                    .getConfigManager()), arguments);
+                    popupManager.getMenu(type, getContainer().getConfigManager()), arguments);
         }
 
         return popupMenu;
@@ -528,8 +549,7 @@ public abstract class TextFrame extends JPanel implements Window,
     /** {@inheritDoc} */
     @Override
     public void configChanged(final String domain, final String key) {
-        if (getContainer().getConfigManager() == null
-                || getTextPane() == null) {
+        if (getContainer().getConfigManager() == null || getTextPane() == null) {
             return;
         }
 
@@ -548,6 +568,7 @@ public abstract class TextFrame extends JPanel implements Window,
 
     /** {@inheritDoc} */
     @Override
+    @Deprecated
     public SwingController getController() {
         return controller;
     }
@@ -558,7 +579,7 @@ public abstract class TextFrame extends JPanel implements Window,
      * @return This frame's IconManager
      */
     public IconManager getIconManager() {
-        return getContainer().getIconManager(controller.getUrlBuilder());
+        return getContainer().getIconManager(urlBuilder);
     }
 
     /**
@@ -578,4 +599,40 @@ public abstract class TextFrame extends JPanel implements Window,
         frameParent.getConfigManager().removeListener(this);
         frameParent.removeCloseListener(this);
     }
+
+    /**
+     * Bundle of dependencies required by {@link TextFrame}.
+     *
+     * <p>Because of the number of dependencies and the amount of subclassing, collect the
+     * dependencies together here so they can be easily modified without having to modify all
+     * subclasses.
+     */
+    public static class TextFrameDependencies {
+
+        private final TextPaneFactory textPaneFactory;
+        private final SwingController controller;
+        private final Provider<MainFrame> mainFrame;
+        private final PopupManager popupManager;
+        private final URLHandler urlHandler;
+        private final URLBuilder urlBuilder;
+        private final CommandController commandController;
+
+        @Inject
+        public TextFrameDependencies(
+                final TextPaneFactory textPaneFactory,
+                final SwingController controller,
+                final Provider<MainFrame> mainFrame,
+                final PopupManager popupManager,
+                final URLHandler urlHandler,
+                final URLBuilder urlBuilder,
+                final CommandController commandController) {
+            this.textPaneFactory = textPaneFactory;
+            this.controller = controller;
+            this.mainFrame = mainFrame;
+            this.popupManager = popupManager;
+            this.urlHandler = urlHandler;
+            this.urlBuilder = urlBuilder;
+            this.commandController = commandController;
+        }
+    }
 }

src/com/dmdirc/addons/ui_swing/textpane/TextPane.java

@@ -24,6 +24,7 @@ package com.dmdirc.addons.ui_swing.textpane;
 
 import com.dmdirc.addons.ui_swing.UIUtilities;
 import com.dmdirc.addons.ui_swing.components.frames.TextFrame;
+import com.dmdirc.addons.ui_swing.injection.SwingModule.SwingSettingsDomain;
 import com.dmdirc.interfaces.config.ConfigChangeListener;
 import com.dmdirc.interfaces.ui.Window;
 import com.dmdirc.ui.messages.IRCDocument;
@@ -31,6 +32,8 @@ import com.dmdirc.ui.messages.IRCDocumentListener;
 import com.dmdirc.ui.messages.LinePosition;
 import com.dmdirc.ui.messages.Styliser;
 import com.dmdirc.util.URLBuilder;
+import com.dmdirc.util.annotations.factory.Factory;
+import com.dmdirc.util.annotations.factory.Unbound;
 
 import java.awt.Color;
 import java.awt.Point;
@@ -57,6 +60,7 @@ import org.jdesktop.jxlayer.JXLayer;
 /**
  * Styled, scrollable text pane.
  */
+@Factory(inject = true, singleton = true)
 public final class TextPane extends JComponent implements MouseWheelListener,
         AdjustmentListener, IRCDocumentListener, ConfigChangeListener {
 
@@ -92,7 +96,10 @@ public final class TextPane extends JComponent implements MouseWheelListener,
      * @param urlBuilder The builder to use to construct URLs for resources.
      * @param frame Parent Frame
      */
-    public TextPane(final String configDomain, final URLBuilder urlBuilder, final TextFrame frame) {
+    public TextPane(
+            @SuppressWarnings("qualifiers") @SwingSettingsDomain final String configDomain,
+            final URLBuilder urlBuilder,
+            @Unbound final TextFrame frame) {
         super();
         this.frame = frame;
         this.configDomain = configDomain;