3180: treat UI and non-UI controls differently, on non-UI controls `d…

…raw` method should be empty.

lib/OpenLayers/Control.js

@@ -83,6 +83,14 @@ OpenLayers.Control = OpenLayers.Class({
      */
     type: null, 
 
+    /** 
+     * Property: outsideViewport
+     * {Boolean} This property is set to true when the control is added to the 
+     * map if the control was created with a <div> property (to take value the 
+     * control must have a draw method)
+     */
+    outsideViewport: false,
+
     /** 
      * Property: allowSelection
      * {Boolean} By default, controls do not allow selection, because
@@ -248,6 +256,8 @@ OpenLayers.Control = OpenLayers.Class({
      * on the page.  If a div has not been created one is created.  Controls
      * with a visual component will almost always want to override this method 
      * to customize the look of control. 
+     * Controls without a visual HTML component should override this method 
+     * with a empty function.
      *
      * Parameters:
      * px - {<OpenLayers.Pixel>} The top-left pixel position of the control

lib/OpenLayers/Control/ArgParser.js

@@ -132,6 +132,12 @@ OpenLayers.Control.ArgParser = OpenLayers.Class(OpenLayers.Control, {
         }
     },
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /** 
      * Method: setCenter
      * As soon as a baseLayer has been loaded, we center and zoom

lib/OpenLayers/Control/Button.js

@@ -34,6 +34,12 @@ OpenLayers.Control.Button = OpenLayers.Class(OpenLayers.Control, {
      */
     type: OpenLayers.Control.TYPE_BUTTON,
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /**
      * Method: trigger
      * Called by a control panel when the button is clicked.

lib/OpenLayers/Control/DragFeature.js

@@ -233,6 +233,12 @@ OpenLayers.Control.DragFeature = OpenLayers.Class(OpenLayers.Control, {
         return OpenLayers.Control.prototype.deactivate.apply(this, arguments);
     },
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /**
      * Method: overFeature
      * Called when the feature handler detects a mouse-over on a feature.

lib/OpenLayers/Control/DragPan.js

@@ -72,11 +72,14 @@ OpenLayers.Control.DragPan = OpenLayers.Class(OpenLayers.Control, {
 
 
     /**
-     * Method: draw
-     * Creates a Drag handler, using <panMap> and
-     * <panMapDone> as callbacks.
+     * Constructor: OpenLayers.Control.DragPan
+     * Create a DragPan control.
+     *
+     * Parameters:
+     * options - {Object} The options object.
      */    
-    draw: function() {
+    initialize: function(options) {
+        OpenLayers.Control.prototype.initialize.call(this, options);
         if(this.enableKinetic) {
             var config = {interval: this.kineticInterval};
             if(typeof this.enableKinetic === "object") {
@@ -95,6 +98,12 @@ OpenLayers.Control.DragPan = OpenLayers.Class(OpenLayers.Control, {
         );
     },
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /**
      * Method: panMapStart
      */

lib/OpenLayers/Control/DrawFeature.js

@@ -110,6 +110,12 @@ OpenLayers.Control.DrawFeature = OpenLayers.Class(OpenLayers.Control, {
         this.handler = new handler(this, this.callbacks, this.handlerOptions);
     },
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /**
      * Method: drawFeature
      */

lib/OpenLayers/Control/Geolocate.js

@@ -82,6 +82,12 @@ OpenLayers.Control.Geolocate = OpenLayers.Class(OpenLayers.Control, {
         OpenLayers.Control.prototype.destroy.apply(this, arguments);
     },
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /**
      * Method: activate
      * Activates the control.

lib/OpenLayers/Control/GetFeature.js

@@ -284,6 +284,12 @@ OpenLayers.Control.GetFeature = OpenLayers.Class(OpenLayers.Control, {
         );
     },
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /**
      * Method: selectClick
      * Called on click

lib/OpenLayers/Control/Graticule.js

@@ -122,32 +122,9 @@ OpenLayers.Control.Graticule = OpenLayers.Class(OpenLayers.Control, {
         this.labelSymbolizer.labelAlign = "${labelAlign}";
         this.labelSymbolizer.labelXOffset = "${xOffset}";
         this.labelSymbolizer.labelYOffset = "${yOffset}";
-    },
 
-    /**
-     * APIMethod: destroy
-     */
-    destroy: function() {
-        this.deactivate();        
-        OpenLayers.Control.prototype.destroy.apply(this, arguments);        
-        if (this.gratLayer) {
-            this.gratLayer.destroy();
-            this.gratLayer = null;
-        }
-    },
-
-    /**
-     * Method: draw
-     *
-     * initializes the graticule layer and does the initial update
-     * 
-     * Returns:
-     * {DOMElement}
-     */
-    draw: function() {
-        OpenLayers.Control.prototype.draw.apply(this, arguments);
         if (!this.gratLayer) {
-            var gratStyle = new OpenLayers.Style({},{
+            var gratStyle = new OpenLayers.Style({}, {
                 rules: [new OpenLayers.Rule({'symbolizer':
                     {"Point":this.labelSymbolizer,
                      "Line":this.lineSymbolizer}
@@ -159,10 +136,27 @@ OpenLayers.Control.Graticule = OpenLayers.Class(OpenLayers.Control, {
                 displayInLayerSwitcher: this.displayInLayerSwitcher
             });
         }
-        return this.div;
     },
 
-     /**
+    /**
+     * APIMethod: destroy
+     */
+    destroy: function() {
+        this.deactivate();
+        OpenLayers.Control.prototype.destroy.apply(this, arguments);
+        if (this.gratLayer) {
+            this.gratLayer.destroy();
+            this.gratLayer = null;
+        }
+    },
+
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
+    /**
      * APIMethod: activate
      */
     activate: function() {

lib/OpenLayers/Control/KeyboardDefaults.js

@@ -48,10 +48,14 @@ OpenLayers.Control.KeyboardDefaults = OpenLayers.Class(OpenLayers.Control, {
      */
 
     /**
-     * Method: draw
-     * Create handler.
+     * Method: initialize
+     * Create a KeyboardDefaults handler.
+     *
+     * Parameters:
+     * options - {Object} The options object.
      */
-    draw: function() {
+    initialize: function(options) {
+        OpenLayers.Control.prototype.initialize.call(this, options);
         var observeElement = this.observeElement || document;
         this.handler = new OpenLayers.Handler.Keyboard( this,
                 {"keydown": this.defaultKeyPress},

lib/OpenLayers/Control/Measure.js

@@ -134,6 +134,12 @@ OpenLayers.Control.Measure = OpenLayers.Class(OpenLayers.Control, {
         this.handler = new handler(this, this.callbacks, this.handlerOptions);
     },
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /**
      * APIMethod: deactivate
      */

lib/OpenLayers/Control/ModifyFeature.js

@@ -297,6 +297,12 @@ OpenLayers.Control.ModifyFeature = OpenLayers.Class(OpenLayers.Control, {
         OpenLayers.Control.prototype.destroy.apply(this, []);
     },
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /**
      * APIMethod: activate
      * Activate the control.

lib/OpenLayers/Control/Navigation.js

@@ -178,9 +178,14 @@ OpenLayers.Control.Navigation = OpenLayers.Class(OpenLayers.Control, {
     },
 
     /**
-     * Method: draw
+     * Method: setMap
+     *
+     * Parameters:
+     * map - {<OpenLayers.Map>} The map.
      */
-    draw: function() {
+    setMap: function(map) {
+        OpenLayers.Control.prototype.setMap.call(this, map);
+
         // disable right mouse context menu for support of right click events
         if (this.handleRightClicks) {
             this.map.viewPortDiv.oncontextmenu = OpenLayers.Function.False;
@@ -206,8 +211,8 @@ OpenLayers.Control.Navigation = OpenLayers.Class(OpenLayers.Control, {
         );
         this.zoomBox = new OpenLayers.Control.ZoomBox(
                     {map: this.map, keyMask: this.zoomBoxKeyMask});
-        this.dragPan.draw();
-        this.zoomBox.draw();
+        this.dragPan.setMap(map);
+        this.zoomBox.setMap(map);
         this.handlers.wheel = new OpenLayers.Handler.MouseWheel(
                                     this, {"up"  : this.wheelUp,
                                            "down": this.wheelDown},
@@ -219,6 +224,12 @@ OpenLayers.Control.Navigation = OpenLayers.Class(OpenLayers.Control, {
         }
     },
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /**
      * Method: defaultClick
      *

lib/OpenLayers/Control/NavigationHistory.js

@@ -213,13 +213,9 @@ OpenLayers.Control.NavigationHistory = OpenLayers.Class(OpenLayers.Control, {
 
     /**
      * Method: draw
-     * Called when the control is added to the map.
+     * This control does not have HTML component, so this method should be empty.
      */
-    draw: function() {
-        OpenLayers.Control.prototype.draw.apply(this, arguments);
-        this.next.draw();
-        this.previous.draw();
-    },
+    draw: function() {},
 
     /**
      * Method: previousTrigger

lib/OpenLayers/Control/Pan.js

@@ -66,6 +66,12 @@ OpenLayers.Control.Pan = OpenLayers.Class(OpenLayers.Control, {
         OpenLayers.Control.prototype.initialize.apply(this, [options]);
     },
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /**
      * Method: trigger
      */

lib/OpenLayers/Control/PinchZoom.js

@@ -64,6 +64,12 @@ OpenLayers.Control.PinchZoom = OpenLayers.Class(OpenLayers.Control, {
         }, this.handlerOptions);
     },
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /**
      * APIMethod: activate
      * Activate this control.  Must be called after the control is added to a 

lib/OpenLayers/Control/SLDSelect.js

@@ -177,6 +177,12 @@ OpenLayers.Control.SLDSelect = OpenLayers.Class(OpenLayers.Control, {
         OpenLayers.Control.prototype.destroy.apply(this, arguments);
     },
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /**
      * Method: coupleLayerVisiblity
      * Couple the selection layer and the source layer with respect to

lib/OpenLayers/Control/SelectFeature.js

@@ -246,6 +246,12 @@ OpenLayers.Control.SelectFeature = OpenLayers.Class(OpenLayers.Control, {
         }
     },
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /**
      * Method: activate
      * Activates the control.

lib/OpenLayers/Control/Snapping.js

@@ -191,6 +191,12 @@ OpenLayers.Control.Snapping = OpenLayers.Class(OpenLayers.Control, {
         this.geoToleranceCache = {};
     },
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /**
      * APIMethod: setLayer
      * Set the editable layer.  Call the setLayer method if the editable layer

lib/OpenLayers/Control/Split.js

@@ -176,6 +176,12 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, {
         }
     },
 
+    /**
+     * Method: draw
+     * This control does not have HTML component, so this method should be empty.
+     */
+    draw: function() {},
+
     /**
      * APIMethod: setSource
      * Set the source layer for edits layer.