This mixin provides a common interface for the logical behavior and state of form fields, including:
\n\n*NOTE**: When implementing custom fields, it is most likely that you will want to extend the Ext.form.field.Base\ncomponent class rather than using this mixin directly, as BaseField contains additional logic for generating an\nactual DOM complete with label and error message display and a form input field,\nplus methods that bind the Field value getters and setters to the input field's value.
\n\nIf you do want to implement this mixin directly and don't want to extend Ext.form.field.Base, then\nyou will most likely want to override the following methods with custom implementations: getValue,\nsetValue, and getErrors. 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 initField\nis called during the component's initialization.
\n", + "extends": null, + "mixins": [ + + ], + "alternateClassNames": [ + + ], + "xtype": null, + "author": null, + "docauthor": "Jason JohnstonTrue to disable the field (defaults to false). Disabled Fields will not be\nsubmitted.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 43, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-cfg-disabled" + }, + { + "tagname": "cfg", + "name": "name", + "member": "Ext.form.field.Field", + "type": "String", + "doc": "The name of the field (defaults to undefined). By default this is used as the parameter\nname when including the field value in a form submit().\nTo prevent the field from being included in the form submit, set submitValue to false.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 37, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-cfg-name", + "shortDoc": "The name of the field (defaults to undefined). By default this is used as the parameter\nname when including the field..." + }, + { + "tagname": "cfg", + "name": "submitValue", + "member": "Ext.form.field.Field", + "type": "Boolean", + "doc": "Setting this to false will prevent the field from being\nsubmitted even when it is not disabled. Defaults to true.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 49, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-cfg-submitValue" + }, + { + "tagname": "cfg", + "name": "validateOnChange", + "member": "Ext.form.field.Field", + "type": "Boolean", + "doc": "Specifies whether this field should be validated immediately whenever a change in its value is detected.\nDefaults to true. If the validation results in a change in the field's validity, a\nvaliditychange event will be fired. This allows the field to show feedback about the\nvalidity of its contents immediately as the user is typing.
\n\n\nWhen set to false, feedback will not be immediate. However the form will still be validated\nbefore submitting if the clientValidation option to Ext.form.Basic.doAction is\nenabled, or if the field or form are validated manually.
\n\n\nSee also Ext.form.field.Base.checkChangeEventsfor controlling how changes to the field's value are detected.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 55, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-cfg-validateOnChange", + "shortDoc": "Specifies whether this field should be validated immediately whenever a change in its value is detected.\nDefaults to ..." + }, + { + "tagname": "cfg", + "name": "value", + "member": "Ext.form.field.Field", + "type": "Mixed", + "doc": "A value to initialize this field with (defaults to undefined).
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 33, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-cfg-value" + } + ], + "method": [ + { + "tagname": "method", + "name": "batchChanges", + "member": "Ext.form.field.Field", + "doc": "A utility for grouping a set of modifications which may trigger value changes into a single\ntransaction, to prevent excessive firing of change 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.
\n", + "params": [ + { + "type": "Object", + "name": "fn", + "doc": "A function containing the transaction code
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 348, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-batchChanges", + "shortDoc": "A utility for grouping a set of modifications which may trigger value changes into a single\ntransaction, to prevent e..." + }, + { + "tagname": "method", + "name": "checkChange", + "member": "Ext.form.field.Field", + "doc": "Checks whether the value of the field has changed since the last time it was checked. If the value\nhas changed, it:
\n\n\nChecks the isDirty state of the field and if it has changed since the last time\nit was checked, fires the dirtychange event.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 286, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-checkDirty", + "shortDoc": "Checks the isDirty state of the field and if it has changed since the last time\nit was checked, fires the dirtychange..." + }, + { + "tagname": "method", + "name": "clearInvalid", + "member": "Ext.form.field.Field", + "doc": "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.
\n\n\nNote: this method does not cause the Field's validate or isValid methods to\nreturn true if the value does not pass validation. So simply clearing a field's errors\nwill not necessarily allow submission of forms submitted with the Ext.form.action.Submit.clientValidation\noption set.
Only relevant if the instance's isFileUpload 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.
\n", + "params": [ + + ], + "return": { + "type": "HTMLInputElement", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 373, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-extractFileInput", + "shortDoc": "Only relevant if the instance's isFileUpload method returns true. Returns a reference\nto the file input DOM element h..." + }, + { + "tagname": "method", + "name": "getErrors", + "member": "Ext.form.field.Field", + "doc": "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.
\n\n\nEach subclass should override or augment the return value to provide their own errors.
\n\n", + "params": [ + { + "type": "Mixed", + "name": "value", + "doc": "The value to get errors for (defaults to the current field value)
\n", + "optional": false + } + ], + "return": { + "type": "Array", + "doc": "All error messages for this field; an empty Array if none.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 306, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-getErrors", + "shortDoc": "Runs this field's validators and returns an array of error messages for any validation failures.\nThis is called inter..." + }, + { + "tagname": "method", + "name": "getModelData", + "member": "Ext.form.field.Field", + "doc": "Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when\nExt.form.Basic.updateRecord is called. Typically this will be an object with a single name-value\npair, the name being this field's name 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.
\n\n\nNote that the values returned from this method are not guaranteed to have been successfully\nvalidated.
\n\n", + "params": [ + + ], + "return": { + "type": "Object", + "doc": "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 null if there are no\nparameters to be submitted.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 190, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-getModelData", + "shortDoc": "Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when\nExt.form.Basic.updateRe..." + }, + { + "tagname": "method", + "name": "getName", + "member": "Ext.form.field.Field", + "doc": "Returns the name attribute of the field. This is used as the parameter\nname when including the field value in a form submit().
\n", + "params": [ + + ], + "return": { + "type": "String", + "doc": "name The field name
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 128, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-getName", + "shortDoc": "Returns the name attribute of the field. This is used as the parameter\nname when including the field value in a form ..." + }, + { + "tagname": "method", + "name": "getSubmitData", + "member": "Ext.form.field.Field", + "doc": "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 name and the\nvalue being its current stringified value. More advanced field implementations may return more than one\nname-value pair.
\n\n\nNote that the values returned from this method are not guaranteed to have been successfully\nvalidated.
\n\n", + "params": [ + + ], + "return": { + "type": "Object", + "doc": "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 null if there are no\nparameters to be submitted.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 169, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-getSubmitData", + "shortDoc": "Returns the parameter(s) that would be included in a standard form submit for this field. Typically this\nwill be an o..." + }, + { + "tagname": "method", + "name": "getValue", + "member": "Ext.form.field.Field", + "doc": "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 Ext.form.field.Date).
\n", + "params": [ + + ], + "return": { + "type": "Mixed", + "doc": "value The field value
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 137, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-getValue", + "shortDoc": "Returns the current data value of the field. The type of value returned is particular to the type of the\nparticular f..." + }, + { + "tagname": "method", + "name": "initField", + "member": "Ext.form.field.Field", + "doc": "Initializes this Field mixin on the current instance. Components using this mixin should call\nthis method during their own initialization process.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 73, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-initField", + "shortDoc": "Initializes this Field mixin on the current instance. Components using this mixin should call\nthis method during thei..." + }, + { + "tagname": "method", + "name": "isDirty", + "member": "Ext.form.field.Field", + "doc": "Returns true if the value of this Field has been changed from its originalValue.\nWill always return false if the field is disabled.
\n\n\nNote that if the owning form was configured with\ntrackResetOnLoad\nthen the originalValue is updated when the values are loaded by\nExt.form.Basic.setValues.
\n\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "True if this field has been changed from its original value (and\nis not disabled), false otherwise.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 271, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-isDirty", + "shortDoc": "Returns true if the value of this Field has been changed from its originalValue.\nWill always return false if the fiel..." + }, + { + "tagname": "method", + "name": "isEqual", + "member": "Ext.form.field.Field", + "doc": "Returns whether two field values are logically equal. Field implementations may override\nthis to provide custom comparison logic appropriate for the particular field's data type.
\n", + "params": [ + { + "type": "Mixed", + "name": "value1", + "doc": "The first value to compare
\n", + "optional": false + }, + { + "type": "Mixed", + "name": "value2", + "doc": "The second value to compare
\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "True if the values are equal, false if inequal.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 158, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-isEqual", + "shortDoc": "Returns whether two field values are logically equal. Field implementations may override\nthis to provide custom compa..." + }, + { + "tagname": "method", + "name": "isFileUpload", + "member": "Ext.form.field.Field", + "doc": "Returns whether this Field is a file upload field; if it returns true, forms will use\nspecial techniques for submitting the form via AJAX. See\nExt.form.Basic.hasUpload for details. If this returns true, the extractFileInput\nmethod must also be implemented to return the corresponding file input element.
\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 362, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-isFileUpload", + "shortDoc": "Returns whether this Field is a file upload field; if it returns true, forms will use\nspecial techniques for submitti..." + }, + { + "tagname": "method", + "name": "isValid", + "member": "Ext.form.field.Field", + "doc": "Returns whether or not the field value is currently valid by validating the\nfield's current value. The validitychange event will not be fired; use validate\ninstead if you want the event to fire. Note: disabled fields are always treated as valid.
\n\n\nImplementations are encouraged to ensure that this method does not have side-effects such as\ntriggering error message display.
\n\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "True if the value is valid, else false
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 317, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-isValid", + "shortDoc": "Returns whether or not the field value is currently valid by validating the\nfield's current value. The validitychange..." + }, + { + "tagname": "method", + "name": "markInvalid", + "member": "Ext.form.field.Field", + "doc": "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.
\n\n\nNote: this method does not cause the Field's validate or isValid methods to\nreturn false if the value does pass validation. So simply marking a Field as invalid\nwill not prevent submission of forms submitted with the Ext.form.action.Submit.clientValidation\noption set.
The error message(s) for the field.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 383, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-markInvalid", + "shortDoc": "Associate one or more error messages with this field. Components using this mixin should implement\nthis method to upd..." + }, + { + "tagname": "method", + "name": "reset", + "member": "Ext.form.field.Field", + "doc": "Resets the current field value to the originally loaded value and clears any validation messages.\nSee Ext.form.Basic.trackResetOnLoad
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 212, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-reset", + "shortDoc": "Resets the current field value to the originally loaded value and clears any validation messages.\nSee Ext.form.Basic...." + }, + { + "tagname": "method", + "name": "resetOriginalValue", + "member": "Ext.form.field.Field", + "doc": "Resets the field's originalValue property so it matches the current value.\nThis is called by Ext.form.Basic.setValues if the form's\ntrackResetOnLoad property is set to true.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 225, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-resetOriginalValue", + "shortDoc": "Resets the field's originalValue property so it matches the current value.\nThis is called by Ext.form.Basic.setValues..." + }, + { + "tagname": "method", + "name": "setValue", + "member": "Ext.form.field.Field", + "doc": "Sets a data value into the field and runs the change detection and validation.
\n", + "params": [ + { + "type": "Mixed", + "name": "value", + "doc": "The value to set
\n", + "optional": false + } + ], + "return": { + "type": "Ext.form.field.Field", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 146, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-setValue", + "shortDoc": "Sets a data value into the field and runs the change detection and validation.
\n" + }, + { + "tagname": "method", + "name": "validate", + "member": "Ext.form.field.Field", + "doc": "Returns whether or not the field value is currently valid by validating the\nfield's current value, and fires the validitychange event if the field's validity has\nchanged since the last validation. Note: disabled fields are always treated as valid.
\n\n\nCustom implementations of this method are allowed to have side-effects such as triggering error\nmessage display. To validate without side-effects, use isValid.
\n\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "True if the value is valid, else false
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 330, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-validate", + "shortDoc": "Returns whether or not the field value is currently valid by validating the\nfield's current value, and fires the vali..." + } + ], + "property": [ + { + "tagname": "property", + "name": "isFormField", + "member": "Ext.form.field.Field", + "type": "Boolean", + "doc": "Flag denoting that this component is a Field. Always true.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 26, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-property-isFormField" + }, + { + "tagname": "property", + "name": "originalValue", + "member": "Ext.form.field.Field", + "type": "Mixed", + "doc": "The original value of the field as configured in the value configuration, or as loaded by\nthe last form load operation if the form's trackResetOnLoad\nsetting is true.
Fires when a user-initiated change is detected in the value of the field.
\n", + "params": [ + { + "type": "Ext.form.field.Field", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Mixed", + "name": "newValue", + "doc": "The new value
\n", + "optional": false + }, + { + "type": "Mixed", + "name": "oldValue", + "doc": "The original value
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 79, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-event-change", + "shortDoc": "Fires when a user-initiated change is detected in the value of the field.
\n" + }, + { + "tagname": "event", + "name": "dirtychange", + "member": "Ext.form.field.Field", + "doc": "Fires when a change in the field's isDirty state is detected.
\n", + "params": [ + { + "type": "Ext.form.field.Field", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Boolean", + "name": "isDirty", + "doc": "Whether or not the field is now dirty
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 94, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-event-dirtychange", + "shortDoc": "Fires when a change in the field's isDirty state is detected.
\n" + }, + { + "tagname": "event", + "name": "validitychange", + "member": "Ext.form.field.Field", + "doc": "Fires when a change in the field's validity is detected.
\n", + "params": [ + { + "type": "Ext.form.field.Field", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Boolean", + "name": "isValid", + "doc": "Whether or not the field is now valid
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 87, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-event-validitychange", + "shortDoc": "Fires when a change in the field's validity is detected.
\n" + } + ], + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 1, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + + ], + "subclasses": [ + + ], + "mixedInto": [ + "Ext.form.CheckboxGroup", + "Ext.form.field.Base", + "Ext.form.field.HtmlEditor" + ], + "allMixins": [ + + ] +}); \ No newline at end of file