Switch to using component frames.

Change-Id: Ibbed782aaf570bdac2641842ad4bebbc7e285404
Reviewed-on: http://gerrit.dmdirc.com/2050
Reviewed-by: Chris Smith <chris@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

src/com/dmdirc/addons/dcc/DCCPlugin.java

@@ -32,10 +32,9 @@ import com.dmdirc.addons.dcc.io.DCC;
 import com.dmdirc.addons.dcc.io.DCCChat;
 import com.dmdirc.addons.dcc.io.DCCTransfer;
 import com.dmdirc.addons.dcc.kde.KFileChooser;
-import com.dmdirc.addons.dcc.ui.PlaceholderWindow;
-import com.dmdirc.addons.dcc.ui.TransferWindow;
 import com.dmdirc.addons.ui_swing.SwingController;
 import com.dmdirc.addons.ui_swing.SwingWindowFactory;
+import com.dmdirc.addons.ui_swing.components.frames.ComponentFrame;
 import com.dmdirc.config.Identity;
 import com.dmdirc.config.IdentityManager;
 import com.dmdirc.config.prefs.PluginPreferencesCategory;
@@ -81,10 +80,10 @@ public final class DCCPlugin extends BasePlugin implements ActionListener {
         final SwingWindowFactory factory = controller.getWindowFactory();
         factory.registerImplementation(new HashSet<String>(Arrays.asList(
                 "com.dmdirc.addons.dcc.ui.PlaceholderPanel")),
-                PlaceholderWindow.class);
+                ComponentFrame.class);
         factory.registerImplementation(new HashSet<String>(Arrays.asList(
                 "com.dmdirc.addons.dcc.ui.TransferPanel")),
-                TransferWindow.class);
+                ComponentFrame.class);
     }
 
     /**

src/com/dmdirc/addons/dcc/PlaceholderContainer.java

@@ -24,8 +24,8 @@ package com.dmdirc.addons.dcc;
 
 import com.dmdirc.FrameContainer;
 import com.dmdirc.Server;
-import com.dmdirc.addons.dcc.ui.PlaceholderWindow;
 import com.dmdirc.addons.ui_swing.SwingController;
+import com.dmdirc.addons.ui_swing.components.frames.ComponentFrame;
 import com.dmdirc.addons.ui_swing.dialogs.StandardQuestionDialog;
 import com.dmdirc.config.IdentityManager;
 import com.dmdirc.plugins.PluginManager;
@@ -47,7 +47,7 @@ public class PlaceholderContainer extends FrameContainer {
      * @param plugin The plugin which owns this placeholder
      */
     public PlaceholderContainer(final DCCPlugin plugin) {
-        super("dcc", "DCCs", "DCCs", PlaceholderWindow.class,
+        super("dcc", "DCCs", "DCCs", ComponentFrame.class,
                 IdentityManager.getGlobalConfig(),
                 Arrays.asList("com.dmdirc.addons.dcc.ui.PlaceholderPanel"));
 

src/com/dmdirc/addons/dcc/TransferContainer.java

@@ -29,7 +29,7 @@ import com.dmdirc.actions.ActionManager;
 import com.dmdirc.addons.dcc.actions.DCCActions;
 import com.dmdirc.addons.dcc.io.DCC;
 import com.dmdirc.addons.dcc.io.DCCTransfer;
-import com.dmdirc.addons.dcc.ui.TransferWindow;
+import com.dmdirc.addons.ui_swing.components.frames.ComponentFrame;
 import com.dmdirc.config.IdentityManager;
 import com.dmdirc.parser.interfaces.Parser;
 import com.dmdirc.parser.interfaces.callbacks.SocketCloseListener;
@@ -93,7 +93,7 @@ public class TransferContainer extends FrameContainer implements
             final String title, final String targetNick, final Server server) {
         super(dcc.getType() == DCCTransfer.TransferType.SEND
                 ? "dcc-send-inactive" : "dcc-receive-inactive",
-                title, title, TransferWindow.class,
+                title, title, ComponentFrame.class,
                 IdentityManager.getGlobalConfig(),
                 Arrays.asList("com.dmdirc.addons.dcc.ui.TransferPanel"));
         this.plugin = plugin;

src/com/dmdirc/addons/dcc/ui/EmptyWindow.java

@@ -1,80 +0,0 @@
-/*
- * Copyright (c) 2006-2011 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.addons.dcc.ui;
-
-import com.dmdirc.FrameContainer;
-import com.dmdirc.addons.ui_swing.SwingController;
-import com.dmdirc.addons.ui_swing.components.frames.TextFrame;
-import com.dmdirc.commandparser.PopupType;
-
-import javax.swing.JPopupMenu;
-
-/**
- * Empty Frame.
- */
-public class EmptyWindow extends TextFrame {
-
-    /** A version number for this class. */
-    private static final long serialVersionUID = 2L;
-
-    /**
-     * Creates a new empty window for the specified UI controller and owner.
-     *
-     * @param controller The UIController that owns this window
-     * @param owner The frame container that owns this window
-     */
-    public EmptyWindow(final SwingController controller, final FrameContainer owner) {
-        super(owner, controller);
-        setTextPane(null);
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public PopupType getNicknamePopupType() {
-        return null;
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public PopupType getChannelPopupType() {
-        return null;
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public PopupType getHyperlinkPopupType() {
-        return null;
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public PopupType getNormalPopupType() {
-        return null;
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public void addCustomPopupItems(final JPopupMenu popupMenu) {
-        //Add no custom popup items
-    }
-}

src/com/dmdirc/addons/dcc/ui/PlaceholderPanel.java

@@ -22,6 +22,7 @@
 
 package com.dmdirc.addons.dcc.ui;
 
+import com.dmdirc.addons.ui_swing.components.frames.SwingFrameComponent;
 import com.dmdirc.addons.ui_swing.components.text.TextLabel;
 
 import javax.swing.JPanel;
@@ -33,7 +34,7 @@ import net.miginfocom.swing.MigLayout;
  *
  * @since 0.6.6
  */
-public class PlaceholderPanel extends JPanel {
+public class PlaceholderPanel extends JPanel implements SwingFrameComponent {
 
     /** A version number for this class. */
     private static final long serialVersionUID = 1L;

src/com/dmdirc/addons/dcc/ui/PlaceholderWindow.java

@@ -1,51 +0,0 @@
-/*
- * Copyright (c) 2006-2011 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.addons.dcc.ui;
-
-import com.dmdirc.FrameContainer;
-import com.dmdirc.addons.ui_swing.SwingController;
-
-/**
- * A virtually empty window which serves as a top-level placeholder for other
- * DCC windows.
- *
- * @since 0.6.4
- */
-public class PlaceholderWindow extends EmptyWindow {
-
-    /** A version number for this class. */
-    private static final long serialVersionUID = 1L;
-
-    /**
-     * Creates a new placeholder window for the specified UI controller and owner.
-     *
-     * @param controller The UIController that owns this window
-     * @param owner The frame container that owns this window
-     */
-    public PlaceholderWindow(final SwingController controller,
-            final FrameContainer owner) {
-        super(controller, owner);
-        add(new PlaceholderPanel());
-    }
-
-}

src/com/dmdirc/addons/dcc/ui/TransferPanel.java

@@ -27,6 +27,7 @@ import com.dmdirc.addons.dcc.DCCTransferHandler;
 import com.dmdirc.addons.dcc.TransferContainer;
 import com.dmdirc.addons.dcc.io.DCCTransfer;
 import com.dmdirc.addons.ui_swing.UIUtilities;
+import com.dmdirc.addons.ui_swing.components.frames.SwingFrameComponent;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
 import com.dmdirc.parser.interfaces.Parser;
@@ -52,7 +53,7 @@ import net.miginfocom.swing.MigLayout;
  * @since 0.6.6
  */
 public class TransferPanel extends JPanel implements ActionListener,
-        SocketCloseListener, DCCTransferHandler {
+        SocketCloseListener, DCCTransferHandler, SwingFrameComponent {
 
     /** A version number for this class. */
     private static final long serialVersionUID = 1L;
@@ -78,7 +79,7 @@ public class TransferPanel extends JPanel implements ActionListener,
     /**
      * Creates a new transfer window for the specified UI controller and owner.
      *
-     * @param owner The frame container that owns this window
+     * @param owner The frame container that owns this frame
      */
     public TransferPanel(final FrameContainer owner) {
         super();

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

@@ -0,0 +1,87 @@
+/*
+ * Copyright (c) 2006-2011 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.addons.ui_swing.components.frames;
+
+import com.dmdirc.FrameContainer;
+import com.dmdirc.addons.ui_swing.SwingController;
+import com.dmdirc.addons.ui_swing.components.inputfields.SwingInputField;
+import com.dmdirc.addons.ui_swing.textpane.TextPane;
+import com.dmdirc.logger.ErrorLevel;
+import com.dmdirc.logger.Logger;
+import com.dmdirc.ui.core.components.WindowComponent;
+import com.dmdirc.util.SimpleInjector;
+
+import java.util.HashSet;
+import java.util.Set;
+
+import javax.swing.JComponent;
+
+/**
+ * Utility class to create frame components.
+ */
+public class ComponentCreator {
+
+    /**
+     * Initialises the components specified by the given frame.
+     *
+     * @param frame Frame to initialise
+     * @param controller UI Controller
+     * @param owner container
+     *
+     * @return Set of initialised components
+     */
+    public Set<JComponent> initFrameComponents(final Object frame,
+            final SwingController controller,
+            final FrameContainer owner) {
+        final SimpleInjector injector = new SimpleInjector();
+        final Set<String> names = owner.getComponents();
+        final Set<JComponent> components = new HashSet<JComponent>();
+
+        injector.addParameter(frame);
+        injector.addParameter(controller);
+        injector.addParameter(controller.getMainFrame());
+
+        for (String string : names) {
+            Object object;
+            try {
+                Class<?> clazz = null;
+                if (string.equals(WindowComponent.INPUTFIELD.getIdentifier())) {
+                    clazz = SwingInputField.class;
+                } else if (string.equals(WindowComponent.TEXTAREA
+                        .getIdentifier())) {
+                    clazz = TextPane.class;
+                }
+                object = injector.createInstance(clazz);
+            } catch (IllegalArgumentException ex) {
+                object = null;
+                Logger.userError(ErrorLevel.HIGH, "Unable to create component: "
+                        + ex.getMessage());
+            }
+            if (object instanceof JComponent) {
+                components.add((JComponent) object);
+            }
+        }
+
+        return components;
+    }
+}

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

@@ -25,6 +25,7 @@ import com.dmdirc.FrameContainer;
 import com.dmdirc.addons.ui_swing.SwingController;
 import com.dmdirc.commandparser.PopupType;
 
+import javax.swing.JComponent;
 import javax.swing.JPopupMenu;
 
 import net.miginfocom.swing.MigLayout;
@@ -40,6 +41,10 @@ public class ComponentFrame extends TextFrame {
      * objects being unserialized with the new class).
      */
     private static final long serialVersionUID = 2;
+    /** Parent frame container. */
+    private final FrameContainer owner;
+    /** Parent controller. */
+    private final SwingController controller;
 
     /**
      * Creates a new instance of CustomFrame.
@@ -50,7 +55,8 @@ public class ComponentFrame extends TextFrame {
     public ComponentFrame(final SwingController controller,
             final FrameContainer owner) {
         super(owner, controller);
-
+        this.controller = controller;
+        this.owner = owner;
         initComponents();
     }
 
@@ -58,9 +64,11 @@ public class ComponentFrame extends TextFrame {
      * Initialises components in this frame.
      */
     private void initComponents() {
-        setLayout(new MigLayout("ins 0, fill, hidemode 3, wrap 1"));
-        add(getTextPane(), "grow, push");
-        add(getSearchBar(), "growx, pushx");
+        setLayout(new MigLayout("fill"));
+        for (JComponent comp : new ComponentCreator().initFrameComponents(this,
+                controller, owner)) {
+            add(comp, "wrap, grow");
+        }
     }
 
     /** {@inheritDoc} */

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

@@ -22,11 +22,13 @@
 
 package com.dmdirc.addons.ui_swing.components.frames;
 
+import com.dmdirc.FrameContainer;
 import com.dmdirc.WritableFrameContainer;
 import com.dmdirc.addons.ui_swing.SwingController;
 import com.dmdirc.addons.ui_swing.components.inputfields.SwingInputHandler;
 import com.dmdirc.commandparser.PopupType;
 
+import javax.swing.JComponent;
 import javax.swing.JPopupMenu;
 
 import net.miginfocom.swing.MigLayout;
@@ -43,6 +45,10 @@ public class ComponentInputFrame extends InputTextFrame {
      * objects being unserialized with the new class).
      */
     private static final long serialVersionUID = 2;
+    /** Parent frame container. */
+    private final FrameContainer owner;
+    /** Parent controller. */
+    private final SwingController controller;
 
     /**
      * Creates a new instance of CustomInputFrame.
@@ -55,8 +61,10 @@ public class ComponentInputFrame extends InputTextFrame {
         super(controller, owner);
 
         setInputHandler(new SwingInputHandler(getInputField(),
-                owner.getCommandParser(), getContainer()));
+                owner.getCommandParser(), owner));
 
+        this.controller = controller;
+        this.owner = owner;
         initComponents();
     }
 
@@ -64,10 +72,11 @@ public class ComponentInputFrame extends InputTextFrame {
      * Initialises components in this frame.
      */
     private void initComponents() {
-        setLayout(new MigLayout("ins 0, fill, hidemode 3, wrap 1"));
-        add(getTextPane(), "grow, push");
-        add(getSearchBar(), "growx, pushx");
-        add(inputPanel, "growx, pushx");
+        setLayout(new MigLayout("fill"));
+        for (JComponent comp : new ComponentCreator().initFrameComponents(this,
+                controller, owner)) {
+            add(comp, "wrap, grow");
+        }
     }
 
     /** {@inheritDoc} */

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

@@ -123,7 +123,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
      * Initialises the components for this frame.
      */
     private void initComponents() {
-        setInputField(new SwingInputField(getController().getMainFrame()));
+        setInputField(new SwingInputField(this, getController().getMainFrame()));
 
         getInputField().addMouseListener(this);
 

src/com/dmdirc/addons/dcc/ui/TransferWindow.java → src/com/dmdirc/addons/ui_swing/components/frames/SwingFrameComponent.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2006-2011 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ * Copyright (c) 2006-2010 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
@@ -20,30 +20,9 @@
  * SOFTWARE.
  */
 
-package com.dmdirc.addons.dcc.ui;
-
-import com.dmdirc.FrameContainer;
-import com.dmdirc.addons.ui_swing.SwingController;
+package com.dmdirc.addons.ui_swing.components.frames;
 
 /**
- * A window for displaying the progress of DCC transfers.
- *
- * @since 0.6.4
+ * Interface to express how components should be added to the UI.
  */
-public class TransferWindow extends EmptyWindow {
-
-    /** A version number for this class. */
-    private static final long serialVersionUID = 1L;
-
-    /**
-     * Creates a new transfer window for the specified UI controller and owner.
-     *
-     * @param controller The UIController that owns this window
-     * @param owner The frame container that owns this window
-     */
-    public TransferWindow(final SwingController controller,
-            final FrameContainer owner) {
-        super(controller, owner);
-        add(new TransferPanel(owner));
-    }
-}
+public interface SwingFrameComponent {}

src/com/dmdirc/addons/ui_swing/components/inputfields/SwingInputField.java

@@ -24,6 +24,7 @@ package com.dmdirc.addons.ui_swing.components.inputfields;
 
 import com.dmdirc.addons.ui_swing.UIUtilities;
 import com.dmdirc.addons.ui_swing.components.colours.ColourPickerDialog;
+import com.dmdirc.addons.ui_swing.components.frames.InputTextFrame;
 import com.dmdirc.config.IdentityManager;
 import com.dmdirc.ui.IconManager;
 import com.dmdirc.ui.interfaces.InputField;
@@ -76,9 +77,11 @@ public class SwingInputField extends JComponent implements InputField,
     /**
      * Instantiates a new swing input field.
      *
+     * @param textFrame Parent textFrame
      * @param parentWindow Parent window
      */
-    public SwingInputField(final Window parentWindow) {
+    public SwingInputField(final InputTextFrame textFrame,
+            final Window parentWindow) {
         super();
 
         this.parentWindow = parentWindow;
@@ -113,6 +116,9 @@ public class SwingInputField extends JComponent implements InputField,
                 textField.getInputMap(SwingInputField.WHEN_IN_FOCUSED_WINDOW));
         KeyboardFocusManager.getCurrentKeyboardFocusManager()
                 .addPropertyChangeListener(this);
+
+        textFrame.setInputHandler(new SwingInputHandler(this, textFrame
+                .getContainer().getCommandParser(), textFrame.getContainer()));
     }
 
     /** {@inheritDoc} */