X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.form.field.Field.js diff --git a/docs/output/Ext.form.field.Field.js b/docs/output/Ext.form.field.Field.js index d7696f85..3235277c 100644 --- a/docs/output/Ext.form.field.Field.js +++ b/docs/output/Ext.form.field.Field.js @@ -1,1069 +1 @@ -Ext.data.JsonP.Ext_form_field_Field({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": "Jason Johnston ", - "members": { - "cfg": [ - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Field.html#Ext-form-field-Field-cfg-disabled", - "shortDoc": "True to disable the field (defaults to false). ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "name": "disabled", - "owner": "Ext.form.field.Field", - "doc": "

True to disable the field (defaults to false). Disabled Fields will not be\nsubmitted.

\n", - "linenr": 43, - "html_filename": "Field.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Field.html#Ext-form-field-Field-cfg-name", - "shortDoc": "The name of the field (defaults to undefined). ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "name": "name", - "owner": "Ext.form.field.Field", - "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", - "linenr": 37, - "html_filename": "Field.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Field.html#Ext-form-field-Field-cfg-submitValue", - "shortDoc": "Setting this to false will prevent the field from being\nsubmitted even when it is not disabled. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "name": "submitValue", - "owner": "Ext.form.field.Field", - "doc": "

Setting this to false will prevent the field from being\nsubmitted even when it is not disabled. Defaults to true.

\n", - "linenr": 49, - "html_filename": "Field.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "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. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "name": "validateOnChange", - "owner": "Ext.form.field.Field", - "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\n

When 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\n

See also Ext.form.field.Base.checkChangeEventsfor controlling how changes to the field's value are detected.

\n\n", - "linenr": 55, - "html_filename": "Field.html" - }, - { - "type": "Mixed", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Field.html#Ext-form-field-Field-cfg-value", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "name": "value", - "owner": "Ext.form.field.Field", - "doc": "

A value to initialize this field with (defaults to undefined).

\n", - "linenr": 33, - "html_filename": "Field.html" - } - ], - "method": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-addStatics", - "shortDoc": "Add / override static properties of this class. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "members" - } - ], - "name": "addStatics", - "owner": "Ext.Base", - "doc": "

Add / override static properties of this class.

\n\n
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
\n", - "linenr": 388, - "return": { - "type": "Ext.Base", - "doc": "

this

\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "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...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

A function containing the transaction code

\n", - "name": "fn" - } - ], - "name": "batchChanges", - "owner": "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", - "linenr": 348, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-callOverridden", - "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n constructo...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Array/Arguments", - "optional": false, - "doc": "

The arguments, either an array or the arguments object

\n", - "name": "args" - } - ], - "name": "callOverridden", - "owner": "Ext.Base", - "doc": "

Call the original method that was previously overridden with Ext.Base.override

\n\n
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
\n", - "linenr": 269, - "return": { - "type": "Mixed", - "doc": "

Returns the result after calling the overridden method

\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": true, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-callParent", - "shortDoc": "Call the parent's overridden method. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Array/Arguments", - "optional": false, - "doc": "

The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)

\n", - "name": "args" - } - ], - "name": "callParent", - "owner": "Ext.Base", - "doc": "

Call the parent's overridden method. For example:

\n\n
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
\n", - "linenr": 124, - "return": { - "type": "Mixed", - "doc": "

Returns the result from the superclass' method

\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Field.html#Ext-form-field-Field-method-checkChange", - "shortDoc": "Checks whether the value of the field has changed since the last time it was checked. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "checkChange", - "owner": "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\n
    \n
  1. Fires the change event,
  2. \n
  3. Performs validation if the validateOnChange config is enabled, firing the\nvalidationchange event if the validity has changed, and
  4. \n
  5. Checks the dirty state of the field and fires the dirtychange event\nif it has changed.
  6. \n
\n\n", - "linenr": 235, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "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...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "checkDirty", - "owner": "Ext.form.field.Field", - "doc": "

Checks the isDirty state of the field and if it has changed since the last time\nit was checked, fires the dirtychange event.

\n", - "linenr": 286, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Field.html#Ext-form-field-Field-method-clearInvalid", - "shortDoc": "Clear any invalid styles/messages for this field. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "clearInvalid", - "owner": "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\n

Note: 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.

\n\n", - "linenr": 395, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-create", - "shortDoc": "Create a new instance of this Class. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - - ], - "name": "create", - "owner": "Ext.Base", - "doc": "

Create a new instance of this Class.

\n\n
Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n
\n\n

All parameters are passed to the constructor of the class.

\n", - "linenr": 329, - "return": { - "type": "Object", - "doc": "

the created instance.

\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-createAlias", - "shortDoc": "Create aliases for existing prototype methods. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "String/Object", - "optional": false, - "doc": "

The new method name, or an object to set multiple aliases. See\nflexSetter

\n", - "name": "alias" - }, - { - "type": "String/Object", - "optional": false, - "doc": "

The original method name

\n", - "name": "origin" - } - ], - "name": "createAlias", - "owner": "Ext.Base", - "doc": "

Create aliases for existing prototype methods. Example:

\n\n
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() -> test.method1()\n
\n", - "linenr": 648, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Field.html#Ext-form-field-Field-method-extractFileInput", - "shortDoc": "Only relevant if the instance's isFileUpload method returns true. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "extractFileInput", - "owner": "Ext.form.field.Field", - "doc": "

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", - "linenr": 373, - "return": { - "type": "HTMLInputElement", - "doc": "\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "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. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - { - "type": "Mixed", - "optional": false, - "doc": "

The value to get errors for (defaults to the current field value)

\n", - "name": "value" - } - ], - "name": "getErrors", - "owner": "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\n

Each subclass should override or augment the return value to provide their own errors.

\n\n", - "linenr": 306, - "return": { - "type": "Array", - "doc": "

All error messages for this field; an empty Array if none.

\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "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...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "getModelData", - "owner": "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\n

Note that the values returned from this method are not guaranteed to have been successfully\nvalidated.

\n\n", - "linenr": 190, - "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" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Field.html#Ext-form-field-Field-method-getName", - "shortDoc": "Returns the name attribute of the field. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "getName", - "owner": "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", - "linenr": 128, - "return": { - "type": "String", - "doc": "

name The field name

\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "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. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "getSubmitData", - "owner": "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\n

Note that the values returned from this method are not guaranteed to have been successfully\nvalidated.

\n\n", - "linenr": 169, - "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" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Field.html#Ext-form-field-Field-method-getValue", - "shortDoc": "Returns the current data value of the field. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "getValue", - "owner": "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", - "linenr": 137, - "return": { - "type": "Mixed", - "doc": "

value The field value

\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-implement", - "shortDoc": "Add methods / properties to the prototype of this class. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "members" - } - ], - "name": "implement", - "owner": "Ext.Base", - "doc": "

Add methods / properties to the prototype of this class.

\n\n
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
\n", - "linenr": 415, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": true, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-initConfig", - "shortDoc": "Initialize configuration for this class. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "config" - } - ], - "name": "initConfig", - "owner": "Ext.Base", - "doc": "

Initialize configuration for this class. a typical example:

\n\n
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
\n", - "linenr": 63, - "return": { - "type": "Object", - "doc": "

mixins The mixin prototypes as key - value pairs

\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Field.html#Ext-form-field-Field-method-initField", - "shortDoc": "Initializes this Field mixin on the current instance. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "initField", - "owner": "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", - "linenr": 73, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": true, - "tagname": "method", - "href": "Field.html#Ext-form-field-Field-method-initValue", - "shortDoc": "Initializes the field's value based on the initial config. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "initValue", - "owner": "Ext.form.field.Field", - "doc": "

Initializes the field's value based on the initial config.

\n", - "linenr": 106, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Field.html#Ext-form-field-Field-method-isDirty", - "shortDoc": "Returns true if the value of this Field has been changed from its originalValue. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "isDirty", - "owner": "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\n

Note 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", - "linenr": 271, - "return": { - "type": "Boolean", - "doc": "

True if this field has been changed from its original value (and\nis not disabled), false otherwise.

\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Field.html#Ext-form-field-Field-method-isEqual", - "shortDoc": "Returns whether two field values are logically equal. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - { - "type": "Mixed", - "optional": false, - "doc": "

The first value to compare

\n", - "name": "value1" - }, - { - "type": "Mixed", - "optional": false, - "doc": "

The second value to compare

\n", - "name": "value2" - } - ], - "name": "isEqual", - "owner": "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", - "linenr": 158, - "return": { - "type": "Boolean", - "doc": "

True if the values are equal, false if inequal.

\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "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...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "isFileUpload", - "owner": "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", - "linenr": 362, - "return": { - "type": "Boolean", - "doc": "\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "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. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "isValid", - "owner": "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\n

Implementations are encouraged to ensure that this method does not have side-effects such as\ntriggering error message display.

\n\n", - "linenr": 317, - "return": { - "type": "Boolean", - "doc": "

True if the value is valid, else false

\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Field.html#Ext-form-field-Field-method-markInvalid", - "shortDoc": "Associate one or more error messages with this field. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - { - "type": "String/Array", - "optional": false, - "doc": "

The error message(s) for the field.

\n", - "name": "errors" - } - ], - "name": "markInvalid", - "owner": "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\n

Note: 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.

\n\n", - "linenr": 383, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-override", - "shortDoc": "Override prototype members of this class. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "members" - } - ], - "name": "override", - "owner": "Ext.Base", - "doc": "

Override prototype members of this class. Overridden methods can be invoked via\nExt.Base.callOverridden

\n\n
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
\n", - "linenr": 518, - "return": { - "type": "Ext.Base", - "doc": "

this

\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "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. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "reset", - "owner": "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", - "linenr": 212, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Field.html#Ext-form-field-Field-method-resetOriginalValue", - "shortDoc": "Resets the field's originalValue property so it matches the current value. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "resetOriginalValue", - "owner": "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", - "linenr": 225, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Field.html#Ext-form-field-Field-method-setValue", - "shortDoc": "Sets a data value into the field and runs the change detection and validation. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - { - "type": "Mixed", - "optional": false, - "doc": "

The value to set

\n", - "name": "value" - } - ], - "name": "setValue", - "owner": "Ext.form.field.Field", - "doc": "

Sets a data value into the field and runs the change detection and validation.

\n", - "linenr": 146, - "return": { - "type": "Ext.form.field.Field", - "doc": "

this

\n" - }, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": true, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-statics", - "shortDoc": "Get the reference to the class from which this object was instantiated. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - - ], - "name": "statics", - "owner": "Ext.Base", - "doc": "

Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base.self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n
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
\n", - "linenr": 199, - "return": { - "type": "Class", - "doc": "\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "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...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - - ], - "name": "validate", - "owner": "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\n

Custom 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", - "linenr": 330, - "return": { - "type": "Boolean", - "doc": "

True if the value is valid, else false

\n" - }, - "html_filename": "Field.html" - } - ], - "property": [ - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Field.html#Ext-form-field-Field-property-isFormField", - "shortDoc": "Flag denoting that this component is a Field. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "name": "isFormField", - "owner": "Ext.form.field.Field", - "doc": "

Flag denoting that this component is a Field. Always true.

\n", - "linenr": 26, - "html_filename": "Field.html" - }, - { - "type": "Mixed", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Field.html#Ext-form-field-Field-property-originalValue", - "shortDoc": "The original value of the field as configured in the value configuration, or as loaded by\nthe last form load operatio...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "name": "originalValue", - "owner": "Ext.form.field.Field", - "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.

\n", - "linenr": 113, - "html_filename": "Field.html" - }, - { - "type": "Class", - "deprecated": null, - "alias": null, - "protected": true, - "tagname": "property", - "href": "Base3.html#Ext-Base-property-self", - "shortDoc": "Get the reference to the current class from which this object was instantiated. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "name": "self", - "owner": "Ext.Base", - "doc": "

Get the reference to the current class from which this object was instantiated. Unlike Ext.Base.statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base.statics\nfor a detailed comparison

\n\n
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
\n", - "linenr": 18, - "html_filename": "Base3.html" - } - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "Field.html#Ext-form-field-Field-event-change", - "shortDoc": "Fires when a user-initiated change is detected in the value of the field. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - { - "type": "Ext.form.field.Field", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Mixed", - "optional": false, - "doc": "

The new value

\n", - "name": "newValue" - }, - { - "type": "Mixed", - "optional": false, - "doc": "

The original value

\n", - "name": "oldValue" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "

The options object passed to Ext.util.Observable.addListener.

\n" - } - ], - "name": "change", - "owner": "Ext.form.field.Field", - "doc": "

Fires when a user-initiated change is detected in the value of the field.

\n", - "linenr": 79, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "Field.html#Ext-form-field-Field-event-dirtychange", - "shortDoc": "Fires when a change in the field's isDirty state is detected. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - { - "type": "Ext.form.field.Field", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Boolean", - "optional": false, - "doc": "

Whether or not the field is now dirty

\n", - "name": "isDirty" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "

The options object passed to Ext.util.Observable.addListener.

\n" - } - ], - "name": "dirtychange", - "owner": "Ext.form.field.Field", - "doc": "

Fires when a change in the field's isDirty state is detected.

\n", - "linenr": 94, - "html_filename": "Field.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "Field.html#Ext-form-field-Field-event-validitychange", - "shortDoc": "Fires when a change in the field's validity is detected. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "params": [ - { - "type": "Ext.form.field.Field", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Boolean", - "optional": false, - "doc": "

Whether or not the field is now valid

\n", - "name": "isValid" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "

The options object passed to Ext.util.Observable.addListener.

\n" - } - ], - "name": "validitychange", - "owner": "Ext.form.field.Field", - "doc": "

Fires when a change in the field's validity is detected.

\n", - "linenr": 87, - "html_filename": "Field.html" - } - ] - }, - "singleton": false, - "alias": null, - "superclasses": [ - "Ext.Base" - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "Field.html#Ext-form-field-Field", - "subclasses": [ - - ], - "static": false, - "author": null, - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/Field.js", - "private": false, - "alternateClassNames": [ - - ], - "name": "Ext.form.field.Field", - "doc": "

This mixin provides a common interface for the logical behavior and state of form fields, including:

\n\n\n\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\n

If 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", - "mixedInto": [ - "Ext.form.CheckboxGroup", - "Ext.form.field.HtmlEditor", - "Ext.form.field.Base" - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "Field.html", - "extends": "Ext.Base" -}); \ No newline at end of file +Ext.data.JsonP.Ext_form_field_Field({"tagname":"class","html":"

Hierarchy

Ext.Base
Ext.form.field.Field

Files

This mixin provides a common interface for the logical behavior and state of form fields, including:

\n\n
    \n
  • Getter and setter methods for field values
  • \n
  • Events and methods for tracking value and validity changes
  • \n
  • Methods for triggering validation
  • \n
\n\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\n

If 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
Defined By

Config options

True to disable the field. ...

True to disable the field. Disabled Fields will not be submitted.

\n

Defaults to: false

The name of the field. ...

The name of the field. By default this is used as the parameter name when including the\nfield value in a form submit(). To prevent the field from\nbeing included in the form submit, set submitValue to false.

\n
Setting this to false will prevent the field from being submitted even when it is\nnot disabled. ...

Setting this to false will prevent the field from being submitted even when it is\nnot disabled.

\n

Defaults to: true

Specifies whether this field should be validated immediately whenever a change in its value is detected. ...

Specifies whether this field should be validated immediately whenever a change in its value is detected.\nIf the validation results in a change in the field's validity, a validitychange event will be\nfired. This allows the field to show feedback about the validity of its contents immediately as the user is\ntyping.

\n\n

When set to false, feedback will not be immediate. However the form will still be validated before submitting if\nthe clientValidation option to Ext.form.Basic.doAction is enabled, or if the field or form are validated\nmanually.

\n\n

See also Ext.form.field.Base.checkChangeEvents for controlling how changes to the field's value are\ndetected.

\n

Defaults to: true

 

A value to initialize this field with.

\n

A value to initialize this field with.

\n
Defined By

Properties

Flag denoting that this component is a Field. ...

Flag denoting that this component is a Field. Always true.

\n
The original value of the field as configured in the value configuration, or as loaded by the last\nform load operatio...

The original value of the field as configured in the value configuration, or as loaded by the last\nform load operation if the form's trackResetOnLoad setting is true.

\n
Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n
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
\n

Methods

Defined By

Instance Methods

A utility for grouping a set of modifications which may trigger value changes into a single transaction, to\nprevent e...

A utility for grouping a set of modifications which may trigger value changes into a single transaction, to\nprevent excessive firing of change events. This is useful for instance if the field has sub-fields which\nare being updated as a group; you don't want the container field to check its own changed state for each subfield\nchange.

\n

Parameters

  • fn : Object

    A function containing the transaction code

    \n
( Array/Arguments args ) : Objectprotected
Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n
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
\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object

    \n

Returns

  • Object

    Returns the result after calling the overridden method

    \n
( Array/Arguments args ) : Objectprotected
Call the parent's overridden method. ...

Call the parent's overridden method. For example:

\n\n
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
\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)

    \n

Returns

  • Object

    Returns the result from the superclass' method

    \n
Checks whether the value of the field has changed since the last time it was checked. ...

Checks whether the value of the field has changed since the last time it was checked.\nIf the value has changed, it:

\n\n
    \n
  1. Fires the change event,
  2. \n
  3. Performs validation if the validateOnChange config is enabled, firing the\nvaliditychange event if the validity has changed, and
  4. \n
  5. Checks the dirty state of the field and fires the dirtychange event\nif it has changed.
  6. \n
\n\n
Checks the isDirty state of the field and if it has changed since the last time it was checked,\nfires the dirtychange...

Checks the isDirty state of the field and if it has changed since the last time it was checked,\nfires the dirtychange event.

\n
Clear any invalid styles/messages for this field. ...

Clear any invalid styles/messages for this field. Components using this mixin should implement this method to\nupdate the components rendering to clear any existing messages.

\n\n

Note: this method does not cause the Field's validate or isValid methods to return true\nif the value does not pass validation. So simply clearing a field's errors will not necessarily allow\nsubmission of forms submitted with the Ext.form.action.Submit.clientValidation option set.

\n
Only relevant if the instance's isFileUpload method returns true. ...

Only relevant if the instance's isFileUpload method returns true. Returns a reference to the file input\nDOM element holding the user's selected file. The input will be appended into the submission form and will not be\nreturned, so this method should also create a replacement.

\n

Returns

  • HTMLElement
    \n
Runs this field's validators and returns an array of error messages for any validation failures. ...

Runs this field's validators and returns an array of error messages for any validation failures. This is called\ninternally during validation and would not usually need to be used manually.

\n\n

Each subclass should override or augment the return value to provide their own errors.

\n

Parameters

  • value : Object

    The value to get errors for (defaults to the current field value)

    \n

Returns

  • String[]

    All error messages for this field; an empty Array if none.

    \n
Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when Ext.form.Basic.updateRe...

Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when Ext.form.Basic.updateRecord is called. Typically this will be an object with a single name-value pair, the name\nbeing this field's name and the value being its current data value. More advanced field\nimplementations may return more than one name-value pair. The returned values will be saved to the corresponding\nfield names in the Model.

\n\n

Note that the values returned from this method are not guaranteed to have been successfully validated.

\n

Returns

  • Object

    A mapping of submit parameter names to values; each value should be a string, or an array of\nstrings if that particular name has multiple values. It can also return null if there are no parameters to be\nsubmitted.

    \n
Returns the name attribute of the field. ...

Returns the name attribute of the field. This is used as the parameter name\nwhen including the field value in a form submit().

\n

Returns

Returns the parameter(s) that would be included in a standard form submit for this field. ...

Returns the parameter(s) that would be included in a standard form submit for this field. Typically this will be\nan object with a single name-value pair, the name being this field's name and the value being\nits current stringified value. More advanced field implementations may return more than one name-value pair.

\n\n

Note that the values returned from this method are not guaranteed to have been successfully validated.

\n

Returns

  • Object

    A mapping of submit parameter names to values; each value should be a string, or an array of\nstrings if that particular name has multiple values. It can also return null if there are no parameters to be\nsubmitted.

    \n
Returns the current data value of the field. ...

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

Returns

Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n
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
\n

Parameters

Returns

  • Object

    mixins The mixin prototypes as key - value pairs

    \n
Initializes this Field mixin on the current instance. ...

Initializes this Field mixin on the current instance. Components using this mixin should call this method during\ntheir own initialization process.

\n
Initializes the field's value based on the initial config. ...

Initializes the field's value based on the initial config.

\n
Returns true if the value of this Field has been changed from its originalValue. ...

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

Note that if the owning form was configured with\ntrackResetOnLoad then the originalValue is updated when\nthe values are loaded by Ext.form.Basic.setValues.

\n

Returns

  • Boolean

    True if this field has been changed from its original value (and is not disabled),\nfalse otherwise.

    \n
Returns whether two field values are logically equal. ...

Returns whether two field values are logically equal. Field implementations may override this\nto provide custom comparison logic appropriate for the particular field's data type.

\n

Parameters

  • value1 : Object

    The first value to compare

    \n
  • value2 : Object

    The second value to compare

    \n

Returns

  • Boolean

    True if the values are equal, false if inequal.

    \n
Returns whether this Field is a file upload field; if it returns true, forms will use special techniques for\nsubmitti...

Returns whether this Field is a file upload field; if it returns true, forms will use special techniques for\nsubmitting the form via AJAX. See Ext.form.Basic.hasUpload for details. If\nthis returns true, the extractFileInput method must also be implemented to return the corresponding file\ninput element.

\n

Returns

Returns whether or not the field value is currently valid by validating the field's current\nvalue. ...

Returns whether or not the field value is currently valid by validating the field's current\nvalue. The validitychange event will not be fired; use validate instead if you want the event\nto fire. Note: disabled fields are always treated as valid.

\n\n

Implementations are encouraged to ensure that this method does not have side-effects such as triggering error\nmessage display.

\n

Returns

  • Boolean

    True if the value is valid, else false

    \n
Associate one or more error messages with this field. ...

Associate one or more error messages with this field. Components using this mixin should implement this method to\nupdate the component's rendering to display the messages.

\n\n

Note: this method does not cause the Field's validate or isValid methods to return false\nif the value does pass validation. So simply marking a Field as invalid will not prevent submission of forms\nsubmitted with the Ext.form.action.Submit.clientValidation option set.

\n

Parameters

  • errors : String/String[]

    The error message(s) for the field.

    \n
Resets the current field value to the originally loaded value and clears any validation messages. ...

Resets the current field value to the originally loaded value and clears any validation messages. See Ext.form.Basic.trackResetOnLoad

\n
Resets the field's originalValue property so it matches the current value. ...

Resets the field's originalValue property so it matches the current value. This is\ncalled by Ext.form.Basic.setValues if the form's\ntrackResetOnLoad property is set to true.

\n
Sets a data value into the field and runs the change detection and validation. ...

Sets a data value into the field and runs the change detection and validation.

\n

Parameters

  • value : Object

    The value to set

    \n

Returns

Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n
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
\n

Returns

Returns whether or not the field value is currently valid by validating the field's current\nvalue, and fires the vali...

Returns whether or not the field value is currently valid by validating the field's current\nvalue, and fires the validitychange event if the field's validity has changed since the last validation.\nNote: disabled fields are always treated as valid.

\n\n

Custom implementations of this method are allowed to have side-effects such as triggering error message display.\nTo validate without side-effects, use isValid.

\n

Returns

  • Boolean

    True if the value is valid, else false

    \n
Defined By

Static Methods

Add / override static properties of this class. ...

Add / override static properties of this class.

\n\n
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
\n

Parameters

Returns

( Ext.Base fromClass, String/String[] members ) : Ext.Basestatic
Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

\n\n
Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\n

Parameters

  • fromClass : Ext.Base

    The class to borrow members from

    \n
  • members : String/String[]

    The names of the members to borrow

    \n

Returns

Create a new instance of this Class. ...

Create a new instance of this Class.

\n\n
Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n
\n\n

All parameters are passed to the constructor of the class.

\n

Returns

Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

\n\n
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() -> test.method1()\n
\n

Parameters

Get the current class' name in string format. ...

Get the current class' name in string format.

\n\n
Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\n

Returns

Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

\n\n
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
\n

Parameters

Override prototype members of this class. ...

Override prototype members of this class. Overridden methods can be invoked via\ncallOverridden

\n\n
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
\n

Parameters

Returns

Defined By

Events

Fires when a user-initiated change is detected in the value of the field. ...

Fires when a user-initiated change is detected in the value of the field.

\n

Parameters

Fires when a change in the field's isDirty state is detected. ...

Fires when a change in the field's isDirty state is detected.

\n

Parameters

Fires when a change in the field's validity is detected. ...

Fires when a change in the field's validity is detected.

\n

Parameters

","allMixins":[],"meta":{"docauthor":["Jason Johnston "]},"requires":[],"deprecated":null,"extends":"Ext.Base","inheritable":false,"static":false,"superclasses":["Ext.Base","Ext.form.field.Field"],"singleton":false,"code_type":"ext_define","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"addStatics","id":"static-method-addStatics"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"borrow","id":"static-method-borrow"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"create","id":"static-method-create"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"createAlias","id":"static-method-createAlias"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"getName","id":"static-method-getName"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"implement","id":"static-method-implement"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"override","id":"static-method-override"}],"event":[]},"subclasses":[],"uses":[],"protected":false,"mixins":[],"members":{"property":[{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":null,"required":null,"protected":false,"name":"isFormField","id":"property-isFormField"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":null,"required":null,"protected":false,"name":"originalValue","id":"property-originalValue"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.Base","template":null,"required":null,"protected":true,"name":"self","id":"property-self"}],"css_var":[],"css_mixin":[],"cfg":[{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":null,"required":false,"protected":false,"name":"disabled","id":"cfg-disabled"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":null,"required":false,"protected":false,"name":"name","id":"cfg-name"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":null,"required":false,"protected":false,"name":"submitValue","id":"cfg-submitValue"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":null,"required":false,"protected":false,"name":"validateOnChange","id":"cfg-validateOnChange"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":null,"required":false,"protected":false,"name":"value","id":"cfg-value"}],"method":[{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"batchChanges","id":"method-batchChanges"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callOverridden","id":"method-callOverridden"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callParent","id":"method-callParent"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"checkChange","id":"method-checkChange"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"checkDirty","id":"method-checkDirty"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"clearInvalid","id":"method-clearInvalid"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"extractFileInput","id":"method-extractFileInput"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"getErrors","id":"method-getErrors"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"getModelData","id":"method-getModelData"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"getName","id":"method-getName"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"getSubmitData","id":"method-getSubmitData"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"getValue","id":"method-getValue"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"initConfig","id":"method-initConfig"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"initField","id":"method-initField"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"initValue","id":"method-initValue"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"isDirty","id":"method-isDirty"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"isEqual","id":"method-isEqual"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"isFileUpload","id":"method-isFileUpload"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"isValid","id":"method-isValid"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"markInvalid","id":"method-markInvalid"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"reset","id":"method-reset"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"resetOriginalValue","id":"method-resetOriginalValue"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"setValue","id":"method-setValue"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"statics","id":"method-statics"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":false,"required":null,"protected":false,"name":"validate","id":"method-validate"}],"event":[{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":null,"required":null,"protected":false,"name":"change","id":"event-change"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":null,"required":null,"protected":false,"name":"dirtychange","id":"event-dirtychange"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.form.field.Field","template":null,"required":null,"protected":false,"name":"validitychange","id":"event-validitychange"}]},"private":false,"component":false,"name":"Ext.form.field.Field","alternateClassNames":[],"id":"class-Ext.form.field.Field","mixedInto":["Ext.form.CheckboxGroup","Ext.form.field.Base","Ext.form.field.HtmlEditor"],"xtypes":{},"files":[{"href":"Field.html#Ext-form-field-Field","filename":"Field.js"}]}); \ No newline at end of file