Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.dd.DragTracker.html
1 <!DOCTYPE html><html><head><title>Ext.dd.DragTracker | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.dd.DragTracker',
13         docClass: 'Ext.dd.DragTracker',
14         docReq: 'Ext.dd.DragTracker',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'DragTracker.html#Ext-dd.DragTracker';
33     clsInfo = {"methods":["addEvents","addListener","addManagedListener","capture","clearListeners","clearManagedListeners","enableBubble","fireEvent","getDragTarget","getOffset","hasListener","initEl","observe","on","onBeforeStart","onDrag","onEnd","onStart","relayEvents","releaseCapture","removeListener","removeManagedListener","resumeEvents","suspendEvents","un"],"cfgs":["autoStart","constrainTo","delegate","listeners","overCls","preventDefault","stopEvent","tolerance","trackOver"],"properties":["active","dragTarget"],"events":["drag","dragend","dragstart","mousedown","mousemove","mouseout","mouseover","mouseup"],"subclasses":["Ext.resizer.ResizeTracker","Ext.resizer.SplitterTracker","Ext.util.ComponentDragger"]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/DragTracker.html#Ext-dd.DragTracker" target="_blank">Ext.dd.DragTracker</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div></pre><p>A DragTracker listens for drag events on an Element and fires events at the start and end of the drag,
38 as well as during the drag. This is useful for components such as <a href="Ext.slider.Multi.html" rel="Ext.slider.Multi" class="docClass">Ext.slider.Multi</a>, where there is
39 an element that can be dragged around to change the Slider's value.
40 DragTracker provides a series of template methods that should be overridden to provide functionality
41 in response to detected drag operations. These are onBeforeStart, onStart, onDrag and onEnd.
42 See <a href="Ext.slider.Multi.html" rel="Ext.slider.Multi" class="docClass">Ext.slider.Multi</a>'s initEvents function for an example implementation.</p>
43 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">CSS Class configs</h4><div id="config-overCls" class="member f ni"><a href="Ext.dd.DragTracker.html#config-overCls" rel="config-overCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-cfg-overCls" class="viewSource">view source</a></div><a name="overCls"></a><a name="config-overCls"></a><a href="Ext.dd.DragTracker.html#" rel="config-overCls" class="cls expand">overCls</a><span> : String</span></div><div class="description"><div class="short">A CSS class to add to the DragTracker's target element when the element (or, if the delegate option is used,
44 when a d...</div><div class="long"><p>A CSS class to add to the DragTracker's target element when the element (or, if the <a href="Ext.dd.DragTracker.html#delegate" rel="Ext.dd.DragTracker#delegate" class="docClass">delegate</a> option is used,
45 when a delegate element) is mouseovered.</p>
46
47
48 <p><b>If the <a href="Ext.dd.DragTracker.html#delegate" rel="Ext.dd.DragTracker#delegate" class="docClass">delegate</a> option is used, these events fire only when a delegate element is entered of left.</b>.</p>
49 </div></div></div><h4 class="cfgGroup">Other Configs</h4><div id="config-autoStart" class="member f ni"><a href="Ext.dd.DragTracker.html#config-autoStart" rel="config-autoStart" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-cfg-autoStart" class="viewSource">view source</a></div><a name="autoStart"></a><a name="config-autoStart"></a><a href="Ext.dd.DragTracker.html#" rel="config-autoStart" class="cls expand">autoStart</a><span> : Boolean/Number</span></div><div class="description"><div class="short">Defaults to false. Specify true to defer trigger start by 1000 ms.
50 Specify a Number for the number of milliseconds to...</div><div class="long"><p>Defaults to <code>false</code>. Specify <code>true</code> to defer trigger start by 1000 ms.
51 Specify a Number for the number of milliseconds to defer trigger start.</p>
52 </div></div></div><div id="config-constrainTo" class="member ni"><a href="Ext.dd.DragTracker.html#config-constrainTo" rel="config-constrainTo" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-cfg-constrainTo" class="viewSource">view source</a></div><a name="constrainTo"></a><a name="config-constrainTo"></a><a href="Ext.dd.DragTracker.html#" rel="config-constrainTo" class="cls expand">constrainTo</a><span> : Ext.util.Region/Element</span></div><div class="description"><div class="short">A Region (Or an element from which a Region measurement will be read) which is used to constrain
53 the result of the ge...</div><div class="long"><p>A <a href="Ext.util.Region.html" rel="Ext.util.Region" class="docClass">Region</a> (Or an element from which a Region measurement will be read) which is used to constrain
54 the result of the <a href="Ext.dd.DragTracker.html#getOffset" rel="Ext.dd.DragTracker#getOffset" class="docClass">getOffset</a> call.</p>
55
56
57 <p>This may be set any time during the DragTracker's lifecycle to set a dynamic constraining region.</p>
58
59 </div></div></div><div id="config-delegate" class="member ni"><a href="Ext.dd.DragTracker.html#config-delegate" rel="config-delegate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-cfg-delegate" class="viewSource">view source</a></div><a name="delegate"></a><a name="config-delegate"></a><a href="Ext.dd.DragTracker.html#" rel="config-delegate" class="cls expand">delegate</a><span> : String</span></div><div class="description"><div class="short">Optional. A DomQuery selector which identifies child elements within the DragTracker's encapsulating
60 Element which ar...</div><div class="long"><p>Optional. <p>A <a href="Ext.DomQuery.html" rel="Ext.DomQuery" class="docClass">DomQuery</a> selector which identifies child elements within the DragTracker's encapsulating
61 Element which are the tracked elements. This limits tracking to only begin when the matching elements are mousedowned.</p></p>
62
63 <p>This may also be a specific child element within the DragTracker's encapsulating element to use as the tracked element.</p>
64
65 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.dd.DragTracker.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.dd.DragTracker.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
66 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
67 object during initialization.  This should be a valid listeners config object as specified in the
68 <a href="Ext.dd.DragTracker.html#addListener" rel="Ext.dd.DragTracker#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
69
70 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
71
72
73 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
74
75
76 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
77 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
78 events directly from a child element of a Component, we need to specify the <code>element</code> option to
79 identify the Component property to add a DOM listener to:</p>
80
81 <pre><code>new Ext.panel.Panel({
82     width: 400,
83     height: 200,
84     dockedItems: [{
85         xtype: 'toolbar'
86     }],
87     listeners: {
88         click: {
89             element: 'el', //bind to the underlying el property on the panel
90             fn: function(){ console.log('click el'); }
91         },
92         dblclick: {
93             element: 'body', //bind to the underlying body property on the panel
94             fn: function(){ console.log('dblclick body'); }
95         }
96     }
97 });
98 </code></pre>
99
100
101 <p></p></p>
102 </div></div></div><div id="config-overCls" class="member ni"><a href="Ext.dd.DragTracker.html#config-overCls" rel="config-overCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-cfg-overCls" class="viewSource">view source</a></div><a name="overCls"></a><a name="config-overCls"></a><a href="Ext.dd.DragTracker.html#" rel="config-overCls" class="cls expand">overCls</a><span> : String</span></div><div class="description"><div class="short">A CSS class to add to the DragTracker's target element when the element (or, if the delegate option is used,
103 when a d...</div><div class="long"><p>A CSS class to add to the DragTracker's target element when the element (or, if the <a href="Ext.dd.DragTracker.html#delegate" rel="Ext.dd.DragTracker#delegate" class="docClass">delegate</a> option is used,
104 when a delegate element) is mouseovered.</p>
105
106
107 <p><b>If the <a href="Ext.dd.DragTracker.html#delegate" rel="Ext.dd.DragTracker#delegate" class="docClass">delegate</a> option is used, these events fire only when a delegate element is entered of left.</b>.</p>
108 </div></div></div><div id="config-preventDefault" class="member ni"><a href="Ext.dd.DragTracker.html#config-preventDefault" rel="config-preventDefault" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-cfg-preventDefault" class="viewSource">view source</a></div><a name="preventDefault"></a><a name="config-preventDefault"></a><a href="Ext.dd.DragTracker.html#" rel="config-preventDefault" class="cls expand">preventDefault</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Specify <code>false</code> to enable default actions on onMouseDown events. Defaults to <code>true</code>.</p>
109 </div><div class="long"><p>Specify <code>false</code> to enable default actions on onMouseDown events. Defaults to <code>true</code>.</p>
110 </div></div></div><div id="config-stopEvent" class="member ni"><a href="Ext.dd.DragTracker.html#config-stopEvent" rel="config-stopEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-cfg-stopEvent" class="viewSource">view source</a></div><a name="stopEvent"></a><a name="config-stopEvent"></a><a href="Ext.dd.DragTracker.html#" rel="config-stopEvent" class="cls expand">stopEvent</a><span> : Boolean</span></div><div class="description"><div class="short">Specify true to stop the mousedown event from bubbling to outer listeners from the target element (or its delegates)....</div><div class="long"><p>Specify <code>true</code> to stop the <code>mousedown</code> event from bubbling to outer listeners from the target element (or its delegates). Defaults to <code>false</code>.</p>
111 </div></div></div><div id="config-tolerance" class="member ni"><a href="Ext.dd.DragTracker.html#config-tolerance" rel="config-tolerance" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-cfg-tolerance" class="viewSource">view source</a></div><a name="tolerance"></a><a name="config-tolerance"></a><a href="Ext.dd.DragTracker.html#" rel="config-tolerance" class="cls expand">tolerance</a><span> : Number</span></div><div class="description"><div class="short"><p>Number of pixels the drag target must be moved before dragging is
112 considered to have started. Defaults to <code>5</code>.</p>
113 </div><div class="long"><p>Number of pixels the drag target must be moved before dragging is
114 considered to have started. Defaults to <code>5</code>.</p>
115 </div></div></div><div id="config-trackOver" class="member ni"><a href="Ext.dd.DragTracker.html#config-trackOver" rel="config-trackOver" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-cfg-trackOver" class="viewSource">view source</a></div><a name="trackOver"></a><a name="config-trackOver"></a><a href="Ext.dd.DragTracker.html#" rel="config-trackOver" class="cls expand">trackOver</a><span> : Boolean</span></div><div class="description"><div class="short">Defaults to false. Set to true to fire mouseover and mouseout events when the mouse enters or leaves the target eleme...</div><div class="long"><p>Defaults to <code>false</code>. Set to true to fire mouseover and mouseout events when the mouse enters or leaves the target element.</p>
116
117
118 <p>This is implicitly set when an <a href="Ext.dd.DragTracker.html#overCls" rel="Ext.dd.DragTracker#overCls" class="docClass">overCls</a> is specified.</p>
119
120
121 <p><b>If the <a href="Ext.dd.DragTracker.html#delegate" rel="Ext.dd.DragTracker#delegate" class="docClass">delegate</a> option is used, these events fire only when a delegate element is entered of left.</b>.</p>
122 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-active" class="member f ni"><a href="Ext.dd.DragTracker.html#property-active" rel="property-active" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-property-active" class="viewSource">view source</a></div><a name="active"></a><a name="property-active"></a><a href="Ext.dd.DragTracker.html#" rel="property-active" class="cls expand">active</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Read-only property indicated whether the user is currently dragging this
123 tracker.</p>
124 </div><div class="long"><p>Read-only property indicated whether the user is currently dragging this
125 tracker.</p>
126 </div></div></div><div id="property-dragTarget" class="member ni"><a href="Ext.dd.DragTracker.html#property-dragTarget" rel="property-dragTarget" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-property-dragTarget" class="viewSource">view source</a></div><a name="dragTarget"></a><a name="property-dragTarget"></a><a href="Ext.dd.DragTracker.html#" rel="property-dragTarget" class="cls expand">dragTarget</a><span> : HtmlElement</span></div><div class="description"><div class="short">Only valid during drag operations. Read-only.
127
128
129 The element being dragged.
130
131
132 If the delegate option is used, this wil...</div><div class="long"><p><b>Only valid during drag operations. Read-only.</b></p>
133
134
135 <p>The element being dragged.</p>
136
137
138 <p>If the <a href="Ext.dd.DragTracker.html#delegate" rel="Ext.dd.DragTracker#delegate" class="docClass">delegate</a> option is used, this will be the delegate element which was mousedowned.</p>
139
140 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-addEvents" class="member f inherited"><a href="Ext.dd.DragTracker.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.dd.DragTracker.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
141 <span class="pre">Object/String o, String </span>)
142  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
143 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
144 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
145 or the first event name string if multiple event names are being passed as separate parameters.</p>
146 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
147 Usage:</p>
148
149 <pre><code>this.addEvents('storeloaded', 'storecleared');
150 </code></pre>
151
152 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
153 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.dd.DragTracker.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.dd.DragTracker.html#" rel="method-addListener" class="cls expand">addListener</a>(
154 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
155  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
156 </div><div class="long"><p>Appends an event handler to this object.</p>
157 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
158 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
159 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
160 <b>If omitted, defaults to the object which fired the event.</b></p>
161 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
162 properties. This may contain any of the following properties:<ul>
163 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
164 <b>If omitted, defaults to the object which fired the event.</b></div></li>
165 <li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
166 <li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
167 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
168 by the specified number of milliseconds. If the event fires again within that time, the original
169 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
170 <li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
171 if the event was bubbled up from a child Observable.</div></li>
172 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
173 The name of a Component property which references an element to add a listener to.</p>
174
175 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
176 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
177 <pre><code>new Ext.panel.Panel({
178     title: 'The title',
179     listeners: {
180         click: this.handlePanelClick,
181         element: 'body'
182     }
183 });
184 </code></pre></p>
185
186
187 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
188
189
190 <p></div></li>
191 </ul><br></p>
192
193 <p>
194 <b>Combining Options</b><br>
195 Using the options argument, it is possible to combine different types of listeners:<br>
196 <br>
197 A delayed, one-time listener.
198 <pre><code>myPanel.on('hide', this.handleClick, this, {
199 single: true,
200 delay: 100
201 });</code></pre>
202 <p>
203 <b>Attaching multiple handlers in 1 call</b><br>
204 The method also allows for a single argument to be passed which is a config object containing properties
205 which specify multiple events. For example:
206 <pre><code>myGridPanel.on({
207     cellClick: this.onCellClick,
208     mouseover: this.onMouseOver,
209     mouseout: this.onMouseOut,
210     scope: this // Important. Ensure "this" is correct during handler execution
211 });
212 </code></pre>.
213 <p>
214
215 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
216 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.dd.DragTracker.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.dd.DragTracker.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
217 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
218  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
219 is destroyed.
220
221 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
222 is destroyed.
223
224 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
225 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
226 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
227 is the handler function.</p>
228 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
229 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
230 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
231 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
232 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
233 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.dd.DragTracker.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.dd.DragTracker.html#" rel="method-capture" class="cls expand">capture</a>(
234 <span class="pre">Observable o, Function fn, [Object scope]</span>)
235  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
236 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
237 to the supplied function with the event name + standard signature of the event
238 <b>before</b> the event is fired. If the supplied function returns false,
239 the event will not fire.</p>
240 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
241 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
242 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
243 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
244 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.dd.DragTracker.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.dd.DragTracker.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
245 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
246 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
247 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.dd.DragTracker.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.dd.DragTracker.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
248 </div><div class="long"><p>Removes all managed listeners for this object.</p>
249 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
250 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.dd.DragTracker.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.dd.DragTracker.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
251 <span class="pre">String/Array events</span>)
252  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
253 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
254 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
255
256
257 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
258 implementation in <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to
259 access the required target more quickly.</p>
260
261
262 <p>Example:</p>
263
264
265 <pre><code>Ext.override(Ext.form.field.Base, {
266 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
267 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
268     this.enableBubble('change');
269 }),
270
271 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
272 getBubbleTarget : function() {
273     if (!this.formPanel) {
274         this.formPanel = this.findParentByType('form');
275     }
276     return this.formPanel;
277 }
278 });
279
280 var myForm = new Ext.formPanel({
281 title: 'User Details',
282 items: [{
283     ...
284 }],
285 listeners: {
286     change: function() {
287         // Title goes red if form has been modified.
288         myForm.header.setStyle('color', 'red');
289     }
290 }
291 });
292 </code></pre>
293
294 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
295 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
296 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.dd.DragTracker.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.dd.DragTracker.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
297 <span class="pre">String eventName, Object... args</span>)
298  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
299
300
301 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
302
303
304 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
305 by calling <a href="Ext.dd.DragTracker.html#enableBubble" rel="Ext.dd.DragTracker#enableBubble" class="docClass">enableBubble</a>.</p>
306
307 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
308 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
309 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
310 </li></ul></div></div></div><div id="method-getDragTarget" class="member ni"><a href="Ext.dd.DragTracker.html#method-getDragTarget" rel="method-getDragTarget" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-method-getDragTarget" class="viewSource">view source</a></div><a name="getDragTarget"></a><a name="method-getDragTarget"></a><a href="Ext.dd.DragTracker.html#" rel="method-getDragTarget" class="cls expand">getDragTarget</a> : Ext.core.Element</div><div class="description"><div class="short">Returns the drag target. This is usually the DragTracker's encapsulating element.
311
312 If the delegate option is being us...</div><div class="long"><p></p>Returns the drag target. This is usually the DragTracker's encapsulating element.</p></p>
313
314 <p>If the <a href="Ext.dd.DragTracker.html#delegate" rel="Ext.dd.DragTracker#delegate" class="docClass">delegate</a> option is being used, this may be a child element which matches the
315 <a href="Ext.dd.DragTracker.html#delegate" rel="Ext.dd.DragTracker#delegate" class="docClass">delegate</a> selector.</p>
316
317 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.core.Element</span>&nbsp; &nbsp;<p>The element currently being tracked.</p>
318 </li></ul></div></div></div><div id="method-getOffset" class="member ni"><a href="Ext.dd.DragTracker.html#method-getOffset" rel="method-getOffset" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-method-getOffset" class="viewSource">view source</a></div><a name="getOffset"></a><a name="method-getOffset"></a><a href="Ext.dd.DragTracker.html#" rel="method-getOffset" class="cls expand">getOffset</a>(
319 <span class="pre">Object constrainMode</span>)
320  : Array</div><div class="description"><div class="short">Returns the X, Y offset of the current mouse position from the mousedown point.
321
322
323 This method may optionally constrai...</div><div class="long"><p>Returns the X, Y offset of the current mouse position from the mousedown point.</p>
324
325
326 <p>This method may optionally constrain the real offset values, and returns a point coerced in one
327 of two modes:</p>
328
329
330 <ul>
331 <li><code>point</code><div class="sub-desc">The current mouse position is coerced into the
332 <a href="Ext.dd.DragTracker.html#constrainRegion" rel="Ext.dd.DragTracker#constrainRegion" class="docClass">constrainRegion</a>, and the resulting position is returned.</div></li>
333 <li><code>dragTarget</code><div class="sub-desc">The new <a href="Ext.util.Region.html" rel="Ext.util.Region" class="docClass">Region</a> of the
334 <a href="Ext.dd.DragTracker.html#getDragTarget" rel="Ext.dd.DragTracker#getDragTarget" class="docClass">dragTarget</a> is calculated based upon the current mouse position, and then
335 coerced into the <a href="Ext.dd.DragTracker.html#constrainRegion" rel="Ext.dd.DragTracker#constrainRegion" class="docClass">constrainRegion</a>. The returned mouse position is then adjusted by the
336 same delta as was used to coerce the region.</div></li>
337 </ul>
338
339 <h3 class="pa">Parameters</h3><ul><li><span class="pre">constrainMode</span> : Object<div class="sub-desc"><p>{String} Optional. If omitted the true mouse position is returned. May be passed
340 as <code>'point'</code> or <code>'dragTarget'. See above.</code>.</p>
341 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>The <code>X, Y</code> offset from the mousedown point, optionally constrained.</p>
342 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.dd.DragTracker.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.dd.DragTracker.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
343 <span class="pre">String eventName</span>)
344  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
345 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
346 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
347 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
348 </li></ul></div></div></div><div id="method-initEl" class="member ni"><a href="Ext.dd.DragTracker.html#method-initEl" rel="method-initEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-method-initEl" class="viewSource">view source</a></div><a name="initEl"></a><a name="method-initEl"></a><a href="Ext.dd.DragTracker.html#" rel="method-initEl" class="cls expand">initEl</a>(
349 <span class="pre">Ext.core.Element/HTMLElement el</span>)
350  : void</div><div class="description"><div class="short"><p>Initializes the DragTracker on a given element.</p>
351 </div><div class="long"><p>Initializes the DragTracker on a given element.</p>
352 <h3 class="pa">Parameters</h3><ul><li><span class="pre">el</span> : Ext.core.Element/HTMLElement<div class="sub-desc"><p>The element</p>
353 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
354 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.dd.DragTracker.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.dd.DragTracker.html#" rel="method-observe" class="cls expand">observe</a>(
355 <span class="pre">Function c, Object listeners</span>)
356  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
357
358 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
359
360 <p>This makes any event fired on any instance of the passed class also fire a single event through
361 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
362
363 <p>Usage:</p>
364
365 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
366 Ext.data.Connection.on('beforerequest', function(con, options) {
367     console.log('Ajax request made to ' + options.url);
368 });
369 </code></pre>
370 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
371 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.dd.DragTracker.html#addListener" rel="Ext.dd.DragTracker#addListener" class="docClass">addListener</a>.</p>
372 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
373 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.dd.DragTracker.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.dd.DragTracker.html#" rel="method-on" class="cls expand">on</a>(
374 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
375  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.dd.DragTracker.html#addListener" rel="Ext.dd.DragTracker#addListener" class="docClass">addListener</a>.)</p>
376 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.dd.DragTracker.html#addListener" rel="Ext.dd.DragTracker#addListener" class="docClass">addListener</a>.)</p>
377 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
378 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
379 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
380 <b>If omitted, defaults to the object which fired the event.</b></p>
381 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
382 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
383 </li></ul></div></div></div><div id="method-onBeforeStart" class="member ni"><a href="Ext.dd.DragTracker.html#method-onBeforeStart" rel="method-onBeforeStart" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-method-onBeforeStart" class="viewSource">view source</a></div><a name="onBeforeStart"></a><a name="method-onBeforeStart"></a><a href="Ext.dd.DragTracker.html#" rel="method-onBeforeStart" class="cls expand">onBeforeStart</a>(
384 <span class="pre">Ext.EventObject e</span>)
385  : void</div><div class="description"><div class="short">Template method which should be overridden by each DragTracker instance. Called when the user first clicks and
386 holds ...</div><div class="long"><p>Template method which should be overridden by each DragTracker instance. Called when the user first clicks and
387 holds the mouse button down. Return false to disallow the drag</p>
388 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Ext.EventObject<div class="sub-desc"><p>The event object</p>
389 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
390 </li></ul></div></div></div><div id="method-onDrag" class="member ni"><a href="Ext.dd.DragTracker.html#method-onDrag" rel="method-onDrag" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-method-onDrag" class="viewSource">view source</a></div><a name="onDrag"></a><a name="method-onDrag"></a><a href="Ext.dd.DragTracker.html#" rel="method-onDrag" class="cls expand">onDrag</a>(
391 <span class="pre">Ext.EventObject e</span>)
392  : void</div><div class="description"><div class="short"><p>Template method which should be overridden by each DragTracker instance. Called whenever a drag has been detected.</p>
393 </div><div class="long"><p>Template method which should be overridden by each DragTracker instance. Called whenever a drag has been detected.</p>
394 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Ext.EventObject<div class="sub-desc"><p>The event object</p>
395 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
396 </li></ul></div></div></div><div id="method-onEnd" class="member ni"><a href="Ext.dd.DragTracker.html#method-onEnd" rel="method-onEnd" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-method-onEnd" class="viewSource">view source</a></div><a name="onEnd"></a><a name="method-onEnd"></a><a href="Ext.dd.DragTracker.html#" rel="method-onEnd" class="cls expand">onEnd</a>(
397 <span class="pre">Ext.EventObject e</span>)
398  : void</div><div class="description"><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"><p>Template method which should be overridden by each DragTracker instance. Called when a drag operation has been completed
399 (e.g. the user clicked and held the mouse down, dragged the element and then released the mouse button)</p>
400 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Ext.EventObject<div class="sub-desc"><p>The event object</p>
401 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
402 </li></ul></div></div></div><div id="method-onStart" class="member ni"><a href="Ext.dd.DragTracker.html#method-onStart" rel="method-onStart" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-method-onStart" class="viewSource">view source</a></div><a name="onStart"></a><a name="method-onStart"></a><a href="Ext.dd.DragTracker.html#" rel="method-onStart" class="cls expand">onStart</a>(
403 <span class="pre">Ext.EventObject e</span>)
404  : void</div><div class="description"><div class="short">Template method which should be overridden by each DragTracker instance. Called when a drag operation starts
405 (e.g. th...</div><div class="long"><p>Template method which should be overridden by each DragTracker instance. Called when a drag operation starts
406 (e.g. the user has moved the tracked element beyond the specified tolerance)</p>
407 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Ext.EventObject<div class="sub-desc"><p>The event object</p>
408 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
409 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.dd.DragTracker.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.dd.DragTracker.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
410 <span class="pre">Object origin, Array events, Object prefix</span>)
411  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
412 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
413 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
414 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
415 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
416 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
417 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.dd.DragTracker.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.dd.DragTracker.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
418 <span class="pre">Observable o</span>)
419  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
420 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
421 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
422 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
423 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.dd.DragTracker.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.dd.DragTracker.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
424 <span class="pre">String eventName, Function handler, [Object scope]</span>)
425  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
426 </div><div class="long"><p>Removes an event handler.</p>
427 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
428 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.dd.DragTracker.html#addListener" rel="Ext.dd.DragTracker#addListener" class="docClass">addListener</a> call.</b></p>
429 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
430 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
431 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.dd.DragTracker.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.dd.DragTracker.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
432 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
433  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.dd.DragTracker.html#mon" rel="Ext.dd.DragTracker#mon" class="docClass">mon</a> method.</p>
434 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.dd.DragTracker.html#mon" rel="Ext.dd.DragTracker#mon" class="docClass">mon</a> method.</p>
435 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
436 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
437 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
438 is the handler function.</p>
439 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
440 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
441 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
442 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.dd.DragTracker.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.dd.DragTracker.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
443 If events were suspended using the queueSuspended parameter, then all
444 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.dd.DragTracker.html#suspendEvents" rel="Ext.dd.DragTracker#suspendEvents" class="docClass">suspendEvents</a>)
445 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
446 events fired during event suspension will be sent to any listeners now.</p>
447 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
448 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.dd.DragTracker.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.dd.DragTracker.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
449 <span class="pre">Boolean queueSuspended</span>)
450  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.dd.DragTracker.html#resumeEvents" rel="Ext.dd.DragTracker#resumeEvents" class="docClass">resumeEvents</a>)</p>
451 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.dd.DragTracker.html#resumeEvents" rel="Ext.dd.DragTracker#resumeEvents" class="docClass">resumeEvents</a>)</p>
452 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
453 after the <a href="Ext.dd.DragTracker.html#resumeEvents" rel="Ext.dd.DragTracker#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
454 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
455 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.dd.DragTracker.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.dd.DragTracker.html#" rel="method-un" class="cls expand">un</a>(
456 <span class="pre">String eventName, Function handler, [Object scope]</span>)
457  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.dd.DragTracker.html#removeListener" rel="Ext.dd.DragTracker#removeListener" class="docClass">removeListener</a>.)</p>
458 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.dd.DragTracker.html#removeListener" rel="Ext.dd.DragTracker#removeListener" class="docClass">removeListener</a>.)</p>
459 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
460 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.dd.DragTracker.html#addListener" rel="Ext.dd.DragTracker#addListener" class="docClass">addListener</a> call.</b></p>
461 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
462 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
463 </li></ul></div></div></div></div><div class="m-events"><a name="events"></a><div class="definedBy">Defined By</div><h3 class="evt p">Events</h3><div id="event-drag" class="member f ni"><a href="Ext.dd.DragTracker.html#event-drag" rel="event-drag" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-event-drag" class="viewSource">view source</a></div><a name="drag"></a><a name="event-drag"></a><a href="Ext.dd.DragTracker.html#" rel="event-drag" class="cls expand">drag</a>(
464 <span class="pre">Object this, Object e</span>)
465 </div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
466 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Object<div class="sub-desc">
467 </div></li><li><span class="pre">e</span> : Object<div class="sub-desc"><p>event object</p>
468 </div></li></ul></div></div></div><div id="event-dragend" class="member ni"><a href="Ext.dd.DragTracker.html#event-dragend" rel="event-dragend" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-event-dragend" class="viewSource">view source</a></div><a name="dragend"></a><a name="event-dragend"></a><a href="Ext.dd.DragTracker.html#" rel="event-dragend" class="cls expand">dragend</a>(
469 <span class="pre">Object this, Object e</span>)
470 </div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
471 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Object<div class="sub-desc">
472 </div></li><li><span class="pre">e</span> : Object<div class="sub-desc"><p>event object</p>
473 </div></li></ul></div></div></div><div id="event-dragstart" class="member ni"><a href="Ext.dd.DragTracker.html#event-dragstart" rel="event-dragstart" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-event-dragstart" class="viewSource">view source</a></div><a name="dragstart"></a><a name="event-dragstart"></a><a href="Ext.dd.DragTracker.html#" rel="event-dragstart" class="cls expand">dragstart</a>(
474 <span class="pre">Object this, Object e</span>)
475 </div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
476 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Object<div class="sub-desc">
477 </div></li><li><span class="pre">e</span> : Object<div class="sub-desc"><p>event object</p>
478 </div></li></ul></div></div></div><div id="event-mousedown" class="member ni"><a href="Ext.dd.DragTracker.html#event-mousedown" rel="event-mousedown" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-event-mousedown" class="viewSource">view source</a></div><a name="mousedown"></a><a name="event-mousedown"></a><a href="Ext.dd.DragTracker.html#" rel="event-mousedown" class="cls expand">mousedown</a>(
479 <span class="pre">Object this, Object e</span>)
480 </div><div class="description"><div class="short">Fires when the mouse button is pressed down, but before a drag operation begins. The
481 drag operation begins after eith...</div><div class="long"><p>Fires when the mouse button is pressed down, but before a drag operation begins. The
482 drag operation begins after either the mouse has been moved by <a href="Ext.dd.DragTracker.html#tolerance" rel="Ext.dd.DragTracker#tolerance" class="docClass">tolerance</a> pixels, or after
483 the <a href="Ext.dd.DragTracker.html#autoStart" rel="Ext.dd.DragTracker#autoStart" class="docClass">autoStart</a> timer fires.</p>
484
485
486 <p>Return false to veto the drag operation.</p>
487
488 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Object<div class="sub-desc">
489 </div></li><li><span class="pre">e</span> : Object<div class="sub-desc"><p>event object</p>
490 </div></li></ul></div></div></div><div id="event-mousemove" class="member ni"><a href="Ext.dd.DragTracker.html#event-mousemove" rel="event-mousemove" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-event-mousemove" class="viewSource">view source</a></div><a name="mousemove"></a><a name="event-mousemove"></a><a href="Ext.dd.DragTracker.html#" rel="event-mousemove" class="cls expand">mousemove</a>(
491 <span class="pre">Object this, Object e</span>)
492 </div><div class="description"><div class="short"><p>Fired when the mouse is moved. Returning false cancels the drag operation.</p>
493 </div><div class="long"><p>Fired when the mouse is moved. Returning false cancels the drag operation.</p>
494 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Object<div class="sub-desc">
495 </div></li><li><span class="pre">e</span> : Object<div class="sub-desc"><p>event object</p>
496 </div></li></ul></div></div></div><div id="event-mouseout" class="member ni"><a href="Ext.dd.DragTracker.html#event-mouseout" rel="event-mouseout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-event-mouseout" class="viewSource">view source</a></div><a name="mouseout"></a><a name="event-mouseout"></a><a href="Ext.dd.DragTracker.html#" rel="event-mouseout" class="cls expand">mouseout</a>(
497 <span class="pre">Object this, Object e</span>)
498 </div><div class="description"><div class="short">Only available when trackOver is true
499
500
501 Fires when the mouse exits the DragTracker's target element (or if delegate i...</div><div class="long"><p><b>Only available when <a href="Ext.dd.DragTracker.html#trackOver" rel="Ext.dd.DragTracker#trackOver" class="docClass">trackOver</a> is <code>true</code></b></p>
502
503
504 <p>Fires when the mouse exits the DragTracker's target element (or if <a href="Ext.dd.DragTracker.html#delegate" rel="Ext.dd.DragTracker#delegate" class="docClass">delegate</a> is
505 used, when the mouse exits a delegate element).</p>
506
507 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Object<div class="sub-desc">
508 </div></li><li><span class="pre">e</span> : Object<div class="sub-desc"><p>event object</p>
509 </div></li></ul></div></div></div><div id="event-mouseover" class="member ni"><a href="Ext.dd.DragTracker.html#event-mouseover" rel="event-mouseover" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-event-mouseover" class="viewSource">view source</a></div><a name="mouseover"></a><a name="event-mouseover"></a><a href="Ext.dd.DragTracker.html#" rel="event-mouseover" class="cls expand">mouseover</a>(
510 <span class="pre">Object this, Object e, HtmlElement target</span>)
511 </div><div class="description"><div class="short">Only available when trackOver is true
512
513
514 Fires when the mouse enters the DragTracker's target element (or if delegate ...</div><div class="long"><p><b>Only available when <a href="Ext.dd.DragTracker.html#trackOver" rel="Ext.dd.DragTracker#trackOver" class="docClass">trackOver</a> is <code>true</code></b></p>
515
516
517 <p>Fires when the mouse enters the DragTracker's target element (or if <a href="Ext.dd.DragTracker.html#delegate" rel="Ext.dd.DragTracker#delegate" class="docClass">delegate</a> is
518 used, when the mouse enters a delegate element).</p>
519
520 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Object<div class="sub-desc">
521 </div></li><li><span class="pre">e</span> : Object<div class="sub-desc"><p>event object</p>
522 </div></li><li><span class="pre">target</span> : HtmlElement<div class="sub-desc"><p>The element mouseovered.</p>
523 </div></li></ul></div></div></div><div id="event-mouseup" class="member ni"><a href="Ext.dd.DragTracker.html#event-mouseup" rel="event-mouseup" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragTracker.html" class="definedIn docClass">Ext.dd.DragTracker</a><br/><a href="../source/DragTracker.html#Ext-dd.DragTracker-event-mouseup" class="viewSource">view source</a></div><a name="mouseup"></a><a name="event-mouseup"></a><a href="Ext.dd.DragTracker.html#" rel="event-mouseup" class="cls expand">mouseup</a>(
524 <span class="pre">Object this, Object e</span>)
525 </div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
526 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Object<div class="sub-desc">
527 </div></li><li><span class="pre">e</span> : Object<div class="sub-desc"><p>event object</p>
528 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>