From 9758910fc6988d959747c707d73095dd41d6a924 Mon Sep 17 00:00:00 2001
From: ahocevar <andreas.hocevar@gmail.com>
Date: Sun, 24 Jun 2012 22:12:38 +0200
Subject: [PATCH] Making Element/Node types more consistent.

---
 src/ol/Map.js          | 46 +++++++++++++++++++++++++++++++-----------
 src/ol/control/Zoom.js |  3 ++-
 src/ol/event/Events.js |  4 ++--
 3 files changed, 38 insertions(+), 15 deletions(-)

diff --git a/src/ol/Map.js b/src/ol/Map.js
index 2a4f833a56..e20a4497c6 100644
--- a/src/ol/Map.js
+++ b/src/ol/Map.js
@@ -87,13 +87,13 @@ ol.Map = function() {
     
     /**
      * @private
-     * @type {Element}
+     * @type {Node}
      */
     this.mapOverlay_ = null;
     
     /**
      * @private
-     * @type {Element}
+     * @type {Node}
      */
     this.staticOverlay_ = null;
     
@@ -433,8 +433,11 @@ ol.Map.prototype.setContainer = function(container) {
  * Check if everything is ready.  Render if so.
  */
 ol.Map.prototype.conditionallyRender = function() {
-    if (!goog.isNull(this.layers_) && goog.isDef(this.zoom_) && !goog.isNull(this.center_)) {
-        this.renderer_.draw(this.layers_, this.center_, this.getResolutionForZoom(this.zoom_));
+    if (goog.isDef(this.renderer_) && !goog.isNull(this.layers_) &&
+       goog.isDef(this.zoom_) && !goog.isNull(this.center_)) {
+        this.renderer_.draw(this.layers_, this.center_,
+            this.getResolutionForZoom(this.zoom_)
+        );
     }
 };
 
@@ -447,13 +450,10 @@ ol.Map.prototype.getViewport = function() {
 
 ol.Map.prototype.setViewport = function() {
     if (!this.viewport_) {
-        this.viewport_ = goog.dom.createDom('div', {
+        this.viewport_ = /** @type {Element} */ (goog.dom.createDom('div', {
             'class': 'ol-viewport',
-            'style': 'height:100%;width:100%;position:relative;top:0;left:0;overflow:hidden'
-        });
-        this.mapOverlay_ = goog.dom.createDom('div', 'ol-overlay-map');
-        this.staticOverlay_ = goog.dom.createDom('div', 'ol-overlay-static');
-        goog.dom.append(this.viewport_, this.mapOverlay_, this.staticOverlay_);
+            'style': 'width:100%;height:100%;top:0;left:0;position:relative;overflow:hidden'
+        }));
     }
     this.events_.setElement(this.viewport_);
     goog.dom.appendChild(this.container_, this.viewport_);
@@ -463,6 +463,28 @@ ol.Map.prototype.createRenderer = function() {
     var Renderer = ol.renderer.MapRenderer.pickRendererType(
         ol.Map.preferredRenderers);
     this.renderer_ = new Renderer(this.viewport_);
+    
+    //TODO Consider making a renderer responsible for managing the overlays
+    var viewport = this.viewport_;
+    if (!this.mapOverlay_ && !this.staticOverlay_) {
+        var staticCls = 'ol-overlay-static';
+        this.mapOverlay_ = goog.dom.createDom('div', 'ol-overlay-map');
+        this.staticOverlay_ = goog.dom.createDom('div', {
+            'class': staticCls,
+            'style': 'width:100%;height:100%;top:0;left:0;position:absolute'
+        });
+        // Prevent click events on links in the static overlay from getting 
+        // through to listeners. This is not registered as priority listener,
+        // so priority listeners can still get the click event.
+        this.events_.register('click', function(evt) {
+            var node = evt.target;
+            return !(node.nodeName === 'A' &&
+                goog.dom.getAncestorByClass(node, staticCls));
+        });
+    }
+    if (!goog.isNull(viewport)) {
+        goog.dom.append(viewport, this.mapOverlay_, this.staticOverlay_);
+    } 
 };
 
 /**
@@ -497,14 +519,14 @@ ol.Map.prototype.zoomOut = function() {
 };
 
 /**
- * @returns {Element} the map overlay element
+ * @returns {Node} the map overlay element
  */
 ol.Map.prototype.getMapOverlay = function() {
     return this.mapOverlay_;
 };
 
 /**
- * @returns {Element} the static overlay element
+ * @returns {Node} the static overlay element
  */
 ol.Map.prototype.getStaticOverlay = function() {
     return this.staticOverlay_;
diff --git a/src/ol/control/Zoom.js b/src/ol/control/Zoom.js
index a9edfab2ca..45a3151c76 100644
--- a/src/ol/control/Zoom.js
+++ b/src/ol/control/Zoom.js
@@ -104,7 +104,8 @@ ol.control.Zoom.prototype.handle = function(evt) {
 
 ol.control.Zoom.prototype.destroy = function() {
     goog.dom.removeNode(goog.dom.getElementByClass(
-        ol.control.Zoom.RES.CLS, this.map_.getViewport()
+        ol.control.Zoom.RES.CLS,
+        /** @type {Element} */ (this.map_.getViewport())
     ));
     goog.base(this, 'destroy');
 };
diff --git a/src/ol/event/Events.js b/src/ol/event/Events.js
index aee65fa1c4..1465f43f94 100644
--- a/src/ol/event/Events.js
+++ b/src/ol/event/Events.js
@@ -146,7 +146,7 @@ ol.event.Events.prototype.getElement = function() {
  * Attach this instance to a DOM element. When called, all browser events fired
  * on the provided element will be relayed by this instance.
  *
- * @param {Element} element A DOM element to attach
+ * @param {Element|Node} element A DOM element to attach
  *     browser events to. If called without this argument, all browser events
  *     will be detached from the element they are currently attached to.
  */
@@ -161,7 +161,7 @@ ol.event.Events.prototype.setElement = function(element) {
         this.destroySequences();
         delete this.element_;
     }
-    this.element_ = element || null;
+    this.element_ = /** @type {Element} */ (element) || null;
     if (goog.isDefAndNotNull(element)) {
         this.createSequences();
         for (t in types) {