Upgrade to ExtJS 3.3.1 - Released 11/30/2010
[extjs.git] / docs / output / Ext.dd.DragTracker.html
index 35a5f4f..4272694 100644 (file)
@@ -1,9 +1,10 @@
-<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.dd.DragTracker-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.dd.DragTracker-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.dd.DragTracker-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.dd.DragTracker-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.dd.DragTracker"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif">DragTracker</pre></div><h1>Class <a href="source/DragTracker.html#cls-Ext.dd.DragTracker">Ext.dd.DragTracker</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.dd</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/DragTracker.html#cls-Ext.dd.DragTracker">DragTracker.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/DragTracker.html#cls-Ext.dd.DragTracker">DragTracker</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.util.Observable.html" ext:cls="Ext.util.Observable" ext:member="">Observable</a></td></tr></table><div class="description">A DragTracker listens for drag events on an Element and fires events at the start and end of the drag,
-as well as during the drag. This is useful for components such as <a href="output/Ext.Slider.html" ext:cls="Ext.Slider">Ext.Slider</a>, where there is
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.dd.DragTracker-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.dd.DragTracker-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.dd.DragTracker-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.dd.DragTracker-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.dd.DragTracker"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a>
+  <img src="resources/elbow-end.gif">DragTracker</pre></div><h1>Class <a href="source/DragTracker.html#cls-Ext.dd.DragTracker">Ext.dd.DragTracker</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.dd</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/DragTracker.html#cls-Ext.dd.DragTracker">DragTracker.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/DragTracker.html#cls-Ext.dd.DragTracker">DragTracker</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.util.Observable.html" ext:cls="Ext.util.Observable" ext:member="">Observable</a></td></tr></table><div class="description">A DragTracker listens for drag events on an Element and fires events at the start and end of the drag,
+as well as during the drag. This is useful for components such as <a href="output/Ext.slider.MultiSlider.html" ext:cls="Ext.slider.MultiSlider">Ext.slider.MultiSlider</a>, where there is
 an element that can be dragged around to change the Slider's value.
 DragTracker provides a series of template methods that should be overridden to provide functionality
 in response to detected drag operations. These are onBeforeStart, onStart, onDrag and onEnd.
-See <a href="output/Ext.Slider.html" ext:cls="Ext.Slider">Ext.Slider</a>'s initEvents function for an example implementation.</div><div class="hr"></div><a id="Ext.dd.DragTracker-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragTracker-active"></a><b><a href="source/DragTracker.html#cfg-Ext.dd.DragTracker-active">active</a></b> : Boolean<div class="mdesc">Defaults to <tt>false</tt>.</div></td><td class="msource">DragTracker</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragTracker-autoStart"></a><b><a href="source/DragTracker.html#cfg-Ext.dd.DragTracker-autoStart">autoStart</a></b> : Boolean/Number<div class="mdesc"><div class="short">Defaults to false. Specify true to defer trigger start by 1000 ms.
+See <a href="output/Ext.slider.MultiSlider.html" ext:cls="Ext.slider.MultiSlider">Ext.slider.MultiSlider</a>'s initEvents function for an example implementation.</div><div class="hr"></div><a id="Ext.dd.DragTracker-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragTracker-active"></a><b><a href="source/DragTracker.html#cfg-Ext.dd.DragTracker-active">active</a></b> : Boolean<div class="mdesc">Defaults to <tt>false</tt>.</div></td><td class="msource">DragTracker</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragTracker-autoStart"></a><b><a href="source/DragTracker.html#cfg-Ext.dd.DragTracker-autoStart">autoStart</a></b> : Boolean/Number<div class="mdesc"><div class="short">Defaults to false. Specify true to defer trigger start by 1000 ms.
 Specify a Number for the number of milliseconds to...</div><div class="long">Defaults to <tt>false</tt>. Specify <tt>true</tt> to defer trigger start by 1000 ms.
 Specify a Number for the number of milliseconds to defer trigger start.</div></div></td><td class="msource">DragTracker</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this
 object during initialization.  This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
@@ -170,11 +171,11 @@ holds the mouse button down. Return false to disallow the drag<div class="mdetai
                                         void<div class="mdesc"><div class="short">Template method which should be overridden by each DragTracker instance. Called whenever a drag has been detected.</div><div class="long">Template method which should be overridden by each DragTracker instance. Called whenever a drag has been detected.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">DragTracker</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragTracker-onEnd"></a><b><a href="source/DragTracker.html#method-Ext.dd.DragTracker-onEnd">onEnd</a></b>(&nbsp;<code>Ext.EventObject&nbsp;e</code>&nbsp;)
     :
                                         void<div class="mdesc"><div class="short">Template method which should be overridden by each DragTracker instance. Called when a drag operation has been comple...</div><div class="long">Template method which should be overridden by each DragTracker instance. Called when a drag operation has been completed
-(e.g. the user clicked and held the mouse down, dragged the element and then released the mouse button)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">DragTracker</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragTracker-onStart"></a><b><a href="source/DragTracker.html#method-Ext.dd.DragTracker-onStart">onStart</a></b>(&nbsp;<code>Array&nbsp;xy</code>&nbsp;)
+(e.g. the user clicked and held the mouse down, dragged the element and then released the mouse button)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">DragTracker</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragTracker-onStart"></a><b><a href="source/DragTracker.html#method-Ext.dd.DragTracker-onStart">onStart</a></b>(&nbsp;<code>Ext.EventObject&nbsp;e</code>&nbsp;)
     :
                                         void<div class="mdesc"><div class="short">Template method which should be overridden by each DragTracker instance. Called when a drag operation starts
 (e.g. th...</div><div class="long">Template method which should be overridden by each DragTracker instance. Called when a drag operation starts
-(e.g. the user has moved the tracked element beyond the specified tolerance)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>xy</code> : Array<div class="sub-desc">x and y co-ordinates of the original location of the tracked element</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">DragTracker</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-purgeListeners"></a><b><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b>()
+(e.g. the user has moved the tracked element beyond the specified tolerance)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">DragTracker</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-purgeListeners"></a><b><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b>()
     :
                                         void<div class="mdesc"><div class="short">Removes all listeners for this object</div><div class="long">Removes all listeners for this object<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#purgeListeners" ext:member="#purgeListeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-relayEvents"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-relayEvents">relayEvents</a></b>(&nbsp;<code>Object&nbsp;o</code>,&nbsp;<code>Array&nbsp;events</code>&nbsp;)
     :
@@ -196,8 +197,8 @@ after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEve
     <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Object<div class="sub-desc"></div></li><li><code>e</code> : Object<div class="sub-desc">event object</div></li></ul></div></div></div></td><td class="msource">DragTracker</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragTracker-dragend"></a><b><a href="source/DragTracker.html#event-Ext.dd.DragTracker-dragend">dragend</a></b> :
                                       (&nbsp;<code>Object&nbsp;this</code>,&nbsp;<code>Object&nbsp;e</code>&nbsp;)
     <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Object<div class="sub-desc"></div></li><li><code>e</code> : Object<div class="sub-desc">event object</div></li></ul></div></div></div></td><td class="msource">DragTracker</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragTracker-dragstart"></a><b><a href="source/DragTracker.html#event-Ext.dd.DragTracker-dragstart">dragstart</a></b> :
-                                      (&nbsp;<code>Object&nbsp;this</code>,&nbsp;<code>Object&nbsp;startXY</code>&nbsp;)
-    <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Object<div class="sub-desc"></div></li><li><code>startXY</code> : Object<div class="sub-desc">the page coordinates of the event</div></li></ul></div></div></div></td><td class="msource">DragTracker</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragTracker-mousedown"></a><b><a href="source/DragTracker.html#event-Ext.dd.DragTracker-mousedown">mousedown</a></b> :
+                                      (&nbsp;<code>Object&nbsp;this</code>,&nbsp;<code>Object&nbsp;e</code>&nbsp;)
+    <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Object<div class="sub-desc"></div></li><li><code>e</code> : Object<div class="sub-desc">event object</div></li></ul></div></div></div></td><td class="msource">DragTracker</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragTracker-mousedown"></a><b><a href="source/DragTracker.html#event-Ext.dd.DragTracker-mousedown">mousedown</a></b> :
                                       (&nbsp;<code>Object&nbsp;this</code>,&nbsp;<code>Object&nbsp;e</code>&nbsp;)
     <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Object<div class="sub-desc"></div></li><li><code>e</code> : Object<div class="sub-desc">event object</div></li></ul></div></div></div></td><td class="msource">DragTracker</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragTracker-mousemove"></a><b><a href="source/DragTracker.html#event-Ext.dd.DragTracker-mousemove">mousemove</a></b> :
                                       (&nbsp;<code>Object&nbsp;this</code>,&nbsp;<code>Object&nbsp;e</code>&nbsp;)