Changeset 4062

Timestamp:

08/27/07 15:55:04 (1 year ago)

Author:

tschaub

Message:

Give handlers a non-API evt property - this to be used by other controls in the library only. Eventually, we may decide to restructure this. (Closes #902)

Files:

• trunk/openlayers/lib/OpenLayers/Handler.js (modified) (3 diffs)
• trunk/openlayers/tests/Handler/test_Drag.html (modified) (1 diff)
• trunk/openlayers/tests/Handler/test_MouseWheel.html (modified) (1 diff)
• trunk/openlayers/tests/test_Handler.html (modified) (5 diffs)

trunk/openlayers/lib/OpenLayers/Handler.js

@@ -73 +73 @@
-     */
-    active: false,
+    
+    /**
+     * Property: evt
+     * {Event} This property references the last event handled by the handler.
+     *     Note that this property is not part of the stable API.  Use of the
+     *     evt property should be restricted to controls in the library
+     *     or other applications that are willing to update with changes to
+     *     the OpenLayers code.
+     */
+    evt: null,
-
-    /**
@@ -199 +209 @@
-    register: function (name, method) {
-        // TODO: deal with registerPriority in 3.0
-
+
+
-    },
-
@@ -208 +219 @@
-    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;
-    },
-

trunk/openlayers/tests/Handler/test_Drag.html

@@ -58 +58 @@
-        var nonevents = ["dblclick", "resize", "focus", "blur"];
-        map.events.registerPriority = function(type, obj, func) {
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        }
-        

trunk/openlayers/tests/Handler/test_MouseWheel.html

@@ -73 +73 @@
-        var nonevents = ["dblclick", "resize", "focus", "blur"];
-        map.events.registerPriority = function(type, obj, func) {
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        }
-        

trunk/openlayers/tests/test_Handler.html

@@ -23 +23 @@
-    
-    function test_Handler_activate(t) {
-4
+5
-        var map = new OpenLayers.Map('map');
-        var control = new OpenLayers.Control();
@@ -40 +40 @@
-        handler.active = false;
-        map.events.registerPriority = function(type, obj, func) {
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        }
-        
@@ -64 +71 @@
-    
-    function test_Handler_deactivate(t) {
-4
+5
-        var map = new OpenLayers.Map('map');
-        var control = new OpenLayers.Control();
@@ -81 +88 @@
-        handler.activate();
-        map.events.unregister = function(type, obj, func) {
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        }
-        
@@ -102 +116 @@
-             "deactivated returns true if the handler is already active");
-        
+    }
+    
+    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");
-    }
-