From 853bfeaee113cd12289169f18a7504d16a534490 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89ric=20Lemoine?= <eric.lemoine@gmail.com>
Date: Wed, 19 Oct 2011 23:19:29 +0200
Subject: [PATCH] necessary adaptations to the Tile.IFrame mixin - back
 buffering is disabled when using POST and iframe tiles

---
 lib/OpenLayers/Tile/Image/IFrame.js | 90 +++++++++++++++++++----------
 1 file changed, 59 insertions(+), 31 deletions(-)

diff --git a/lib/OpenLayers/Tile/Image/IFrame.js b/lib/OpenLayers/Tile/Image/IFrame.js
index 9616036815..15b9d7e505 100644
--- a/lib/OpenLayers/Tile/Image/IFrame.js
+++ b/lib/OpenLayers/Tile/Image/IFrame.js
@@ -29,40 +29,52 @@ OpenLayers.Tile.Image.IFrame = {
     useIFrame: null,
 
     /**
-    * Method: updateBackBuffer
-    * Update the <backBufferData>, and return a new or reposition the
-    * backBuffer. When a backbuffer is returned, the tile's markup is not
-    * available any more.
-    *
-    * Returns:
-    * {HTMLDivElement} the tile's markup in a cloned element, or undefined if
-    *     no backbuffer is currently available or needed
+     * Method: draw
+     * Set useIFrame in the instance, and operate the to/from image from/to
+     * iframe switch, if necessary. Then call the parent function.
+     *
+     * Returns:
+     * {Boolean}
      */
-    updateBackBuffer: function() {
-        this.url = this.layer.getURL(this.bounds);
-        var usedIFrame = this.useIFrame;
-        this.useIFrame = this.maxGetUrlLength !== null && !this.layer.async &&
-            this.url.length > this.maxGetUrlLength;
-        var fromIFrame = usedIFrame && !this.useIFrame;
-        var toIFrame = !usedIFrame && this.useIFrame;
-        if (fromIFrame || toIFrame) {
-            // switch between get (image) and post (iframe)
-            this.clear();
-            if (this.imgDiv && this.imgDiv.parentNode === this.frame) {
-                this.frame.removeChild(this.imgDiv);
-            }
-            this.imgDiv = null;
-            if (fromIFrame) {
-                // remove eventPane
-                this.frame.removeChild(this.frame.firstChild);
-                this.resetBackBuffer();
+    draw: function() {
+        var draw = OpenLayers.Tile.Image.prototype.shouldDraw.call(this);
+        if(draw) {
+
+            // this.url isn't set to the currect value yet, so we call getURL
+            // on the layer and store the result in a local variable
+            var url = this.layer.getURL(this.bounds);
+
+            var usedIFrame = this.useIFrame;
+            this.useIFrame = this.maxGetUrlLength !== null &&
+                             !this.layer.async &&
+                             url.length > this.maxGetUrlLength;
+
+            var fromIFrame = usedIFrame && !this.useIFrame;
+            var toIFrame = !usedIFrame && this.useIFrame;
+
+            if(fromIFrame || toIFrame) {
+
+                // Switching between GET (image) and POST (iframe).
+
+                // We remove the imgDiv (really either an image or an iframe)
+                // from the frame and set it to null to make sure initImage
+                // will call createImage.
+
+                if(this.imgDiv && this.imgDiv.parentNode === this.frame) {
+                    this.frame.removeChild(this.imgDiv);
+                }
+                this.imgDiv = null;
+
+                // And if we had an iframe we also remove the event pane.
+
+                if(fromIFrame) {
+                    this.frame.removeChild(this.frame.firstChild);
+                }
             }
         }
-        if (!this.useIFrame) {
-            OpenLayers.Tile.Image.prototype.updateBackBuffer.apply(this, arguments);
-        }
+        return OpenLayers.Tile.Image.prototype.draw.apply(this, arguments);
     },
-    
+
     /**
      * Method: createImage
      * Creates the content for the frame on the tile.
@@ -183,6 +195,22 @@ OpenLayers.Tile.Image.IFrame = {
         } else {
             OpenLayers.Tile.Image.prototype.setImgSrc.apply(this, arguments);
         }
-    }
+    },
 
+    /**
+     * Method: cloneMarkup
+     * Override cloneMarkup to not attempt cloning when we use an iframe.
+     * Moving an iframe from one element to another makes it necessary to
+     * reload the iframe because its content is lost. So we just give up.
+     *
+     * Returns:
+     * {DOMElement}
+     */
+    cloneMarkup: function() {
+        var clone;
+        if(!this.useIFrame) {
+            clone = OpenLayers.Tile.Image.prototype.cloneMarkup.call(this);
+        }
+        return clone;
+    }
 };