Fixes issue 3596: support background image in desktoppane.

Change-Id: I86b856491379b78eeb8166bcc6a2f0b5e5ebc039
Reviewed-on: http://gerrit.dmdirc.com/578
Automatic-Compile: Gregory Holmes <greboid@dmdirc.com>
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/addons/ui_swing/textpane/BackgroundOption.java → src/com/dmdirc/addons/ui_swing/BackgroundOption.java

@@ -21,7 +21,7 @@
  * SOFTWARE.
  */
 
-package com.dmdirc.addons.ui_swing.textpane;
+package com.dmdirc.addons.ui_swing;
 
 /**
  * Options available for the background image.

src/com/dmdirc/addons/ui_swing/MainFrame.java

@@ -379,7 +379,7 @@ public final class MainFrame extends JFrame implements WindowListener,
     private void initComponents() {
         statusBar = new SwingStatusBar(controller, this);
         frameManagerPanel = new JPanel();
-        desktopPane = new DMDircDesktopPane(this);
+        desktopPane = new DMDircDesktopPane(this, controller.getDomain());
 
         initFrameManagers();
 

src/com/dmdirc/addons/ui_swing/UIUtilities.java

@@ -31,6 +31,9 @@ import com.dmdirc.util.ReturnableThread;
 
 import java.awt.Dimension;
 import java.awt.FontMetrics;
+import java.awt.Graphics2D;
+import java.awt.Image;
+import java.awt.Rectangle;
 import java.awt.event.KeyEvent;
 import java.lang.reflect.InvocationTargetException;
 
@@ -348,4 +351,88 @@ public final class UIUtilities {
             }
         });
     }
+
+    /**
+     * Paints the background, either from the config setting or the background
+     * colour of the textpane.
+     *
+     * @param g Graphics object to draw onto
+     * @param bounds
+     * @param backgroundImage
+     * @param backgroundOption
+     */
+    public static void paintBackground(final Graphics2D g,
+            final Rectangle bounds,
+            final Image backgroundImage,
+            final BackgroundOption backgroundOption) {
+        if (backgroundImage != null) {
+            switch (backgroundOption) {
+                case TILED:
+                    paintTiledBackground(g, bounds, backgroundImage);
+                    break;
+                case SCALE:
+                    paintStretchedBackground(g, bounds, backgroundImage);
+                    break;
+                case SCALE_ASPECT_RATIO:
+                    paintStretchedAspectRatioBackground(g, bounds, backgroundImage);
+                    break;
+                case CENTER:
+                    paintCenterBackground(g, bounds, backgroundImage);
+                    break;
+                default:
+                    break;
+            }
+        } else {
+            paintNoBackground(g, bounds);
+        }
+    }
+
+    private static void paintNoBackground(final Graphics2D g, final Rectangle bounds) {
+        g.fill(bounds);
+    }
+
+    private static void paintStretchedBackground(final Graphics2D g,
+            final Rectangle bounds, final Image backgroundImage) {
+        g.drawImage(backgroundImage, 0, 0, bounds.width, bounds.height, null);
+    }
+
+    private static void paintCenterBackground(final Graphics2D g,
+            final Rectangle bounds, final Image backgroundImage) {
+        final int x = (bounds.width / 2) - (backgroundImage.getWidth(null) / 2);
+        final int y = (bounds.height / 2) - (backgroundImage.getHeight(null) / 2);
+        g.drawImage(backgroundImage, x, y, backgroundImage.getWidth(null),
+                backgroundImage.getWidth(null), null);
+    }
+
+    private static void paintStretchedAspectRatioBackground(final Graphics2D g,
+            final Rectangle bounds, final Image backgroundImage) {
+        final double widthratio = bounds.width
+                / (double) backgroundImage.getWidth(null);
+        final double heightratio = bounds.height
+                / (double) backgroundImage.getHeight(null);
+        final double ratio = Math.min(widthratio, heightratio);
+        final int width = (int) (backgroundImage.getWidth(null) * ratio);
+        final int height = (int) (backgroundImage.getWidth(null) * ratio);
+
+        final int x = (bounds.width / 2) - (width / 2);
+        final int y = (bounds.height / 2) - (height / 2);
+        g.drawImage(backgroundImage, x, y, width, height, null);
+    }
+
+    private static void paintTiledBackground(final Graphics2D g,
+            final Rectangle bounds, final Image backgroundImage) {
+        final int width = backgroundImage.getWidth(null);
+        final int height = backgroundImage.getWidth(null);
+
+        if (width <= 0 || height <= 0) {
+            // ARG!
+            return;
+        }
+
+        for (int x = 0; x < bounds.width; x += width) {
+            for (int y = 0; y < bounds.height; y += height) {
+                g.drawImage(backgroundImage, x, y, width, height, null);
+            }
+        }
+    }
 }

src/com/dmdirc/addons/ui_swing/components/desktopPane/DMDircDesktopPane.java

@@ -23,6 +23,7 @@
 package com.dmdirc.addons.ui_swing.components.desktopPane;
 
 import com.dmdirc.FrameContainer;
+import com.dmdirc.addons.ui_swing.BackgroundOption;
 import com.dmdirc.addons.ui_swing.MainFrame;
 import com.dmdirc.addons.ui_swing.UIUtilities;
 import com.dmdirc.addons.ui_swing.components.TreeScroller;
@@ -30,6 +31,8 @@ import com.dmdirc.addons.ui_swing.components.frames.InputTextFrame;
 import com.dmdirc.addons.ui_swing.components.frames.TextFrame;
 import com.dmdirc.addons.ui_swing.framemanager.tree.TreeViewModel;
 import com.dmdirc.addons.ui_swing.framemanager.tree.TreeViewNode;
+import com.dmdirc.config.IdentityManager;
+import com.dmdirc.interfaces.ConfigChangeListener;
 import com.dmdirc.interfaces.SelectionListener;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
@@ -37,15 +40,21 @@ import com.dmdirc.ui.WindowManager;
 import com.dmdirc.ui.interfaces.Window;
 import com.dmdirc.ui.interfaces.FrameListener;
 import com.dmdirc.util.ReturnableThread;
+import com.dmdirc.util.URLBuilder;
 
 import java.awt.Color;
+import java.awt.Graphics;
+import java.awt.Graphics2D;
+import java.awt.Image;
 import java.beans.PropertyChangeEvent;
 import java.beans.PropertyChangeListener;
+import java.io.IOException;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Stack;
 import java.util.concurrent.atomic.AtomicBoolean;
+import javax.imageio.ImageIO;
 
 import javax.swing.BorderFactory;
 import javax.swing.JComponent;
@@ -61,7 +70,7 @@ import javax.swing.tree.TreeSelectionModel;
  * DMDirc Extentions to JDesktopPane.
  */
 public class DMDircDesktopPane extends JDesktopPane implements FrameListener,
-        SelectionListener, PropertyChangeListener {
+        SelectionListener, PropertyChangeListener, ConfigChangeListener {
 
     /** Logger to use. */
     private static final java.util.logging.Logger LOGGER =
@@ -96,16 +105,24 @@ public class DMDircDesktopPane extends JDesktopPane implements FrameListener,
     private AtomicBoolean changing = new AtomicBoolean(false);
     /** Main Frame. */
     private MainFrame mainFrame;
+    /** Background image. */
+    private Image backgroundImage;
+    /** Background image option. */
+    private BackgroundOption backgroundOption;
+    /** Config domain. */
+    private String domain;
 
     /**
      * Initialises the DMDirc desktop pane.
      * 
      * @param mainFrame Main frame
+     * @param domain Config domain
      */
-    public DMDircDesktopPane(final MainFrame mainFrame) {
+    public DMDircDesktopPane(final MainFrame mainFrame, final String domain) {
         super();
 
         this.mainFrame = mainFrame;
+        this.domain = domain;
         setBackground(new Color(238, 238, 238));
         setBorder(BorderFactory.createEtchedBorder());
         setUI(new ProxyDesktopPaneUI(getUI(), this));
@@ -125,6 +142,23 @@ public class DMDircDesktopPane extends JDesktopPane implements FrameListener,
         };
 
         WindowManager.addFrameListener(this);
+        IdentityManager.getGlobalConfig().addChangeListener(domain,
+                "desktopbackground", this);
+        IdentityManager.getGlobalConfig().addChangeListener(domain,
+                "desktopbackgroundoption", this);
+
+        updateCachedSettings();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void paintComponent(final Graphics g) {
+        if (backgroundImage == null) {
+            super.paintComponent(g);
+        } else {
+            UIUtilities.paintBackground((Graphics2D) g, getBounds(),
+                backgroundImage, backgroundOption);
+        }
     }
 
     /** {@inheritDoc} */
@@ -227,8 +261,8 @@ public class DMDircDesktopPane extends JDesktopPane implements FrameListener,
                 final TreeViewNode node = nodes.get(window);
                 if (node.getLevel() == 0) {
                     Logger.appError(ErrorLevel.MEDIUM,
-                            "delServer triggered for root node" +
-                            node.toString(),
+                            "delServer triggered for root node"
+                            + node.toString(),
                             new IllegalArgumentException());
                 } else {
                     model.removeNodeFromParent(nodes.get(window));
@@ -354,4 +388,35 @@ public class DMDircDesktopPane extends JDesktopPane implements FrameListener,
         }
         changing.set(false);
     }
+
+    private void updateCachedSettings() {
+        final String backgroundPath = IdentityManager.getGlobalConfig().
+                getOption(domain, "desktopbackground");
+        UIUtilities.invokeAndWait(new Runnable() {
+
+            /** {@inheritDoc} */
+            @Override
+            public void run() {
+                try {
+                    backgroundImage = ImageIO.read(URLBuilder.buildURL(
+                            backgroundPath));
+                } catch (IOException ex) {
+                    backgroundImage = null;
+                }
+            }
+        });
+        try {
+            backgroundOption = BackgroundOption.valueOf(IdentityManager.
+                    getGlobalConfig().getOption(domain,
+                    "desktopbackgroundoption"));
+        } catch (IllegalArgumentException ex) {
+            backgroundOption = BackgroundOption.CENTER;
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void configChanged(final String domain, final String key) {
+        updateCachedSettings();
+    }
 }

src/com/dmdirc/addons/ui_swing/plugin.config

@@ -35,4 +35,6 @@ defaults:
     showfulltopic=false
     hideEmptyTopicBar=false
     textpanebackground=
-    textpanebackgroundoption=stretch
+    textpanebackgroundoption=STRETCH
+    desktopbackground=
+    desktopbackgroundoption=STRETCH

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

@@ -22,6 +22,7 @@
 
 package com.dmdirc.addons.ui_swing.textpane;
 
+import com.dmdirc.addons.ui_swing.BackgroundOption;
 import com.dmdirc.addons.ui_swing.UIUtilities;
 import com.dmdirc.addons.ui_swing.components.frames.TextFrame;
 import com.dmdirc.config.ConfigManager;
@@ -147,7 +148,8 @@ class TextPaneCanvas extends JPanel implements MouseInputListener,
         }
         g.setColor(textPane.getBackground());
         g.fill(g.getClipBounds());
-        paintBackground(g);
+        UIUtilities.paintBackground(g, getBounds(), backgroundImage,
+                backgroundOption);
         paintOntoGraphics(g);
         //g.drawImage(buffer, 0, 0, null);
     }
@@ -162,81 +164,6 @@ class TextPaneCanvas extends JPanel implements MouseInputListener,
         }
     }
 
-    /**
-     * Paints the background, either from the config setting or the background
-     * colour of the textpane.
-     *
-     * @param g Graphics object to draw onto
-     */
-    private void paintBackground(final Graphics2D g) {
-        if (backgroundImage != null) {
-            switch (backgroundOption) {
-                case TILED:
-                    paintTiledBackground(g);
-                    break;
-                case SCALE:
-                    paintStretchedBackground(g);
-                    break;
-                case SCALE_ASPECT_RATIO:
-                    paintStretchedAspectRatioBackground(g);
-                    break;
-                case CENTER:
-                    paintCenterBackground(g);
-                    break;
-                default:
-                    break;
-            }
-        } else {
-            paintNoBackground(g);
-        }
-    }
-
-    private void paintNoBackground(final Graphics2D g) {
-        g.fill(getBounds());
-    }
-
-    private void paintStretchedBackground(final Graphics2D g) {
-        g.drawImage(backgroundImage, 0, 0, getBounds().width,
-                getBounds().height, null);
-    }
-
-    private void paintCenterBackground(final Graphics2D g) {
-        final int x = (getBounds().width / 2) - (backgroundImage.getWidth(null) / 2);
-        final int y = (getBounds().height / 2) - (backgroundImage.getHeight(null) / 2);
-        g.drawImage(backgroundImage, x, y, backgroundImage.getWidth(null),
-                backgroundImage.getWidth(null), null);
-    }
-
-    private void paintStretchedAspectRatioBackground(final Graphics2D g) {
-        final double widthratio = getBounds().width
-                / (double) backgroundImage.getWidth(null);
-        final double heightratio = getBounds().height
-                / (double) backgroundImage.getHeight(null);
-        final double ratio = Math.min(widthratio, heightratio);
-        final int width = (int) (backgroundImage.getWidth(null) * ratio);
-        final int height = (int) (backgroundImage.getWidth(null) * ratio);
-
-        final int x = (getBounds().width / 2) - (width / 2);
-        final int y = (getBounds().height / 2) - (height / 2);
-        g.drawImage(backgroundImage, x, y, width, height, null);
-    }
-
-    private void paintTiledBackground(final Graphics2D g) {
-        final int width = backgroundImage.getWidth(null);
-        final int height = backgroundImage.getWidth(null);
-
-        if (width <= 0 || height <= 0) {
-            // ARG!
-            return;
-        }
-
-        for (int x = 0; x < getBounds().width; x += width) {
-            for (int y = 0; y < getBounds().height; y += height) {
-                g.drawImage(backgroundImage, x, y, width, height, null);
-            }
-        }
-    }
-
     private void updateCachedSettings() {
         final String backgroundPath = manager.getOption(domain,
                 "textpanebackground");