Changeset 6149

Timestamp:

02/08/08 18:31:27 (1 year ago)

Author:

tschaub

Message:

Trigger feature related events with feature information and layer related events with layer information. Also adding events.on and events.un convenience methods. r=crschmidt (closes #1343)

Files:

• trunk/openlayers/lib/OpenLayers/Control/Attribution.js (modified) (2 diffs)
• trunk/openlayers/lib/OpenLayers/Control/LayerSwitcher.js (modified) (2 diffs)
• trunk/openlayers/lib/OpenLayers/Control/ModifyFeature.js (modified) (5 diffs)
• trunk/openlayers/lib/OpenLayers/Control/MouseDefaults.js (modified) (2 diffs)
• trunk/openlayers/lib/OpenLayers/Control/MouseToolbar.js (modified) (1 diff)
• trunk/openlayers/lib/OpenLayers/Control/OverviewMap.js (modified) (1 diff)
• trunk/openlayers/lib/OpenLayers/Control/PanZoomBar.js (modified) (5 diffs)
• trunk/openlayers/lib/OpenLayers/Control/Permalink.js (modified) (1 diff)
• trunk/openlayers/lib/OpenLayers/Control/SelectFeature.js (modified) (2 diffs)
• trunk/openlayers/lib/OpenLayers/Events.js (modified) (6 diffs)
• trunk/openlayers/lib/OpenLayers/Layer.js (modified) (4 diffs)
• trunk/openlayers/lib/OpenLayers/Layer/Grid.js (modified) (1 diff)
• trunk/openlayers/lib/OpenLayers/Layer/Vector.js (modified) (3 diffs)
• trunk/openlayers/lib/OpenLayers/Layer/WFS.js (modified) (1 diff)
• trunk/openlayers/lib/OpenLayers/Map.js (modified) (6 diffs)
• trunk/openlayers/lib/OpenLayers/Popup.js (modified) (1 diff)
• trunk/openlayers/tests/Control/test_ModifyFeature.html (modified) (9 diffs)
• trunk/openlayers/tests/Control/test_SelectFeature.html (modified) (1 diff)
• trunk/openlayers/tests/Layer/test_Grid.html (modified) (1 diff)
• trunk/openlayers/tests/test_Events.html (modified) (1 diff)

trunk/openlayers/lib/OpenLayers/Control/Attribution.js

@@ -36 +36 @@
-     */
-    destroy: function() {
-
-
-
-
+
+
+
+
+
+
+
-        
-        OpenLayers.Control.prototype.destroy.apply(this, arguments);
@@ -54 +57 @@
-        OpenLayers.Control.prototype.draw.apply(this, arguments);
-        
-
-
-
-
+
+
+
+
+
+
+
-        this.updateAttribution();
-        

trunk/openlayers/lib/OpenLayers/Control/LayerSwitcher.js

@@ -114 +114 @@
-        this.clearLayersArray("data");
-        
-
-
-
-
+
+
+
+
+
+
+
-        
-        OpenLayers.Control.prototype.destroy.apply(this, arguments);
@@ -131 +134 @@
-        OpenLayers.Control.prototype.setMap.apply(this, arguments);
-
-
-
-
-
+
+
+
+
+
+
+
-    },
-

trunk/openlayers/lib/OpenLayers/Control/ModifyFeature.js

@@ -183 +183 @@
-            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
@@ -227 +226 @@
-     */
-    destroy: function() {
+        this.layer.events.un({
+            "featureselected": this.selectFeature,
+            "featureunselected": this.unselectFeature,
+            scope: this
+        });
-        this.layer = null;
-        this.selectControl.destroy();
@@ -277 +281 @@
-     *
-     * Parameters:
-
-
-
-
+
+
+
+
+
-        this.resetVertices();
-        this.dragControl.activate();
@@ -291 +296 @@
-     *
-     * Parameters:
-
-
-
+
+
+
+
-        this.layer.removeFeatures(this.vertices);
-        this.vertices = [];
@@ -308 +314 @@
-        this.feature = null;
-        this.dragControl.deactivate();
-
+object.
-    },
-

trunk/openlayers/lib/OpenLayers/Control/MouseDefaults.js

@@ -48 +48 @@
-        this.handler = null;
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-        //unregister mousewheel events specifically on the window and document
@@ -71 +74 @@
-     */
-    draw: function() {
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-        this.registerWheelEvents();

trunk/openlayers/lib/OpenLayers/Control/MouseToolbar.js

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

trunk/openlayers/lib/OpenLayers/Control/OverviewMap.js

@@ -155 +155 @@
-        }
-        
-
-
-
+
+
+
+
+
-
-        OpenLayers.Control.prototype.destroy.apply(this, arguments);    

trunk/openlayers/lib/OpenLayers/Control/PanZoomBar.js

@@ -80 +80 @@
-        this.divEvents = null;
-
-
-
+
+
+
+
+
-
-        OpenLayers.Control.PanZoom.prototype.destroy.apply(this, arguments);
@@ -165 +168 @@
-        
-        this.sliderEvents = new OpenLayers.Events(this, slider, null, true);
-
-
-
-
-
+
+
+
+
+
+
+
-        
-        var sz = new OpenLayers.Size();
@@ -195 +200 @@
-        
-        this.divEvents = new OpenLayers.Events(this, div, null, true);
-
-
-
-
+
+
+
+
+
+
-        
-        this.div.appendChild(div);
@@ -251 +258 @@
-            return;
-        }
-
-
+
+
+
+
+
-        this.mouseDragStart = evt.xy.clone();
-        this.zoomStart = evt.xy.clone();
@@ -299 +309 @@
-        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));

trunk/openlayers/lib/OpenLayers/Control/Permalink.js

@@ -116 +116 @@
-            this.div.appendChild(this.element);
-        }
-
-
-
+
+
+
+
+
+
-        return this.div;
-    },

trunk/openlayers/lib/OpenLayers/Control/SelectFeature.js

@@ -267 +267 @@
-
-        this.layer.drawFeature(feature);
+        this.layer.events.triggerEvent("featureselected", {feature: feature});
-        this.onSelect(feature);
-    },
@@ -285 +286 @@
-        this.layer.drawFeature(feature);
-        OpenLayers.Util.removeItem(this.layer.selectedFeatures, feature);
+        this.layer.events.triggerEvent("featureunselected", {feature: feature});
-        this.onUnselect(feature);
-    },

trunk/openlayers/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]);
+            }
+        }
-    },
-
@@ -554 +575 @@
-    
-    /**
+     * 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
-     *
@@ -597 +639 @@
-     * type - {String} 
-     * evt - {Event}
-     * args - {Array} Optional array of arguments to call the listener with.
-     *
-     * Returns:
@@ -603 +644 @@
-     *     chain of listeners will stop getting called.
-     */
-, args
+
-
-        // prep evt object with object & div references
@@ -611 +652 @@
-        evt.object = this.object;
-        evt.element = this.element;
-
-
-
-
-
-
-
+
-        // execute all callbacks registered for specified type
-        // get a clone of the listeners array to
@@ -628 +663 @@
-                var callback = listeners[i];
-                // bind the context to callback.obj
-args
+[evt]
-    
-                if ((continueChain != undefined) && (continueChain == false)) {

trunk/openlayers/lib/OpenLayers/Layer.js

@@ -38 +38 @@
-    opacity: null,
-
- 
+
-     * Constant: EVENT_TYPES
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-     */
-    EVENT_TYPES: ["loadstart", "loadend", "loadcancel", "visibilitychanged"],
@@ -328 +345 @@
-            this.name = newName;
-            if (this.map != null) {
-
+
+
+
+
-            }
-        }
@@ -531 +551 @@
-            this.redraw();
-            if (this.map != null) {
-
+
+
+
+
-            }
-            this.events.triggerEvent("visibilitychanged");
@@ -577 +600 @@
-            this.isBaseLayer = isBaseLayer;
-            if (this.map != null) {
-
+
+
+
-            }
-        }

trunk/openlayers/lib/OpenLayers/Layer/Grid.js

@@ -527 +527 @@
-     */
-    removeTileMonitoringHooks: function(tile) {
-
-
+
+
+
+
+
-    },
-    

trunk/openlayers/lib/OpenLayers/Layer/Vector.js

@@ -19 +19 @@
- */
-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"],
-
-    /**
@@ -274 +314 @@
-
-            if (notify) {
+                this.events.triggerEvent("beforefeatureadded", {
+                    feature: feature
+                });
-                this.preFeatureInsert(feature);
-            }
@@ -282 +325 @@
-            
-            if (notify) {
+                this.events.triggerEvent("featureadded", {
+                    feature: feature
+                });
-                this.onFeatureInsert(feature);
-            }
+        }
+        
+        if(notify) {
+            this.events.triggerEvent("featuresadded", {features: features});
-        }
-    },

trunk/openlayers/lib/OpenLayers/Layer/WFS.js

@@ -354 +354 @@
-     */
-    removeTileMonitoringHooks: function(tile) {
-
-
+
+
+
+
+
-    },
-

trunk/openlayers/lib/OpenLayers/Map.js

@@ -33 +33 @@
-     * (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
@@ -736 +755 @@
-        }
-
-
+, {layer: layer}
-    },
-
@@ -809 +828 @@
-        this.resetLayersZIndex();
-
-
+, {layer: layer}
-    },
-
@@ -861 +880 @@
-                this.setLayerZIndex(this.layers[i], i);
-            }
-
+
+
+
-        }
-    },
@@ -934 +955 @@
-                }
-
-
+
+
+
-            }        
-        }
@@ -1454 +1477 @@
-                            layer.display(false);
-                        }
-
+
+
+
-                    }
-                    if (inRange && layer.visibility) {

trunk/openlayers/lib/OpenLayers/Popup.js

@@ -404 +404 @@
-        this.events = new OpenLayers.Events(this, this.div, null, true);
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-     },
-

trunk/openlayers/tests/Control/test_ModifyFeature.html

@@ -6 +6 @@
-    function test_ModifyFeature_constructor(t) {
-        t.plan(3);
-
+
+
+
+
+
-        var options = {
-            geometryTypes: "bar"
@@ -12 +16 @@
-        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",
@@ -73 +77 @@
-         */
-        
-
+
+
+
+
+
+
-        var delKey = 46;
-        var dKey = 100;
@@ -198 +207 @@
-            t.ok(verts == 'b', "Virtual verts destroyed correctly");
-        }
-fakeFeature
+{feature: fakeFeature}
-        t.eq(control.feature, null, "feature is set to null");
-    }    
@@ -217 +226 @@
-        
-        // Points don't call collectVertices
-fakeFeature
+{feature: fakeFeature}
-        
-        control.collectVertices = function() { 
@@ -233 +242 @@
-        
-        // OnSelect calls collectVertices and passes features to layer 
-fakeFeature
+{feature: fakeFeature}
-        
-        control.vertices = ['a'];
@@ -245 +254 @@
-
-        // Features are removed whenever they exist
-fakeFeature
+{feature: fakeFeature}
-        
-    }  
@@ -390 +399 @@
-                 "onModificationStart called with the right feature");
-        };
-testFeature
+{feature: testFeature}
-    }
-    
@@ -451 +460 @@
-                 "onModificationEnd called with the right feature");
-        };
-testFeature
+{feature: testFeature}
-    }
-

trunk/openlayers/tests/Control/test_SelectFeature.html

@@ -79 +79 @@
-        var layer = {
-            selectedFeatures: [],
-
+
+
+
+
-        };
-        // mock up active control

trunk/openlayers/tests/Layer/test_Grid.html

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

trunk/openlayers/tests/test_Events.html

@@ -206 +206 @@
-        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);
-