docs/output/Ext.form.field.Field.js

   1 Ext.data.JsonP.Ext_form_field_Field({
   2   "tagname": "class",
   3   "name": "Ext.form.field.Field",
   4   "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",
   5   "extends": null,
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": "Jason Johnston <jason@sencha.com>",
  15   "singleton": false,
  16   "private": false,
  17   "cfg": [
  18     {
  19       "tagname": "cfg",
  20       "name": "disabled",
  21       "member": "Ext.form.field.Field",
  22       "type": "Boolean",
  23       "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",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
  26       "linenr": 43,
  27       "html_filename": "Field.html",
  28       "href": "Field.html#Ext-form-field-Field-cfg-disabled"
  29     },
  30     {
  31       "tagname": "cfg",
  32       "name": "name",
  33       "member": "Ext.form.field.Field",
  34       "type": "String",
  35       "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",
  36       "private": false,
  37       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
  38       "linenr": 37,
  39       "html_filename": "Field.html",
  40       "href": "Field.html#Ext-form-field-Field-cfg-name",
  41       "shortDoc": "The name of the field (defaults to undefined). By default this is used as the parameter\nname when including the field..."
  42     },
  43     {
  44       "tagname": "cfg",
  45       "name": "submitValue",
  46       "member": "Ext.form.field.Field",
  47       "type": "Boolean",
  48       "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",
  49       "private": false,
  50       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
  51       "linenr": 49,
  52       "html_filename": "Field.html",
  53       "href": "Field.html#Ext-form-field-Field-cfg-submitValue"
  54     },
  55     {
  56       "tagname": "cfg",
  57       "name": "validateOnChange",
  58       "member": "Ext.form.field.Field",
  59       "type": "Boolean",
  60       "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",
  61       "private": false,
  62       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
  63       "linenr": 55,
  64       "html_filename": "Field.html",
  65       "href": "Field.html#Ext-form-field-Field-cfg-validateOnChange",
  66       "shortDoc": "Specifies whether this field should be validated immediately whenever a change in its value is detected.\nDefaults to ..."
  67     },
  68     {
  69       "tagname": "cfg",
  70       "name": "value",
  71       "member": "Ext.form.field.Field",
  72       "type": "Mixed",
  73       "doc": "<p>A value to initialize this field with (defaults to undefined).</p>\n",
  74       "private": false,
  75       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
  76       "linenr": 33,
  77       "html_filename": "Field.html",
  78       "href": "Field.html#Ext-form-field-Field-cfg-value"
  79     }
  80   ],
  81   "method": [
  82     {
  83       "tagname": "method",
  84       "name": "batchChanges",
  85       "member": "Ext.form.field.Field",
  86       "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",
  87       "params": [
  88         {
  89           "type": "Object",
  90           "name": "fn",
  91           "doc": "<p>A function containing the transaction code</p>\n",
  92           "optional": false
  93         }
  94       ],
  95       "return": {
  96         "type": "void",
  97         "doc": "\n"
  98       },
  99       "private": false,
 100       "static": false,
 101       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 102       "linenr": 348,
 103       "html_filename": "Field.html",
 104       "href": "Field.html#Ext-form-field-Field-method-batchChanges",
 105       "shortDoc": "A utility for grouping a set of modifications which may trigger value changes into a single\ntransaction, to prevent e..."
 106     },
 107     {
 108       "tagname": "method",
 109       "name": "checkChange",
 110       "member": "Ext.form.field.Field",
 111       "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\n<a href=\"#/api/Ext.form.field.Field--validationchange\" rel=\"Ext.form.field.Field--validationchange\" class=\"docClass\">validationchange event</a> 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",
 112       "params": [
 113
 114       ],
 115       "return": {
 116         "type": "void",
 117         "doc": "\n"
 118       },
 119       "private": false,
 120       "static": false,
 121       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 122       "linenr": 235,
 123       "html_filename": "Field.html",
 124       "href": "Field.html#Ext-form-field-Field-method-checkChange",
 125       "shortDoc": "Checks whether the value of the field has changed since the last time it was checked. If the value\nhas changed, it:\n\n..."
 126     },
 127     {
 128       "tagname": "method",
 129       "name": "checkDirty",
 130       "member": "Ext.form.field.Field",
 131       "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",
 132       "params": [
 133
 134       ],
 135       "return": {
 136         "type": "void",
 137         "doc": "\n"
 138       },
 139       "private": false,
 140       "static": false,
 141       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 142       "linenr": 286,
 143       "html_filename": "Field.html",
 144       "href": "Field.html#Ext-form-field-Field-method-checkDirty",
 145       "shortDoc": "Checks the isDirty state of the field and if it has changed since the last time\nit was checked, fires the dirtychange..."
 146     },
 147     {
 148       "tagname": "method",
 149       "name": "clearInvalid",
 150       "member": "Ext.form.field.Field",
 151       "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",
 152       "params": [
 153
 154       ],
 155       "return": {
 156         "type": "void",
 157         "doc": "\n"
 158       },
 159       "private": false,
 160       "static": false,
 161       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 162       "linenr": 395,
 163       "html_filename": "Field.html",
 164       "href": "Field.html#Ext-form-field-Field-method-clearInvalid",
 165       "shortDoc": "Clear any invalid styles/messages for this field. Components using this mixin should implement\nthis method to update ..."
 166     },
 167     {
 168       "tagname": "method",
 169       "name": "extractFileInput",
 170       "member": "Ext.form.field.Field",
 171       "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",
 172       "params": [
 173
 174       ],
 175       "return": {
 176         "type": "HTMLInputElement",
 177         "doc": "\n"
 178       },
 179       "private": false,
 180       "static": false,
 181       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 182       "linenr": 373,
 183       "html_filename": "Field.html",
 184       "href": "Field.html#Ext-form-field-Field-method-extractFileInput",
 185       "shortDoc": "Only relevant if the instance's isFileUpload method returns true. Returns a reference\nto the file input DOM element h..."
 186     },
 187     {
 188       "tagname": "method",
 189       "name": "getErrors",
 190       "member": "Ext.form.field.Field",
 191       "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",
 192       "params": [
 193         {
 194           "type": "Mixed",
 195           "name": "value",
 196           "doc": "<p>The value to get errors for (defaults to the current field value)</p>\n",
 197           "optional": false
 198         }
 199       ],
 200       "return": {
 201         "type": "Array",
 202         "doc": "<p>All error messages for this field; an empty Array if none.</p>\n"
 203       },
 204       "private": false,
 205       "static": false,
 206       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 207       "linenr": 306,
 208       "html_filename": "Field.html",
 209       "href": "Field.html#Ext-form-field-Field-method-getErrors",
 210       "shortDoc": "Runs this field's validators and returns an array of error messages for any validation failures.\nThis is called inter..."
 211     },
 212     {
 213       "tagname": "method",
 214       "name": "getModelData",
 215       "member": "Ext.form.field.Field",
 216       "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",
 217       "params": [
 218
 219       ],
 220       "return": {
 221         "type": "Object",
 222         "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"
 223       },
 224       "private": false,
 225       "static": false,
 226       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 227       "linenr": 190,
 228       "html_filename": "Field.html",
 229       "href": "Field.html#Ext-form-field-Field-method-getModelData",
 230       "shortDoc": "Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when\nExt.form.Basic.updateRe..."
 231     },
 232     {
 233       "tagname": "method",
 234       "name": "getName",
 235       "member": "Ext.form.field.Field",
 236       "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",
 237       "params": [
 238
 239       ],
 240       "return": {
 241         "type": "String",
 242         "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"
 243       },
 244       "private": false,
 245       "static": false,
 246       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 247       "linenr": 128,
 248       "html_filename": "Field.html",
 249       "href": "Field.html#Ext-form-field-Field-method-getName",
 250       "shortDoc": "Returns the name attribute of the field. This is used as the parameter\nname when including the field value in a form ..."
 251     },
 252     {
 253       "tagname": "method",
 254       "name": "getSubmitData",
 255       "member": "Ext.form.field.Field",
 256       "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",
 257       "params": [
 258
 259       ],
 260       "return": {
 261         "type": "Object",
 262         "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"
 263       },
 264       "private": false,
 265       "static": false,
 266       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 267       "linenr": 169,
 268       "html_filename": "Field.html",
 269       "href": "Field.html#Ext-form-field-Field-method-getSubmitData",
 270       "shortDoc": "Returns the parameter(s) that would be included in a standard form submit for this field. Typically this\nwill be an o..."
 271     },
 272     {
 273       "tagname": "method",
 274       "name": "getValue",
 275       "member": "Ext.form.field.Field",
 276       "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",
 277       "params": [
 278
 279       ],
 280       "return": {
 281         "type": "Mixed",
 282         "doc": "<p>value The field value</p>\n"
 283       },
 284       "private": false,
 285       "static": false,
 286       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 287       "linenr": 137,
 288       "html_filename": "Field.html",
 289       "href": "Field.html#Ext-form-field-Field-method-getValue",
 290       "shortDoc": "Returns the current data value of the field. The type of value returned is particular to the type of the\nparticular f..."
 291     },
 292     {
 293       "tagname": "method",
 294       "name": "initField",
 295       "member": "Ext.form.field.Field",
 296       "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",
 297       "params": [
 298
 299       ],
 300       "return": {
 301         "type": "void",
 302         "doc": "\n"
 303       },
 304       "private": false,
 305       "static": false,
 306       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 307       "linenr": 73,
 308       "html_filename": "Field.html",
 309       "href": "Field.html#Ext-form-field-Field-method-initField",
 310       "shortDoc": "Initializes this Field mixin on the current instance. Components using this mixin should call\nthis method during thei..."
 311     },
 312     {
 313       "tagname": "method",
 314       "name": "isDirty",
 315       "member": "Ext.form.field.Field",
 316       "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",
 317       "params": [
 318
 319       ],
 320       "return": {
 321         "type": "Boolean",
 322         "doc": "<p>True if this field has been changed from its original value (and\nis not disabled), false otherwise.</p>\n"
 323       },
 324       "private": false,
 325       "static": false,
 326       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 327       "linenr": 271,
 328       "html_filename": "Field.html",
 329       "href": "Field.html#Ext-form-field-Field-method-isDirty",
 330       "shortDoc": "Returns true if the value of this Field has been changed from its originalValue.\nWill always return false if the fiel..."
 331     },
 332     {
 333       "tagname": "method",
 334       "name": "isEqual",
 335       "member": "Ext.form.field.Field",
 336       "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",
 337       "params": [
 338         {
 339           "type": "Mixed",
 340           "name": "value1",
 341           "doc": "<p>The first value to compare</p>\n",
 342           "optional": false
 343         },
 344         {
 345           "type": "Mixed",
 346           "name": "value2",
 347           "doc": "<p>The second value to compare</p>\n",
 348           "optional": false
 349         }
 350       ],
 351       "return": {
 352         "type": "Boolean",
 353         "doc": "<p>True if the values are equal, false if inequal.</p>\n"
 354       },
 355       "private": false,
 356       "static": false,
 357       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 358       "linenr": 158,
 359       "html_filename": "Field.html",
 360       "href": "Field.html#Ext-form-field-Field-method-isEqual",
 361       "shortDoc": "Returns whether two field values are logically equal. Field implementations may override\nthis to provide custom compa..."
 362     },
 363     {
 364       "tagname": "method",
 365       "name": "isFileUpload",
 366       "member": "Ext.form.field.Field",
 367       "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",
 368       "params": [
 369
 370       ],
 371       "return": {
 372         "type": "Boolean",
 373         "doc": "\n"
 374       },
 375       "private": false,
 376       "static": false,
 377       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 378       "linenr": 362,
 379       "html_filename": "Field.html",
 380       "href": "Field.html#Ext-form-field-Field-method-isFileUpload",
 381       "shortDoc": "Returns whether this Field is a file upload field; if it returns true, forms will use\nspecial techniques for submitti..."
 382     },
 383     {
 384       "tagname": "method",
 385       "name": "isValid",
 386       "member": "Ext.form.field.Field",
 387       "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",
 388       "params": [
 389
 390       ],
 391       "return": {
 392         "type": "Boolean",
 393         "doc": "<p>True if the value is valid, else false</p>\n"
 394       },
 395       "private": false,
 396       "static": false,
 397       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 398       "linenr": 317,
 399       "html_filename": "Field.html",
 400       "href": "Field.html#Ext-form-field-Field-method-isValid",
 401       "shortDoc": "Returns whether or not the field value is currently valid by validating the\nfield's current value. The validitychange..."
 402     },
 403     {
 404       "tagname": "method",
 405       "name": "markInvalid",
 406       "member": "Ext.form.field.Field",
 407       "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",
 408       "params": [
 409         {
 410           "type": "String/Array",
 411           "name": "errors",
 412           "doc": "<p>The error message(s) for the field.</p>\n",
 413           "optional": false
 414         }
 415       ],
 416       "return": {
 417         "type": "void",
 418         "doc": "\n"
 419       },
 420       "private": false,
 421       "static": false,
 422       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 423       "linenr": 383,
 424       "html_filename": "Field.html",
 425       "href": "Field.html#Ext-form-field-Field-method-markInvalid",
 426       "shortDoc": "Associate one or more error messages with this field. Components using this mixin should implement\nthis method to upd..."
 427     },
 428     {
 429       "tagname": "method",
 430       "name": "reset",
 431       "member": "Ext.form.field.Field",
 432       "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",
 433       "params": [
 434
 435       ],
 436       "return": {
 437         "type": "void",
 438         "doc": "\n"
 439       },
 440       "private": false,
 441       "static": false,
 442       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 443       "linenr": 212,
 444       "html_filename": "Field.html",
 445       "href": "Field.html#Ext-form-field-Field-method-reset",
 446       "shortDoc": "Resets the current field value to the originally loaded value and clears any validation messages.\nSee Ext.form.Basic...."
 447     },
 448     {
 449       "tagname": "method",
 450       "name": "resetOriginalValue",
 451       "member": "Ext.form.field.Field",
 452       "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",
 453       "params": [
 454
 455       ],
 456       "return": {
 457         "type": "void",
 458         "doc": "\n"
 459       },
 460       "private": false,
 461       "static": false,
 462       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 463       "linenr": 225,
 464       "html_filename": "Field.html",
 465       "href": "Field.html#Ext-form-field-Field-method-resetOriginalValue",
 466       "shortDoc": "Resets the field's originalValue property so it matches the current value.\nThis is called by Ext.form.Basic.setValues..."
 467     },
 468     {
 469       "tagname": "method",
 470       "name": "setValue",
 471       "member": "Ext.form.field.Field",
 472       "doc": "<p>Sets a data value into the field and runs the change detection and validation.</p>\n",
 473       "params": [
 474         {
 475           "type": "Mixed",
 476           "name": "value",
 477           "doc": "<p>The value to set</p>\n",
 478           "optional": false
 479         }
 480       ],
 481       "return": {
 482         "type": "Ext.form.field.Field",
 483         "doc": "<p>this</p>\n"
 484       },
 485       "private": false,
 486       "static": false,
 487       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 488       "linenr": 146,
 489       "html_filename": "Field.html",
 490       "href": "Field.html#Ext-form-field-Field-method-setValue",
 491       "shortDoc": "<p>Sets a data value into the field and runs the change detection and validation.</p>\n"
 492     },
 493     {
 494       "tagname": "method",
 495       "name": "validate",
 496       "member": "Ext.form.field.Field",
 497       "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",
 498       "params": [
 499
 500       ],
 501       "return": {
 502         "type": "Boolean",
 503         "doc": "<p>True if the value is valid, else false</p>\n"
 504       },
 505       "private": false,
 506       "static": false,
 507       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 508       "linenr": 330,
 509       "html_filename": "Field.html",
 510       "href": "Field.html#Ext-form-field-Field-method-validate",
 511       "shortDoc": "Returns whether or not the field value is currently valid by validating the\nfield's current value, and fires the vali..."
 512     }
 513   ],
 514   "property": [
 515     {
 516       "tagname": "property",
 517       "name": "isFormField",
 518       "member": "Ext.form.field.Field",
 519       "type": "Boolean",
 520       "doc": "<p>Flag denoting that this component is a Field. Always true.</p>\n",
 521       "private": false,
 522       "static": false,
 523       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 524       "linenr": 26,
 525       "html_filename": "Field.html",
 526       "href": "Field.html#Ext-form-field-Field-property-isFormField"
 527     },
 528     {
 529       "tagname": "property",
 530       "name": "originalValue",
 531       "member": "Ext.form.field.Field",
 532       "type": "Mixed",
 533       "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",
 534       "private": false,
 535       "static": false,
 536       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 537       "linenr": 113,
 538       "html_filename": "Field.html",
 539       "href": "Field.html#Ext-form-field-Field-property-originalValue",
 540       "shortDoc": "The original value of the field as configured in the value configuration, or as loaded by\nthe last form load operatio..."
 541     }
 542   ],
 543   "event": [
 544     {
 545       "tagname": "event",
 546       "name": "change",
 547       "member": "Ext.form.field.Field",
 548       "doc": "<p>Fires when a user-initiated change is detected in the value of the field.</p>\n",
 549       "params": [
 550         {
 551           "type": "Ext.form.field.Field",
 552           "name": "this",
 553           "doc": "\n",
 554           "optional": false
 555         },
 556         {
 557           "type": "Mixed",
 558           "name": "newValue",
 559           "doc": "<p>The new value</p>\n",
 560           "optional": false
 561         },
 562         {
 563           "type": "Mixed",
 564           "name": "oldValue",
 565           "doc": "<p>The original value</p>\n",
 566           "optional": false
 567         }
 568       ],
 569       "private": false,
 570       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 571       "linenr": 79,
 572       "html_filename": "Field.html",
 573       "href": "Field.html#Ext-form-field-Field-event-change",
 574       "shortDoc": "<p>Fires when a user-initiated change is detected in the value of the field.</p>\n"
 575     },
 576     {
 577       "tagname": "event",
 578       "name": "dirtychange",
 579       "member": "Ext.form.field.Field",
 580       "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",
 581       "params": [
 582         {
 583           "type": "Ext.form.field.Field",
 584           "name": "this",
 585           "doc": "\n",
 586           "optional": false
 587         },
 588         {
 589           "type": "Boolean",
 590           "name": "isDirty",
 591           "doc": "<p>Whether or not the field is now dirty</p>\n",
 592           "optional": false
 593         }
 594       ],
 595       "private": false,
 596       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 597       "linenr": 94,
 598       "html_filename": "Field.html",
 599       "href": "Field.html#Ext-form-field-Field-event-dirtychange",
 600       "shortDoc": "<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"
 601     },
 602     {
 603       "tagname": "event",
 604       "name": "validitychange",
 605       "member": "Ext.form.field.Field",
 606       "doc": "<p>Fires when a change in the field's validity is detected.</p>\n",
 607       "params": [
 608         {
 609           "type": "Ext.form.field.Field",
 610           "name": "this",
 611           "doc": "\n",
 612           "optional": false
 613         },
 614         {
 615           "type": "Boolean",
 616           "name": "isValid",
 617           "doc": "<p>Whether or not the field is now valid</p>\n",
 618           "optional": false
 619         }
 620       ],
 621       "private": false,
 622       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 623       "linenr": 87,
 624       "html_filename": "Field.html",
 625       "href": "Field.html#Ext-form-field-Field-event-validitychange",
 626       "shortDoc": "<p>Fires when a change in the field's validity is detected.</p>\n"
 627     }
 628   ],
 629   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js",
 630   "linenr": 1,
 631   "html_filename": "Field.html",
 632   "href": "Field.html#Ext-form-field-Field",
 633   "cssVar": [
 634
 635   ],
 636   "cssMixin": [
 637
 638   ],
 639   "component": false,
 640   "superclasses": [
 641
 642   ],
 643   "subclasses": [
 644
 645   ],
 646   "mixedInto": [
 647     "Ext.form.CheckboxGroup",
 648     "Ext.form.field.Base",
 649     "Ext.form.field.HtmlEditor"
 650   ],
 651   "allMixins": [
 652
 653   ]
 654 });