Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / output / Ext.data.Types.js
1 Ext.data.JsonP.Ext_data_Types({
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         "protected": false,
16         "tagname": "method",
17         "href": "Base3.html#Ext-Base-method-addStatics",
18         "shortDoc": "Add / override static properties of this class. ...",
19         "static": true,
20         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
21         "private": false,
22         "params": [
23           {
24             "type": "Object",
25             "optional": false,
26             "doc": "\n",
27             "name": "members"
28           }
29         ],
30         "name": "addStatics",
31         "owner": "Ext.Base",
32         "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",
33         "linenr": 388,
34         "return": {
35           "type": "Ext.Base",
36           "doc": "<p>this</p>\n"
37         },
38         "html_filename": "Base3.html"
39       },
40       {
41         "deprecated": null,
42         "alias": null,
43         "protected": false,
44         "tagname": "method",
45         "href": "Base3.html#Ext-Base-method-callOverridden",
46         "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n    constructo...",
47         "static": false,
48         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
49         "private": false,
50         "params": [
51           {
52             "type": "Array/Arguments",
53             "optional": false,
54             "doc": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
55             "name": "args"
56           }
57         ],
58         "name": "callOverridden",
59         "owner": "Ext.Base",
60         "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",
61         "linenr": 269,
62         "return": {
63           "type": "Mixed",
64           "doc": "<p>Returns the result after calling the overridden method</p>\n"
65         },
66         "html_filename": "Base3.html"
67       },
68       {
69         "deprecated": null,
70         "alias": null,
71         "protected": true,
72         "tagname": "method",
73         "href": "Base3.html#Ext-Base-method-callParent",
74         "shortDoc": "Call the parent's overridden method. ...",
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\nfrom the current method, for example: <code>this.callParent(arguments)</code></p>\n",
83             "name": "args"
84           }
85         ],
86         "name": "callParent",
87         "owner": "Ext.Base",
88         "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",
89         "linenr": 124,
90         "return": {
91           "type": "Mixed",
92           "doc": "<p>Returns the result from the superclass' method</p>\n"
93         },
94         "html_filename": "Base3.html"
95       },
96       {
97         "deprecated": null,
98         "alias": null,
99         "protected": false,
100         "tagname": "method",
101         "href": "Base3.html#Ext-Base-method-create",
102         "shortDoc": "Create a new instance of this Class. ...",
103         "static": true,
104         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
105         "private": false,
106         "params": [
107
108         ],
109         "name": "create",
110         "owner": "Ext.Base",
111         "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",
112         "linenr": 329,
113         "return": {
114           "type": "Object",
115           "doc": "<p>the created instance.</p>\n"
116         },
117         "html_filename": "Base3.html"
118       },
119       {
120         "deprecated": null,
121         "alias": null,
122         "protected": false,
123         "tagname": "method",
124         "href": "Base3.html#Ext-Base-method-createAlias",
125         "shortDoc": "Create aliases for existing prototype methods. ...",
126         "static": true,
127         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
128         "private": false,
129         "params": [
130           {
131             "type": "String/Object",
132             "optional": false,
133             "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",
134             "name": "alias"
135           },
136           {
137             "type": "String/Object",
138             "optional": false,
139             "doc": "<p>The original method name</p>\n",
140             "name": "origin"
141           }
142         ],
143         "name": "createAlias",
144         "owner": "Ext.Base",
145         "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",
146         "linenr": 648,
147         "return": {
148           "type": "void",
149           "doc": "\n"
150         },
151         "html_filename": "Base3.html"
152       },
153       {
154         "deprecated": null,
155         "alias": null,
156         "protected": false,
157         "tagname": "method",
158         "href": "Base3.html#Ext-Base-method-getName",
159         "shortDoc": "Get the current class' name in string format. ...",
160         "static": false,
161         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
162         "private": false,
163         "params": [
164
165         ],
166         "name": "getName",
167         "owner": "Ext.Base",
168         "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",
169         "linenr": 631,
170         "return": {
171           "type": "String",
172           "doc": "<p>className</p>\n"
173         },
174         "html_filename": "Base3.html"
175       },
176       {
177         "deprecated": null,
178         "alias": null,
179         "protected": false,
180         "tagname": "method",
181         "href": "Base3.html#Ext-Base-method-implement",
182         "shortDoc": "Add methods / properties to the prototype of this class. ...",
183         "static": true,
184         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
185         "private": false,
186         "params": [
187           {
188             "type": "Object",
189             "optional": false,
190             "doc": "\n",
191             "name": "members"
192           }
193         ],
194         "name": "implement",
195         "owner": "Ext.Base",
196         "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",
197         "linenr": 415,
198         "return": {
199           "type": "void",
200           "doc": "\n"
201         },
202         "html_filename": "Base3.html"
203       },
204       {
205         "deprecated": null,
206         "alias": null,
207         "protected": true,
208         "tagname": "method",
209         "href": "Base3.html#Ext-Base-method-initConfig",
210         "shortDoc": "Initialize configuration for this class. ...",
211         "static": false,
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": "config"
220           }
221         ],
222         "name": "initConfig",
223         "owner": "Ext.Base",
224         "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",
225         "linenr": 63,
226         "return": {
227           "type": "Object",
228           "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
229         },
230         "html_filename": "Base3.html"
231       },
232       {
233         "deprecated": null,
234         "alias": null,
235         "protected": false,
236         "tagname": "method",
237         "href": "Base3.html#Ext-Base-method-override",
238         "shortDoc": "Override prototype members of this class. ...",
239         "static": true,
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": "members"
248           }
249         ],
250         "name": "override",
251         "owner": "Ext.Base",
252         "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",
253         "linenr": 518,
254         "return": {
255           "type": "Ext.Base",
256           "doc": "<p>this</p>\n"
257         },
258         "html_filename": "Base3.html"
259       },
260       {
261         "deprecated": null,
262         "alias": null,
263         "protected": true,
264         "tagname": "method",
265         "href": "Base3.html#Ext-Base-method-statics",
266         "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
267         "static": false,
268         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
269         "private": false,
270         "params": [
271
272         ],
273         "name": "statics",
274         "owner": "Ext.Base",
275         "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",
276         "linenr": 199,
277         "return": {
278           "type": "Class",
279           "doc": "\n"
280         },
281         "html_filename": "Base3.html"
282       }
283     ],
284     "property": [
285       {
286         "type": "Object.",
287         "deprecated": null,
288         "alias": null,
289         "protected": false,
290         "tagname": "property",
291         "href": "Types.html#Ext-data-Types-property-AUTO",
292         "static": false,
293         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Types.js",
294         "private": false,
295         "name": "AUTO",
296         "owner": "Ext.data.Types",
297         "doc": "<p>This data type means that no conversion is applied to the raw data before it is placed into a Record.</p>\n",
298         "linenr": 66,
299         "html_filename": "Types.html"
300       },
301       {
302         "type": "Object.",
303         "deprecated": null,
304         "alias": null,
305         "protected": false,
306         "tagname": "property",
307         "href": "Types.html#Ext-data-Types-property-BOOL",
308         "shortDoc": "This data type means that the raw data is converted into a boolean before it is placed into\na Record. ...",
309         "static": false,
310         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Types.js",
311         "private": false,
312         "name": "BOOL",
313         "owner": "Ext.data.Types",
314         "doc": "<p>This data type means that the raw data is converted into a boolean before it is placed into\na Record. The string \"true\" and the number 1 are converted to boolean <code>true</code>.</p>\n\n\n<p>The synonym <code>BOOLEAN</code> is equivalent.</p>\n\n",
315         "linenr": 123,
316         "html_filename": "Types.html"
317       },
318       {
319         "type": "Object.",
320         "deprecated": null,
321         "alias": null,
322         "protected": false,
323         "tagname": "property",
324         "href": "Types.html#Ext-data-Types-property-BOOLEAN",
325         "shortDoc": "This data type means that the raw data is converted into a boolean before it is placed into\na Record. ...",
326         "static": false,
327         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Types.js",
328         "private": false,
329         "name": "BOOLEAN",
330         "owner": "Ext.data.Types",
331         "doc": "<p>This data type means that the raw data is converted into a boolean before it is placed into\na Record. The string \"true\" and the number 1 are converted to boolean <code>true</code>.</p>\n\n\n<p>The synonym <code>BOOL</code> is equivalent.</p>\n\n",
332         "linenr": 176,
333         "html_filename": "Types.html"
334       },
335       {
336         "type": "Object.",
337         "deprecated": null,
338         "alias": null,
339         "protected": false,
340         "tagname": "property",
341         "href": "Types.html#Ext-data-Types-property-DATE",
342         "shortDoc": "This data type means that the raw data is converted into a Date before it is placed into a Record. ...",
343         "static": false,
344         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Types.js",
345         "private": false,
346         "name": "DATE",
347         "owner": "Ext.data.Types",
348         "doc": "<p>This data type means that the raw data is converted into a Date before it is placed into a Record.\nThe date format is specified in the constructor of the <a href=\"#/api/Ext.data.Field\" rel=\"Ext.data.Field\" class=\"docClass\">Ext.data.Field</a> to which this type is\nbeing applied.</p>\n",
349         "linenr": 141,
350         "html_filename": "Types.html"
351       },
352       {
353         "type": "Object.",
354         "deprecated": null,
355         "alias": null,
356         "protected": false,
357         "tagname": "property",
358         "href": "Types.html#Ext-data-Types-property-FLOAT",
359         "shortDoc": "This data type means that the raw data is converted into a number before it is placed into a Record. ...",
360         "static": false,
361         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Types.js",
362         "private": false,
363         "name": "FLOAT",
364         "owner": "Ext.data.Types",
365         "doc": "<p>This data type means that the raw data is converted into a number before it is placed into a Record.</p>\n\n<p>The synonym <code>NUMBER</code> is equivalent.</p>\n\n",
366         "linenr": 108,
367         "html_filename": "Types.html"
368       },
369       {
370         "type": "Object.",
371         "deprecated": null,
372         "alias": null,
373         "protected": false,
374         "tagname": "property",
375         "href": "Types.html#Ext-data-Types-property-INT",
376         "shortDoc": "This data type means that the raw data is converted into an integer before it is placed into a Record. ...",
377         "static": false,
378         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Types.js",
379         "private": false,
380         "name": "INT",
381         "owner": "Ext.data.Types",
382         "doc": "<p>This data type means that the raw data is converted into an integer before it is placed into a Record.</p>\n\n<p>The synonym <code>INTEGER</code> is equivalent.</p>\n\n",
383         "linenr": 93,
384         "html_filename": "Types.html"
385       },
386       {
387         "type": "Object.",
388         "deprecated": null,
389         "alias": null,
390         "protected": false,
391         "tagname": "property",
392         "href": "Types.html#Ext-data-Types-property-INTEGER",
393         "shortDoc": "This data type means that the raw data is converted into an integer before it is placed into a Record. ...",
394         "static": false,
395         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Types.js",
396         "private": false,
397         "name": "INTEGER",
398         "owner": "Ext.data.Types",
399         "doc": "<p>This data type means that the raw data is converted into an integer before it is placed into a Record.</p>\n\n<p>The synonym <code>INT</code> is equivalent.</p>\n\n",
400         "linenr": 185,
401         "html_filename": "Types.html"
402       },
403       {
404         "type": "Object.",
405         "deprecated": null,
406         "alias": null,
407         "protected": false,
408         "tagname": "property",
409         "href": "Types.html#Ext-data-Types-property-NUMBER",
410         "shortDoc": "This data type means that the raw data is converted into a number before it is placed into a Record. ...",
411         "static": false,
412         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Types.js",
413         "private": false,
414         "name": "NUMBER",
415         "owner": "Ext.data.Types",
416         "doc": "<p>This data type means that the raw data is converted into a number before it is placed into a Record.</p>\n\n<p>The synonym <code>FLOAT</code> is equivalent.</p>\n\n",
417         "linenr": 193,
418         "html_filename": "Types.html"
419       },
420       {
421         "type": "Object.",
422         "deprecated": null,
423         "alias": null,
424         "protected": false,
425         "tagname": "property",
426         "href": "Types.html#Ext-data-Types-property-STRING",
427         "static": false,
428         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Types.js",
429         "private": false,
430         "name": "STRING",
431         "owner": "Ext.data.Types",
432         "doc": "<p>This data type means that the raw data is converted into a String before it is placed into a Record.</p>\n",
433         "linenr": 79,
434         "html_filename": "Types.html"
435       },
436       {
437         "type": "Class",
438         "deprecated": null,
439         "alias": null,
440         "protected": true,
441         "tagname": "property",
442         "href": "Base3.html#Ext-Base-property-self",
443         "shortDoc": "Get the reference to the current class from which this object was instantiated. ...",
444         "static": false,
445         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
446         "private": false,
447         "name": "self",
448         "owner": "Ext.Base",
449         "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",
450         "linenr": 18,
451         "html_filename": "Base3.html"
452       },
453       {
454         "type": "Regexp",
455         "deprecated": null,
456         "alias": null,
457         "protected": false,
458         "tagname": "property",
459         "href": "Types.html#Ext-data-Types-property-stripRe",
460         "shortDoc": "A regular expression for stripping non-numeric characters from a numeric value. ...",
461         "static": false,
462         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Types.js",
463         "private": false,
464         "name": "stripRe",
465         "owner": "Ext.data.Types",
466         "doc": "<p>A regular expression for stripping non-numeric characters from a numeric value. Defaults to <tt>/[\\$,%]/g</tt>.\nThis should be overridden for localization.</p>\n",
467         "linenr": 58,
468         "html_filename": "Types.html"
469       }
470     ],
471     "cssVar": [
472
473     ],
474     "cssMixin": [
475
476     ],
477     "event": [
478
479     ]
480   },
481   "singleton": true,
482   "alias": null,
483   "superclasses": [
484     "Ext.Base"
485   ],
486   "protected": false,
487   "tagname": "class",
488   "mixins": [
489
490   ],
491   "href": "Types.html#Ext-data-Types",
492   "subclasses": [
493
494   ],
495   "static": false,
496   "author": null,
497   "component": false,
498   "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Types.js",
499   "private": false,
500   "alternateClassNames": [
501
502   ],
503   "name": "Ext.data.Types",
504   "doc": "<p>This is s static class containing the system-supplied data types which may be given to a <a href=\"#/api/Ext.data.Field\" rel=\"Ext.data.Field\" class=\"docClass\">Field</a>.<p/>\n<p>The properties in this class are used as type indicators in the <a href=\"#/api/Ext.data.Field\" rel=\"Ext.data.Field\" class=\"docClass\">Field</a> class, so to\ntest whether a Field is of a certain type, compare the <a href=\"#/api/Ext.data.Field-cfg-type\" rel=\"Ext.data.Field-cfg-type\" class=\"docClass\">type</a> property against properties\nof this class.</p>\n<p>Developers may add their own application-specific data types to this class. Definition names must be UPPERCASE.\neach type definition must contain three properties:</p>\n<div class=\"mdetail-params\"><ul>\n<li><code>convert</code> : <i>Function</i><div class=\"sub-desc\">A function to convert raw data values from a data block into the data\nto be stored in the Field. The function is passed the collowing parameters:\n<div class=\"mdetail-params\"><ul>\n<li><b>v</b> : Mixed<div class=\"sub-desc\">The data value as read by the Reader, if undefined will use\nthe configured <tt><a href=\"#/api/Ext.data.Field-cfg-defaultValue\" rel=\"Ext.data.Field-cfg-defaultValue\" class=\"docClass\">defaultValue</a></tt>.</div></li>\n<li><b>rec</b> : Mixed<div class=\"sub-desc\">The data object containing the row as read by the Reader.\nDepending on the Reader type, this could be an Array (<a href=\"#/api/Ext.data.reader.Array\" rel=\"Ext.data.reader.Array\" class=\"docClass\">ArrayReader</a>), an object\n(<a href=\"#/api/Ext.data.reader.Json\" rel=\"Ext.data.reader.Json\" class=\"docClass\">JsonReader</a>), or an XML element.</div></li>\n</ul></div></div></li>\n<li><code>sortType</code> : <i>Function</i> <div class=\"sub-desc\">A function to convert the stored data into comparable form, as defined by <a href=\"#/api/Ext.data.SortTypes\" rel=\"Ext.data.SortTypes\" class=\"docClass\">Ext.data.SortTypes</a>.</div></li>\n<li><code>type</code> : <i>String</i> <div class=\"sub-desc\">A textual data type name.</div></li>\n</ul></div>\n<p>For example, to create a VELatLong field (See the Microsoft Bing Mapping API) containing the latitude/longitude value of a datapoint on a map from a JsonReader data block\nwhich contained the properties <code>lat</code> and <code>long</code>, you would define a new data type like this:</p>\n<pre><code>// Add a new Field data type which stores a VELatLong object in the Record.\nExt.data.Types.VELATLONG = {\n    convert: function(v, data) {\n        return new VELatLong(data.lat, data.long);\n    },\n    sortType: function(v) {\n        return v.Latitude;  // When sorting, order by latitude\n    },\n    type: 'VELatLong'\n};\n</code></pre>\n<p>Then, when declaring a Model, use \n<pre><code>var types = Ext.data.Types; // allow shorthand type access\nExt.define('Unit',\n    extend: 'Ext.data.Model', \n    fields: [\n        { name: 'unitName', mapping: 'UnitName' },\n        { name: 'curSpeed', mapping: 'CurSpeed', type: types.INT },\n        { name: 'latitude', mapping: 'lat', type: types.FLOAT },\n        { name: 'latitude', mapping: 'lat', type: types.FLOAT },\n        { name: 'position', type: types.VELATLONG }\n    ]\n});\n</code></pre>\n\n",
505   "mixedInto": [
506
507   ],
508   "linenr": 1,
509   "xtypes": [
510
511   ],
512   "html_filename": "Types.html",
513   "extends": "Ext.Base"
514 });