Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.draw.Sprite.js
1 Ext.data.JsonP.Ext_draw_Sprite({
2   "tagname": "class",
3   "name": "Ext.draw.Sprite",
4   "doc": "<p>A Sprite is an object rendered in a Drawing surface. There are different options and types of sprites.\nThe configuration of a Sprite is an object with the following properties:</p>\n\n<ul>\n<li><strong>type</strong> - (String) The type of the sprite. Possible options are 'circle', 'path', 'rect', 'text', 'square', 'image'.</li>\n<li><strong>width</strong> - (Number) Used in rectangle sprites, the width of the rectangle.</li>\n<li><strong>height</strong> - (Number) Used in rectangle sprites, the height of the rectangle.</li>\n<li><strong>size</strong> - (Number) Used in square sprites, the dimension of the square.</li>\n<li><strong>radius</strong> - (Number) Used in circle sprites, the radius of the circle.</li>\n<li><strong>x</strong> - (Number) The position along the x-axis.</li>\n<li><strong>y</strong> - (Number) The position along the y-axis.</li>\n<li><strong>path</strong> - (Array) Used in path sprites, the path of the sprite written in SVG-like path syntax.</li>\n<li><strong>opacity</strong> - (Number) The opacity of the sprite.</li>\n<li><strong>fill</strong> - (String) The fill color.</li>\n<li><strong>stroke</strong> - (String) The stroke color.</li>\n<li><strong>stroke-width</strong> - (Number) The width of the stroke.</li>\n<li><strong>font</strong> - (String) Used with text type sprites. The full font description. Uses the same syntax as the CSS <code>font</code> parameter.</li>\n<li><strong>text</strong> - (String) Used with text type sprites. The text itself.</li>\n</ul>\n\n\n<p>Additionally there are three transform objects that can be set with <code>setAttributes</code> which are <code>translate</code>, <code>rotate</code> and\n<code>scale</code>.</p>\n\n<p>For translate, the configuration object contains x and y attributes that indicate where to\ntranslate the object. For example:</p>\n\n<pre><code>sprite.setAttributes({\n  translate: {\n   x: 10,\n   y: 10\n  }\n}, true);\n</code></pre>\n\n<p>For rotation, the configuration object contains x and y attributes for the center of the rotation (which are optional),\nand a <code>degrees</code> attribute that specifies the rotation in degrees. For example:</p>\n\n<pre><code>sprite.setAttributes({\n  rotate: {\n   degrees: 90\n  }\n}, true);\n</code></pre>\n\n<p>For scaling, the configuration object contains x and y attributes for the x-axis and y-axis scaling. For example:</p>\n\n<pre><code>sprite.setAttributes({\n  scale: {\n   x: 10,\n   y: 3\n  }\n}, true);\n</code></pre>\n\n<p>Sprites can be created with a reference to a <a href=\"#/api/Ext.draw.Surface\" rel=\"Ext.draw.Surface\" class=\"docClass\">Ext.draw.Surface</a></p>\n\n<pre><code> var drawComponent = Ext.create('Ext.draw.Component', options here...);\n\n var sprite = Ext.create('Ext.draw.Sprite', {\n     type: 'circle',\n     fill: '#ff0',\n     surface: drawComponent.surface,\n     radius: 5\n });\n</code></pre>\n\n<p>Sprites can also be added to the surface as a configuration object:</p>\n\n<pre><code> var sprite = drawComponent.surface.add({\n     type: 'circle',\n     fill: '#ff0',\n     radius: 5\n });\n</code></pre>\n\n<p>In order to properly apply properties and render the sprite we have to\n<code>show</code> the sprite setting the option <code>redraw</code> to <code>true</code>:</p>\n\n<pre><code> sprite.show(true);\n</code></pre>\n\n<p>The constructor configuration object of the Sprite can also be used and passed into the <a href=\"#/api/Ext.draw.Surface\" rel=\"Ext.draw.Surface\" class=\"docClass\">Ext.draw.Surface</a>\nadd method to append a new sprite to the canvas. For example:</p>\n\n<pre><code>drawComponent.surface.add({\n    type: 'circle',\n    fill: '#ffc',\n    radius: 100,\n    x: 100,\n    y: 100\n});\n</code></pre>\n",
5   "extends": "Object",
6   "mixins": [
7     "Ext.util.Observable",
8     "Ext.util.Animate"
9   ],
10   "alternateClassNames": [
11
12   ],
13   "xtype": null,
14   "author": null,
15   "docauthor": null,
16   "singleton": false,
17   "private": false,
18   "cfg": [
19     {
20       "tagname": "cfg",
21       "name": "listeners",
22       "member": "Ext.util.Observable",
23       "type": "Object",
24       "doc": "<p>(optional) <p>A config object containing one or more event handlers to be added to this\nobject during initialization.  This should be a valid listeners config object as specified in the\n<a href=\"#/api/Ext.draw.Sprite-method-addListener\" rel=\"Ext.draw.Sprite-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple handlers at once.</p></p>\n\n<br><p><b><u>DOM events from ExtJs <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></u></b></p>\n\n\n<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n<p>is usually only done when extra value can be added. For example the <a href=\"#/api/Ext.view.View\" rel=\"Ext.view.View\" class=\"docClass\">DataView</a>'s\n<b><code><a href=\"#/api/Ext.view.View--click\" rel=\"Ext.view.View--click\" class=\"docClass\">click</a></code></b> event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the <code>element</code> option to\nidentify the Component property to add a DOM listener to:</p>\n\n<pre><code>new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n</code></pre>\n\n\n<p></p></p>\n",
25       "private": false,
26       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
27       "linenr": 103,
28       "html_filename": "Observable.html",
29       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
30       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
31     }
32   ],
33   "method": [
34     {
35       "tagname": "method",
36       "name": "addCls",
37       "member": "Ext.draw.Sprite",
38       "doc": "<p>Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.  Note this method\nis severly limited in VML.</p>\n",
39       "params": [
40         {
41           "type": "String/Array",
42           "name": "className",
43           "doc": "<p>The CSS class to add, or an array of classes</p>\n",
44           "optional": false
45         }
46       ],
47       "return": {
48         "type": "Ext.draw.Sprite",
49         "doc": "<p>this</p>\n"
50       },
51       "private": false,
52       "static": false,
53       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Sprite.js",
54       "linenr": 378,
55       "html_filename": "Sprite.html",
56       "href": "Sprite.html#Ext-draw-Sprite-method-addCls",
57       "shortDoc": "Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.  Note this method\nis s..."
58     },
59     {
60       "tagname": "method",
61       "name": "addEvents",
62       "member": "Ext.util.Observable",
63       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
64       "params": [
65         {
66           "type": "Object/String",
67           "name": "o",
68           "doc": "<p>Either an object with event names as properties with a value of <code>true</code>\nor the first event name string if multiple event names are being passed as separate parameters.</p>\n",
69           "optional": false
70         },
71         {
72           "type": "String",
73           "name": "",
74           "doc": "<p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n\n",
75           "optional": false
76         }
77       ],
78       "return": {
79         "type": "void",
80         "doc": "\n"
81       },
82       "private": false,
83       "static": false,
84       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
85       "linenr": 452,
86       "html_filename": "Observable.html",
87       "href": "Observable.html#Ext-util-Observable-method-addEvents",
88       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
89     },
90     {
91       "tagname": "method",
92       "name": "addListener",
93       "member": "Ext.util.Observable",
94       "doc": "<p>Appends an event handler to this object.</p>\n",
95       "params": [
96         {
97           "type": "String",
98           "name": "eventName",
99           "doc": "<p>The name of the event to listen for. May also be an object who's property names are event names. See</p>\n",
100           "optional": false
101         },
102         {
103           "type": "Function",
104           "name": "handler",
105           "doc": "<p>The method the event invokes.</p>\n",
106           "optional": false
107         },
108         {
109           "type": "Object",
110           "name": "scope",
111           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
112           "optional": true
113         },
114         {
115           "type": "Object",
116           "name": "options",
117           "doc": "<p>(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:<ul>\n<li><b>scope</b> : Object<div class=\"sub-desc\">The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></div></li>\n<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>\n<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>\n<li><b>buffer</b> : Number<div class=\"sub-desc\">Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>\n<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>\nif the event was bubbled up from a child Observable.</div></li>\n<li><b>element</b> : String<div class=\"sub-desc\"><b>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</b>\nThe name of a Component property which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n<pre><code>new Ext.panel.Panel({\n    title: 'The title',\n    listeners: {\n        click: this.handlePanelClick,\n        element: 'body'\n    }\n});\n</code></pre></p>\n\n\n<p>When added in this way, the options available are the options applicable to <a href=\"#/api/Ext.core.Element-method-addListener\" rel=\"Ext.core.Element-method-addListener\" class=\"docClass\">Ext.core.Element.addListener</a></p>\n\n\n<p></div></li>\n</ul><br></p>\n\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA delayed, one-time listener.\n<pre><code>myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n<pre><code>myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n</code></pre>.\n<p>\n\n",
118           "optional": true
119         }
120       ],
121       "return": {
122         "type": "void",
123         "doc": "\n"
124       },
125       "private": false,
126       "static": false,
127       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
128       "linenr": 271,
129       "html_filename": "Observable.html",
130       "href": "Observable.html#Ext-util-Observable-method-addListener",
131       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
132     },
133     {
134       "tagname": "method",
135       "name": "addManagedListener",
136       "member": "Ext.util.Observable",
137       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
138       "params": [
139         {
140           "type": "Observable/Element",
141           "name": "item",
142           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
143           "optional": false
144         },
145         {
146           "type": "Object/String",
147           "name": "ename",
148           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
149           "optional": false
150         },
151         {
152           "type": "Function",
153           "name": "fn",
154           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
155           "optional": false
156         },
157         {
158           "type": "Object",
159           "name": "scope",
160           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
161           "optional": false
162         },
163         {
164           "type": "Object",
165           "name": "opt",
166           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
167           "optional": false
168         }
169       ],
170       "return": {
171         "type": "void",
172         "doc": "\n"
173       },
174       "private": false,
175       "static": false,
176       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
177       "linenr": 155,
178       "html_filename": "Observable.html",
179       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
180       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
181     },
182     {
183       "tagname": "method",
184       "name": "animate",
185       "member": "Ext.util.Animate",
186       "doc": "<p>Perform custom animation on this object.<p>\n<p>This method is applicable to both the the <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Component</a> class and the <a href=\"#/api/Ext.core.Element\" rel=\"Ext.core.Element\" class=\"docClass\">Element</a> class.\nIt performs animated transitions of certain properties of this object over a specified timeline.</p>\n<p>The sole parameter is an object which specifies start property values, end property values, and properties which\ndescribe the timeline. Of the properties listed below, only <b><code>to</code></b> is mandatory.</p>\n<p>Properties include<ul>\n<li><code>from</code> <div class=\"sub-desc\">An object which specifies start values for the properties being animated.\nIf not supplied, properties are animated from current settings. The actual properties which may be animated depend upon\nths object being animated. See the sections below on Element and Component animation.<div></li>\n<li><code>to</code> <div class=\"sub-desc\">An object which specifies end values for the properties being animated.</div></li>\n<li><code>duration</code><div class=\"sub-desc\">The duration <b>in milliseconds</b> for which the animation will run.</div></li>\n<li><code>easing</code> <div class=\"sub-desc\">A string value describing an easing type to modify the rate of change from the default linear to non-linear. Values may be one of:<code><ul>\n<li>ease</li>\n<li>easeIn</li>\n<li>easeOut</li>\n<li>easeInOut</li>\n<li>backIn</li>\n<li>backOut</li>\n<li>elasticIn</li>\n<li>elasticOut</li>\n<li>bounceIn</li>\n<li>bounceOut</li>\n</ul></code></div></li>\n<li><code>keyframes</code> <div class=\"sub-desc\">This is an object which describes the state of animated properties at certain points along the timeline.\nit is an object containing properties who's names are the percentage along the timeline being described and who's values specify the animation state at that point.</div></li>\n<li><code>listeners</code> <div class=\"sub-desc\">This is a standard <a href=\"#/api/Ext.util.Observable-cfg-listeners\" rel=\"Ext.util.Observable-cfg-listeners\" class=\"docClass\">listeners</a> configuration object which may be used\nto inject behaviour at either the <code>beforeanimate</code> event or the <code>afteranimate</code> event.</div></li>\n</ul></p>\n<h3>Animating an <a href=\"#/api/Ext.core.Element\" rel=\"Ext.core.Element\" class=\"docClass\">Element</a></h3>\nWhen animating an Element, the following properties may be specified in <code>from</code>, <code>to</code>, and <code>keyframe</code> objects:<ul>\n<li><code>x</code> <div class=\"sub-desc\">The page X position in pixels.</div></li>\n<li><code>y</code> <div class=\"sub-desc\">The page Y position in pixels</div></li>\n<li><code>left</code> <div class=\"sub-desc\">The element's CSS <code>left</code> value. Units must be supplied.</div></li>\n<li><code>top</code> <div class=\"sub-desc\">The element's CSS <code>top</code> value. Units must be supplied.</div></li>\n<li><code>width</code> <div class=\"sub-desc\">The element's CSS <code>width</code> value. Units must be supplied.</div></li>\n<li><code>height</code> <div class=\"sub-desc\">The element's CSS <code>height</code> value. Units must be supplied.</div></li>\n<li><code>scrollLeft</code> <div class=\"sub-desc\">The element's <code>scrollLeft</code> value.</div></li>\n<li><code>scrollTop</code> <div class=\"sub-desc\">The element's <code>scrollLeft</code> value.</div></li>\n<li><code>opacity</code> <div class=\"sub-desc\">The element's <code>opacity</code> value. This must be a value between <code>0</code> and <code>1</code>.</div></li>\n</ul>\n<p><b>Be aware than animating an Element which is being used by an <a href=\"#/api/Ext\" rel=\"Ext\" class=\"docClass\">Ext</a> Component without in some way informing the Component about the changed element state\nwill result in incorrect Component behaviour. This is because the Component will be using the old state of the element. To avoid this problem, it is now possible to\ndirectly animate certain properties of Components.</b></p>\n<h3>Animating a <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Component</a></h3>\nWhen animating an Element, the following properties may be specified in <code>from</code>, <code>to</code>, and <code>keyframe</code> objects:<ul>\n<li><code>x</code> <div class=\"sub-desc\">The Component's page X position in pixels.</div></li>\n<li><code>y</code> <div class=\"sub-desc\">The Component's page Y position in pixels</div></li>\n<li><code>left</code> <div class=\"sub-desc\">The Component's <code>left</code> value in pixels.</div></li>\n<li><code>top</code> <div class=\"sub-desc\">The Component's <code>top</code> value in pixels.</div></li>\n<li><code>width</code> <div class=\"sub-desc\">The Component's <code>width</code> value in pixels.</div></li>\n<li><code>width</code> <div class=\"sub-desc\">The Component's <code>width</code> value in pixels.</div></li>\n<li><code>dynamic</code> <div class=\"sub-desc\">Specify as true to update the Component's layout (if it is a Container) at every frame\nof the animation. <i>Use sparingly as laying out on every intermediate size change is an expensive operation</i>.</div></li>\n</ul>\n<p>For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:</p>\n<pre><code>myWindow = Ext.create('Ext.window.Window', {\n    title: 'Test Component animation',\n    width: 500,\n    height: 300,\n    layout: {\n        type: 'hbox',\n        align: 'stretch'\n    },\n    items: [{\n        title: 'Left: 33%',\n        margins: '5 0 5 5',\n        flex: 1\n    }, {\n        title: 'Left: 66%',\n        margins: '5 5 5 5',\n        flex: 2\n    }]\n});\nmyWindow.show();\nmyWindow.header.el.on('click', function() {\n    myWindow.animate({\n        to: {\n            width: (myWindow.getWidth() == 500) ? 700 : 500,\n            height: (myWindow.getHeight() == 300) ? 400 : 300,\n        }\n    });\n});\n</code></pre>\n<p>For performance reasons, by default, the internal layout is only updated when the Window reaches its final <code>\"to\"</code> size. If dynamic updating of the Window's child\nComponents is required, then configure the animation with <code>dynamic: true</code> and the two child items will maintain their proportions during the animation.</p>\n\n",
187       "params": [
188         {
189           "type": "Object",
190           "name": "config",
191           "doc": "<p>An object containing properties which describe the animation's start and end states, and the timeline of the animation.</p>\n",
192           "optional": false
193         }
194       ],
195       "return": {
196         "type": "Object",
197         "doc": "<p>this</p>\n"
198       },
199       "private": false,
200       "static": false,
201       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js",
202       "linenr": 207,
203       "html_filename": "Animate.html",
204       "href": "Animate.html#Ext-util-Animate-method-animate",
205       "shortDoc": "Perform custom animation on this object.\nThis method is applicable to both the the Component class and the Element cl..."
206     },
207     {
208       "tagname": "method",
209       "name": "capture",
210       "member": "Ext.util.Observable",
211       "doc": "<p>Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
212       "params": [
213         {
214           "type": "Observable",
215           "name": "o",
216           "doc": "<p>The Observable to capture events from.</p>\n",
217           "optional": false
218         },
219         {
220           "type": "Function",
221           "name": "fn",
222           "doc": "<p>The function to call when an event is fired.</p>\n",
223           "optional": false
224         },
225         {
226           "type": "Object",
227           "name": "scope",
228           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
229           "optional": true
230         }
231       ],
232       "return": {
233         "type": "void",
234         "doc": "\n"
235       },
236       "private": false,
237       "static": true,
238       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
239       "linenr": 55,
240       "html_filename": "Observable.html",
241       "href": "Observable.html#Ext-util-Observable-method-capture",
242       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
243     },
244     {
245       "tagname": "method",
246       "name": "clearListeners",
247       "member": "Ext.util.Observable",
248       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
249       "params": [
250
251       ],
252       "return": {
253         "type": "void",
254         "doc": "\n"
255       },
256       "private": false,
257       "static": false,
258       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
259       "linenr": 383,
260       "html_filename": "Observable.html",
261       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
262       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
263     },
264     {
265       "tagname": "method",
266       "name": "clearManagedListeners",
267       "member": "Ext.util.Observable",
268       "doc": "<p>Removes all managed listeners for this object.</p>\n",
269       "params": [
270
271       ],
272       "return": {
273         "type": "void",
274         "doc": "\n"
275       },
276       "private": false,
277       "static": false,
278       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
279       "linenr": 412,
280       "html_filename": "Observable.html",
281       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
282       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
283     },
284     {
285       "tagname": "method",
286       "name": "destroy",
287       "member": "Ext.draw.Sprite",
288       "doc": "<p>Removes the sprite and clears all listeners.</p>\n",
289       "params": [
290
291       ],
292       "return": {
293         "type": "void",
294         "doc": "\n"
295       },
296       "private": false,
297       "static": false,
298       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Sprite.js",
299       "linenr": 345,
300       "html_filename": "Sprite.html",
301       "href": "Sprite.html#Ext-draw-Sprite-method-destroy",
302       "shortDoc": "<p>Removes the sprite and clears all listeners.</p>\n"
303     },
304     {
305       "tagname": "method",
306       "name": "enableBubble",
307       "member": "Ext.util.Observable",
308       "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\n<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\n\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default\nimplementation in <a href=\"#/api/Ext.Component\" 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\naccess the required target more quickly.</p>\n\n\n<p>Example:</p>\n\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n//  Add functionality to Field&#39;s initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n    this.enableBubble('change');\n}),\n\n//  We know that we want Field&#39;s events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n    if (!this.formPanel) {\n        this.formPanel = this.findParentByType('form');\n    }\n    return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n    ...\n}],\nlisteners: {\n    change: function() {\n        // Title goes red if form has been modified.\n        myForm.header.setStyle('color', 'red');\n    }\n}\n});\n</code></pre>\n\n",
309       "params": [
310         {
311           "type": "String/Array",
312           "name": "events",
313           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
314           "optional": false
315         }
316       ],
317       "return": {
318         "type": "void",
319         "doc": "\n"
320       },
321       "private": false,
322       "static": false,
323       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
324       "linenr": 554,
325       "html_filename": "Observable.html",
326       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
327       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
328     },
329     {
330       "tagname": "method",
331       "name": "fireEvent",
332       "member": "Ext.util.Observable",
333       "doc": "<p>Fires the specified event with the passed parameters (minus the event name).</p>\n\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>)\nby calling <a href=\"#/api/Ext.draw.Sprite-method-enableBubble\" rel=\"Ext.draw.Sprite-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
334       "params": [
335         {
336           "type": "String",
337           "name": "eventName",
338           "doc": "<p>The name of the event to fire.</p>\n",
339           "optional": false
340         },
341         {
342           "type": "Object...",
343           "name": "args",
344           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
345           "optional": false
346         }
347       ],
348       "return": {
349         "type": "Boolean",
350         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
351       },
352       "private": false,
353       "static": false,
354       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
355       "linenr": 232,
356       "html_filename": "Observable.html",
357       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
358       "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..."
359     },
360     {
361       "tagname": "method",
362       "name": "getActiveAnimation",
363       "member": "Ext.util.Animate",
364       "doc": "<p>Returns thq current animation if this object has any effects actively running or queued, else returns false.</p>\n",
365       "params": [
366
367       ],
368       "return": {
369         "type": "Mixed",
370         "doc": "<p>anim if element has active effects, else false</p>\n"
371       },
372       "private": false,
373       "static": false,
374       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js",
375       "linenr": 377,
376       "html_filename": "Animate.html",
377       "href": "Animate.html#Ext-util-Animate-method-getActiveAnimation",
378       "shortDoc": "<p>Returns thq current animation if this object has any effects actively running or queued, else returns false.</p>\n"
379     },
380     {
381       "tagname": "method",
382       "name": "getBBox",
383       "member": "Ext.draw.Sprite",
384       "doc": "<p>Retrieve the bounding box of the sprite. This will be returned as an object with x, y, width, and height properties.</p>\n",
385       "params": [
386
387       ],
388       "return": {
389         "type": "Object",
390         "doc": "<p>bbox</p>\n"
391       },
392       "private": false,
393       "static": false,
394       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Sprite.js",
395       "linenr": 294,
396       "html_filename": "Sprite.html",
397       "href": "Sprite.html#Ext-draw-Sprite-method-getBBox",
398       "shortDoc": "<p>Retrieve the bounding box of the sprite. This will be returned as an object with x, y, width, and height properties.</p>\n"
399     },
400     {
401       "tagname": "method",
402       "name": "hasActiveFx",
403       "member": "Ext.util.Animate",
404       "doc": "<p>@deprecated 4.0 Replaced by <a href=\"#/api/Ext.draw.Sprite-method-getActiveAnimation\" rel=\"Ext.draw.Sprite-method-getActiveAnimation\" class=\"docClass\">getActiveAnimation</a>\nReturns thq current animation if this object has any effects actively running or queued, else returns false.</p>\n",
405       "params": [
406
407       ],
408       "return": {
409         "type": "Mixed",
410         "doc": "<p>anim if element has active effects, else false</p>\n"
411       },
412       "private": false,
413       "static": false,
414       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js",
415       "linenr": 369,
416       "html_filename": "Animate.html",
417       "href": "Animate.html#Ext-util-Animate-method-hasActiveFx",
418       "shortDoc": "@deprecated 4.0 Replaced by getActiveAnimation\nReturns thq current animation if this object has any effects actively ..."
419     },
420     {
421       "tagname": "method",
422       "name": "hasListener",
423       "member": "Ext.util.Observable",
424       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
425       "params": [
426         {
427           "type": "String",
428           "name": "eventName",
429           "doc": "<p>The name of the event to check for</p>\n",
430           "optional": false
431         }
432       ],
433       "return": {
434         "type": "Boolean",
435         "doc": "<p>True if the event is being listened for, else false</p>\n"
436       },
437       "private": false,
438       "static": false,
439       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
440       "linenr": 480,
441       "html_filename": "Observable.html",
442       "href": "Observable.html#Ext-util-Observable-method-hasListener",
443       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
444     },
445     {
446       "tagname": "method",
447       "name": "hide",
448       "member": "Ext.draw.Sprite",
449       "doc": "<p>Hide the sprite.</p>\n",
450       "params": [
451         {
452           "type": "Boolean",
453           "name": "redraw",
454           "doc": "<p>Flag to immediatly draw the change.</p>\n",
455           "optional": false
456         }
457       ],
458       "return": {
459         "type": "Ext.draw.Sprite",
460         "doc": "<p>this</p>\n"
461       },
462       "private": false,
463       "static": false,
464       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Sprite.js",
465       "linenr": 306,
466       "html_filename": "Sprite.html",
467       "href": "Sprite.html#Ext-draw-Sprite-method-hide",
468       "shortDoc": "<p>Hide the sprite.</p>\n"
469     },
470     {
471       "tagname": "method",
472       "name": "observe",
473       "member": "Ext.util.Observable",
474       "doc": "<p>Sets observability on the passed class constructor.</p>\n\n<p>This makes any event fired on any instance of the passed class also fire a single event through\nthe <strong>class</strong> allowing for central handling of events on many instances at once.</p>\n\n<p>Usage:</p>\n\n<pre><code>Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n    console.log('Ajax request made to ' + options.url);\n});\n</code></pre>\n",
475       "params": [
476         {
477           "type": "Function",
478           "name": "c",
479           "doc": "<p>The class constructor to make observable.</p>\n",
480           "optional": false
481         },
482         {
483           "type": "Object",
484           "name": "listeners",
485           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.draw.Sprite-method-addListener\" rel=\"Ext.draw.Sprite-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
486           "optional": false
487         }
488       ],
489       "return": {
490         "type": "void",
491         "doc": "\n"
492       },
493       "private": false,
494       "static": true,
495       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
496       "linenr": 69,
497       "html_filename": "Observable.html",
498       "href": "Observable.html#Ext-util-Observable-method-observe",
499       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
500     },
501     {
502       "tagname": "method",
503       "name": "on",
504       "member": "Ext.util.Observable",
505       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.draw.Sprite-method-addListener\" rel=\"Ext.draw.Sprite-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
506       "params": [
507         {
508           "type": "String",
509           "name": "eventName",
510           "doc": "<p>The type of event to listen for</p>\n",
511           "optional": false
512         },
513         {
514           "type": "Function",
515           "name": "handler",
516           "doc": "<p>The method the event invokes</p>\n",
517           "optional": false
518         },
519         {
520           "type": "Object",
521           "name": "scope",
522           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
523           "optional": true
524         },
525         {
526           "type": "Object",
527           "name": "options",
528           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
529           "optional": true
530         }
531       ],
532       "return": {
533         "type": "void",
534         "doc": "\n"
535       },
536       "private": false,
537       "static": false,
538       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
539       "linenr": 616,
540       "html_filename": "Observable.html",
541       "href": "Observable.html#Ext-util-Observable-method-on",
542       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.draw.Sprite-method-addListener\" rel=\"Ext.draw.Sprite-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
543     },
544     {
545       "tagname": "method",
546       "name": "redraw",
547       "member": "Ext.draw.Sprite",
548       "doc": "<p>Redraw the sprite.</p>\n",
549       "params": [
550
551       ],
552       "return": {
553         "type": "Ext.draw.Sprite",
554         "doc": "<p>this</p>\n"
555       },
556       "private": false,
557       "static": false,
558       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Sprite.js",
559       "linenr": 358,
560       "html_filename": "Sprite.html",
561       "href": "Sprite.html#Ext-draw-Sprite-method-redraw",
562       "shortDoc": "<p>Redraw the sprite.</p>\n"
563     },
564     {
565       "tagname": "method",
566       "name": "relayEvents",
567       "member": "Ext.util.Observable",
568       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
569       "params": [
570         {
571           "type": "Object",
572           "name": "origin",
573           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
574           "optional": false
575         },
576         {
577           "type": "Array",
578           "name": "events",
579           "doc": "<p>Array of event names to relay.</p>\n",
580           "optional": false
581         },
582         {
583           "type": "Object",
584           "name": "prefix",
585           "doc": "\n",
586           "optional": false
587         }
588       ],
589       "return": {
590         "type": "void",
591         "doc": "\n"
592       },
593       "private": false,
594       "static": false,
595       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
596       "linenr": 520,
597       "html_filename": "Observable.html",
598       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
599       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
600     },
601     {
602       "tagname": "method",
603       "name": "releaseCapture",
604       "member": "Ext.util.Observable",
605       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
606       "params": [
607         {
608           "type": "Observable",
609           "name": "o",
610           "doc": "<p>The Observable to release</p>\n",
611           "optional": false
612         }
613       ],
614       "return": {
615         "type": "void",
616         "doc": "\n"
617       },
618       "private": false,
619       "static": true,
620       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
621       "linenr": 46,
622       "html_filename": "Observable.html",
623       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
624       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
625     },
626     {
627       "tagname": "method",
628       "name": "remove",
629       "member": "Ext.draw.Sprite",
630       "doc": "<p>Remove the sprite.</p>\n",
631       "params": [
632
633       ],
634       "return": {
635         "type": "void",
636         "doc": "\n"
637       },
638       "private": false,
639       "static": false,
640       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Sprite.js",
641       "linenr": 330,
642       "html_filename": "Sprite.html",
643       "href": "Sprite.html#Ext-draw-Sprite-method-remove",
644       "shortDoc": "<p>Remove the sprite.</p>\n"
645     },
646     {
647       "tagname": "method",
648       "name": "removeCls",
649       "member": "Ext.draw.Sprite",
650       "doc": "<p>Removes one or more CSS classes from the element.</p>\n",
651       "params": [
652         {
653           "type": "String/Array",
654           "name": "className",
655           "doc": "<p>The CSS class to remove, or an array of classes.  Note this method\nis severly limited in VML.</p>\n",
656           "optional": false
657         }
658       ],
659       "return": {
660         "type": "Ext.draw.Sprite",
661         "doc": "<p>this</p>\n"
662       },
663       "private": false,
664       "static": false,
665       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Sprite.js",
666       "linenr": 389,
667       "html_filename": "Sprite.html",
668       "href": "Sprite.html#Ext-draw-Sprite-method-removeCls",
669       "shortDoc": "<p>Removes one or more CSS classes from the element.</p>\n"
670     },
671     {
672       "tagname": "method",
673       "name": "removeListener",
674       "member": "Ext.util.Observable",
675       "doc": "<p>Removes an event handler.</p>\n",
676       "params": [
677         {
678           "type": "String",
679           "name": "eventName",
680           "doc": "<p>The type of event the handler was associated with.</p>\n",
681           "optional": false
682         },
683         {
684           "type": "Function",
685           "name": "handler",
686           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.draw.Sprite-method-addListener\" rel=\"Ext.draw.Sprite-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
687           "optional": false
688         },
689         {
690           "type": "Object",
691           "name": "scope",
692           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
693           "optional": true
694         }
695       ],
696       "return": {
697         "type": "void",
698         "doc": "\n"
699       },
700       "private": false,
701       "static": false,
702       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
703       "linenr": 352,
704       "html_filename": "Observable.html",
705       "href": "Observable.html#Ext-util-Observable-method-removeListener",
706       "shortDoc": "<p>Removes an event handler.</p>\n"
707     },
708     {
709       "tagname": "method",
710       "name": "removeManagedListener",
711       "member": "Ext.util.Observable",
712       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.draw.Sprite--mon\" rel=\"Ext.draw.Sprite--mon\" class=\"docClass\">mon</a> method.</p>\n",
713       "params": [
714         {
715           "type": "Observable|Element",
716           "name": "item",
717           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
718           "optional": false
719         },
720         {
721           "type": "Object|String",
722           "name": "ename",
723           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
724           "optional": false
725         },
726         {
727           "type": "Function",
728           "name": "fn",
729           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
730           "optional": false
731         },
732         {
733           "type": "Object",
734           "name": "scope",
735           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
736           "optional": false
737         }
738       ],
739       "return": {
740         "type": "void",
741         "doc": "\n"
742       },
743       "private": false,
744       "static": false,
745       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
746       "linenr": 196,
747       "html_filename": "Observable.html",
748       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
749       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.draw.Sprite--mon\" rel=\"Ext.draw.Sprite--mon\" class=\"docClass\">mon</a> method.</p>\n"
750     },
751     {
752       "tagname": "method",
753       "name": "resumeEvents",
754       "member": "Ext.util.Observable",
755       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.draw.Sprite-method-suspendEvents\" rel=\"Ext.draw.Sprite-method-suspendEvents\" class=\"docClass\">suspendEvents</a>)\nIf events were suspended using the <code><b>queueSuspended</b></code> parameter, then all\nevents fired during event suspension will be sent to any listeners now.</p>\n",
756       "params": [
757
758       ],
759       "return": {
760         "type": "void",
761         "doc": "\n"
762       },
763       "private": false,
764       "static": false,
765       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
766       "linenr": 502,
767       "html_filename": "Observable.html",
768       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
769       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
770     },
771     {
772       "tagname": "method",
773       "name": "sequenceFx",
774       "member": "Ext.util.Animate",
775       "doc": "<p>Ensures that all effects queued after sequenceFx is called on this object are\nrun in sequence.  This is the opposite of <a href=\"#/api/Ext.draw.Sprite-method-syncFx\" rel=\"Ext.draw.Sprite-method-syncFx\" class=\"docClass\">syncFx</a>.</p>\n",
776       "params": [
777
778       ],
779       "return": {
780         "type": "Object",
781         "doc": "<p>this</p>\n"
782       },
783       "private": false,
784       "static": false,
785       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js",
786       "linenr": 357,
787       "html_filename": "Animate.html",
788       "href": "Animate.html#Ext-util-Animate-method-sequenceFx",
789       "shortDoc": "Ensures that all effects queued after sequenceFx is called on this object are\nrun in sequence.  This is the opposite ..."
790     },
791     {
792       "tagname": "method",
793       "name": "setAttributes",
794       "member": "Ext.draw.Sprite",
795       "doc": "<p>Change the attributes of the sprite.</p>\n",
796       "params": [
797         {
798           "type": "Object",
799           "name": "attrs",
800           "doc": "<p>attributes to be changed on the sprite.</p>\n",
801           "optional": false
802         },
803         {
804           "type": "Boolean",
805           "name": "redraw",
806           "doc": "<p>Flag to immediatly draw the change.</p>\n",
807           "optional": false
808         }
809       ],
810       "return": {
811         "type": "Ext.draw.Sprite",
812         "doc": "<p>this</p>\n"
813       },
814       "private": false,
815       "static": false,
816       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Sprite.js",
817       "linenr": 197,
818       "html_filename": "Sprite.html",
819       "href": "Sprite.html#Ext-draw-Sprite-method-setAttributes",
820       "shortDoc": "<p>Change the attributes of the sprite.</p>\n"
821     },
822     {
823       "tagname": "method",
824       "name": "setStyle",
825       "member": "Ext.draw.Sprite",
826       "doc": "<p>Wrapper for setting style properties, also takes single object parameter of multiple styles.</p>\n",
827       "params": [
828         {
829           "type": "String/Object",
830           "name": "property",
831           "doc": "<p>The style property to be set, or an object of multiple styles.</p>\n",
832           "optional": false
833         },
834         {
835           "type": "String",
836           "name": "value",
837           "doc": "<p>(optional) The value to apply to the given property, or null if an object was passed.</p>\n",
838           "optional": true
839         }
840       ],
841       "return": {
842         "type": "Ext.draw.Sprite",
843         "doc": "<p>this</p>\n"
844       },
845       "private": false,
846       "static": false,
847       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Sprite.js",
848       "linenr": 367,
849       "html_filename": "Sprite.html",
850       "href": "Sprite.html#Ext-draw-Sprite-method-setStyle",
851       "shortDoc": "<p>Wrapper for setting style properties, also takes single object parameter of multiple styles.</p>\n"
852     },
853     {
854       "tagname": "method",
855       "name": "show",
856       "member": "Ext.draw.Sprite",
857       "doc": "<p>Show the sprite.</p>\n",
858       "params": [
859         {
860           "type": "Boolean",
861           "name": "redraw",
862           "doc": "<p>Flag to immediatly draw the change.</p>\n",
863           "optional": false
864         }
865       ],
866       "return": {
867         "type": "Ext.draw.Sprite",
868         "doc": "<p>this</p>\n"
869       },
870       "private": false,
871       "static": false,
872       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Sprite.js",
873       "linenr": 318,
874       "html_filename": "Sprite.html",
875       "href": "Sprite.html#Ext-draw-Sprite-method-show",
876       "shortDoc": "<p>Show the sprite.</p>\n"
877     },
878     {
879       "tagname": "method",
880       "name": "stopAnimation",
881       "member": "Ext.util.Animate",
882       "doc": "<p>Stops any running effects and clears this object's internal effects queue if it contains\nany additional effects that haven't started yet.</p>\n",
883       "params": [
884
885       ],
886       "return": {
887         "type": "Ext.core.Element",
888         "doc": "<p>The Element</p>\n"
889       },
890       "private": false,
891       "static": false,
892       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js",
893       "linenr": 335,
894       "html_filename": "Animate.html",
895       "href": "Animate.html#Ext-util-Animate-method-stopAnimation",
896       "shortDoc": "Stops any running effects and clears this object's internal effects queue if it contains\nany additional effects that ..."
897     },
898     {
899       "tagname": "method",
900       "name": "stopFx",
901       "member": "Ext.util.Animate",
902       "doc": "<p>@deprecated 4.0 Replaced by <a href=\"#/api/Ext.draw.Sprite-method-stopAnimation\" rel=\"Ext.draw.Sprite-method-stopAnimation\" class=\"docClass\">stopAnimation</a>\nStops any running effects and clears this object's internal effects queue if it contains\nany additional effects that haven't started yet.</p>\n",
903       "params": [
904
905       ],
906       "return": {
907         "type": "Ext.core.Element",
908         "doc": "<p>The Element</p>\n"
909       },
910       "private": false,
911       "static": false,
912       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js",
913       "linenr": 326,
914       "html_filename": "Animate.html",
915       "href": "Animate.html#Ext-util-Animate-method-stopFx",
916       "shortDoc": "@deprecated 4.0 Replaced by stopAnimation\nStops any running effects and clears this object's internal effects queue i..."
917     },
918     {
919       "tagname": "method",
920       "name": "suspendEvents",
921       "member": "Ext.util.Observable",
922       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.draw.Sprite-method-resumeEvents\" rel=\"Ext.draw.Sprite-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
923       "params": [
924         {
925           "type": "Boolean",
926           "name": "queueSuspended",
927           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.draw.Sprite-method-resumeEvents\" rel=\"Ext.draw.Sprite-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
928           "optional": false
929         }
930       ],
931       "return": {
932         "type": "void",
933         "doc": "\n"
934       },
935       "private": false,
936       "static": false,
937       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
938       "linenr": 490,
939       "html_filename": "Observable.html",
940       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
941       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.draw.Sprite-method-resumeEvents\" rel=\"Ext.draw.Sprite-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
942     },
943     {
944       "tagname": "method",
945       "name": "syncFx",
946       "member": "Ext.util.Animate",
947       "doc": "<p>Ensures that all effects queued after syncFx is called on this object are\nrun concurrently.  This is the opposite of <a href=\"#/api/Ext.draw.Sprite-method-sequenceFx\" rel=\"Ext.draw.Sprite-method-sequenceFx\" class=\"docClass\">sequenceFx</a>.</p>\n",
948       "params": [
949
950       ],
951       "return": {
952         "type": "Object",
953         "doc": "<p>this</p>\n"
954       },
955       "private": false,
956       "static": false,
957       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js",
958       "linenr": 345,
959       "html_filename": "Animate.html",
960       "href": "Animate.html#Ext-util-Animate-method-syncFx",
961       "shortDoc": "Ensures that all effects queued after syncFx is called on this object are\nrun concurrently.  This is the opposite of ..."
962     },
963     {
964       "tagname": "method",
965       "name": "un",
966       "member": "Ext.util.Observable",
967       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.draw.Sprite-method-removeListener\" rel=\"Ext.draw.Sprite-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
968       "params": [
969         {
970           "type": "String",
971           "name": "eventName",
972           "doc": "<p>The type of event the handler was associated with.</p>\n",
973           "optional": false
974         },
975         {
976           "type": "Function",
977           "name": "handler",
978           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.draw.Sprite-method-addListener\" rel=\"Ext.draw.Sprite-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
979           "optional": false
980         },
981         {
982           "type": "Object",
983           "name": "scope",
984           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
985           "optional": true
986         }
987       ],
988       "return": {
989         "type": "void",
990         "doc": "\n"
991       },
992       "private": false,
993       "static": false,
994       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
995       "linenr": 608,
996       "html_filename": "Observable.html",
997       "href": "Observable.html#Ext-util-Observable-method-un",
998       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.draw.Sprite-method-removeListener\" rel=\"Ext.draw.Sprite-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
999     }
1000   ],
1001   "property": [
1002     {
1003       "tagname": "property",
1004       "name": "dd",
1005       "member": "Ext.draw.Sprite",
1006       "type": "Ext.dd.DragSource.",
1007       "doc": "<p>If this Sprite is configured <a href=\"#/api/Ext.draw.Sprite--draggable\" rel=\"Ext.draw.Sprite--draggable\" class=\"docClass\">draggable</a>, this property will contain\nan instance of <a href=\"#/api/Ext.dd.DragSource\" rel=\"Ext.dd.DragSource\" class=\"docClass\">Ext.dd.DragSource</a> which handles dragging the Sprite.</p>\n\n\n<p>The developer must provide implementations of the abstract methods of <a href=\"#/api/Ext.dd.DragSource\" rel=\"Ext.dd.DragSource\" class=\"docClass\">Ext.dd.DragSource</a>\nin order to supply behaviour for each stage of the drag/drop process. See <a href=\"#/api/Ext.draw.Sprite--draggable\" rel=\"Ext.draw.Sprite--draggable\" class=\"docClass\">draggable</a>.</p>\n",
1008       "private": false,
1009       "static": false,
1010       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Sprite.js",
1011       "linenr": 178,
1012       "html_filename": "Sprite.html",
1013       "href": "Sprite.html#Ext-draw-Sprite-property-dd",
1014       "shortDoc": "If this Sprite is configured draggable, this property will contain\nan instance of Ext.dd.DragSource which handles dra..."
1015     }
1016   ],
1017   "event": [
1018
1019   ],
1020   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Sprite.js",
1021   "linenr": 1,
1022   "html_filename": "Sprite.html",
1023   "href": "Sprite.html#Ext-draw-Sprite",
1024   "cssVar": [
1025
1026   ],
1027   "cssMixin": [
1028
1029   ],
1030   "component": false,
1031   "superclasses": [
1032
1033   ],
1034   "subclasses": [
1035
1036   ],
1037   "mixedInto": [
1038
1039   ],
1040   "allMixins": [
1041     "Ext.util.Observable",
1042     "Ext.util.Animate"
1043   ]
1044 });