Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / output / Ext.form.field.Field.js
1 Ext.data.JsonP.Ext_form_field_Field({
2   "allMixins": [
3
4   ],
5   "deprecated": null,
6   "docauthor": "Jason Johnston <jason@sencha.com>",
7   "members": {
8     "cfg": [
9       {
10         "type": "Boolean",
11         "deprecated": null,
12         "alias": null,
13         "protected": false,
14         "tagname": "cfg",
15         "href": "Field.html#Ext-form-field-Field-cfg-disabled",
16         "shortDoc": "True to disable the field (defaults to false). ...",
17         "static": false,
18         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
19         "private": false,
20         "name": "disabled",
21         "owner": "Ext.form.field.Field",
22         "doc": "<p>True to disable the field (defaults to false). Disabled Fields will not be\n<a href=\"#/api/Ext.form.Basic-method-submit\" rel=\"Ext.form.Basic-method-submit\" class=\"docClass\">submitted</a>.</p></p>\n",
23         "linenr": 43,
24         "html_filename": "Field.html"
25       },
26       {
27         "type": "String",
28         "deprecated": null,
29         "alias": null,
30         "protected": false,
31         "tagname": "cfg",
32         "href": "Field.html#Ext-form-field-Field-cfg-name",
33         "shortDoc": "The name of the field (defaults to undefined). ...",
34         "static": false,
35         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
36         "private": false,
37         "name": "name",
38         "owner": "Ext.form.field.Field",
39         "doc": "<p>The name of the field (defaults to undefined). By default this is used as the parameter\nname when including the <a href=\"#/api/Ext.form.field.Field-method-getSubmitData\" rel=\"Ext.form.field.Field-method-getSubmitData\" class=\"docClass\">field value</a> in a <a href=\"#/api/Ext.form.Basic-method-submit\" rel=\"Ext.form.Basic-method-submit\" class=\"docClass\">form submit()</a>.\nTo prevent the field from being included in the form submit, set <a href=\"#/api/Ext.form.field.Field-cfg-submitValue\" rel=\"Ext.form.field.Field-cfg-submitValue\" class=\"docClass\">submitValue</a> to <tt>false</tt>.</p>\n",
40         "linenr": 37,
41         "html_filename": "Field.html"
42       },
43       {
44         "type": "Boolean",
45         "deprecated": null,
46         "alias": null,
47         "protected": false,
48         "tagname": "cfg",
49         "href": "Field.html#Ext-form-field-Field-cfg-submitValue",
50         "shortDoc": "Setting this to false will prevent the field from being\nsubmitted even when it is not disabled. ...",
51         "static": false,
52         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
53         "private": false,
54         "name": "submitValue",
55         "owner": "Ext.form.field.Field",
56         "doc": "<p>Setting this to <tt>false</tt> will prevent the field from being\n<a href=\"#/api/Ext.form.Basic-method-submit\" rel=\"Ext.form.Basic-method-submit\" class=\"docClass\">submitted</a> even when it is not disabled. Defaults to <tt>true</tt>.</p>\n",
57         "linenr": 49,
58         "html_filename": "Field.html"
59       },
60       {
61         "type": "Boolean",
62         "deprecated": null,
63         "alias": null,
64         "protected": false,
65         "tagname": "cfg",
66         "href": "Field.html#Ext-form-field-Field-cfg-validateOnChange",
67         "shortDoc": "Specifies whether this field should be validated immediately whenever a change in its value is detected. ...",
68         "static": false,
69         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
70         "private": false,
71         "name": "validateOnChange",
72         "owner": "Ext.form.field.Field",
73         "doc": "<p>Specifies whether this field should be validated immediately whenever a change in its value is detected.\nDefaults to <tt>true</tt>. If the validation results in a change in the field's validity, a\n<a href=\"#/api/Ext.form.field.Field-event-validitychange\" rel=\"Ext.form.field.Field-event-validitychange\" class=\"docClass\">validitychange</a> event will be fired. This allows the field to show feedback about the\nvalidity of its contents immediately as the user is typing.</p>\n\n\n<p>When set to <tt>false</tt>, feedback will not be immediate. However the form will still be validated\nbefore submitting if the <tt>clientValidation</tt> option to <a href=\"#/api/Ext.form.Basic-method-doAction\" rel=\"Ext.form.Basic-method-doAction\" class=\"docClass\">Ext.form.Basic.doAction</a> is\nenabled, or if the field or form are validated manually.</p>\n\n\n<p>See also <a href=\"#/api/Ext.form.field.Base-cfg-checkChangeEvents\" rel=\"Ext.form.field.Base-cfg-checkChangeEvents\" class=\"docClass\">Ext.form.field.Base.checkChangeEvents</a>for controlling how changes to the field's value are detected.</p>\n\n",
74         "linenr": 55,
75         "html_filename": "Field.html"
76       },
77       {
78         "type": "Mixed",
79         "deprecated": null,
80         "alias": null,
81         "protected": false,
82         "tagname": "cfg",
83         "href": "Field.html#Ext-form-field-Field-cfg-value",
84         "static": false,
85         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
86         "private": false,
87         "name": "value",
88         "owner": "Ext.form.field.Field",
89         "doc": "<p>A value to initialize this field with (defaults to undefined).</p>\n",
90         "linenr": 33,
91         "html_filename": "Field.html"
92       }
93     ],
94     "method": [
95       {
96         "deprecated": null,
97         "alias": null,
98         "protected": false,
99         "tagname": "method",
100         "href": "Base3.html#Ext-Base-method-addStatics",
101         "shortDoc": "Add / override static properties of this class. ...",
102         "static": true,
103         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
104         "private": false,
105         "params": [
106           {
107             "type": "Object",
108             "optional": false,
109             "doc": "\n",
110             "name": "members"
111           }
112         ],
113         "name": "addStatics",
114         "owner": "Ext.Base",
115         "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",
116         "linenr": 388,
117         "return": {
118           "type": "Ext.Base",
119           "doc": "<p>this</p>\n"
120         },
121         "html_filename": "Base3.html"
122       },
123       {
124         "deprecated": null,
125         "alias": null,
126         "protected": false,
127         "tagname": "method",
128         "href": "Field.html#Ext-form-field-Field-method-batchChanges",
129         "shortDoc": "A utility for grouping a set of modifications which may trigger value changes into a single\ntransaction, to prevent e...",
130         "static": false,
131         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
132         "private": false,
133         "params": [
134           {
135             "type": "Object",
136             "optional": false,
137             "doc": "<p>A function containing the transaction code</p>\n",
138             "name": "fn"
139           }
140         ],
141         "name": "batchChanges",
142         "owner": "Ext.form.field.Field",
143         "doc": "<p>A utility for grouping a set of modifications which may trigger value changes into a single\ntransaction, to prevent excessive firing of <a href=\"#/api/Ext.form.field.Field-event-change\" rel=\"Ext.form.field.Field-event-change\" class=\"docClass\">change</a> events. This is useful for instance\nif the field has sub-fields which are being updated as a group; you don't want the container\nfield to check its own changed state for each subfield change.</p>\n",
144         "linenr": 348,
145         "return": {
146           "type": "void",
147           "doc": "\n"
148         },
149         "html_filename": "Field.html"
150       },
151       {
152         "deprecated": null,
153         "alias": null,
154         "protected": false,
155         "tagname": "method",
156         "href": "Base3.html#Ext-Base-method-callOverridden",
157         "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n    constructo...",
158         "static": false,
159         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
160         "private": false,
161         "params": [
162           {
163             "type": "Array/Arguments",
164             "optional": false,
165             "doc": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
166             "name": "args"
167           }
168         ],
169         "name": "callOverridden",
170         "owner": "Ext.Base",
171         "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",
172         "linenr": 269,
173         "return": {
174           "type": "Mixed",
175           "doc": "<p>Returns the result after calling the overridden method</p>\n"
176         },
177         "html_filename": "Base3.html"
178       },
179       {
180         "deprecated": null,
181         "alias": null,
182         "protected": true,
183         "tagname": "method",
184         "href": "Base3.html#Ext-Base-method-callParent",
185         "shortDoc": "Call the parent's overridden method. ...",
186         "static": false,
187         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
188         "private": false,
189         "params": [
190           {
191             "type": "Array/Arguments",
192             "optional": false,
193             "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",
194             "name": "args"
195           }
196         ],
197         "name": "callParent",
198         "owner": "Ext.Base",
199         "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",
200         "linenr": 124,
201         "return": {
202           "type": "Mixed",
203           "doc": "<p>Returns the result from the superclass' method</p>\n"
204         },
205         "html_filename": "Base3.html"
206       },
207       {
208         "deprecated": null,
209         "alias": null,
210         "protected": false,
211         "tagname": "method",
212         "href": "Field.html#Ext-form-field-Field-method-checkChange",
213         "shortDoc": "Checks whether the value of the field has changed since the last time it was checked. ...",
214         "static": false,
215         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
216         "private": false,
217         "params": [
218
219         ],
220         "name": "checkChange",
221         "owner": "Ext.form.field.Field",
222         "doc": "<p>Checks whether the value of the field has changed since the last time it was checked. If the value\nhas changed, it:</p>\n\n\n<ol>\n<li>Fires the <a href=\"#/api/Ext.form.field.Field-event-change\" rel=\"Ext.form.field.Field-event-change\" class=\"docClass\">change event</a>,</li>\n<li>Performs validation if the <a href=\"#/api/Ext.form.field.Field-cfg-validateOnChange\" rel=\"Ext.form.field.Field-cfg-validateOnChange\" class=\"docClass\">validateOnChange</a> config is enabled, firing the\nvalidationchange event if the validity has changed, and</li>\n<li>Checks the <a href=\"#/api/Ext.form.field.Field-method-isDirty\" rel=\"Ext.form.field.Field-method-isDirty\" class=\"docClass\">dirty state</a> of the field and fires the <a href=\"#/api/Ext.form.field.Field-event-dirtychange\" rel=\"Ext.form.field.Field-event-dirtychange\" class=\"docClass\">dirtychange event</a>\nif it has changed.</li>\n</ol>\n\n",
223         "linenr": 235,
224         "return": {
225           "type": "void",
226           "doc": "\n"
227         },
228         "html_filename": "Field.html"
229       },
230       {
231         "deprecated": null,
232         "alias": null,
233         "protected": false,
234         "tagname": "method",
235         "href": "Field.html#Ext-form-field-Field-method-checkDirty",
236         "shortDoc": "Checks the isDirty state of the field and if it has changed since the last time\nit was checked, fires the dirtychange...",
237         "static": false,
238         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
239         "private": false,
240         "params": [
241
242         ],
243         "name": "checkDirty",
244         "owner": "Ext.form.field.Field",
245         "doc": "<p>Checks the <a href=\"#/api/Ext.form.field.Field-method-isDirty\" rel=\"Ext.form.field.Field-method-isDirty\" class=\"docClass\">isDirty</a> state of the field and if it has changed since the last time\nit was checked, fires the <a href=\"#/api/Ext.form.field.Field-event-dirtychange\" rel=\"Ext.form.field.Field-event-dirtychange\" class=\"docClass\">dirtychange</a> event.</p>\n",
246         "linenr": 286,
247         "return": {
248           "type": "void",
249           "doc": "\n"
250         },
251         "html_filename": "Field.html"
252       },
253       {
254         "deprecated": null,
255         "alias": null,
256         "protected": false,
257         "tagname": "method",
258         "href": "Field.html#Ext-form-field-Field-method-clearInvalid",
259         "shortDoc": "Clear any invalid styles/messages for this field. ...",
260         "static": false,
261         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
262         "private": false,
263         "params": [
264
265         ],
266         "name": "clearInvalid",
267         "owner": "Ext.form.field.Field",
268         "doc": "<p>Clear any invalid styles/messages for this field. Components using this mixin should implement\nthis method to update the components rendering to clear any existing messages.</p>\n\n\n<p><b>Note</b>: this method does not cause the Field's <a href=\"#/api/Ext.form.field.Field-method-validate\" rel=\"Ext.form.field.Field-method-validate\" class=\"docClass\">validate</a> or <a href=\"#/api/Ext.form.field.Field-method-isValid\" rel=\"Ext.form.field.Field-method-isValid\" class=\"docClass\">isValid</a> methods to\nreturn <code>true</code> if the value does not <i>pass</i> validation. So simply clearing a field's errors\nwill not necessarily allow submission of forms submitted with the <a href=\"#/api/Ext.form.action.Submit-cfg-clientValidation\" rel=\"Ext.form.action.Submit-cfg-clientValidation\" class=\"docClass\">Ext.form.action.Submit.clientValidation</a>\noption set.</p>\n\n",
269         "linenr": 395,
270         "return": {
271           "type": "void",
272           "doc": "\n"
273         },
274         "html_filename": "Field.html"
275       },
276       {
277         "deprecated": null,
278         "alias": null,
279         "protected": false,
280         "tagname": "method",
281         "href": "Base3.html#Ext-Base-method-create",
282         "shortDoc": "Create a new instance of this Class. ...",
283         "static": true,
284         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
285         "private": false,
286         "params": [
287
288         ],
289         "name": "create",
290         "owner": "Ext.Base",
291         "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",
292         "linenr": 329,
293         "return": {
294           "type": "Object",
295           "doc": "<p>the created instance.</p>\n"
296         },
297         "html_filename": "Base3.html"
298       },
299       {
300         "deprecated": null,
301         "alias": null,
302         "protected": false,
303         "tagname": "method",
304         "href": "Base3.html#Ext-Base-method-createAlias",
305         "shortDoc": "Create aliases for existing prototype methods. ...",
306         "static": true,
307         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
308         "private": false,
309         "params": [
310           {
311             "type": "String/Object",
312             "optional": false,
313             "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",
314             "name": "alias"
315           },
316           {
317             "type": "String/Object",
318             "optional": false,
319             "doc": "<p>The original method name</p>\n",
320             "name": "origin"
321           }
322         ],
323         "name": "createAlias",
324         "owner": "Ext.Base",
325         "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",
326         "linenr": 648,
327         "return": {
328           "type": "void",
329           "doc": "\n"
330         },
331         "html_filename": "Base3.html"
332       },
333       {
334         "deprecated": null,
335         "alias": null,
336         "protected": false,
337         "tagname": "method",
338         "href": "Field.html#Ext-form-field-Field-method-extractFileInput",
339         "shortDoc": "Only relevant if the instance's isFileUpload method returns true. ...",
340         "static": false,
341         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
342         "private": false,
343         "params": [
344
345         ],
346         "name": "extractFileInput",
347         "owner": "Ext.form.field.Field",
348         "doc": "<p>Only relevant if the instance's <a href=\"#/api/Ext.form.field.Field-method-isFileUpload\" rel=\"Ext.form.field.Field-method-isFileUpload\" class=\"docClass\">isFileUpload</a> method returns true. Returns a reference\nto the file input DOM element holding the user's selected file. The input will be appended into\nthe submission form and will not be returned, so this method should also create a replacement.</p>\n",
349         "linenr": 373,
350         "return": {
351           "type": "HTMLInputElement",
352           "doc": "\n"
353         },
354         "html_filename": "Field.html"
355       },
356       {
357         "deprecated": null,
358         "alias": null,
359         "protected": false,
360         "tagname": "method",
361         "href": "Field.html#Ext-form-field-Field-method-getErrors",
362         "shortDoc": "Runs this field's validators and returns an array of error messages for any validation failures. ...",
363         "static": false,
364         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
365         "private": false,
366         "params": [
367           {
368             "type": "Mixed",
369             "optional": false,
370             "doc": "<p>The value to get errors for (defaults to the current field value)</p>\n",
371             "name": "value"
372           }
373         ],
374         "name": "getErrors",
375         "owner": "Ext.form.field.Field",
376         "doc": "<p>Runs this field's validators and returns an array of error messages for any validation failures.\nThis is called internally during validation and would not usually need to be used manually.</p>\n\n\n<p>Each subclass should override or augment the return value to provide their own errors.</p>\n\n",
377         "linenr": 306,
378         "return": {
379           "type": "Array",
380           "doc": "<p>All error messages for this field; an empty Array if none.</p>\n"
381         },
382         "html_filename": "Field.html"
383       },
384       {
385         "deprecated": null,
386         "alias": null,
387         "protected": false,
388         "tagname": "method",
389         "href": "Field.html#Ext-form-field-Field-method-getModelData",
390         "shortDoc": "Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when\nExt.form.Basic.updateRe...",
391         "static": false,
392         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
393         "private": false,
394         "params": [
395
396         ],
397         "name": "getModelData",
398         "owner": "Ext.form.field.Field",
399         "doc": "<p>Returns the value(s) that should be saved to the <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> instance for this field, when\n<a href=\"#/api/Ext.form.Basic-method-updateRecord\" rel=\"Ext.form.Basic-method-updateRecord\" class=\"docClass\">Ext.form.Basic.updateRecord</a> is called. Typically this will be an object with a single name-value\npair, the name being this field's <a href=\"#/api/Ext.form.field.Field-method-getName\" rel=\"Ext.form.field.Field-method-getName\" class=\"docClass\">name</a> and the value being its current data value. More\nadvanced field implementations may return more than one name-value pair. The returned values will be\nsaved to the corresponding field names in the Model.</p>\n\n\n<p>Note that the values returned from this method are not guaranteed to have been successfully\n<a href=\"#/api/Ext.form.field.Field-method-validate\" rel=\"Ext.form.field.Field-method-validate\" class=\"docClass\">validated</a>.</p>\n\n",
400         "linenr": 190,
401         "return": {
402           "type": "Object",
403           "doc": "<p>A mapping of submit parameter names to values; each value should be a string, or an array\nof strings if that particular name has multiple values. It can also return <tt>null</tt> if there are no\nparameters to be submitted.</p>\n"
404         },
405         "html_filename": "Field.html"
406       },
407       {
408         "deprecated": null,
409         "alias": null,
410         "protected": false,
411         "tagname": "method",
412         "href": "Field.html#Ext-form-field-Field-method-getName",
413         "shortDoc": "Returns the name attribute of the field. ...",
414         "static": false,
415         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
416         "private": false,
417         "params": [
418
419         ],
420         "name": "getName",
421         "owner": "Ext.form.field.Field",
422         "doc": "<p>Returns the <a href=\"#/api/Ext.form.field.Field-cfg-name\" rel=\"Ext.form.field.Field-cfg-name\" class=\"docClass\">name</a> attribute of the field. This is used as the parameter\nname when including the field value in a <a href=\"#/api/Ext.form.Basic-method-submit\" rel=\"Ext.form.Basic-method-submit\" class=\"docClass\">form submit()</a>.</p>\n",
423         "linenr": 128,
424         "return": {
425           "type": "String",
426           "doc": "<p>name The field <a href=\"#/api/Ext.form.field.Field-cfg-name\" rel=\"Ext.form.field.Field-cfg-name\" class=\"docClass\">name</a></p>\n"
427         },
428         "html_filename": "Field.html"
429       },
430       {
431         "deprecated": null,
432         "alias": null,
433         "protected": false,
434         "tagname": "method",
435         "href": "Field.html#Ext-form-field-Field-method-getSubmitData",
436         "shortDoc": "Returns the parameter(s) that would be included in a standard form submit for this field. ...",
437         "static": false,
438         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
439         "private": false,
440         "params": [
441
442         ],
443         "name": "getSubmitData",
444         "owner": "Ext.form.field.Field",
445         "doc": "<p>Returns the parameter(s) that would be included in a standard form submit for this field. Typically this\nwill be an object with a single name-value pair, the name being this field's <a href=\"#/api/Ext.form.field.Field-method-getName\" rel=\"Ext.form.field.Field-method-getName\" class=\"docClass\">name</a> and the\nvalue being its current stringified value. More advanced field implementations may return more than one\nname-value pair.</p>\n\n\n<p>Note that the values returned from this method are not guaranteed to have been successfully\n<a href=\"#/api/Ext.form.field.Field-method-validate\" rel=\"Ext.form.field.Field-method-validate\" class=\"docClass\">validated</a>.</p>\n\n",
446         "linenr": 169,
447         "return": {
448           "type": "Object",
449           "doc": "<p>A mapping of submit parameter names to values; each value should be a string, or an array\nof strings if that particular name has multiple values. It can also return <tt>null</tt> if there are no\nparameters to be submitted.</p>\n"
450         },
451         "html_filename": "Field.html"
452       },
453       {
454         "deprecated": null,
455         "alias": null,
456         "protected": false,
457         "tagname": "method",
458         "href": "Field.html#Ext-form-field-Field-method-getValue",
459         "shortDoc": "Returns the current data value of the field. ...",
460         "static": false,
461         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
462         "private": false,
463         "params": [
464
465         ],
466         "name": "getValue",
467         "owner": "Ext.form.field.Field",
468         "doc": "<p>Returns the current data value of the field. The type of value returned is particular to the type of the\nparticular field (e.g. a Date object for <a href=\"#/api/Ext.form.field.Date\" rel=\"Ext.form.field.Date\" class=\"docClass\">Ext.form.field.Date</a>).</p>\n",
469         "linenr": 137,
470         "return": {
471           "type": "Mixed",
472           "doc": "<p>value The field value</p>\n"
473         },
474         "html_filename": "Field.html"
475       },
476       {
477         "deprecated": null,
478         "alias": null,
479         "protected": false,
480         "tagname": "method",
481         "href": "Base3.html#Ext-Base-method-implement",
482         "shortDoc": "Add methods / properties to the prototype of this class. ...",
483         "static": true,
484         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
485         "private": false,
486         "params": [
487           {
488             "type": "Object",
489             "optional": false,
490             "doc": "\n",
491             "name": "members"
492           }
493         ],
494         "name": "implement",
495         "owner": "Ext.Base",
496         "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",
497         "linenr": 415,
498         "return": {
499           "type": "void",
500           "doc": "\n"
501         },
502         "html_filename": "Base3.html"
503       },
504       {
505         "deprecated": null,
506         "alias": null,
507         "protected": true,
508         "tagname": "method",
509         "href": "Base3.html#Ext-Base-method-initConfig",
510         "shortDoc": "Initialize configuration for this class. ...",
511         "static": false,
512         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
513         "private": false,
514         "params": [
515           {
516             "type": "Object",
517             "optional": false,
518             "doc": "\n",
519             "name": "config"
520           }
521         ],
522         "name": "initConfig",
523         "owner": "Ext.Base",
524         "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",
525         "linenr": 63,
526         "return": {
527           "type": "Object",
528           "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
529         },
530         "html_filename": "Base3.html"
531       },
532       {
533         "deprecated": null,
534         "alias": null,
535         "protected": false,
536         "tagname": "method",
537         "href": "Field.html#Ext-form-field-Field-method-initField",
538         "shortDoc": "Initializes this Field mixin on the current instance. ...",
539         "static": false,
540         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
541         "private": false,
542         "params": [
543
544         ],
545         "name": "initField",
546         "owner": "Ext.form.field.Field",
547         "doc": "<p>Initializes this Field mixin on the current instance. Components using this mixin should call\nthis method during their own initialization process.</p>\n",
548         "linenr": 73,
549         "return": {
550           "type": "void",
551           "doc": "\n"
552         },
553         "html_filename": "Field.html"
554       },
555       {
556         "deprecated": null,
557         "alias": null,
558         "protected": true,
559         "tagname": "method",
560         "href": "Field.html#Ext-form-field-Field-method-initValue",
561         "shortDoc": "Initializes the field's value based on the initial config. ...",
562         "static": false,
563         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
564         "private": false,
565         "params": [
566
567         ],
568         "name": "initValue",
569         "owner": "Ext.form.field.Field",
570         "doc": "<p>Initializes the field's value based on the initial config.</p>\n",
571         "linenr": 106,
572         "return": {
573           "type": "void",
574           "doc": "\n"
575         },
576         "html_filename": "Field.html"
577       },
578       {
579         "deprecated": null,
580         "alias": null,
581         "protected": false,
582         "tagname": "method",
583         "href": "Field.html#Ext-form-field-Field-method-isDirty",
584         "shortDoc": "Returns true if the value of this Field has been changed from its originalValue. ...",
585         "static": false,
586         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
587         "private": false,
588         "params": [
589
590         ],
591         "name": "isDirty",
592         "owner": "Ext.form.field.Field",
593         "doc": "<p>Returns true if the value of this Field has been changed from its <a href=\"#/api/Ext.form.field.Field-property-originalValue\" rel=\"Ext.form.field.Field-property-originalValue\" class=\"docClass\">originalValue</a>.\nWill always return false if the field is disabled.</p>\n\n\n<p>Note that if the owning <a href=\"#/api/Ext.form.Basic\" rel=\"Ext.form.Basic\" class=\"docClass\">form</a> was configured with\n<a href=\"#/api/Ext.form.Basic-cfg-trackResetOnLoad\" rel=\"Ext.form.Basic-cfg-trackResetOnLoad\" class=\"docClass\">trackResetOnLoad</a>\nthen the <a href=\"#/api/Ext.form.field.Field-property-originalValue\" rel=\"Ext.form.field.Field-property-originalValue\" class=\"docClass\">originalValue</a> is updated when the values are loaded by\n<a href=\"#/api/Ext.form.Basic\" rel=\"Ext.form.Basic\" class=\"docClass\">Ext.form.Basic</a>.<a href=\"#/api/Ext.form.Basic-method-setValues\" rel=\"Ext.form.Basic-method-setValues\" class=\"docClass\">setValues</a>.</p>\n\n",
594         "linenr": 271,
595         "return": {
596           "type": "Boolean",
597           "doc": "<p>True if this field has been changed from its original value (and\nis not disabled), false otherwise.</p>\n"
598         },
599         "html_filename": "Field.html"
600       },
601       {
602         "deprecated": null,
603         "alias": null,
604         "protected": false,
605         "tagname": "method",
606         "href": "Field.html#Ext-form-field-Field-method-isEqual",
607         "shortDoc": "Returns whether two field values are logically equal. ...",
608         "static": false,
609         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
610         "private": false,
611         "params": [
612           {
613             "type": "Mixed",
614             "optional": false,
615             "doc": "<p>The first value to compare</p>\n",
616             "name": "value1"
617           },
618           {
619             "type": "Mixed",
620             "optional": false,
621             "doc": "<p>The second value to compare</p>\n",
622             "name": "value2"
623           }
624         ],
625         "name": "isEqual",
626         "owner": "Ext.form.field.Field",
627         "doc": "<p>Returns whether two field <a href=\"#/api/Ext.form.field.Field-method-getValue\" rel=\"Ext.form.field.Field-method-getValue\" class=\"docClass\">values</a> are logically equal. Field implementations may override\nthis to provide custom comparison logic appropriate for the particular field's data type.</p>\n",
628         "linenr": 158,
629         "return": {
630           "type": "Boolean",
631           "doc": "<p>True if the values are equal, false if inequal.</p>\n"
632         },
633         "html_filename": "Field.html"
634       },
635       {
636         "deprecated": null,
637         "alias": null,
638         "protected": false,
639         "tagname": "method",
640         "href": "Field.html#Ext-form-field-Field-method-isFileUpload",
641         "shortDoc": "Returns whether this Field is a file upload field; if it returns true, forms will use\nspecial techniques for submitti...",
642         "static": false,
643         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
644         "private": false,
645         "params": [
646
647         ],
648         "name": "isFileUpload",
649         "owner": "Ext.form.field.Field",
650         "doc": "<p>Returns whether this Field is a file upload field; if it returns true, forms will use\nspecial techniques for <a href=\"#/api/Ext.form.Basic-method-submit\" rel=\"Ext.form.Basic-method-submit\" class=\"docClass\">submitting the form</a> via AJAX. See\n<a href=\"#/api/Ext.form.Basic-method-hasUpload\" rel=\"Ext.form.Basic-method-hasUpload\" class=\"docClass\">Ext.form.Basic.hasUpload</a> for details. If this returns true, the <a href=\"#/api/Ext.form.field.Field-method-extractFileInput\" rel=\"Ext.form.field.Field-method-extractFileInput\" class=\"docClass\">extractFileInput</a>\nmethod must also be implemented to return the corresponding file input element.</p>\n",
651         "linenr": 362,
652         "return": {
653           "type": "Boolean",
654           "doc": "\n"
655         },
656         "html_filename": "Field.html"
657       },
658       {
659         "deprecated": null,
660         "alias": null,
661         "protected": false,
662         "tagname": "method",
663         "href": "Field.html#Ext-form-field-Field-method-isValid",
664         "shortDoc": "Returns whether or not the field value is currently valid by validating the\nfield's current value. ...",
665         "static": false,
666         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
667         "private": false,
668         "params": [
669
670         ],
671         "name": "isValid",
672         "owner": "Ext.form.field.Field",
673         "doc": "<p>Returns whether or not the field value is currently valid by <a href=\"#/api/Ext.form.field.Field-method-getErrors\" rel=\"Ext.form.field.Field-method-getErrors\" class=\"docClass\">validating</a> the\nfield's current value. The <a href=\"#/api/Ext.form.field.Field-event-validitychange\" rel=\"Ext.form.field.Field-event-validitychange\" class=\"docClass\">validitychange</a> event will not be fired; use <a href=\"#/api/Ext.form.field.Field-method-validate\" rel=\"Ext.form.field.Field-method-validate\" class=\"docClass\">validate</a>\ninstead if you want the event to fire. <b>Note</b>: <a href=\"#/api/Ext.form.field.Field-cfg-disabled\" rel=\"Ext.form.field.Field-cfg-disabled\" class=\"docClass\">disabled</a> fields are always treated as valid.</p>\n\n\n<p>Implementations are encouraged to ensure that this method does not have side-effects such as\ntriggering error message display.</p>\n\n",
674         "linenr": 317,
675         "return": {
676           "type": "Boolean",
677           "doc": "<p>True if the value is valid, else false</p>\n"
678         },
679         "html_filename": "Field.html"
680       },
681       {
682         "deprecated": null,
683         "alias": null,
684         "protected": false,
685         "tagname": "method",
686         "href": "Field.html#Ext-form-field-Field-method-markInvalid",
687         "shortDoc": "Associate one or more error messages with this field. ...",
688         "static": false,
689         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
690         "private": false,
691         "params": [
692           {
693             "type": "String/Array",
694             "optional": false,
695             "doc": "<p>The error message(s) for the field.</p>\n",
696             "name": "errors"
697           }
698         ],
699         "name": "markInvalid",
700         "owner": "Ext.form.field.Field",
701         "doc": "<p>Associate one or more error messages with this field. Components using this mixin should implement\nthis method to update the component's rendering to display the messages.</p>\n\n\n<p><b>Note</b>: this method does not cause the Field's <a href=\"#/api/Ext.form.field.Field-method-validate\" rel=\"Ext.form.field.Field-method-validate\" class=\"docClass\">validate</a> or <a href=\"#/api/Ext.form.field.Field-method-isValid\" rel=\"Ext.form.field.Field-method-isValid\" class=\"docClass\">isValid</a> methods to\nreturn <code>false</code> if the value does <i>pass</i> validation. So simply marking a Field as invalid\nwill not prevent submission of forms submitted with the <a href=\"#/api/Ext.form.action.Submit-cfg-clientValidation\" rel=\"Ext.form.action.Submit-cfg-clientValidation\" class=\"docClass\">Ext.form.action.Submit.clientValidation</a>\noption set.</p>\n\n",
702         "linenr": 383,
703         "return": {
704           "type": "void",
705           "doc": "\n"
706         },
707         "html_filename": "Field.html"
708       },
709       {
710         "deprecated": null,
711         "alias": null,
712         "protected": false,
713         "tagname": "method",
714         "href": "Base3.html#Ext-Base-method-override",
715         "shortDoc": "Override prototype members of this class. ...",
716         "static": true,
717         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
718         "private": false,
719         "params": [
720           {
721             "type": "Object",
722             "optional": false,
723             "doc": "\n",
724             "name": "members"
725           }
726         ],
727         "name": "override",
728         "owner": "Ext.Base",
729         "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",
730         "linenr": 518,
731         "return": {
732           "type": "Ext.Base",
733           "doc": "<p>this</p>\n"
734         },
735         "html_filename": "Base3.html"
736       },
737       {
738         "deprecated": null,
739         "alias": null,
740         "protected": false,
741         "tagname": "method",
742         "href": "Field.html#Ext-form-field-Field-method-reset",
743         "shortDoc": "Resets the current field value to the originally loaded value and clears any validation messages. ...",
744         "static": false,
745         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
746         "private": false,
747         "params": [
748
749         ],
750         "name": "reset",
751         "owner": "Ext.form.field.Field",
752         "doc": "<p>Resets the current field value to the originally loaded value and clears any validation messages.\nSee <a href=\"#/api/Ext.form.Basic\" rel=\"Ext.form.Basic\" class=\"docClass\">Ext.form.Basic</a>.<a href=\"#/api/Ext.form.Basic-cfg-trackResetOnLoad\" rel=\"Ext.form.Basic-cfg-trackResetOnLoad\" class=\"docClass\">trackResetOnLoad</a></p>\n",
753         "linenr": 212,
754         "return": {
755           "type": "void",
756           "doc": "\n"
757         },
758         "html_filename": "Field.html"
759       },
760       {
761         "deprecated": null,
762         "alias": null,
763         "protected": false,
764         "tagname": "method",
765         "href": "Field.html#Ext-form-field-Field-method-resetOriginalValue",
766         "shortDoc": "Resets the field's originalValue property so it matches the current value. ...",
767         "static": false,
768         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
769         "private": false,
770         "params": [
771
772         ],
773         "name": "resetOriginalValue",
774         "owner": "Ext.form.field.Field",
775         "doc": "<p>Resets the field's <a href=\"#/api/Ext.form.field.Field-property-originalValue\" rel=\"Ext.form.field.Field-property-originalValue\" class=\"docClass\">originalValue</a> property so it matches the current <a href=\"#/api/Ext.form.field.Field-method-getValue\" rel=\"Ext.form.field.Field-method-getValue\" class=\"docClass\">value</a>.\nThis is called by <a href=\"#/api/Ext.form.Basic\" rel=\"Ext.form.Basic\" class=\"docClass\">Ext.form.Basic</a>.<a href=\"#/api/Ext.form.Basic-method-setValues\" rel=\"Ext.form.Basic-method-setValues\" class=\"docClass\">setValues</a> if the form's\n<a href=\"#/api/Ext.form.Basic-cfg-trackResetOnLoad\" rel=\"Ext.form.Basic-cfg-trackResetOnLoad\" class=\"docClass\">trackResetOnLoad</a> property is set to true.</p>\n",
776         "linenr": 225,
777         "return": {
778           "type": "void",
779           "doc": "\n"
780         },
781         "html_filename": "Field.html"
782       },
783       {
784         "deprecated": null,
785         "alias": null,
786         "protected": false,
787         "tagname": "method",
788         "href": "Field.html#Ext-form-field-Field-method-setValue",
789         "shortDoc": "Sets a data value into the field and runs the change detection and validation. ...",
790         "static": false,
791         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
792         "private": false,
793         "params": [
794           {
795             "type": "Mixed",
796             "optional": false,
797             "doc": "<p>The value to set</p>\n",
798             "name": "value"
799           }
800         ],
801         "name": "setValue",
802         "owner": "Ext.form.field.Field",
803         "doc": "<p>Sets a data value into the field and runs the change detection and validation.</p>\n",
804         "linenr": 146,
805         "return": {
806           "type": "Ext.form.field.Field",
807           "doc": "<p>this</p>\n"
808         },
809         "html_filename": "Field.html"
810       },
811       {
812         "deprecated": null,
813         "alias": null,
814         "protected": true,
815         "tagname": "method",
816         "href": "Base3.html#Ext-Base-method-statics",
817         "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
818         "static": false,
819         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
820         "private": false,
821         "params": [
822
823         ],
824         "name": "statics",
825         "owner": "Ext.Base",
826         "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",
827         "linenr": 199,
828         "return": {
829           "type": "Class",
830           "doc": "\n"
831         },
832         "html_filename": "Base3.html"
833       },
834       {
835         "deprecated": null,
836         "alias": null,
837         "protected": false,
838         "tagname": "method",
839         "href": "Field.html#Ext-form-field-Field-method-validate",
840         "shortDoc": "Returns whether or not the field value is currently valid by validating the\nfield's current value, and fires the vali...",
841         "static": false,
842         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
843         "private": false,
844         "params": [
845
846         ],
847         "name": "validate",
848         "owner": "Ext.form.field.Field",
849         "doc": "<p>Returns whether or not the field value is currently valid by <a href=\"#/api/Ext.form.field.Field-method-getErrors\" rel=\"Ext.form.field.Field-method-getErrors\" class=\"docClass\">validating</a> the\nfield's current value, and fires the <a href=\"#/api/Ext.form.field.Field-event-validitychange\" rel=\"Ext.form.field.Field-event-validitychange\" class=\"docClass\">validitychange</a> event if the field's validity has\nchanged since the last validation. <b>Note</b>: <a href=\"#/api/Ext.form.field.Field-cfg-disabled\" rel=\"Ext.form.field.Field-cfg-disabled\" class=\"docClass\">disabled</a> fields are always treated as valid.</p>\n\n\n<p>Custom implementations of this method are allowed to have side-effects such as triggering error\nmessage display. To validate without side-effects, use <a href=\"#/api/Ext.form.field.Field-method-isValid\" rel=\"Ext.form.field.Field-method-isValid\" class=\"docClass\">isValid</a>.</p>\n\n",
850         "linenr": 330,
851         "return": {
852           "type": "Boolean",
853           "doc": "<p>True if the value is valid, else false</p>\n"
854         },
855         "html_filename": "Field.html"
856       }
857     ],
858     "property": [
859       {
860         "type": "Boolean",
861         "deprecated": null,
862         "alias": null,
863         "protected": false,
864         "tagname": "property",
865         "href": "Field.html#Ext-form-field-Field-property-isFormField",
866         "shortDoc": "Flag denoting that this component is a Field. ...",
867         "static": false,
868         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
869         "private": false,
870         "name": "isFormField",
871         "owner": "Ext.form.field.Field",
872         "doc": "<p>Flag denoting that this component is a Field. Always true.</p>\n",
873         "linenr": 26,
874         "html_filename": "Field.html"
875       },
876       {
877         "type": "Mixed",
878         "deprecated": null,
879         "alias": null,
880         "protected": false,
881         "tagname": "property",
882         "href": "Field.html#Ext-form-field-Field-property-originalValue",
883         "shortDoc": "The original value of the field as configured in the value configuration, or as loaded by\nthe last form load operatio...",
884         "static": false,
885         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
886         "private": false,
887         "name": "originalValue",
888         "owner": "Ext.form.field.Field",
889         "doc": "<p>The original value of the field as configured in the <a href=\"#/api/Ext.form.field.Field-cfg-value\" rel=\"Ext.form.field.Field-cfg-value\" class=\"docClass\">value</a> configuration, or as loaded by\nthe last form load operation if the form's <a href=\"#/api/Ext.form.Basic-cfg-trackResetOnLoad\" rel=\"Ext.form.Basic-cfg-trackResetOnLoad\" class=\"docClass\">trackResetOnLoad</a>\nsetting is <code>true</code>.</p>\n",
890         "linenr": 113,
891         "html_filename": "Field.html"
892       },
893       {
894         "type": "Class",
895         "deprecated": null,
896         "alias": null,
897         "protected": true,
898         "tagname": "property",
899         "href": "Base3.html#Ext-Base-property-self",
900         "shortDoc": "Get the reference to the current class from which this object was instantiated. ...",
901         "static": false,
902         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
903         "private": false,
904         "name": "self",
905         "owner": "Ext.Base",
906         "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",
907         "linenr": 18,
908         "html_filename": "Base3.html"
909       }
910     ],
911     "cssVar": [
912
913     ],
914     "cssMixin": [
915
916     ],
917     "event": [
918       {
919         "deprecated": null,
920         "alias": null,
921         "protected": false,
922         "tagname": "event",
923         "href": "Field.html#Ext-form-field-Field-event-change",
924         "shortDoc": "Fires when a user-initiated change is detected in the value of the field. ...",
925         "static": false,
926         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
927         "private": false,
928         "params": [
929           {
930             "type": "Ext.form.field.Field",
931             "optional": false,
932             "doc": "\n",
933             "name": "this"
934           },
935           {
936             "type": "Mixed",
937             "optional": false,
938             "doc": "<p>The new value</p>\n",
939             "name": "newValue"
940           },
941           {
942             "type": "Mixed",
943             "optional": false,
944             "doc": "<p>The original value</p>\n",
945             "name": "oldValue"
946           },
947           {
948             "type": "Object",
949             "tagname": "param",
950             "name": "options",
951             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
952           }
953         ],
954         "name": "change",
955         "owner": "Ext.form.field.Field",
956         "doc": "<p>Fires when a user-initiated change is detected in the value of the field.</p>\n",
957         "linenr": 79,
958         "html_filename": "Field.html"
959       },
960       {
961         "deprecated": null,
962         "alias": null,
963         "protected": false,
964         "tagname": "event",
965         "href": "Field.html#Ext-form-field-Field-event-dirtychange",
966         "shortDoc": "Fires when a change in the field's isDirty state is detected. ...",
967         "static": false,
968         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
969         "private": false,
970         "params": [
971           {
972             "type": "Ext.form.field.Field",
973             "optional": false,
974             "doc": "\n",
975             "name": "this"
976           },
977           {
978             "type": "Boolean",
979             "optional": false,
980             "doc": "<p>Whether or not the field is now dirty</p>\n",
981             "name": "isDirty"
982           },
983           {
984             "type": "Object",
985             "tagname": "param",
986             "name": "options",
987             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
988           }
989         ],
990         "name": "dirtychange",
991         "owner": "Ext.form.field.Field",
992         "doc": "<p>Fires when a change in the field's <a href=\"#/api/Ext.form.field.Field-method-isDirty\" rel=\"Ext.form.field.Field-method-isDirty\" class=\"docClass\">isDirty</a> state is detected.</p>\n",
993         "linenr": 94,
994         "html_filename": "Field.html"
995       },
996       {
997         "deprecated": null,
998         "alias": null,
999         "protected": false,
1000         "tagname": "event",
1001         "href": "Field.html#Ext-form-field-Field-event-validitychange",
1002         "shortDoc": "Fires when a change in the field's validity is detected. ...",
1003         "static": false,
1004         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
1005         "private": false,
1006         "params": [
1007           {
1008             "type": "Ext.form.field.Field",
1009             "optional": false,
1010             "doc": "\n",
1011             "name": "this"
1012           },
1013           {
1014             "type": "Boolean",
1015             "optional": false,
1016             "doc": "<p>Whether or not the field is now valid</p>\n",
1017             "name": "isValid"
1018           },
1019           {
1020             "type": "Object",
1021             "tagname": "param",
1022             "name": "options",
1023             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
1024           }
1025         ],
1026         "name": "validitychange",
1027         "owner": "Ext.form.field.Field",
1028         "doc": "<p>Fires when a change in the field's validity is detected.</p>\n",
1029         "linenr": 87,
1030         "html_filename": "Field.html"
1031       }
1032     ]
1033   },
1034   "singleton": false,
1035   "alias": null,
1036   "superclasses": [
1037     "Ext.Base"
1038   ],
1039   "protected": false,
1040   "tagname": "class",
1041   "mixins": [
1042
1043   ],
1044   "href": "Field.html#Ext-form-field-Field",
1045   "subclasses": [
1046
1047   ],
1048   "static": false,
1049   "author": null,
1050   "component": false,
1051   "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js",
1052   "private": false,
1053   "alternateClassNames": [
1054
1055   ],
1056   "name": "Ext.form.field.Field",
1057   "doc": "<p>This mixin provides a common interface for the logical behavior and state of form fields, including:</p>\n\n<ul>\n<li>Getter and setter methods for field values</li>\n<li>Events and methods for tracking value and validity changes</li>\n<li>Methods for triggering validation</li>\n</ul>\n\n\n<p>*NOTE**: When implementing custom fields, it is most likely that you will want to extend the <a href=\"#/api/Ext.form.field.Base\" rel=\"Ext.form.field.Base\" class=\"docClass\">Ext.form.field.Base</a>\ncomponent class rather than using this mixin directly, as BaseField contains additional logic for generating an\nactual DOM complete with <a href=\"#/api/Ext.form.Labelable\" rel=\"Ext.form.Labelable\" class=\"docClass\">label and error message</a> display and a form input field,\nplus methods that bind the Field value getters and setters to the input field's value.</p>\n\n<p>If you do want to implement this mixin directly and don't want to extend <a href=\"#/api/Ext.form.field.Base\" rel=\"Ext.form.field.Base\" class=\"docClass\">Ext.form.field.Base</a>, then\nyou will most likely want to override the following methods with custom implementations: <a href=\"#/api/Ext.form.field.Field-method-getValue\" rel=\"Ext.form.field.Field-method-getValue\" class=\"docClass\">getValue</a>,\n<a href=\"#/api/Ext.form.field.Field-method-setValue\" rel=\"Ext.form.field.Field-method-setValue\" class=\"docClass\">setValue</a>, and <a href=\"#/api/Ext.form.field.Field-method-getErrors\" rel=\"Ext.form.field.Field-method-getErrors\" class=\"docClass\">getErrors</a>. Other methods may be overridden as needed but their base\nimplementations should be sufficient for common cases. You will also need to make sure that <a href=\"#/api/Ext.form.field.Field-method-initField\" rel=\"Ext.form.field.Field-method-initField\" class=\"docClass\">initField</a>\nis called during the component's initialization.</p>\n",
1058   "mixedInto": [
1059     "Ext.form.CheckboxGroup",
1060     "Ext.form.field.HtmlEditor",
1061     "Ext.form.field.Base"
1062   ],
1063   "linenr": 1,
1064   "xtypes": [
1065
1066   ],
1067   "html_filename": "Field.html",
1068   "extends": "Ext.Base"
1069 });