X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/docs/output/Ext.form.field.VTypes.js diff --git a/docs/output/Ext.form.field.VTypes.js b/docs/output/Ext.form.field.VTypes.js index 2a46b793..7c437a9d 100644 --- a/docs/output/Ext.form.field.VTypes.js +++ b/docs/output/Ext.form.field.VTypes.js @@ -1,577 +1 @@ -Ext.data.JsonP.Ext_form_field_VTypes({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": null, - "members": { - "cfg": [ - - ], - "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": "VTypes.html#Ext-form-field-VTypes-method-alpha", - "shortDoc": "The function used to validate alpha values ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/VTypes.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The value

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

The function used to validate alpha values

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

true if the RegExp test passed, and false if not.

\n" - }, - "html_filename": "VTypes.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "VTypes.html#Ext-form-field-VTypes-method-alphanum", - "shortDoc": "The function used to validate alphanumeric values ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/VTypes.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The value

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

The function used to validate alphanumeric values

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

true if the RegExp test passed, and false if not.

\n" - }, - "html_filename": "VTypes.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": "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": "VTypes.html#Ext-form-field-VTypes-method-email", - "shortDoc": "The function used to validate email addresses. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/VTypes.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The email address

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

The function used to validate email addresses. Note that this is a very basic validation -- complete\nvalidation per the email RFC specifications is very complex and beyond the scope of this class, although\nthis function can be overridden if a more comprehensive validation scheme is desired. See the validation\nsection of the Wikipedia article on email addresses\nfor additional information. This implementation is intended to validate the following emails:\n'barney@example.de', 'barney.rubble@example.com', 'barney-rubble@example.coop', 'barney+rubble@example.com'\n.

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

true if the RegExp test passed, and false if not.

\n" - }, - "html_filename": "VTypes.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-getName", - "shortDoc": "Get the current class' name in string format. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - - ], - "name": "getName", - "owner": "Ext.Base", - "doc": "

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", - "linenr": 631, - "return": { - "type": "String", - "doc": "

className

\n" - }, - "html_filename": "Base3.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": "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": 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": "VTypes.html#Ext-form-field-VTypes-method-url", - "shortDoc": "The function used to validate URLs ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/VTypes.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The URL

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

The function used to validate URLs

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

true if the RegExp test passed, and false if not.

\n" - }, - "html_filename": "VTypes.html" - } - ], - "property": [ - { - "type": "RegExp", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "VTypes.html#Ext-form-field-VTypes-property-alphaMask", - "shortDoc": "The keystroke filter mask to be applied on alpha input. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/VTypes.js", - "private": false, - "name": "alphaMask", - "owner": "Ext.form.field.VTypes", - "doc": "

The keystroke filter mask to be applied on alpha input. Defaults to:\n/[a-z_]/i

\n", - "linenr": 104, - "html_filename": "VTypes.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "VTypes.html#Ext-form-field-VTypes-property-alphaText", - "shortDoc": "The error text to display when the alpha validation function returns false. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/VTypes.js", - "private": false, - "name": "alphaText", - "owner": "Ext.form.field.VTypes", - "doc": "

The error text to display when the alpha validation function returns false. Defaults to:\n'This field should only contain letters and _'

\n", - "linenr": 98, - "html_filename": "VTypes.html" - }, - { - "type": "RegExp", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "VTypes.html#Ext-form-field-VTypes-property-alphanumMask", - "shortDoc": "The keystroke filter mask to be applied on alphanumeric input. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/VTypes.js", - "private": false, - "name": "alphanumMask", - "owner": "Ext.form.field.VTypes", - "doc": "

The keystroke filter mask to be applied on alphanumeric input. Defaults to:\n/[a-z0-9_]/i

\n", - "linenr": 125, - "html_filename": "VTypes.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "VTypes.html#Ext-form-field-VTypes-property-alphanumText", - "shortDoc": "The error text to display when the alphanumeric validation function returns false. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/VTypes.js", - "private": false, - "name": "alphanumText", - "owner": "Ext.form.field.VTypes", - "doc": "

The error text to display when the alphanumeric validation function returns false. Defaults to:\n'This field should only contain letters, numbers and _'

\n", - "linenr": 119, - "html_filename": "VTypes.html" - }, - { - "type": "RegExp", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "VTypes.html#Ext-form-field-VTypes-property-emailMask", - "shortDoc": "The keystroke filter mask to be applied on email input. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/VTypes.js", - "private": false, - "name": "emailMask", - "owner": "Ext.form.field.VTypes", - "doc": "

The keystroke filter mask to be applied on email input. See the email method for\ninformation about more complex email validation. Defaults to:\n/[a-z0-9_.-@]/i

\n", - "linenr": 67, - "html_filename": "VTypes.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "VTypes.html#Ext-form-field-VTypes-property-emailText", - "shortDoc": "The error text to display when the email validation function returns false. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/VTypes.js", - "private": false, - "name": "emailText", - "owner": "Ext.form.field.VTypes", - "doc": "

The error text to display when the email validation function returns false. Defaults to:\n'This field should be an e-mail address in the format \"user@example.com\"'

\n", - "linenr": 61, - "html_filename": "VTypes.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" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "VTypes.html#Ext-form-field-VTypes-property-urlText", - "shortDoc": "The error text to display when the url validation function returns false. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/form/field/VTypes.js", - "private": false, - "name": "urlText", - "owner": "Ext.form.field.VTypes", - "doc": "

The error text to display when the url validation function returns false. Defaults to:\n'This field should be a URL in the format \"http:/'+'/www.example.com\"'

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

This is a singleton object which contains a set of commonly used field validation functions.\nThe validations provided are basic and intended to be easily customizable and extended.

\n\n\n

To add custom VTypes specify the vtype validation\ntest function, and optionally specify any corresponding error text to display and any keystroke\nfiltering mask to apply. For example:

\n\n\n
// custom Vtype for vtype:'time'\nvar timeTest = /^([1-9]|1[0-9]):([0-5][0-9])(\\s[a|p]m)$/i;\nExt.apply(Ext.form.field.VTypes, {\n    //  vtype validation function\n    time: function(val, field) {\n        return timeTest.test(val);\n    },\n    // vtype Text property: The error text to display when the validation function returns false\n    timeText: 'Not a valid time.  Must be in the format \"12:34 PM\".',\n    // vtype Mask property: The keystroke filter mask\n    timeMask: /[\\d\\s:amp]/i\n});\n
\n\n\n

Another example:

\n\n
// custom Vtype for vtype:'IPAddress'\nExt.apply(Ext.form.field.VTypes, {\n    IPAddress:  function(v) {\n        return /^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$/.test(v);\n    },\n    IPAddressText: 'Must be a numeric IP address',\n    IPAddressMask: /[\\d\\.]/i\n});\n
\n\n", - "mixedInto": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "VTypes.html", - "extends": "Ext.Base" -}); \ No newline at end of file +Ext.data.JsonP.Ext_form_field_VTypes({"tagname":"class","html":"

Alternate names

Ext.form.VTypes

Hierarchy

Ext.Base
Ext.form.field.VTypes

Files

This is a singleton object which contains a set of commonly used field validation functions\nand provides a mechanism for creating reusable custom field validations.\nThe following field validation functions are provided out of the box:

\n\n\n\n\n

VTypes can be applied to a Text Field using the vtype configuration:

\n\n
Ext.create('Ext.form.field.Text', {\n    fieldLabel: 'Email Address',\n    name: 'email',\n    vtype: 'email' // applies email validation rules to this field\n});\n
\n\n

To create custom VTypes:

\n\n
// custom Vtype for vtype:'time'\nvar timeTest = /^([1-9]|1[0-9]):([0-5][0-9])(\\s[a|p]m)$/i;\nExt.apply(Ext.form.field.VTypes, {\n    //  vtype validation function\n    time: function(val, field) {\n        return timeTest.test(val);\n    },\n    // vtype Text property: The error text to display when the validation function returns false\n    timeText: 'Not a valid time.  Must be in the format \"12:34 PM\".',\n    // vtype Mask property: The keystroke filter mask\n    timeMask: /[\\d\\s:amp]/i\n});\n
\n\n

In the above example the time function is the validator that will run when field validation occurs,\ntimeText is the error message, and timeMask limits what characters can be typed into the field.\nNote that the Text and Mask functions must begin with the same name as the validator function.

\n\n

Using a custom validator is the same as using one of the build-in validators - just use the name of the validator function\nas the vtype configuration on a Text Field:

\n\n
Ext.create('Ext.form.field.Text', {\n    fieldLabel: 'Departure Time',\n    name: 'departureTime',\n    vtype: 'time' // applies custom time validation rules to this field\n});\n
\n\n

Another example of a custom validator:

\n\n
// custom Vtype for vtype:'IPAddress'\nExt.apply(Ext.form.field.VTypes, {\n    IPAddress:  function(v) {\n        return /^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$/.test(v);\n    },\n    IPAddressText: 'Must be a numeric IP address',\n    IPAddressMask: /[\\d\\.]/i\n});\n
\n\n

It's important to note that using Ext.apply() means that the custom validator function\nas well as Text and Mask fields are added as properties of the Ext.form.field.VTypes singleton.

\n
Defined By

Properties

The keystroke filter mask to be applied on alpha input. ...

The keystroke filter mask to be applied on alpha input. Defaults to: /[a-z_]/i

\n
The error text to display when the alpha validation function returns false. ...

The error text to display when the alpha validation function returns false.\nDefaults to: 'This field should only contain letters and _'

\n
The keystroke filter mask to be applied on alphanumeric input. ...

The keystroke filter mask to be applied on alphanumeric input. Defaults to: /[a-z0-9_]/i

\n
The error text to display when the alphanumeric validation function returns false. ...

The error text to display when the alphanumeric validation function returns false.\nDefaults to: 'This field should only contain letters, numbers and _'

\n
The keystroke filter mask to be applied on email input. ...

The keystroke filter mask to be applied on email input. See the email method for information about\nmore complex email validation. Defaults to: /[a-z0-9_.-@]/i

\n
The error text to display when the email validation function returns false. ...

The error text to display when the email validation function returns false.\nDefaults to: 'This field should be an e-mail address in the format \"user@example.com\"'

\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
The error text to display when the url validation function returns false. ...

The error text to display when the url validation function returns false.\nDefaults to: 'This field should be a URL in the format \"http:/'+'/www.example.com\"'

\n
Defined By

Methods

The function used to validate alpha values ...

The function used to validate alpha values

\n

Parameters

Returns

  • Boolean

    true if the RegExp test passed, and false if not.

    \n
The function used to validate alphanumeric values ...

The function used to validate alphanumeric values

\n

Parameters

Returns

  • Boolean

    true if the RegExp test passed, and false if not.

    \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
The function used to validate email addresses. ...

The function used to validate email addresses. Note that this is a very basic validation - complete\nvalidation per the email RFC specifications is very complex and beyond the scope of this class, although this\nfunction can be overridden if a more comprehensive validation scheme is desired. See the validation section\nof the Wikipedia article on email addresses for additional information. This implementation is intended\nto validate the following emails:

\n\n
    \n
  • barney@example.de
  • \n
  • barney.rubble@example.com
  • \n
  • barney-rubble@example.coop
  • \n
  • barney+rubble@example.com
  • \n
\n\n

Parameters

  • value : String

    The email address

    \n

Returns

  • Boolean

    true if the RegExp test passed, and false if not.

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

The function used to validate URLs ...

The function used to validate URLs

\n

Parameters

Returns

  • Boolean

    true if the RegExp test passed, and false if not.

    \n
","allMixins":[],"meta":{},"requires":[],"deprecated":null,"extends":"Ext.Base","inheritable":false,"static":false,"superclasses":["Ext.Base","Ext.form.field.VTypes"],"singleton":true,"code_type":"ext_define","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[],"event":[]},"subclasses":[],"uses":[],"protected":false,"mixins":[],"members":{"property":[{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.form.field.VTypes","template":null,"required":null,"protected":false,"name":"alphaMask","id":"property-alphaMask"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.form.field.VTypes","template":null,"required":null,"protected":false,"name":"alphaText","id":"property-alphaText"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.form.field.VTypes","template":null,"required":null,"protected":false,"name":"alphanumMask","id":"property-alphanumMask"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.form.field.VTypes","template":null,"required":null,"protected":false,"name":"alphanumText","id":"property-alphanumText"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.form.field.VTypes","template":null,"required":null,"protected":false,"name":"emailMask","id":"property-emailMask"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.form.field.VTypes","template":null,"required":null,"protected":false,"name":"emailText","id":"property-emailText"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.Base","template":null,"required":null,"protected":true,"name":"self","id":"property-self"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.form.field.VTypes","template":null,"required":null,"protected":false,"name":"urlText","id":"property-urlText"}],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.VTypes","template":false,"required":null,"protected":false,"name":"alpha","id":"method-alpha"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.VTypes","template":false,"required":null,"protected":false,"name":"alphanum","id":"method-alphanum"},{"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.VTypes","template":false,"required":null,"protected":false,"name":"email","id":"method-email"},{"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.Base","template":false,"required":null,"protected":true,"name":"statics","id":"method-statics"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.form.field.VTypes","template":false,"required":null,"protected":false,"name":"url","id":"method-url"}],"event":[]},"private":false,"component":false,"name":"Ext.form.field.VTypes","alternateClassNames":["Ext.form.VTypes"],"id":"class-Ext.form.field.VTypes","mixedInto":[],"xtypes":{},"files":[{"href":"VTypes.html#Ext-form-field-VTypes","filename":"VTypes.js"}]}); \ No newline at end of file