Ticket #827: drag.patch

lib/OpenLayers/Handler/Drag.js

@@ -73 +73 @@
-    },
-    
-    /**
+     * Method: activate
+     * Activate the handler.
+     * 
+     * Return:
+     * {Boolean} The handler was successfully activated.
+     */
+    activate: function() {
+        var activated = false;
+        if(OpenLayers.Handler.prototype.activate.apply(this, arguments)) {
+            this.dragging = false;
+            activated = true;
+        }
+        return activated;
+    },
+
+    /**
+     * Method: deactivate 
+     * Deactivate the handler.
+     * 
+     * Return:
+     * {Boolean} The handler was successfully deactivated.
+     */
+    deactivate: function() {
+        var deactivated = false;
+        if(OpenLayers.Handler.prototype.deactivate.apply(this, arguments)) {
+            this.dragging = false;
+            deactivated = true;
+        }
+        return deactivated;
+    },
+
+    /**
+     * The four methods below (down, move, up, and out) are used by subclasses
+     *     to do their own processing related to these mouse events, or to
+     *     modify the handling of these events before the drag handler gets to
+     *     them. In subclasses, these methods should typically return true.
+     */
+    
+    /**
+     * Method: down
+     * This method is called prior to handling the mouse down event.  Subclasses
+     *     can do their own processing here and return true to continue with the
+     *     normal drag handling, or they can return false to do their own
+     *     handling. Note that this method should only be used/overridden by
+     *     subclasses; controls that wrap handlers should deal with callbacks
+     *     instead.
+     *
+     * Parameters:
+     * evt - {Event} The mouse down event
+     *
+     * Return:
+     * {Boolean} Let the handler deal with the mouse down event.  This should
+     *     typically return true unless a subclass wants to modify event
+     *     handling.
+     */
+    down: function(evt) {
+        return true;
+    },
+    
+    /**
+     * Method: move
+     * This method is called prior to handling the mouse move event.  Subclasses
+     *     can do their own processing here and return true to continue with the
+     *     normal drag handling, or they can return false to do their own
+     *     handling. Note that this method should only be used/overridden by
+     *     subclasses; controls that wrap handlers should deal with callbacks
+     *     instead.
+     *
+     * Parameters:
+     * evt - {Event} The mouse move event
+     *
+     * Return:
+     * {Boolean} Let the handler deal with the mouse move event.  This should
+     *     typically return true unless a subclass wants to modify event
+     *     handling.
+     */
+    move: function(evt) {
+        return true;
+    },
+
+    /**
+     * Method: up
+     * This method is called prior to handling the mouse up event.  Subclasses
+     *     can do their own processing here and return true to continue with the
+     *     normal drag handling, or they can return false to do their own
+     *     handling. Note that this method should only be used/overridden by
+     *     subclasses; controls that wrap handlers should deal with callbacks
+     *     instead.
+     *
+     * Parameters:
+     * evt - {Event} The mouse up event
+     *
+     * Return:
+     * {Boolean} Let the handler deal with the mouse up event.  This should
+     *     typically return true unless a subclass wants to modify event
+     *     handling.
+     */
+    up: function(evt) {
+        return true;
+    },
+
+    /**
+     * Method: out
+     * This method is called prior to handling the mouse out event.  Subclasses
+     *     can do their own processing here and return true to continue with the
+     *     normal drag handling, or they can return false to do their own
+     *     handling. Note that this method should only be used/overridden by
+     *     subclasses; controls that wrap handlers should deal with callbacks
+     *     instead.
+     *
+     * Parameters:
+     * evt - {Event} The mouse out event
+     *
+     * Return:
+     * {Boolean} Let the handler deal with the mouse out event.  This should
+     *     typically return true unless a subclass wants to modify event
+     *     handling.
+     */
+    out: function(evt) {
+        return true;
+    },
+
+    /**
-     * The methods below are part of the magic of event handling.  Because
-     *     they are named like browser events, they are registered as listeners
-     *     for the events they represent.
@@ -89 +212 @@
-     * {Boolean} Let the event propagate.
-     */
-    mousedown: function (evt) {
+        var propagate = true;
-        if (this.checkModifiers(evt) && OpenLayers.Event.isLeftClick(evt)) {
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-        }
-tru
+propagat
-    },
-
-    /**
@@ -114 +240 @@
-     */
-    mousemove: function (evt) {
-        if (this.started) {
-
-
-
-
-
+
+
+
+
+
+
+
-            }
-        }
-        return true;
@@ -136 +264 @@
-     */
-    mouseup: function (evt) {
-        if (this.started) {
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-        }
-        return true;
-    },
@@ -158 +288 @@
-     */
-    mouseout: function (evt) {
-        if (this.started && OpenLayers.Util.mouseLeft(evt, this.map.div)) {
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-            }
-            this.callback("done", [evt.xy])
-        }
-        return true;
-    },
@@ -193 +325 @@
-        return true;
-    },
-
-    /**
-     * Method: activate
-     * Activate the handler.
-     * 
-     * Return:
-     * {Boolean} The handler was successfully activated.
-     */
-    activate: function() {
-        if(OpenLayers.Handler.prototype.activate.apply(this, arguments)) {
-            this.dragging = false;
-            return true;
-        } else {
-            return false;
-        }
-    },
-
-    /**
-     * Method: deactivate 
-     * Deactivate the handler.
-     * 
-     * Return:
-     * {Boolean} The handler was successfully deactivated.
-     */
-    deactivate: function() {
-        if(OpenLayers.Handler.prototype.deactivate.apply(this, arguments)) {
-            this.dragging = false;
-            return true;
-        } else {
-            return false;
-        }
-    },
-
-    /** @final @type String */
-    CLASS_NAME: "OpenLayers.Handler.Drag"
-});