(Almost) Generic background image painter

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

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

@@ -544,6 +544,7 @@ public abstract class TextFrame extends JPanel implements Window,
     @Override
     public void windowClosing(final FrameContainer window) {
         setVisible(false);
+        getTextPane().close();
     }
 
     /** {@inheritDoc} */

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

@@ -1,86 +0,0 @@
-/*
- * Copyright (c) 2006-2012 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.ui_swing.textpane;
-
-import com.dmdirc.addons.ui_swing.components.LoggingSwingWorker;
-import com.dmdirc.logger.ErrorLevel;
-import com.dmdirc.logger.Logger;
-
-import java.awt.Image;
-import java.io.IOException;
-import java.net.URL;
-import java.util.concurrent.ExecutionException;
-
-import javax.imageio.ImageIO;
-
-/**
- * Loads a background image in the background.
- */
-class BackgroundImageLoader extends LoggingSwingWorker<Image, Void> {
-
-    /** URL of image file to load. */
-    private final URL imageURL;
-    /** Textpane canvas to load image for. */
-    private final TextPaneCanvas canvas;
-
-    /**
-     * Creates a new background image loader.
-     *
-     * @param canvas Canvas we're loading image for
-     * @param url URL of image to load
-     */
-    protected BackgroundImageLoader(final TextPaneCanvas canvas,
-            final URL url) {
-        super();
-        imageURL = url;
-        this.canvas = canvas;
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    protected Image doInBackground() {
-        try {
-            if (imageURL != null) {
-                return ImageIO.read(imageURL);
-            }
-            return null;
-        } catch (IOException ex) {
-            return null;
-        }
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    protected void done() {
-        if (isCancelled()) {
-            return;
-        }
-        try {
-            canvas.setBackgroundImage(get());
-        } catch (InterruptedException ex) {
-            canvas.setBackgroundImage(null);
-        } catch (ExecutionException ex) {
-            Logger.appError(ErrorLevel.MEDIUM, ex.getMessage(), ex);
-        }
-    }
-}

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

@@ -0,0 +1,208 @@
+/*
+ * Copyright (c) 2006-2012 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.ui_swing.textpane;
+
+import com.dmdirc.addons.ui_swing.BackgroundOption;
+import com.dmdirc.addons.ui_swing.UIUtilities;
+import com.dmdirc.addons.ui_swing.components.LoggingSwingWorker;
+import com.dmdirc.config.ConfigBinding;
+import com.dmdirc.config.ConfigManager;
+import com.dmdirc.util.URLBuilder;
+
+import java.awt.Graphics;
+import java.awt.Graphics2D;
+import java.awt.Image;
+import java.io.IOException;
+import java.net.URL;
+import java.util.concurrent.ExecutionException;
+
+import javax.imageio.ImageIO;
+import javax.swing.JComponent;
+
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NonNull;
+import lombok.extern.slf4j.Slf4j;
+
+import org.jdesktop.jxlayer.plaf.LayerUI;
+
+/**
+ * Background painting layer UI. Paints a opaque background then paints the
+ * specified image onto the background layer.
+ */
+@Slf4j
+@SuppressWarnings("unused")
+public class BackgroundPainter extends LayerUI<JComponent> {
+
+    /**
+     * Domain to retrieve settings from.
+     */
+    @Getter(value = AccessLevel.PROTECTED)
+    @NonNull
+    private final String domain;
+
+    /**
+     * Key in domain to get image URL from.
+     */
+    @NonNull
+    @Getter(value = AccessLevel.PROTECTED)
+    private final String imageKey;
+
+    /**
+     * Key in domain to get image background type from.
+     */
+    @NonNull
+    @Getter(value = AccessLevel.PROTECTED)
+    private final String optionKey;
+
+    /**
+     * Config manager to bind to and retrieve settings from.
+     */
+    private final ConfigManager configManager;
+
+    /**
+     * Background image.
+     */
+    private Image backgroundImage;
+
+    /**
+     * Background option type.
+     */
+    private BackgroundOption backgroundOption;
+
+    /**
+     * Creates a new background painter.
+     *
+     * @param configManager Config manager to retrieve settings from
+     * @param domain Domain to retrieve settings from
+     * @param imageKey Key for background image
+     * @param optionKey Key for background type
+     */
+    public BackgroundPainter(final ConfigManager configManager,
+            final String domain, final String imageKey,
+            final String optionKey) {
+        this.configManager = configManager;
+        this.domain = domain;
+        this.imageKey = imageKey;
+        this.optionKey = optionKey;
+        configManager.getBinder().bind(this, BackgroundPainter.class);
+    }
+
+    /**
+     * Called to update the value of the image URL.
+     *
+     * @param value New image URL
+     */
+    @ConfigBinding(domain = "plugin-ui_swing", key = "textpanebackground")
+    public void updateImage(final String value) {
+        if (value == null || value.isEmpty()) {
+            backgroundImage = null;
+        } else {
+            new ImageLoader(URLBuilder.buildURL(value)).executeInExecutor();
+        }
+    }
+
+    /**
+     * Called to update the value of the background type
+     *
+     * @param value New background type
+     */
+    @ConfigBinding(domain = "plugin-ui_swing", key = "textpanebackgroundoption")
+    public void updateOption(final String value) {
+        try {
+            backgroundOption = BackgroundOption.valueOf(value);
+        } catch (IllegalArgumentException ex) {
+            backgroundOption = BackgroundOption.CENTER;
+        }
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void paint(final Graphics graphics, final JComponent component) {
+        final Graphics2D g2 = (Graphics2D) graphics;
+        g2.setColor(component.getBackground());
+        g2.fill(g2.getClipBounds());
+        UIUtilities.paintBackground(g2, component.getBounds(),
+                backgroundImage, backgroundOption);
+        super.paint(graphics, component);
+    }
+
+    /**
+     * Called to unbind this painter from its config binder.
+     */
+    public void unbind() {
+        configManager.getBinder().unbind(this);
+    }
+
+    /**
+     * Loads image URLs in the background.
+     */
+    @AllArgsConstructor
+    private class ImageLoader extends LoggingSwingWorker<Image, Void> {
+
+        /**
+         * URL of image file to load.
+         */
+        private final URL imageURL;
+
+        /**
+         * {@inheritDoc}
+         */
+        @Override
+        protected Image doInBackground() {
+            try {
+                log.trace("Loading image: {}", imageURL);
+                if (imageURL != null) {
+                    return ImageIO.read(imageURL);
+                }
+                return null;
+            } catch (IOException ex) {
+                log.trace("Background loading IOException: {}", ex.getMessage());
+                return null;
+            }
+        }
+
+        /**
+         * {@inheritDoc}
+         */
+        @Override
+        protected void done() {
+            try {
+                if (isCancelled()) {
+                    log.trace("Background loading cancelled.");
+                    return;
+                }
+                log.trace("Background loading complete: {}", get());
+                backgroundImage = get();
+            } catch (InterruptedException ex) {
+                log.debug("Interrupted whilst loading image: {}", imageURL);
+            } catch (ExecutionException ex) {
+                log.debug("Exception whilst loading image: {}. "
+                        + "Exception message:", imageURL, ex.getMessage());
+            }
+        }
+    }
+}

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

@@ -52,6 +52,8 @@ import javax.swing.SwingConstants;
 
 import net.miginfocom.swing.MigLayout;
 
+import org.jdesktop.jxlayer.JXLayer;
+
 /**
  * Styled, scrollable text pane.
  */
@@ -74,6 +76,8 @@ public final class TextPane extends JComponent implements MouseWheelListener,
     private final Window frame;
     /** Indicator to show whether new lines have been added. */
     private final JLabel newLineIndicator;
+    /** Background painter. */
+    private final BackgroundPainter backgroundPainter;
     /** Last seen line. */
     private int lastSeenLine = 0;
     /** Show new line notifications. */
@@ -98,8 +102,13 @@ public final class TextPane extends JComponent implements MouseWheelListener,
         newLineIndicator.setVisible(false);
 
         setLayout(new MigLayout("fill, hidemode 3"));
+        backgroundPainter = new BackgroundPainter(frame.getContainer()
+                .getConfigManager(), "plugin-ui_swing", "textpanebackground",
+                "textpanebackgroundoption");
         canvas = new TextPaneCanvas(this, document);
-        add(canvas, "dock center");
+        final JXLayer<JComponent> layer = new JXLayer<JComponent>(canvas);
+        layer.setUI(backgroundPainter);
+        add(layer, "dock center");
         add(newLineIndicator, "dock south, center, grow");
         scrollModel = new TextPaneBoundedRangeModel();
         scrollModel.setExtent(0);
@@ -574,4 +583,11 @@ public final class TextPane extends JComponent implements MouseWheelListener,
             });
         }
     }
+
+    /**
+     * Called to close this textpane and any associated resources.
+     */
+    public void close() {
+        backgroundPainter.unbind();
+    }
 }

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

@@ -22,21 +22,17 @@
 
 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;
 import com.dmdirc.interfaces.ConfigChangeListener;
 import com.dmdirc.ui.messages.IRCDocument;
 import com.dmdirc.ui.messages.IRCTextAttribute;
 import com.dmdirc.ui.messages.LinePosition;
 import com.dmdirc.util.collections.ListenerList;
-import com.dmdirc.util.URLBuilder;
 
 import java.awt.Cursor;
 import java.awt.Graphics;
 import java.awt.Graphics2D;
-import java.awt.Image;
 import java.awt.Point;
 import java.awt.Rectangle;
 import java.awt.Shape;
@@ -94,14 +90,8 @@ class TextPaneCanvas extends JPanel implements MouseInputListener,
     private int firstVisibleLine;
     /** Last visible line (from the top). */
     private int lastVisibleLine;
-    /** Background image. */
-    private Image backgroundImage;
     /** Config Manager. */
     private final ConfigManager manager;
-    /** Config domain. */
-    private final String domain;
-    /** Background image option. */
-    private BackgroundOption backgroundOption;
     /** Quick copy? */
     private boolean quickCopy;
     /** Mouse click listeners. */
@@ -118,8 +108,6 @@ class TextPaneCanvas extends JPanel implements MouseInputListener,
         this.document = document;
         textPane = parent;
         this.manager = parent.getWindow().getContainer().getConfigManager();
-        this.domain = ((TextFrame) parent.getWindow()).getController().
-                getDomain();
         startLine = 0;
         setDoubleBuffered(true);
         setOpaque(true);
@@ -129,8 +117,6 @@ class TextPaneCanvas extends JPanel implements MouseInputListener,
         addMouseListener(this);
         addMouseMotionListener(this);
         addComponentListener(this);
-        manager.addChangeListener(domain, "textpanebackground", this);
-        manager.addChangeListener(domain, "textpanebackgroundoption", this);
         manager.addChangeListener("ui", "quickCopy", this);
 
         updateCachedSettings();
@@ -150,10 +136,6 @@ class TextPaneCanvas extends JPanel implements MouseInputListener,
         if (desktopHints != null) {
             g.addRenderingHints(desktopHints);
         }
-        g.setColor(textPane.getBackground());
-        g.fill(g.getClipBounds());
-        UIUtilities.paintBackground(g, getBounds(), backgroundImage,
-                backgroundOption);
         paintOntoGraphics(g);
     }
 
@@ -170,20 +152,6 @@ class TextPaneCanvas extends JPanel implements MouseInputListener,
      * Updates cached config settings.
      */
     private void updateCachedSettings() {
-        final String backgroundPath = manager.getOption(domain,
-                "textpanebackground");
-        if (backgroundPath.isEmpty()) {
-            backgroundImage = null;
-        } else {
-            new BackgroundImageLoader(TextPaneCanvas.this,
-                    URLBuilder.buildURL(backgroundPath)).executeInExecutor();
-        }
-        try {
-            backgroundOption = BackgroundOption.valueOf(manager.getOption(
-                    domain, "textpanebackgroundoption"));
-        } catch (IllegalArgumentException ex) {
-            backgroundOption = BackgroundOption.CENTER;
-        }
         quickCopy = manager.getOptionBool("ui", "quickCopy");
         UIUtilities.invokeLater(new Runnable() {
 
@@ -1092,14 +1060,4 @@ class TextPaneCanvas extends JPanel implements MouseInputListener,
     public void removeTextPaneListener(final TextPaneListener listener) {
         listeners.remove(TextPaneListener.class, listener);
     }
-
-    /**
-     * Sets the background image for this canvas.
-     *
-     * @param image Background image
-     */
-    protected void setBackgroundImage(final Image image) {
-        backgroundImage = image;
-        recalc();
-    }
 }