Fixes issue 1811: Background Images in the text pane

Change-Id: I70616e8749f066af6b24ab0a934e94def37671e6
Reviewed-on: http://gerrit.dmdirc.com/415
Reviewed-by: Chris Smith <chris@dmdirc.com>
Tested-by: Chris Smith <chris@dmdirc.com>

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

@@ -34,4 +34,5 @@ defaults:
     shownicklist=true
     showfulltopic=false
     hideEmptyTopicBar=false
-    textpanebackground=
+    textpanebackground=
+    textpanebackgroundoption=stretch

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

@@ -0,0 +1,39 @@
+/*
+ * 
+ * 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
+ * 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;
+
+/**
+ * Options available for the background image.
+ */
+public enum BackgroundOption {
+
+    /** Stretched to fit. */
+    SCALE,
+    /** Stretched to fit, maintaining aspect ratio. */
+    SCALE_ASPECT_RATIO,
+    /** Centered, no stretching. */
+    CENTER,
+    /** Tiled. */
+    TILED;
+}

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

@@ -47,11 +47,13 @@ import java.awt.font.TextAttribute;
 import java.awt.font.TextHitInfo;
 import java.awt.font.TextLayout;
 import java.awt.image.BufferedImage;
+import java.io.IOException;
 import java.text.AttributedCharacterIterator;
 import java.text.AttributedString;
 import java.util.HashMap;
 import java.util.Map;
 
+import javax.imageio.ImageIO;
 import javax.swing.JPanel;
 import javax.swing.SwingUtilities;
 import javax.swing.event.MouseInputListener;
@@ -96,6 +98,8 @@ class TextPaneCanvas extends JPanel implements MouseInputListener,
     private  ConfigManager manager;
     /** Config domain. */
     private  String domain;
+    /** Background image option. */
+    private BackgroundOption backgroundOption;
 
     /**
      * Creates a new text pane canvas.
@@ -120,6 +124,7 @@ class TextPaneCanvas extends JPanel implements MouseInputListener,
         addMouseMotionListener(this);
         addComponentListener(this);
         manager.addChangeListener(domain, "textpanebackground", this);
+        manager.addChangeListener(domain, "textpanebackgroundoption", this);
 
         updateCachedSettings();
     }
@@ -142,6 +147,7 @@ class TextPaneCanvas extends JPanel implements MouseInputListener,
         }
         g.setColor(textPane.getBackground());
         g.fill(g.getClipBounds());
+        paintBackground(g);
         paintOntoGraphics(g);
         //g.drawImage(buffer, 0, 0, null);
     }
@@ -164,26 +170,95 @@ class TextPaneCanvas extends JPanel implements MouseInputListener,
      */
     private void paintBackground(final Graphics2D g) {
         if (backgroundImage != null) {
-            g.drawImage(backgroundImage, 0,
-                    0, getBounds().width, getBounds().height, 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 {
-            g.fill(getBounds());
+            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");
-        UIUtilities.invokeLater(new Runnable() {
+        UIUtilities.invokeAndWait(new Runnable() {
 
             /** {@inheritDoc} */
             @Override
             public void run() {
-                backgroundImage = backgroundPath.isEmpty() ? null : Toolkit.
-                getDefaultToolkit().createImage(URLBuilder.buildURL(backgroundPath));
-                repaint();
+                try {
+                    backgroundImage = ImageIO.read(URLBuilder.
+                            buildURL(backgroundPath));
+                } catch (IOException ex) {
+                    backgroundImage = null;
+                }
             }
         });
+        try {
+        backgroundOption = BackgroundOption.valueOf(manager.getOption(domain,
+                "textpanebackgroundoption"));
+        } catch (IllegalArgumentException ex) {
+            backgroundOption = BackgroundOption.CENTER;
+        }
     }
 
     /**
@@ -216,9 +291,6 @@ class TextPaneCanvas extends JPanel implements MouseInputListener,
         int paragraphEnd;
         LineBreakMeasurer lineMeasurer;
 
-        g.setColor(textPane.getBackground());
-        paintBackground(g);
-
         textLayouts.clear();
         positions.clear();