Changeset 4096

Timestamp:

08/28/07 23:11:41 (1 year ago)

Author:

tschaub

Message:

Modify drag handler for easier subclassing. Thanks for the team effort on this one (closes #827).

Files:

• trunk/openlayers/lib/OpenLayers/Handler/Drag.js (modified) (7 diffs)
• trunk/openlayers/tests/Handler/test_Drag.html (modified) (1 diff)

trunk/openlayers/lib/OpenLayers/Handler/Drag.js

@@ -78 +78 @@
-    
-    /**
+     * The four methods below (down, move, up, and out) are used by subclasses
+     *     to do their own processing related to these mouse events.
+     */
+    
+    /**
+     * Method: down
+     * This method is called during the handling of the mouse down event.
+     *     Subclasses can do their own processing here.
+     *
+     * Parameters:
+     * evt - {Event} The mouse down event
+     */
+    down: function(evt) {
+    },
+    
+    /**
+     * Method: move
+     * This method is called during the handling of the mouse move event.
+     *     Subclasses can do their own processing here.
+     *
+     * Parameters:
+     * evt - {Event} The mouse move event
+     *
+     */
+    move: function(evt) {
+    },
+
+    /**
+     * Method: up
+     * This method is called during the handling of the mouse up event.
+     *     Subclasses can do their own processing here.
+     *
+     * Parameters:
+     * evt - {Event} The mouse up event
+     */
+    up: function(evt) {
+    },
+
+    /**
+     * Method: out
+     * This method is called during the handling of the mouse out event.
+     *     Subclasses can do their own processing here.
+     *
+     * Parameters:
+     * evt - {Event} The mouse out event
+     */
+    out: function(evt) {
+    },
+
+    /**
-     * The methods below are part of the magic of event handling.  Because
-     *     they are named like browser events, they are registered as listeners
@@ -101 +151 @@
-            // TBD replace with CSS classes
-            this.map.div.style.cursor = "move";
+            this.down(evt);
-            this.callback("down", [evt.xy]);
-            OpenLayers.Event.stop(evt);
@@ -122 +173 @@
-            if(evt.xy.x != this.last.x || evt.xy.y != this.last.y) {
-                this.dragging = true;
+                this.move(evt);
-                this.callback("move", [evt.xy]);
-                if(!this.oldOnselectstart) {
@@ -149 +201 @@
-            // TBD replace with CSS classes
-            this.map.div.style.cursor = "";
+            this.up(evt);
-            this.callback("up", [evt.xy]);
-            this.callback("done", [evt.xy]);
@@ -172 +225 @@
-            // TBD replace with CSS classes
-            this.map.div.style.cursor = "";
+            this.out(evt);
-            this.callback("out", []);
-            if(document.onselectstart) {
@@ -211 +265 @@
-     */
-    activate: function() {
+        var activated = false;
-        if(OpenLayers.Handler.prototype.activate.apply(this, arguments)) {
-            this.dragging = false;
-
-
-
-
+
+
+
-    },
-
@@ -227 +281 @@
-     */
-    deactivate: function() {
+        var deactivated = false;
-        if(OpenLayers.Handler.prototype.deactivate.apply(this, arguments)) {
-            this.dragging = false;
-
-
-
-
+
+
+
-    },
-

trunk/openlayers/tests/Handler/test_Drag.html

@@ -249 +249 @@
-    }
-
+    function test_Handler_Drag_submethods(t) {
+        t.plan(4);
+        
+        var map = new OpenLayers.Map('map', {controls: []});
+
+        var control = new OpenLayers.Control();
+        map.addControl(control);
+        
+
+        var handler = new OpenLayers.Handler.Drag(control, {});
+        // set test events
+        var events = ["down", "move", "up", "out"];
+        var testEvents = {};
+        var type, px;
+        for(var i=0; i<events.length; ++i) {
+            type = events[i];
+            px = new OpenLayers.Pixel(Math.random(), Math.random());
+            testEvents[type] = {xy: px};
+            setMethod(type);
+        }
+        function setMethod(type) {
+            handler[type] = function(evt) {
+                t.ok(evt.xy.x == testEvents[type].xy.x &&
+                     evt.xy.y == testEvents[type].xy.y,
+                     "handler." + type + " called with the right event");
+            }
+        }
+        handler.activate();
+        
+        // test mousedown
+        handler.checkModifiers = function(evt) {
+            return true;
+        }
+        var oldIsLeftClick = OpenLayers.Event.isLeftClick;
+        OpenLayers.Event.isLeftClick = function(evt) {
+            return true;
+        }
+        map.events.triggerEvent("mousedown", testEvents.down);
+        OpenLayers.Event.isLeftClick = oldIsLeftClick;
+
+        // test mousemove
+        map.events.triggerEvent("mousemove", testEvents.move);
+        
+        // test mouseup
+        map.events.triggerEvent("mouseup", testEvents.up);
+        
+        // test mouseout
+        var oldMouseLeft = OpenLayers.Util.mouseLeft;
+        OpenLayers.Util.mouseLeft = function() {
+            return true;
+        };
+        handler.started = true;
+        map.events.triggerEvent("mouseout", testEvents.out);
+        OpenLayers.Util.mouseLeft = oldMouseLeft;
+        
+    }
+
-    function test_Handler_Drag_deactivate(t) {
-        t.plan(3);