Upgrade to ExtJS 3.3.0 - Released 10/06/2010
[extjs.git] / docs / output / Ext.dd.DragTracker.html
1 <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,
2 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
3 an element that can be dragged around to change the Slider's value.
4 DragTracker provides a series of template methods that should be overridden to provide functionality
5 in response to detected drag operations. These are onBeforeStart, onStart, onDrag and onEnd.
6 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.
7 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.
8 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
9 object during initialization.  This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
10 object during initialization.  This should be a valid listeners config object as specified in the
11 <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> example for attaching multiple handlers at once.</p>
12 <br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
13 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
14 is usually only done when extra value can be added. For example the <a href="output/Ext.DataView.html" ext:cls="Ext.DataView">DataView</a>'s
15 <b><code><a href="output/Ext.DataView.html#Ext.DataView-click" ext:member="click" ext:cls="Ext.DataView">click</a></code></b> event passing the node clicked on. To access DOM
16 events directly from a Component's HTMLElement, listeners must be added to the <i><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a></i> after the Component
17 has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
18 <i>// The Component is appended to the argument list of all handler functions.</i>
19 Ext.DomObserver = Ext.extend(Object, {
20     constructor: <b>function</b>(config) {
21         this.listeners = config.listeners ? config.listeners : config;
22     },
23
24     <i>// Component passes itself into plugin&#39;s init method</i>
25     init: <b>function</b>(c) {
26         <b>var</b> p, l = this.listeners;
27         <b>for</b> (p <b>in</b> l) {
28             <b>if</b> (Ext.isFunction(l[p])) {
29                 l[p] = this.createHandler(l[p], c);
30             } <b>else</b> {
31                 l[p].fn = this.createHandler(l[p].fn, c);
32             }
33         }
34
35         <i>// Add the listeners to the Element immediately following the render call</i>
36         c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
37             <b>var</b> e = c.getEl();
38             <b>if</b> (e) {
39                 e.on(l);
40             }
41         });
42     },
43
44     createHandler: <b>function</b>(fn, c) {
45         <b>return</b> <b>function</b>(e) {
46             fn.call(this, e, c);
47         };
48     }
49 });
50
51 <b>var</b> combo = <b>new</b> Ext.form.ComboBox({
52
53     <i>// Collapse combo when its element is clicked on</i>
54     plugins: [ <b>new</b> Ext.DomObserver({
55         click: <b>function</b>(evt, comp) {
56             comp.collapse();
57         }
58     })],
59     store: myStore,
60     typeAhead: true,
61     mode: <em>'local'</em>,
62     triggerAction: <em>'all'</em>
63 });</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragTracker-tolerance"></a><b><a href="source/DragTracker.html#cfg-Ext.dd.DragTracker-tolerance">tolerance</a></b> : Number<div class="mdesc">Number of pixels the drag target must be moved before dragging is considered to have started. Defaults to <tt>5</tt>.</div></td><td class="msource">DragTracker</td></tr></tbody></table><a id="Ext.dd.DragTracker-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.dd.DragTracker-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></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-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>(&nbsp;<code>Object|String&nbsp;o</code>,&nbsp;<code>string&nbsp;Optional.</code>&nbsp;)
64     :
65                                         void<div class="mdesc"><div class="short">Adds the specified events to the list of events which this Observable may fire.</div><div class="long">Adds the specified events to the list of events which this Observable may fire.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object|String<div class="sub-desc">Either an object with event names as properties with a value of <code>true</code>
66 or the first event name string if multiple event names are being passed as separate parameters.</div></li><li><code>Optional.</code> : string<div class="sub-desc">Event name if multiple event names are being passed as separate parameters.
67 Usage:<pre><code>this.addEvents(<em>'storeloaded'</em>, <em>'storecleared'</em>);</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addEvents" ext:member="#addEvents" 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-addListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)
68     :
69                                         void<div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to listen for.</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
70 <b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.
71 properties. This may contain any of the following properties:<ul>
72 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
73 <b>If omitted, defaults to the object which fired the event.</b></div></li>
74 <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>
75 <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>
76 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed
77 by the specified number of milliseconds. If the event fires again within that time, the original
78 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
79 <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>
80 if the event was bubbled up from a child Observable.</div></li>
81 </ul><br>
82 <p>
83 <b>Combining Options</b><br>
84 Using the options argument, it is possible to combine different types of listeners:<br>
85 <br>
86 A delayed, one-time listener.
87 <pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
88 single: true,
89 delay: 100
90 });</code></pre>
91 <p>
92 <b>Attaching multiple handlers in 1 call</b><br>
93 The method also allows for a single argument to be passed which is a config object containing properties
94 which specify multiple handlers.
95 <p>
96 <pre><code>myGridPanel.on({
97 <em>'click'</em> : {
98     fn: this.onClick,
99     scope: this,
100     delay: 100
101 },
102 <em>'mouseover'</em> : {
103     fn: this.onMouseOver,
104     scope: this
105 },
106 <em>'mouseout'</em> : {
107     fn: this.onMouseOut,
108     scope: this
109 }
110 });</code></pre>
111 <p>
112 Or a shorthand syntax:<br>
113 <pre><code>myGridPanel.on({
114 <em>'click'</em> : this.onClick,
115 <em>'mouseover'</em> : this.onMouseOver,
116 <em>'mouseout'</em> : this.onMouseOut,
117  scope: this
118 });</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" 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-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>(&nbsp;<code>String/Array&nbsp;events</code>&nbsp;)
119     :
120                                         void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
121 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
122 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
123 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default
124 implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
125 access the required target more quickly.</p>
126 <p>Example:</p><pre><code>Ext.override(Ext.form.Field, {
127     <i>//  Add functionality to Field&#39;s initComponent to enable the change event to bubble</i>
128     initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {
129         this.enableBubble(<em>'change'</em>);
130     }),
131
132     <i>//  We know that we want Field&#39;s events to bubble directly to the FormPanel.</i>
133     getBubbleTarget : <b>function</b>() {
134         <b>if</b> (!this.formPanel) {
135             this.formPanel = this.findParentByType(<em>'form'</em>);
136         }
137         <b>return</b> this.formPanel;
138     }
139 });
140
141 <b>var</b> myForm = <b>new</b> Ext.formPanel({
142     title: <em>'User Details'</em>,
143     items: [{
144         ...
145     }],
146     listeners: {
147         change: <b>function</b>() {
148             <i>// Title goes red <b>if</b> form has been modified.</i>
149             myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);
150         }
151     }
152 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : String/Array<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" 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-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Object...&nbsp;args</code>&nbsp;)
153     :
154                                         Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
155 An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
156 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>)
157 by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" ext:cls="Ext.util.Observable">Observable</a></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-getDragTarget"></a><b><a href="source/DragTracker.html#method-Ext.dd.DragTracker-getDragTarget">getDragTarget</a></b>()
158     :
159                                         Ext.Element<div class="mdesc"><div class="short">Returns the drag target</div><div class="long">Returns the drag target<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The element currently being tracked</div></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-hasListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>&nbsp;)
160     :
161                                         Boolean<div class="mdesc"><div class="short">Checks to see if this object has any listeners for a specified event</div><div class="long">Checks to see if this object has any listeners for a specified event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" 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-on"></a><b><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)
162     :
163                                         void<div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) 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><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#on" ext:member="#on" ext:cls="Ext.util.Observable">Observable</a></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-onBeforeStart"></a><b><a href="source/DragTracker.html#method-Ext.dd.DragTracker-onBeforeStart">onBeforeStart</a></b>(&nbsp;<code>Ext.EventObject&nbsp;e</code>&nbsp;)
165     :
166                                         void<div class="mdesc"><div class="short">Template method which should be overridden by each DragTracker instance. Called when the user first clicks and
167 holds ...</div><div class="long">Template method which should be overridden by each DragTracker instance. Called when the user first clicks and
168 holds the mouse button down. Return false to disallow the drag<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-onDrag"></a><b><a href="source/DragTracker.html#method-Ext.dd.DragTracker-onDrag">onDrag</a></b>(&nbsp;<code>Ext.EventObject&nbsp;e</code>&nbsp;)
169     :
170                                         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;)
171     :
172                                         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
173 (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;)
174     :
175                                         void<div class="mdesc"><div class="short">Template method which should be overridden by each DragTracker instance. Called when a drag operation starts
176 (e.g. th...</div><div class="long">Template method which should be overridden by each DragTracker instance. Called when a drag operation starts
177 (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>()
178     :
179                                         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;)
180     :
181                                         void<div class="mdesc"><div class="short">Relays selected events from the specified Observable as if the events were fired by this.</div><div class="long">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#relayEvents" ext:member="#relayEvents" 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-removeListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-removeListener">removeListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
182     :
183                                         void<div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#removeListener" ext:member="#removeListener" 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-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()
184     :
185                                         void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)
186 If events were suspended using the queueSuspended parameter, then all
187 event...</div><div class="long">Resume firing events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-suspendEvents" ext:member="suspendEvents" ext:cls="Ext.util.Observable">suspendEvents</a>)
188 If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
189 events fired during event suspension will be sent to any listeners now.<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#resumeEvents" ext:member="#resumeEvents" 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-suspendEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-suspendEvents">suspendEvents</a></b>(&nbsp;<code>Boolean&nbsp;queueSuspended</code>&nbsp;)
190     :
191                                         void<div class="mdesc"><div class="short">Suspend the firing of all events. (see resumeEvents)</div><div class="long">Suspend the firing of all events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a>)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>queueSuspended</code> : Boolean<div class="sub-desc">Pass as true to queue up suspended events to be fired
192 after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" 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-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
193     :
194                                         void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr></tbody></table><a id="Ext.dd.DragTracker-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></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-drag"></a><b><a href="source/DragTracker.html#event-Ext.dd.DragTracker-drag">drag</a></b> :
195                                       (&nbsp;<code>Object&nbsp;this</code>,&nbsp;<code>Object&nbsp;e</code>&nbsp;)
196     <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> :
197                                       (&nbsp;<code>Object&nbsp;this</code>,&nbsp;<code>Object&nbsp;e</code>&nbsp;)
198     <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> :
199                                       (&nbsp;<code>Object&nbsp;this</code>,&nbsp;<code>Object&nbsp;e</code>&nbsp;)
200     <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> :
201                                       (&nbsp;<code>Object&nbsp;this</code>,&nbsp;<code>Object&nbsp;e</code>&nbsp;)
202     <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> :
203                                       (&nbsp;<code>Object&nbsp;this</code>,&nbsp;<code>Object&nbsp;e</code>&nbsp;)
204     <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-mouseup"></a><b><a href="source/DragTracker.html#event-Ext.dd.DragTracker-mouseup">mouseup</a></b> :
205                                       (&nbsp;<code>Object&nbsp;this</code>,&nbsp;<code>Object&nbsp;e</code>&nbsp;)
206     <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></tbody></table></div>