Ticket #1343: events.patch

tests/Control/test_SelectFeature.html

@@ -78 +78 @@
-        // mock up layer
-        var layer = {
-            selectedFeatures: [],
-
+
+
+
+
-        };
-        // mock up active control
-        var control = new OpenLayers.Control.SelectFeature(layer);

tests/Control/test_ModifyFeature.html

@@ -5 +5 @@
-    
-    function test_ModifyFeature_constructor(t) {
-        t.plan(3);
-
+
+
+
+
+
-        var options = {
-            geometryTypes: "bar"
-        };
-        var control = new OpenLayers.Control.ModifyFeature(layer, options);
-        
-eq(control.layer, "foo"
+ok(control.layer == layer
-             "constructor sets layer correctly");
-        t.eq(control.selectControl.geometryTypes, "bar",
-             "constructor sets options correctly on feature handler");
@@ -72 +76 @@
-         * In the future, feature deletion may be added to the control.
-         */
-        
-
+
+
+
+
+
+
-        var delKey = 46;
-        var dKey = 100;
-        control.deleteCodes = [delKey, dKey];
@@ -197 +206 @@
-        layer.destroyFeatures = function(verts) {
-            t.ok(verts == 'b', "Virtual verts destroyed correctly");
-        }
-fakeFeature
+{feature: fakeFeature}
-        t.eq(control.feature, null, "feature is set to null");
-    }    
-    function test_ModifyFeature_selectFeature(t) {
@@ -216 +225 @@
-        var fakeFeature = {'id':'myFakeFeature','geometry':{'CLASS_NAME':'OpenLayers.Geometry.Point'}};
-        
-        // Points don't call collectVertices
-fakeFeature
+{feature: fakeFeature}
-        
-        control.collectVertices = function() { 
-          t.ok(true, "collectVertices called"); 
@@ -232 +241 @@
-        fakeFeature.geometry.CLASS_NAME='OpenLayers.Geometry.Polygon';
-        
-        // OnSelect calls collectVertices and passes features to layer 
-fakeFeature
+{feature: fakeFeature}
-        
-        control.vertices = ['a'];
-        control.virtualVertices = ['b'];
@@ -244 +253 @@
-        }    
-
-        // Features are removed whenever they exist
-fakeFeature
+{feature: fakeFeature}
-        
-    }  
-
@@ -389 +398 @@
-            t.eq(feature.id, testFeature.id,
-                 "onModificationStart called with the right feature");
-        };
-testFeature
+{feature: testFeature}
-    }
-    
-    function test_ModifyFeature_onModification(t) {
@@ -450 +459 @@
-            t.eq(feature.id, testFeature.id,
-                 "onModificationEnd called with the right feature");
-        };
-testFeature
+{feature: testFeature}
-    }
-
-

tests/test_Events.html

@@ -205 +205 @@
-        eventTypes = ["something"];
-        events = new OpenLayers.Events(null, null, eventTypes);
-        var instance = {id: Math.random()};
-
+obj
-            t.eq(this.id, instance.id,
-                 "listener called with proper scope");
-[0].id, evt.id
-evt as first arg
-arguments[1], "arg1
-correct extra arg1
-arguments[2], "arg2"
-listener called with correct extra arg2
+.length, 1
+a single argument
+typeof arguments, "object
+an object
+obj.foo, evt.foo
+foo property set on the layer
-        };
-        events.register("something", instance, listener);        
-
-
+
+
+
+
+
-        events.unregister("something", instance, listener);
-        
-        // test return from triggerEvent

tests/Layer/test_Grid.html

@@ -499 +499 @@
-            events: {
-                unregister: function(name, obj, func) {
-                    g_unregistered[name] = [obj, func];
-
+
+
-            }
-        }
-

lib/OpenLayers/Map.js

@@ -32 +32 @@
-     * map.events.register(type, obj, listener);
-     * (end)
-     *
+     * Listeners will be called with a reference to an event object.  The
+     *     properties of this event depends on exactly what happened.
+     *
+     * All event objects have at least the following properties:
+     *  - *object* {Object} A reference to map.events.object.
+     *  - *element* {DOMElement} A reference to map.events.element.
+     *
+     * Browser events have the following additional properties:
+     *  - *xy* {<OpenLayers.Pixel>} The pixel location of the event (relative
+     *      to the the map viewport).
+     *  - other properties that come with browser events
+     *
-     * Supported map event types:
-
-
+
+
+
+
+
-     *  - *changelayer* triggered after a layer name change, order change, or
-
+
+
+
+
+
-     *  - *movestart* triggered after the start of a drag, pan, or zoom
-     *  - *move* triggered after each drag, pan, or zoom
-     *  - *moveend* triggered after a drag, pan, or zoom completes
@@ -735 +754 @@
-            layer.redraw();
-        }
-
-
+, {layer: layer}
-    },
-
-    /**
@@ -808 +827 @@
-
-        this.resetLayersZIndex();
-
-
+, {layer: layer}
-    },
-
-    /**
@@ -860 +879 @@
-            for (var i = 0; i < this.layers.length; i++) {
-                this.setLayerZIndex(this.layers[i], i);
-            }
-
+
+
+
-        }
-    },
-
@@ -933 +954 @@
-                    this.setCenter(newCenter, newZoom, false, true);
-                }
-
-
+
+
+
-            }        
-        }
-    },
@@ -1453 +1476 @@
-                        if (!inRange) {
-                            layer.display(false);
-                        }
-
+
+
+
-                    }
-                    if (inRange && layer.visibility) {
-                        layer.moveTo(bounds, zoomChanged, dragging);

lib/OpenLayers/Popup.js

@@ -403 +403 @@
-     registerEvents:function() {
-        this.events = new OpenLayers.Events(this, this.div, null, true);
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-     },
-
-    /** 

lib/OpenLayers/Events.js

@@ -481 +481 @@
-        // disable dragstart in IE so that mousedown/move/up works normally
-        OpenLayers.Event.observe(element, "dragstart", OpenLayers.Event.stop);
-    },
+    
+    /**
+     * Method: on
+     * Convenience method for registering listeners with a common scope.
+     *
+     * Example use:
+     * (code)
+     * events.on({
+     *     "loadstart": loadStartListener,
+     *     "loadend": loadEndListener,
+     *     scope: object
+     * });
+     * (end)
+     */
+    on: function(object) {
+        for(var type in object) {
+            if(type != "scope") {
+                this.register(type, object.scope, object[type]);
+            }
+        }
+    },
-
-    /**
-     * APIMethod: register
@@ -553 +574 @@
-    },
-    
-    /**
+     * Method: un
+     * Convenience method for unregistering listeners with a common scope.
+     *
+     * Example use:
+     * (code)
+     * events.un({
+     *     "loadstart": loadStartListener,
+     *     "loadend": loadEndListener,
+     *     scope: object
+     * });
+     * (end)
+     */
+    un: function(object) {
+        for(var type in object) {
+            if(type != "scope") {
+                this.unregister(type, object.scope, object[type]);
+            }
+        }
+    },
+
+    /**
-     * APIMethod: unregister
-     *
-     * Parameters:
@@ -596 +638 @@
-     * Parameters:
-     * type - {String} 
-     * evt - {Event}
-     * args - {Array} Optional array of arguments to call the listener with.
-     *
-     * Returns:
-     * {Boolean} The last listener return.  If a listener returns false, the
-     *     chain of listeners will stop getting called.
-     */
-, args
+
-
-        // prep evt object with object & div references
-        if (evt == null) {
@@ -610 +651 @@
-        }
-        evt.object = this.object;
-        evt.element = this.element;
-
-
-
-
-
-
-
+
-        // execute all callbacks registered for specified type
-        // get a clone of the listeners array to
-        // allow for splicing during callbacks
@@ -627 +662 @@
-            for (var i = 0; i < listeners.length; i++) {
-                var callback = listeners[i];
-                // bind the context to callback.obj
-args
+[evt]
-    
-                if ((continueChain != undefined) && (continueChain == false)) {
-                    // if callback returns false, execute no more callbacks.

lib/OpenLayers/Control/OverviewMap.js

@@ -154 +154 @@
-            this.minimizeDiv = null;
-        }
-        
-
-
-
+
+
+
+
+
-
-        OpenLayers.Control.prototype.destroy.apply(this, arguments);    
-    },

lib/OpenLayers/Control/Attribution.js

@@ -35 +35 @@
-     * Destroy control.
-     */
-    destroy: function() {
-
-
-
-
+
+
+
+
+
+
+
-        
-        OpenLayers.Control.prototype.destroy.apply(this, arguments);
-    },    
@@ -53 +56 @@
-    draw: function() {
-        OpenLayers.Control.prototype.draw.apply(this, arguments);
-        
-
-
-
-
+
+
+
+
+
+
+
-        this.updateAttribution();
-        
-        return this.div;    

lib/OpenLayers/Control/PanZoomBar.js

@@ -79 +79 @@
-        this.divEvents.destroy();
-        this.divEvents = null;
-
-
-
+
+
+
+
+
-
-        OpenLayers.Control.PanZoom.prototype.destroy.apply(this, arguments);
-    },
@@ -164 +167 @@
-        this.slider = slider;
-        
-        this.sliderEvents = new OpenLayers.Events(this, slider, null, true);
-
-
-
-
-
+
+
+
+
+
+
+
-        
-        var sz = new OpenLayers.Size();
-        sz.h = this.zoomStopHeight * this.map.getNumZoomLevels();
@@ -194 +199 @@
-        this.zoombarDiv = div;
-        
-        this.divEvents = new OpenLayers.Events(this, div, null, true);
-
-
-
-
+
+
+
+
+
+
-        
-        this.div.appendChild(div);
-
@@ -250 +257 @@
-        if (!OpenLayers.Event.isLeftClick(evt)) {
-            return;
-        }
-
-
+
+
+
+
+
-        this.mouseDragStart = evt.xy.clone();
-        this.zoomStart = evt.xy.clone();
-        this.div.style.cursor = "move";
@@ -298 +308 @@
-        }
-        if (this.zoomStart) {
-            this.div.style.cursor="";
-
-
+
+
+
+
+
-            var deltaY = this.zoomStart.y - evt.xy.y;
-            this.map.zoomTo(this.map.zoom + Math.round(deltaY/this.zoomStopHeight));
-            this.moveZoomBar();

lib/OpenLayers/Control/MouseToolbar.js

@@ -105 +105 @@
-        btn.activeImgLocation = activeImgLocation;
-        
-        btn.events = new OpenLayers.Events(this, btn, null, true);
-
-
-
+
+
+
+
+
+
-        btn.action = id;
-        btn.title = title;
-        btn.alt = title;

lib/OpenLayers/Control/MouseDefaults.js

@@ -47 +47 @@
-        }
-        this.handler = null;
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-        //unregister mousewheel events specifically on the window and document
-        OpenLayers.Event.stopObserving(window, "DOMMouseScroll", 
@@ -70 +73 @@
-     * Method: draw
-     */
-    draw: function() {
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-        this.registerWheelEvents();
-

lib/OpenLayers/Control/Permalink.js

@@ -115 +115 @@
-            this.element.href="";
-            this.div.appendChild(this.element);
-        }
-
-
-
+
+
+
+
+
+
-        return this.div;
-    },
-   

lib/OpenLayers/Control/LayerSwitcher.js

@@ -113 +113 @@
-        this.clearLayersArray("base");
-        this.clearLayersArray("data");
-        
-
-
-
-
+
+
+
+
+
+
+
-        
-        OpenLayers.Control.prototype.destroy.apply(this, arguments);
-    },
@@ -130 +133 @@
-    setMap: function(map) {
-        OpenLayers.Control.prototype.setMap.apply(this, arguments);
-
-
-
-
-
+
+
+
+
+
+
+
-    },
-
-    /**

lib/OpenLayers/Control/SelectFeature.js

@@ -266 +266 @@
-        OpenLayers.Util.extend(feature.style, selectStyle);
-
-        this.layer.drawFeature(feature);
+        this.layer.events.triggerEvent("featureselected", {feature: feature});
-        this.onSelect(feature);
-    },
-
@@ -284 +285 @@
-        }
-        this.layer.drawFeature(feature);
-        OpenLayers.Util.removeItem(this.layer.selectedFeatures, feature);
+        this.layer.events.triggerEvent("featureunselected", {feature: feature});
-        this.onUnselect(feature);
-    },
-

lib/OpenLayers/Control/ModifyFeature.js

@@ -182 +182 @@
-        var selectOptions = {
-            geometryTypes: this.geometryTypes,
-            clickout: this.clickout,
-
-
-
-
-
-
-
+
-        };
-        this.selectControl = new OpenLayers.Control.SelectFeature(
-            layer, selectOptions
-        );
+        this.layer.events.on({
+            "featureselected": this.selectFeature,
+            "featureunselected": this.unselectFeature,
+            scope: this
+        });
-
-        // configure the drag control
-        var dragOptions = {
@@ -226 +225 @@
-     * Take care of things that are not handled in superclass.
-     */
-    destroy: function() {
+        this.layer.events.un({
+            "featureselected": this.selectFeature,
+            "featureunselected": this.unselectFeature,
+            scope: this
+        });
-        this.layer = null;
-        this.selectControl.destroy();
-        this.dragControl.destroy();
@@ -276 +280 @@
-     * Called when the select feature control selects a feature.
-     *
-     * Parameters:
-
+
+
-     */
-feature
-
+object
+object.
-        this.resetVertices();
-        this.dragControl.activate();
-        this.onModificationStart(this.feature);
@@ -290 +295 @@
-     * Called when the select feature control unselects a feature.
-     *
-     * Parameters:
-
+
+
-     */
-feature
+object
-        this.layer.removeFeatures(this.vertices);
-        this.vertices = [];
-        this.layer.destroyFeatures(this.virtualVertices);
@@ -307 +313 @@
-        }
-        this.feature = null;
-        this.dragControl.deactivate();
-
+object.
-    },
-
-    /**

lib/OpenLayers/Layer.js

@@ -37 +37 @@
-     */
-    opacity: null,
-
- 
+
-     * Constant: EVENT_TYPES
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-     */
-    EVENT_TYPES: ["loadstart", "loadend", "loadcancel", "visibilitychanged"],
-        
@@ -327 +344 @@
-        if (newName != this.name) {
-            this.name = newName;
-            if (this.map != null) {
-
+
+
+
+
-            }
-        }
-    },    
@@ -530 +550 @@
-            this.display(visibility);
-            this.redraw();
-            if (this.map != null) {
-
+
+
+
+
-            }
-            this.events.triggerEvent("visibilitychanged");
-        }
@@ -576 +599 @@
-        if (isBaseLayer != this.isBaseLayer) {
-            this.isBaseLayer = isBaseLayer;
-            if (this.map != null) {
-
+
+
+
-            }
-        }
-    },

lib/OpenLayers/Layer/Grid.js

@@ -526 +526 @@
-     * tile - {<OpenLayers.Tile>}
-     */
-    removeTileMonitoringHooks: function(tile) {
-
-
+
+
+
+
+
-    },
-    
-    /**

lib/OpenLayers/Layer/WFS.js

@@ -353 +353 @@
-     * tile - {<OpenLayers.Tile>}
-     */
-    removeTileMonitoringHooks: function(tile) {
-
-
+
+
+
+
+
-    },
-
-    /**

lib/OpenLayers/Layer/Vector.js

@@ -20 +20 @@
-OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, {
-
-    /**
+     * Constant: EVENT_TYPES
+     * {Array(String)} Supported application event types.  Register a listener
+     *     for a particular event with the following syntax:
+     * (code)
+     * layer.events.register(type, obj, listener);
+     * (end)
+     *
+     * Listeners will be called with a reference to an event object.  The
+     *     properties of this event depends on exactly what happened.
+     *
+     * All event objects have at least the following properties:
+     *  - *object* {Object} A reference to layer.events.object.
+     *  - *element* {DOMElement} A reference to layer.events.element.
+     *
+     * Supported map event types:
+     *  - *loadstart* Triggered when layer loading starts.
+     *  - *loadend* Triggered when layer loading ends.
+     *  - *loadcancel* Triggered when layer loading is canceled.
+     *  - *visibilitychanged* Triggered when layer visibility is changed.
+     *  - *beforefeatureadded* Triggered before a feature is added.  Listeners
+     *      will receive an object with a *feature* property referencing the
+     *      feature to be added.
+     *  - *featureadded* Triggered after a feature is added.  The event
+     *      object passed to listeners will have a *feature* property with a
+     *      reference to the added feature.
+     *  - *featuresadded* Triggered after features are added.  The event
+     *      object passed to listeners will have a *features* property with a
+     *      reference to an array of added features.
+     *  - *featureselected* Triggered after a feature is selected.  Listeners
+     *      will receive an object with a *feature* property referencing the
+     *      selected feature.
+     *  - *featureunselected* Triggered after a feature is unselected.
+     *      Listeners will receive an object with a *feature* property
+     *      referencing the unselected feature.
+     */
+    EVENT_TYPES: ["loadstart", "loadend", "loadcancel", "visibilitychanged",
+                  "beforefeatureadded", "featureadded",
+                  "featuresadded", "featureselected", "featureunselected"],
+
+    /**
-     * APIProperty: isBaseLayer
-     * {Boolean} The layer is a base layer.  Default is true.  Set this property
-     * in the layer options
@@ -273 +313 @@
-            }
-
-            if (notify) {
+                this.events.triggerEvent("beforefeatureadded", {
+                    feature: feature
+                });
-                this.preFeatureInsert(feature);
-            }
-
@@ -281 +324 @@
-            }
-            
-            if (notify) {
+                this.events.triggerEvent("featureadded", {
+                    feature: feature
+                });
-                this.onFeatureInsert(feature);
-            }
-        }
+        
+        if(notify) {
+            this.events.triggerEvent("featuresadded", {features: features});
+        }
-    },
-
-