The drag handler is used to deal with sequences of browser events related to dragging. The handler is used by controls that want to know when a drag sequence begins, when a drag is happening, and when it has finished.
Controls that use the drag handler typically construct it with callbacks for ‘down’, ‘move’, and ‘done’. Callbacks for these keys are called when the drag begins, with each move, and when the drag is done. In addition, controls can have callbacks keyed to ‘up’ and ‘out’ if they care to differentiate between the types of events that correspond with the end of a drag sequence. If no drag actually occurs (no mouse move) the ‘down’ and ‘up’ callbacks will be called, but not the ‘done’ callback.
Create a new drag handler with the OpenLayers.Handler.Drag constructor.
Inherits from
Summary
OpenLayers.Handler.Drag | The drag handler is used to deal with sequences of browser events related to dragging. |
Properties | |
started | {Boolean} When a mousedown event is received, we want to record it, but not set ‘dragging’ until the mouse moves after starting. |
stopDown | {Boolean} Stop propagation of mousedown events from getting to listeners on the same element. |
dragging | {Boolean} |
last | {OpenLayers.Pixel} The last pixel location of the drag. |
start | {OpenLayers.Pixel} The first pixel location of the drag. |
oldOnselectstart | {Function} |
interval | {Integer} In order to increase performance, an interval (in milliseconds) can be set to reduce the number of drag events called. |
timeoutId | {String} The id of the timeout used for the mousedown interval. |
Constructor | |
OpenLayers.Handler.Drag | Returns OpenLayers.Handler.Drag |
Functions | |
down | This method is called during the handling of the mouse down event. |
move | This method is called during the handling of the mouse move event. |
up | This method is called during the handling of the mouse up event. |
out | This method is called during the handling of the mouse out event. |
mousedown | Handle mousedown events |
mousemove | Handle mousemove events |
removeTimeout | Private. |
mouseup | Handle mouseup events |
mouseout | Handle mouseout events |
click | The drag handler captures the click event. |
activate | Activate the handler. |
deactivate | Deactivate the handler. |