Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.draw.engine.Vml.js
1 Ext.data.JsonP.Ext_draw_engine_Vml({
2   "tagname": "class",
3   "name": "Ext.draw.engine.Vml",
4   "doc": "<p>Provides specific methods to draw with VML.</p>\n",
5   "extends": "Ext.draw.Surface",
6   "mixins": [
7
8   ],
9   "alternateClassNames": [
10
11   ],
12   "xtype": null,
13   "author": null,
14   "docauthor": null,
15   "singleton": false,
16   "private": false,
17   "cfg": [
18     {
19       "tagname": "cfg",
20       "name": "height",
21       "member": "Ext.draw.Surface",
22       "type": "Number",
23       "doc": "<p>The height of this component in pixels (defaults to auto).\n<b>Note</b> to express this dimension as a percentage or offset see <a href=\"#/api/Ext.Component--anchor\" rel=\"Ext.Component--anchor\" class=\"docClass\">Ext.Component.anchor</a>.</p>\n",
24       "private": false,
25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js",
26       "linenr": 199,
27       "html_filename": "Surface.html",
28       "href": "Surface.html#Ext-draw-Surface-cfg-height",
29       "shortDoc": "The height of this component in pixels (defaults to auto).\nNote to express this dimension as a percentage or offset s..."
30     },
31     {
32       "tagname": "cfg",
33       "name": "listeners",
34       "member": "Ext.util.Observable",
35       "type": "Object",
36       "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.engine.Vml-method-addListener\" rel=\"Ext.draw.engine.Vml-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",
37       "private": false,
38       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
39       "linenr": 103,
40       "html_filename": "Observable.html",
41       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
42       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
43     },
44     {
45       "tagname": "cfg",
46       "name": "width",
47       "member": "Ext.draw.Surface",
48       "type": "Number",
49       "doc": "<p>The width of this component in pixels (defaults to auto).\n<b>Note</b> to express this dimension as a percentage or offset see <a href=\"#/api/Ext.Component--anchor\" rel=\"Ext.Component--anchor\" class=\"docClass\">Ext.Component.anchor</a>.</p>\n",
50       "private": false,
51       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js",
52       "linenr": 204,
53       "html_filename": "Surface.html",
54       "href": "Surface.html#Ext-draw-Surface-cfg-width",
55       "shortDoc": "The width of this component in pixels (defaults to auto).\nNote to express this dimension as a percentage or offset se..."
56     }
57   ],
58   "method": [
59     {
60       "tagname": "method",
61       "name": "add",
62       "member": "Ext.draw.Surface",
63       "doc": "<p>Add a Sprite to the surface. See <a href=\"#/api/Ext.draw.Sprite\" rel=\"Ext.draw.Sprite\" class=\"docClass\">Ext.draw.Sprite</a> for the configuration object to be passed into this method.</p>\n\n<p>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",
64       "params": [
65
66       ],
67       "return": {
68         "type": "void",
69         "doc": "\n"
70       },
71       "private": false,
72       "static": false,
73       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js",
74       "linenr": 474,
75       "html_filename": "Surface.html",
76       "href": "Surface.html#Ext-draw-Surface-method-add",
77       "shortDoc": "Add a Sprite to the surface. See Ext.draw.Sprite for the configuration object to be passed into this method.\n\nFor exa..."
78     },
79     {
80       "tagname": "method",
81       "name": "addCls",
82       "member": "Ext.draw.Surface",
83       "doc": "<p>Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.</p>\n\n<p>For example:</p>\n\n<pre><code>     drawComponent.surface.addCls(sprite, 'x-visible');\n</code></pre>\n",
84       "params": [
85         {
86           "type": "Object",
87           "name": "sprite",
88           "doc": "<p>The sprite to add the class to.</p>\n",
89           "optional": false
90         },
91         {
92           "type": "String/Array",
93           "name": "className",
94           "doc": "<p>The CSS class to add, or an array of classes</p>\n",
95           "optional": false
96         }
97       ],
98       "return": {
99         "type": "void",
100         "doc": "\n"
101       },
102       "private": false,
103       "static": false,
104       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js",
105       "linenr": 261,
106       "html_filename": "Surface.html",
107       "href": "Surface.html#Ext-draw-Surface-method-addCls",
108       "shortDoc": "Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.\n\nFor example:\n\n     dr..."
109     },
110     {
111       "tagname": "method",
112       "name": "addEvents",
113       "member": "Ext.util.Observable",
114       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
115       "params": [
116         {
117           "type": "Object/String",
118           "name": "o",
119           "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",
120           "optional": false
121         },
122         {
123           "type": "String",
124           "name": "",
125           "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",
126           "optional": false
127         }
128       ],
129       "return": {
130         "type": "void",
131         "doc": "\n"
132       },
133       "private": false,
134       "static": false,
135       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
136       "linenr": 452,
137       "html_filename": "Observable.html",
138       "href": "Observable.html#Ext-util-Observable-method-addEvents",
139       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
140     },
141     {
142       "tagname": "method",
143       "name": "addGradient",
144       "member": "Ext.draw.engine.Vml",
145       "doc": "<p>Adds a definition to this Surface for a linear gradient. We convert the gradient definition\nto its corresponding VML attributes and store it for later use by individual sprites.</p>\n",
146       "params": [
147         {
148           "type": "Object",
149           "name": "gradient",
150           "doc": "\n",
151           "optional": false
152         }
153       ],
154       "return": {
155         "type": "void",
156         "doc": "\n"
157       },
158       "private": false,
159       "static": false,
160       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/engine/Vml.js",
161       "linenr": 863,
162       "html_filename": "Vml.html",
163       "href": "Vml.html#Ext-draw-engine-Vml-method-addGradient",
164       "shortDoc": "Adds a definition to this Surface for a linear gradient. We convert the gradient definition\nto its corresponding VML ..."
165     },
166     {
167       "tagname": "method",
168       "name": "addListener",
169       "member": "Ext.util.Observable",
170       "doc": "<p>Appends an event handler to this object.</p>\n",
171       "params": [
172         {
173           "type": "String",
174           "name": "eventName",
175           "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",
176           "optional": false
177         },
178         {
179           "type": "Function",
180           "name": "handler",
181           "doc": "<p>The method the event invokes.</p>\n",
182           "optional": false
183         },
184         {
185           "type": "Object",
186           "name": "scope",
187           "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",
188           "optional": true
189         },
190         {
191           "type": "Object",
192           "name": "options",
193           "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",
194           "optional": true
195         }
196       ],
197       "return": {
198         "type": "void",
199         "doc": "\n"
200       },
201       "private": false,
202       "static": false,
203       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
204       "linenr": 271,
205       "html_filename": "Observable.html",
206       "href": "Observable.html#Ext-util-Observable-method-addListener",
207       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
208     },
209     {
210       "tagname": "method",
211       "name": "addManagedListener",
212       "member": "Ext.util.Observable",
213       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
214       "params": [
215         {
216           "type": "Observable/Element",
217           "name": "item",
218           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
219           "optional": false
220         },
221         {
222           "type": "Object/String",
223           "name": "ename",
224           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
225           "optional": false
226         },
227         {
228           "type": "Function",
229           "name": "fn",
230           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
231           "optional": false
232         },
233         {
234           "type": "Object",
235           "name": "scope",
236           "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",
237           "optional": false
238         },
239         {
240           "type": "Object",
241           "name": "opt",
242           "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",
243           "optional": false
244         }
245       ],
246       "return": {
247         "type": "void",
248         "doc": "\n"
249       },
250       "private": false,
251       "static": false,
252       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
253       "linenr": 155,
254       "html_filename": "Observable.html",
255       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
256       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
257     },
258     {
259       "tagname": "method",
260       "name": "capture",
261       "member": "Ext.util.Observable",
262       "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",
263       "params": [
264         {
265           "type": "Observable",
266           "name": "o",
267           "doc": "<p>The Observable to capture events from.</p>\n",
268           "optional": false
269         },
270         {
271           "type": "Function",
272           "name": "fn",
273           "doc": "<p>The function to call when an event is fired.</p>\n",
274           "optional": false
275         },
276         {
277           "type": "Object",
278           "name": "scope",
279           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
280           "optional": true
281         }
282       ],
283       "return": {
284         "type": "void",
285         "doc": "\n"
286       },
287       "private": false,
288       "static": true,
289       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
290       "linenr": 55,
291       "html_filename": "Observable.html",
292       "href": "Observable.html#Ext-util-Observable-method-capture",
293       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
294     },
295     {
296       "tagname": "method",
297       "name": "clearListeners",
298       "member": "Ext.util.Observable",
299       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
300       "params": [
301
302       ],
303       "return": {
304         "type": "void",
305         "doc": "\n"
306       },
307       "private": false,
308       "static": false,
309       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
310       "linenr": 383,
311       "html_filename": "Observable.html",
312       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
313       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
314     },
315     {
316       "tagname": "method",
317       "name": "clearManagedListeners",
318       "member": "Ext.util.Observable",
319       "doc": "<p>Removes all managed listeners for this object.</p>\n",
320       "params": [
321
322       ],
323       "return": {
324         "type": "void",
325         "doc": "\n"
326       },
327       "private": false,
328       "static": false,
329       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
330       "linenr": 412,
331       "html_filename": "Observable.html",
332       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
333       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
334     },
335     {
336       "tagname": "method",
337       "name": "create",
338       "member": "Ext.draw.Surface",
339       "doc": "<p>Create and return a new concrete Surface instance appropriate for the current environment.</p>\n",
340       "params": [
341         {
342           "type": "Object",
343           "name": "config",
344           "doc": "<p>Initial configuration for the Surface instance</p>\n",
345           "optional": false
346         },
347         {
348           "type": "Array",
349           "name": "enginePriority",
350           "doc": "<p>Optional order of implementations to use; the first one that is</p>\n\n<pre><code>           available in the current environment will be used. Defaults to\n           &lt;code&gt;['Svg', 'Vml']&lt;/code&gt;.\n</code></pre>\n",
351           "optional": false
352         }
353       ],
354       "return": {
355         "type": "void",
356         "doc": "\n"
357       },
358       "private": false,
359       "static": false,
360       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js",
361       "linenr": 131,
362       "html_filename": "Surface.html",
363       "href": "Surface.html#Ext-draw-Surface-method-create",
364       "shortDoc": "<p>Create and return a new concrete Surface instance appropriate for the current environment.</p>\n"
365     },
366     {
367       "tagname": "method",
368       "name": "destroy",
369       "member": "Ext.draw.Surface",
370       "doc": "<p>Destroys the surface. This is done by removing all components from it and\nalso removing its reference to a DOM element.</p>\n\n<p>For example:</p>\n\n<pre><code> drawComponent.surface.destroy();\n</code></pre>\n",
371       "params": [
372
373       ],
374       "return": {
375         "type": "void",
376         "doc": "\n"
377       },
378       "private": false,
379       "static": false,
380       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js",
381       "linenr": 823,
382       "html_filename": "Surface.html",
383       "href": "Surface.html#Ext-draw-Surface-method-destroy",
384       "shortDoc": "Destroys the surface. This is done by removing all components from it and\nalso removing its reference to a DOM elemen..."
385     },
386     {
387       "tagname": "method",
388       "name": "enableBubble",
389       "member": "Ext.util.Observable",
390       "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",
391       "params": [
392         {
393           "type": "String/Array",
394           "name": "events",
395           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
396           "optional": false
397         }
398       ],
399       "return": {
400         "type": "void",
401         "doc": "\n"
402       },
403       "private": false,
404       "static": false,
405       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
406       "linenr": 554,
407       "html_filename": "Observable.html",
408       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
409       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
410     },
411     {
412       "tagname": "method",
413       "name": "fireEvent",
414       "member": "Ext.util.Observable",
415       "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.engine.Vml-method-enableBubble\" rel=\"Ext.draw.engine.Vml-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
416       "params": [
417         {
418           "type": "String",
419           "name": "eventName",
420           "doc": "<p>The name of the event to fire.</p>\n",
421           "optional": false
422         },
423         {
424           "type": "Object...",
425           "name": "args",
426           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
427           "optional": false
428         }
429       ],
430       "return": {
431         "type": "Boolean",
432         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
433       },
434       "private": false,
435       "static": false,
436       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
437       "linenr": 232,
438       "html_filename": "Observable.html",
439       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
440       "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..."
441     },
442     {
443       "tagname": "method",
444       "name": "getGroup",
445       "member": "Ext.draw.Surface",
446       "doc": "<p>Returns a new group or an existent group associated with the current surface.\nThe group returned is a <a href=\"#/api/Ext.draw.CompositeSprite\" rel=\"Ext.draw.CompositeSprite\" class=\"docClass\">Ext.draw.CompositeSprite</a> group.</p>\n\n<p>For example:</p>\n\n<pre><code> var spriteGroup = drawComponent.surface.getGroup('someGroupId');\n</code></pre>\n",
447       "params": [
448         {
449           "type": "String",
450           "name": "id",
451           "doc": "<p>The unique identifier of the group.</p>\n",
452           "optional": false
453         }
454       ],
455       "return": {
456         "type": "Object",
457         "doc": "<p>The <a href=\"#/api/Ext.draw.CompositeSprite\" rel=\"Ext.draw.CompositeSprite\" class=\"docClass\">Ext.draw.CompositeSprite</a>.</p>\n"
458       },
459       "private": false,
460       "static": false,
461       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js",
462       "linenr": 756,
463       "html_filename": "Surface.html",
464       "href": "Surface.html#Ext-draw-Surface-method-getGroup",
465       "shortDoc": "Returns a new group or an existent group associated with the current surface.\nThe group returned is a Ext.draw.Compos..."
466     },
467     {
468       "tagname": "method",
469       "name": "getId",
470       "member": "Ext.draw.Surface",
471       "doc": "<p>Retrieves the id of this component.\nWill autogenerate an id if one has not already been set.</p>\n",
472       "params": [
473
474       ],
475       "return": {
476         "type": "void",
477         "doc": "\n"
478       },
479       "private": false,
480       "static": false,
481       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js",
482       "linenr": 815,
483       "html_filename": "Surface.html",
484       "href": "Surface.html#Ext-draw-Surface-method-getId",
485       "shortDoc": "<p>Retrieves the id of this component.\nWill autogenerate an id if one has not already been set.</p>\n"
486     },
487     {
488       "tagname": "method",
489       "name": "hasListener",
490       "member": "Ext.util.Observable",
491       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
492       "params": [
493         {
494           "type": "String",
495           "name": "eventName",
496           "doc": "<p>The name of the event to check for</p>\n",
497           "optional": false
498         }
499       ],
500       "return": {
501         "type": "Boolean",
502         "doc": "<p>True if the event is being listened for, else false</p>\n"
503       },
504       "private": false,
505       "static": false,
506       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
507       "linenr": 480,
508       "html_filename": "Observable.html",
509       "href": "Observable.html#Ext-util-Observable-method-hasListener",
510       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
511     },
512     {
513       "tagname": "method",
514       "name": "observe",
515       "member": "Ext.util.Observable",
516       "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",
517       "params": [
518         {
519           "type": "Function",
520           "name": "c",
521           "doc": "<p>The class constructor to make observable.</p>\n",
522           "optional": false
523         },
524         {
525           "type": "Object",
526           "name": "listeners",
527           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.draw.engine.Vml-method-addListener\" rel=\"Ext.draw.engine.Vml-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
528           "optional": false
529         }
530       ],
531       "return": {
532         "type": "void",
533         "doc": "\n"
534       },
535       "private": false,
536       "static": true,
537       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
538       "linenr": 69,
539       "html_filename": "Observable.html",
540       "href": "Observable.html#Ext-util-Observable-method-observe",
541       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
542     },
543     {
544       "tagname": "method",
545       "name": "on",
546       "member": "Ext.util.Observable",
547       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.draw.engine.Vml-method-addListener\" rel=\"Ext.draw.engine.Vml-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
548       "params": [
549         {
550           "type": "String",
551           "name": "eventName",
552           "doc": "<p>The type of event to listen for</p>\n",
553           "optional": false
554         },
555         {
556           "type": "Function",
557           "name": "handler",
558           "doc": "<p>The method the event invokes</p>\n",
559           "optional": false
560         },
561         {
562           "type": "Object",
563           "name": "scope",
564           "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",
565           "optional": true
566         },
567         {
568           "type": "Object",
569           "name": "options",
570           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
571           "optional": true
572         }
573       ],
574       "return": {
575         "type": "void",
576         "doc": "\n"
577       },
578       "private": false,
579       "static": false,
580       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
581       "linenr": 616,
582       "html_filename": "Observable.html",
583       "href": "Observable.html#Ext-util-Observable-method-on",
584       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.draw.engine.Vml-method-addListener\" rel=\"Ext.draw.engine.Vml-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
585     },
586     {
587       "tagname": "method",
588       "name": "relayEvents",
589       "member": "Ext.util.Observable",
590       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
591       "params": [
592         {
593           "type": "Object",
594           "name": "origin",
595           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
596           "optional": false
597         },
598         {
599           "type": "Array",
600           "name": "events",
601           "doc": "<p>Array of event names to relay.</p>\n",
602           "optional": false
603         },
604         {
605           "type": "Object",
606           "name": "prefix",
607           "doc": "\n",
608           "optional": false
609         }
610       ],
611       "return": {
612         "type": "void",
613         "doc": "\n"
614       },
615       "private": false,
616       "static": false,
617       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
618       "linenr": 520,
619       "html_filename": "Observable.html",
620       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
621       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
622     },
623     {
624       "tagname": "method",
625       "name": "releaseCapture",
626       "member": "Ext.util.Observable",
627       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
628       "params": [
629         {
630           "type": "Observable",
631           "name": "o",
632           "doc": "<p>The Observable to release</p>\n",
633           "optional": false
634         }
635       ],
636       "return": {
637         "type": "void",
638         "doc": "\n"
639       },
640       "private": false,
641       "static": true,
642       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
643       "linenr": 46,
644       "html_filename": "Observable.html",
645       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
646       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
647     },
648     {
649       "tagname": "method",
650       "name": "remove",
651       "member": "Ext.draw.Surface",
652       "doc": "<p>Remove a given sprite from the surface, optionally destroying the sprite in the process.\nYou can also call the sprite own <code>remove</code> method.</p>\n\n<p>For example:</p>\n\n<pre><code> drawComponent.surface.remove(sprite);\n //or...\n sprite.remove();\n</code></pre>\n",
653       "params": [
654         {
655           "type": "Ext.draw.Sprite",
656           "name": "sprite",
657           "doc": "\n",
658           "optional": false
659         },
660         {
661           "type": "Boolean",
662           "name": "destroySprite",
663           "doc": "\n",
664           "optional": false
665         }
666       ],
667       "return": {
668         "type": "Number",
669         "doc": "<p>the sprite's new index in the list</p>\n"
670       },
671       "private": false,
672       "static": false,
673       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js",
674       "linenr": 561,
675       "html_filename": "Surface.html",
676       "href": "Surface.html#Ext-draw-Surface-method-remove",
677       "shortDoc": "Remove a given sprite from the surface, optionally destroying the sprite in the process.\nYou can also call the sprite..."
678     },
679     {
680       "tagname": "method",
681       "name": "removeAll",
682       "member": "Ext.draw.Surface",
683       "doc": "<p>Remove all sprites from the surface, optionally destroying the sprites in the process.</p>\n\n<p>For example:</p>\n\n<pre><code> drawComponent.surface.removeAll();\n</code></pre>\n",
684       "params": [
685         {
686           "type": "Boolean",
687           "name": "destroySprites",
688           "doc": "<p>Whether to destroy all sprites when removing them.</p>\n",
689           "optional": false
690         }
691       ],
692       "return": {
693         "type": "Number",
694         "doc": "<p>The sprite's new index in the list.</p>\n"
695       },
696       "private": false,
697       "static": false,
698       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js",
699       "linenr": 588,
700       "html_filename": "Surface.html",
701       "href": "Surface.html#Ext-draw-Surface-method-removeAll",
702       "shortDoc": "Remove all sprites from the surface, optionally destroying the sprites in the process.\n\nFor example:\n\n drawComponent...."
703     },
704     {
705       "tagname": "method",
706       "name": "removeCls",
707       "member": "Ext.draw.Surface",
708       "doc": "<p>Removes one or more CSS classes from the element.</p>\n\n<p>For example:</p>\n\n<pre><code> drawComponent.surface.removeCls(sprite, 'x-visible');\n</code></pre>\n",
709       "params": [
710         {
711           "type": "Object",
712           "name": "sprite",
713           "doc": "<p>The sprite to remove the class from.</p>\n",
714           "optional": false
715         },
716         {
717           "type": "String/Array",
718           "name": "className",
719           "doc": "<p>The CSS class to remove, or an array of classes</p>\n",
720           "optional": false
721         }
722       ],
723       "return": {
724         "type": "void",
725         "doc": "\n"
726       },
727       "private": false,
728       "static": false,
729       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js",
730       "linenr": 274,
731       "html_filename": "Surface.html",
732       "href": "Surface.html#Ext-draw-Surface-method-removeCls",
733       "shortDoc": "Removes one or more CSS classes from the element.\n\nFor example:\n\n drawComponent.surface.removeCls(sprite, 'x-visible'..."
734     },
735     {
736       "tagname": "method",
737       "name": "removeListener",
738       "member": "Ext.util.Observable",
739       "doc": "<p>Removes an event handler.</p>\n",
740       "params": [
741         {
742           "type": "String",
743           "name": "eventName",
744           "doc": "<p>The type of event the handler was associated with.</p>\n",
745           "optional": false
746         },
747         {
748           "type": "Function",
749           "name": "handler",
750           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.draw.engine.Vml-method-addListener\" rel=\"Ext.draw.engine.Vml-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
751           "optional": false
752         },
753         {
754           "type": "Object",
755           "name": "scope",
756           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
757           "optional": true
758         }
759       ],
760       "return": {
761         "type": "void",
762         "doc": "\n"
763       },
764       "private": false,
765       "static": false,
766       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
767       "linenr": 352,
768       "html_filename": "Observable.html",
769       "href": "Observable.html#Ext-util-Observable-method-removeListener",
770       "shortDoc": "<p>Removes an event handler.</p>\n"
771     },
772     {
773       "tagname": "method",
774       "name": "removeManagedListener",
775       "member": "Ext.util.Observable",
776       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.draw.engine.Vml--mon\" rel=\"Ext.draw.engine.Vml--mon\" class=\"docClass\">mon</a> method.</p>\n",
777       "params": [
778         {
779           "type": "Observable|Element",
780           "name": "item",
781           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
782           "optional": false
783         },
784         {
785           "type": "Object|String",
786           "name": "ename",
787           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
788           "optional": false
789         },
790         {
791           "type": "Function",
792           "name": "fn",
793           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
794           "optional": false
795         },
796         {
797           "type": "Object",
798           "name": "scope",
799           "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",
800           "optional": false
801         }
802       ],
803       "return": {
804         "type": "void",
805         "doc": "\n"
806       },
807       "private": false,
808       "static": false,
809       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
810       "linenr": 196,
811       "html_filename": "Observable.html",
812       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
813       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.draw.engine.Vml--mon\" rel=\"Ext.draw.engine.Vml--mon\" class=\"docClass\">mon</a> method.</p>\n"
814     },
815     {
816       "tagname": "method",
817       "name": "resumeEvents",
818       "member": "Ext.util.Observable",
819       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.draw.engine.Vml-method-suspendEvents\" rel=\"Ext.draw.engine.Vml-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",
820       "params": [
821
822       ],
823       "return": {
824         "type": "void",
825         "doc": "\n"
826       },
827       "private": false,
828       "static": false,
829       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
830       "linenr": 502,
831       "html_filename": "Observable.html",
832       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
833       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
834     },
835     {
836       "tagname": "method",
837       "name": "setSize",
838       "member": "Ext.draw.Surface",
839       "doc": "<p>Sets the size of the surface. Accomodates the background (if any) to fit the new size too.</p>\n\n<p>For example:</p>\n\n<pre><code> drawComponent.surface.setSize(500, 500);\n</code></pre>\n\n<p>This method is generally called when also setting the size of the draw Component.</p>\n",
840       "params": [
841         {
842           "type": "Number",
843           "name": "w",
844           "doc": "<p>The new width of the canvas.</p>\n",
845           "optional": false
846         },
847         {
848           "type": "Number",
849           "name": "h",
850           "doc": "<p>The new height of the canvas.</p>\n",
851           "optional": false
852         }
853       ],
854       "return": {
855         "type": "void",
856         "doc": "\n"
857       },
858       "private": false,
859       "static": false,
860       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js",
861       "linenr": 361,
862       "html_filename": "Surface.html",
863       "href": "Surface.html#Ext-draw-Surface-method-setSize",
864       "shortDoc": "Sets the size of the surface. Accomodates the background (if any) to fit the new size too.\n\nFor example:\n\n drawCompon..."
865     },
866     {
867       "tagname": "method",
868       "name": "setStyle",
869       "member": "Ext.draw.Surface",
870       "doc": "<p>Sets CSS style attributes to an element.</p>\n\n<p>For example:</p>\n\n<pre><code> drawComponent.surface.setStyle(sprite, {\n     'cursor': 'pointer'\n });\n</code></pre>\n",
871       "params": [
872         {
873           "type": "Object",
874           "name": "sprite",
875           "doc": "<p>The sprite to add, or an array of classes to</p>\n",
876           "optional": false
877         },
878         {
879           "type": "Object",
880           "name": "styles",
881           "doc": "<p>An Object with CSS styles.</p>\n",
882           "optional": false
883         }
884       ],
885       "return": {
886         "type": "void",
887         "doc": "\n"
888       },
889       "private": false,
890       "static": false,
891       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js",
892       "linenr": 287,
893       "html_filename": "Surface.html",
894       "href": "Surface.html#Ext-draw-Surface-method-setStyle",
895       "shortDoc": "Sets CSS style attributes to an element.\n\nFor example:\n\n drawComponent.surface.setStyle(sprite, {\n     'cursor': 'poi..."
896     },
897     {
898       "tagname": "method",
899       "name": "setText",
900       "member": "Ext.draw.Surface",
901       "doc": "<p>Changes the text in the sprite element. The sprite must be a <code>text</code> sprite.\nThis method can also be called from <a href=\"#/api/Ext.draw.Sprite\" rel=\"Ext.draw.Sprite\" class=\"docClass\">Ext.draw.Sprite</a>.</p>\n\n<p>For example:</p>\n\n<pre><code> var spriteGroup = drawComponent.surface.setText(sprite, 'my new text');\n</code></pre>\n",
902       "params": [
903         {
904           "type": "Object",
905           "name": "sprite",
906           "doc": "<p>The Sprite to change the text.</p>\n",
907           "optional": false
908         },
909         {
910           "type": "String",
911           "name": "text",
912           "doc": "<p>The new text to be set.</p>\n",
913           "optional": false
914         }
915       ],
916       "return": {
917         "type": "void",
918         "doc": "\n"
919       },
920       "private": false,
921       "static": false,
922       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js",
923       "linenr": 797,
924       "html_filename": "Surface.html",
925       "href": "Surface.html#Ext-draw-Surface-method-setText",
926       "shortDoc": "Changes the text in the sprite element. The sprite must be a text sprite.\nThis method can also be called from Ext.dra..."
927     },
928     {
929       "tagname": "method",
930       "name": "suspendEvents",
931       "member": "Ext.util.Observable",
932       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.draw.engine.Vml-method-resumeEvents\" rel=\"Ext.draw.engine.Vml-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
933       "params": [
934         {
935           "type": "Boolean",
936           "name": "queueSuspended",
937           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.draw.engine.Vml-method-resumeEvents\" rel=\"Ext.draw.engine.Vml-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
938           "optional": false
939         }
940       ],
941       "return": {
942         "type": "void",
943         "doc": "\n"
944       },
945       "private": false,
946       "static": false,
947       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
948       "linenr": 490,
949       "html_filename": "Observable.html",
950       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
951       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.draw.engine.Vml-method-resumeEvents\" rel=\"Ext.draw.engine.Vml-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
952     },
953     {
954       "tagname": "method",
955       "name": "un",
956       "member": "Ext.util.Observable",
957       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.draw.engine.Vml-method-removeListener\" rel=\"Ext.draw.engine.Vml-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
958       "params": [
959         {
960           "type": "String",
961           "name": "eventName",
962           "doc": "<p>The type of event the handler was associated with.</p>\n",
963           "optional": false
964         },
965         {
966           "type": "Function",
967           "name": "handler",
968           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.draw.engine.Vml-method-addListener\" rel=\"Ext.draw.engine.Vml-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
969           "optional": false
970         },
971         {
972           "type": "Object",
973           "name": "scope",
974           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
975           "optional": true
976         }
977       ],
978       "return": {
979         "type": "void",
980         "doc": "\n"
981       },
982       "private": false,
983       "static": false,
984       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
985       "linenr": 608,
986       "html_filename": "Observable.html",
987       "href": "Observable.html#Ext-util-Observable-method-un",
988       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.draw.engine.Vml-method-removeListener\" rel=\"Ext.draw.engine.Vml-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
989     }
990   ],
991   "property": [
992
993   ],
994   "event": [
995
996   ],
997   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/engine/Vml.js",
998   "linenr": 1,
999   "html_filename": "Vml.html",
1000   "href": "Vml.html#Ext-draw-engine-Vml",
1001   "cssVar": [
1002
1003   ],
1004   "cssMixin": [
1005
1006   ],
1007   "component": false,
1008   "superclasses": [
1009     "Ext.draw.Surface"
1010   ],
1011   "subclasses": [
1012
1013   ],
1014   "mixedInto": [
1015
1016   ],
1017   "allMixins": [
1018     "Ext.util.Observable"
1019   ]
1020 });