Ticket #902: handler.evt.patch

lib/OpenLayers/Handler.js

@@ -198 +198 @@
-    */
-    register: function (name, method) {
-        // TODO: deal with registerPriority in 3.0
-
+
+
-    },
-
-    /**
@@ -207 +208 @@
-    */
-    unregister: function (name, method) {
-        this.map.events.unregister(name, this, method);   
+        this.map.events.unregister(name, this, this.setEvent);
-    },
+    
+    /**
+     * Method: setEvent
+     * With each registered browser event, the handler sets its own evt
+     *     property.  This property can be accessed by controls if needed
+     *     to get more information about the event that the handler is
+     *     processing.
+     *
+     * This allows modifier keys on the event to be checked (alt, shift,
+     *     and ctrl cannot be checked with the keyboard handler).  For a
+     *     control to determine which modifier keys are associated with the
+     *     event that a handler is currently processing, it should access
+     *     (code)handler.evt.altKey || handler.evt.shiftKey ||
+     *     handler.evt.ctrlKey(end).
+     *
+     * Parameters:
+     * evt - {Event} The browser event.
+     */
+    setEvent: function(evt) {
+        this.evt = evt;
+        return true;
+    },
-
-    /**
-     * Method: destroy

tests/Handler/test_Drag.html

@@ -57 +57 @@
-        var events = ["mousedown", "mouseup", "mousemove", "mouseout", "click"];
-        var nonevents = ["dblclick", "resize", "focus", "blur"];
-        map.events.registerPriority = function(type, obj, func) {
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        }
-        
-        // set browser event like properties on the handler

tests/test_Handler.html

@@ -22 +22 @@
-    }
-    
-    function test_Handler_activate(t) {
-4
+5
-        var map = new OpenLayers.Map('map');
-        var control = new OpenLayers.Control();
-        map.addControl(control);
@@ -39 +39 @@
-
-        handler.active = false;
-        map.events.registerPriority = function(type, obj, func) {
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        }
-        
-        // set browser event like properties on the handler
@@ -63 +70 @@
-    }
-    
-    function test_Handler_deactivate(t) {
-4
+5
-        var map = new OpenLayers.Map('map');
-        var control = new OpenLayers.Control();
-        map.addControl(control);
@@ -80 +87 @@
-
-        handler.activate();
-        map.events.unregister = function(type, obj, func) {
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        }
-        
-        // set browser event like properties on the handler
@@ -103 +117 @@
-        
-    }
-    
+    function test_Handler_setEvent(t) {
+        t.plan(4);
+        var map = new OpenLayers.Map('map');
+        var control = new OpenLayers.Control();
+        map.addControl(control);
+        var handler = new OpenLayers.Handler(control);
+        handler.click = function(evt) {
+        }
+        handler.activate();
+        var testEvent = {
+            xy: new OpenLayers.Pixel(Math.random(), Math.random()),
+            altKey: (Math.random() > 0.5),
+            shiftKey: (Math.random() > 0.5),
+            ctrlKey: (Math.random() > 0.5)
+        }
+        map.events.triggerEvent("click", testEvent);
+        t.ok(handler.evt.xy.x == testEvent.xy.x &&
+             handler.evt.xy.y == testEvent.xy.y,
+             "handler.evt has proper xy object");
+        t.eq(handler.evt.altKey, testEvent.altKey,
+             "handler.evt.altKey correct");
+        t.eq(handler.evt.shiftKey, testEvent.shiftKey,
+             "handler.evt.shiftKey correct");
+        t.eq(handler.evt.ctrlKey, testEvent.ctrlKey,
+             "handler.evt.ctrlKey correct");
+    }
+    
-    function test_Handler_destroy(t) {
-        t.plan(4);
-        var map = new OpenLayers.Map('map');