Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / output / Ext.fx.target.CompositeSprite.js
1 Ext.data.JsonP.Ext_fx_target_CompositeSprite({
2   "allMixins": [
3
4   ],
5   "deprecated": null,
6   "docauthor": null,
7   "members": {
8     "cfg": [
9
10     ],
11     "method": [
12       {
13         "deprecated": null,
14         "alias": null,
15         "href": "Target.html#Ext-fx-target-Target-method-constructor",
16         "tagname": "method",
17         "protected": false,
18         "shortDoc": "Creates new Target. ...",
19         "static": false,
20         "params": [
21           {
22             "type": "Mixed",
23             "optional": false,
24             "doc": "<p>The object to be animated</p>\n",
25             "name": "target"
26           }
27         ],
28         "private": false,
29         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/fx/target/Target.js",
30         "doc": "<p>Creates new Target.</p>\n",
31         "owner": "Ext.fx.target.Target",
32         "name": "CompositeSprite",
33         "html_filename": "Target.html",
34         "return": {
35           "type": "Object",
36           "doc": "\n"
37         },
38         "linenr": 24
39       },
40       {
41         "deprecated": null,
42         "alias": null,
43         "protected": false,
44         "tagname": "method",
45         "href": "Base3.html#Ext-Base-method-addStatics",
46         "shortDoc": "Add / override static properties of this class. ...",
47         "static": true,
48         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
49         "private": false,
50         "params": [
51           {
52             "type": "Object",
53             "optional": false,
54             "doc": "\n",
55             "name": "members"
56           }
57         ],
58         "name": "addStatics",
59         "owner": "Ext.Base",
60         "doc": "<p>Add / override static properties of this class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n</code></pre>\n",
61         "linenr": 388,
62         "return": {
63           "type": "Ext.Base",
64           "doc": "<p>this</p>\n"
65         },
66         "html_filename": "Base3.html"
67       },
68       {
69         "deprecated": null,
70         "alias": null,
71         "protected": false,
72         "tagname": "method",
73         "href": "Base3.html#Ext-Base-method-callOverridden",
74         "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n    constructo...",
75         "static": false,
76         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
77         "private": false,
78         "params": [
79           {
80             "type": "Array/Arguments",
81             "optional": false,
82             "doc": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
83             "name": "args"
84           }
85         ],
86         "name": "callOverridden",
87         "owner": "Ext.Base",
88         "doc": "<p>Call the original method that was previously overridden with <a href=\"#/api/Ext.Base-method-override\" rel=\"Ext.Base-method-override\" class=\"docClass\">Ext.Base.override</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n</code></pre>\n",
89         "linenr": 269,
90         "return": {
91           "type": "Mixed",
92           "doc": "<p>Returns the result after calling the overridden method</p>\n"
93         },
94         "html_filename": "Base3.html"
95       },
96       {
97         "deprecated": null,
98         "alias": null,
99         "protected": true,
100         "tagname": "method",
101         "href": "Base3.html#Ext-Base-method-callParent",
102         "shortDoc": "Call the parent's overridden method. ...",
103         "static": false,
104         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
105         "private": false,
106         "params": [
107           {
108             "type": "Array/Arguments",
109             "optional": false,
110             "doc": "<p>The arguments, either an array or the <code>arguments</code> object\nfrom the current method, for example: <code>this.callParent(arguments)</code></p>\n",
111             "name": "args"
112           }
113         ],
114         "name": "callParent",
115         "owner": "Ext.Base",
116         "doc": "<p>Call the parent's overridden method. For example:</p>\n\n<pre><code>Ext.define('My.own.A', {\n    constructor: function(test) {\n        alert(test);\n    }\n});\n\nExt.define('My.own.B', {\n    extend: 'My.own.A',\n\n    constructor: function(test) {\n        alert(test);\n\n        this.callParent([test + 1]);\n    }\n});\n\nExt.define('My.own.C', {\n    extend: 'My.own.B',\n\n    constructor: function() {\n        alert(\"Going to call parent's overriden constructor...\");\n\n        this.callParent(arguments);\n    }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n                         // alerts '2', then alerts '3'\n</code></pre>\n",
117         "linenr": 124,
118         "return": {
119           "type": "Mixed",
120           "doc": "<p>Returns the result from the superclass' method</p>\n"
121         },
122         "html_filename": "Base3.html"
123       },
124       {
125         "deprecated": null,
126         "alias": null,
127         "protected": false,
128         "tagname": "method",
129         "href": "Base3.html#Ext-Base-method-create",
130         "shortDoc": "Create a new instance of this Class. ...",
131         "static": true,
132         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
133         "private": false,
134         "params": [
135
136         ],
137         "name": "create",
138         "owner": "Ext.Base",
139         "doc": "<p>Create a new instance of this Class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n</code></pre>\n\n<p>All parameters are passed to the constructor of the class.</p>\n",
140         "linenr": 329,
141         "return": {
142           "type": "Object",
143           "doc": "<p>the created instance.</p>\n"
144         },
145         "html_filename": "Base3.html"
146       },
147       {
148         "deprecated": null,
149         "alias": null,
150         "protected": false,
151         "tagname": "method",
152         "href": "Base3.html#Ext-Base-method-createAlias",
153         "shortDoc": "Create aliases for existing prototype methods. ...",
154         "static": true,
155         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
156         "private": false,
157         "params": [
158           {
159             "type": "String/Object",
160             "optional": false,
161             "doc": "<p>The new method name, or an object to set multiple aliases. See\n<a href=\"#/api/Ext.Function-method-flexSetter\" rel=\"Ext.Function-method-flexSetter\" class=\"docClass\">flexSetter</a></p>\n",
162             "name": "alias"
163           },
164           {
165             "type": "String/Object",
166             "optional": false,
167             "doc": "<p>The original method name</p>\n",
168             "name": "origin"
169           }
170         ],
171         "name": "createAlias",
172         "owner": "Ext.Base",
173         "doc": "<p>Create aliases for existing prototype methods. Example:</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -&gt; test.method1()\n</code></pre>\n",
174         "linenr": 648,
175         "return": {
176           "type": "void",
177           "doc": "\n"
178         },
179         "html_filename": "Base3.html"
180       },
181       {
182         "deprecated": null,
183         "alias": null,
184         "protected": false,
185         "tagname": "method",
186         "href": "Base3.html#Ext-Base-method-getName",
187         "shortDoc": "Get the current class' name in string format. ...",
188         "static": false,
189         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
190         "private": false,
191         "params": [
192
193         ],
194         "name": "getName",
195         "owner": "Ext.Base",
196         "doc": "<p>Get the current class' name in string format.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n</code></pre>\n",
197         "linenr": 631,
198         "return": {
199           "type": "String",
200           "doc": "<p>className</p>\n"
201         },
202         "html_filename": "Base3.html"
203       },
204       {
205         "deprecated": null,
206         "alias": null,
207         "protected": false,
208         "tagname": "method",
209         "href": "Base3.html#Ext-Base-method-implement",
210         "shortDoc": "Add methods / properties to the prototype of this class. ...",
211         "static": true,
212         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
213         "private": false,
214         "params": [
215           {
216             "type": "Object",
217             "optional": false,
218             "doc": "\n",
219             "name": "members"
220           }
221         ],
222         "name": "implement",
223         "owner": "Ext.Base",
224         "doc": "<p>Add methods / properties to the prototype of this class.</p>\n\n<pre><code>Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.implement({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n</code></pre>\n",
225         "linenr": 415,
226         "return": {
227           "type": "void",
228           "doc": "\n"
229         },
230         "html_filename": "Base3.html"
231       },
232       {
233         "deprecated": null,
234         "alias": null,
235         "protected": true,
236         "tagname": "method",
237         "href": "Base3.html#Ext-Base-method-initConfig",
238         "shortDoc": "Initialize configuration for this class. ...",
239         "static": false,
240         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
241         "private": false,
242         "params": [
243           {
244             "type": "Object",
245             "optional": false,
246             "doc": "\n",
247             "name": "config"
248           }
249         ],
250         "name": "initConfig",
251         "owner": "Ext.Base",
252         "doc": "<p>Initialize configuration for this class. a typical example:</p>\n\n<pre><code>Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n\n        return this;\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n</code></pre>\n",
253         "linenr": 63,
254         "return": {
255           "type": "Object",
256           "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
257         },
258         "html_filename": "Base3.html"
259       },
260       {
261         "deprecated": null,
262         "alias": null,
263         "protected": false,
264         "tagname": "method",
265         "href": "Base3.html#Ext-Base-method-override",
266         "shortDoc": "Override prototype members of this class. ...",
267         "static": true,
268         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
269         "private": false,
270         "params": [
271           {
272             "type": "Object",
273             "optional": false,
274             "doc": "\n",
275             "name": "members"
276           }
277         ],
278         "name": "override",
279         "owner": "Ext.Base",
280         "doc": "<p>Override prototype members of this class. Overridden methods can be invoked via\n<a href=\"#/api/Ext.Base-method-callOverridden\" rel=\"Ext.Base-method-callOverridden\" class=\"docClass\">Ext.Base.callOverridden</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n</code></pre>\n",
281         "linenr": 518,
282         "return": {
283           "type": "Ext.Base",
284           "doc": "<p>this</p>\n"
285         },
286         "html_filename": "Base3.html"
287       },
288       {
289         "deprecated": null,
290         "alias": null,
291         "protected": true,
292         "tagname": "method",
293         "href": "Base3.html#Ext-Base-method-statics",
294         "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
295         "static": false,
296         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
297         "private": false,
298         "params": [
299
300         ],
301         "name": "statics",
302         "owner": "Ext.Base",
303         "doc": "<p>Get the reference to the class from which this object was instantiated. Note that unlike <a href=\"#/api/Ext.Base-property-self\" rel=\"Ext.Base-property-self\" class=\"docClass\">Ext.Base.self</a>,\n<code>this.statics()</code> is scope-independent and it always returns the class from which it was called, regardless of what\n<code>this</code> points to during run-time</p>\n\n<pre><code>Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n\n        return this;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n</code></pre>\n",
304         "linenr": 199,
305         "return": {
306           "type": "Class",
307           "doc": "\n"
308         },
309         "html_filename": "Base3.html"
310       }
311     ],
312     "property": [
313       {
314         "type": "Class",
315         "deprecated": null,
316         "alias": null,
317         "protected": true,
318         "tagname": "property",
319         "href": "Base3.html#Ext-Base-property-self",
320         "shortDoc": "Get the reference to the current class from which this object was instantiated. ...",
321         "static": false,
322         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
323         "private": false,
324         "name": "self",
325         "owner": "Ext.Base",
326         "doc": "<p>Get the reference to the current class from which this object was instantiated. Unlike <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>,\n<code>this.self</code> is scope-dependent and it's meant to be used for dynamic inheritance. See <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>\nfor a detailed comparison</p>\n\n<pre><code>Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); / dependent on 'this'\n\n        return this;\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n</code></pre>\n",
327         "linenr": 18,
328         "html_filename": "Base3.html"
329       }
330     ],
331     "cssVar": [
332
333     ],
334     "cssMixin": [
335
336     ],
337     "event": [
338
339     ]
340   },
341   "singleton": false,
342   "alias": null,
343   "superclasses": [
344     "Ext.Base",
345     "Ext.fx.target.Target",
346     "Ext.fx.target.Sprite"
347   ],
348   "protected": false,
349   "tagname": "class",
350   "mixins": [
351
352   ],
353   "href": "CompositeSprite.html#Ext-fx-target-CompositeSprite",
354   "subclasses": [
355
356   ],
357   "static": false,
358   "author": null,
359   "component": false,
360   "filename": "/mnt/ebs/nightly/git/SDK/platform/src/fx/target/CompositeSprite.js",
361   "private": false,
362   "alternateClassNames": [
363
364   ],
365   "name": "Ext.fx.target.CompositeSprite",
366   "doc": "<p>This class represents a animation target for a <a href=\"#/api/Ext.draw.CompositeSprite\" rel=\"Ext.draw.CompositeSprite\" class=\"docClass\">Ext.draw.CompositeSprite</a>. It allows\neach <a href=\"#/api/Ext.draw.Sprite\" rel=\"Ext.draw.Sprite\" class=\"docClass\">Ext.draw.Sprite</a> in the group to be animated as a whole. In general this class will not be\ncreated directly, the <a href=\"#/api/Ext.draw.CompositeSprite\" rel=\"Ext.draw.CompositeSprite\" class=\"docClass\">Ext.draw.CompositeSprite</a> will be passed to the animation and\nand the appropriate target will be created.</p>\n",
367   "mixedInto": [
368
369   ],
370   "linenr": 1,
371   "xtypes": [
372
373   ],
374   "html_filename": "CompositeSprite.html",
375   "extends": "Ext.fx.target.Sprite"
376 });