X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/docs/output/Ext.data.validations.js diff --git a/docs/output/Ext.data.validations.js b/docs/output/Ext.data.validations.js index 5ba5968e..d52f170e 100644 --- a/docs/output/Ext.data.validations.js +++ b/docs/output/Ext.data.validations.js @@ -1,308 +1 @@ -Ext.data.JsonP.Ext_data_validations({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": null, - "members": { - "cfg": [ - - ], - "method": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "validations.html#Ext-data-validations-method-exclusion", - "shortDoc": "Validates that the given value is present in the configured list ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/validations.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

Optional config object

\n", - "name": "config" - }, - { - "type": "String", - "optional": false, - "doc": "

The value to validate

\n", - "name": "value" - } - ], - "name": "exclusion", - "owner": "Ext.data.validations", - "doc": "

Validates that the given value is present in the configured list

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

True if the value is not present in the list

\n" - }, - "html_filename": "validations.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "validations.html#Ext-data-validations-method-format", - "shortDoc": "Returns true if the given value passes validation against the configured matcher regex ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/validations.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

Optional config object

\n", - "name": "config" - }, - { - "type": "String", - "optional": false, - "doc": "

The value to validate

\n", - "name": "value" - } - ], - "name": "format", - "owner": "Ext.data.validations", - "doc": "

Returns true if the given value passes validation against the configured matcher regex

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

True if the value passes the format validation

\n" - }, - "html_filename": "validations.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "validations.html#Ext-data-validations-method-inclusion", - "shortDoc": "Validates that the given value is present in the configured list ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/validations.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The value to validate

\n", - "name": "value" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "value" - } - ], - "name": "inclusion", - "owner": "Ext.data.validations", - "doc": "

Validates that the given value is present in the configured list

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

True if the value is present in the list

\n" - }, - "html_filename": "validations.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "validations.html#Ext-data-validations-method-length", - "shortDoc": "Returns true if the given value is between the configured min and max values ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/validations.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

Optional config object

\n", - "name": "config" - }, - { - "type": "String", - "optional": false, - "doc": "

The value to validate

\n", - "name": "value" - } - ], - "name": "length", - "owner": "Ext.data.validations", - "doc": "

Returns true if the given value is between the configured min and max values

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

True if the value passes validation

\n" - }, - "html_filename": "validations.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "validations.html#Ext-data-validations-method-presence", - "shortDoc": "Validates that the given value is present ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/validations.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

Optional config object

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

The value to validate

\n", - "name": "value" - } - ], - "name": "presence", - "owner": "Ext.data.validations", - "doc": "

Validates that the given value is present

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

True if validation passed

\n" - }, - "html_filename": "validations.html" - } - ], - "property": [ - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "validations.html#Ext-data-validations-property-exclusionMessage", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/validations.js", - "private": false, - "name": "exclusionMessage", - "owner": "Ext.data.validations", - "doc": "

The default error message used when an exclusion validation fails

\n", - "linenr": 41, - "html_filename": "validations.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "validations.html#Ext-data-validations-property-formatMessage", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/validations.js", - "private": false, - "name": "formatMessage", - "owner": "Ext.data.validations", - "doc": "

The default error message used when a format validation fails

\n", - "linenr": 27, - "html_filename": "validations.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "validations.html#Ext-data-validations-property-inclusionMessage", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/validations.js", - "private": false, - "name": "inclusionMessage", - "owner": "Ext.data.validations", - "doc": "

The default error message used when an inclusion validation fails

\n", - "linenr": 34, - "html_filename": "validations.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "validations.html#Ext-data-validations-property-lengthMessage", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/validations.js", - "private": false, - "name": "lengthMessage", - "owner": "Ext.data.validations", - "doc": "

The default error message used when a length validation fails

\n", - "linenr": 20, - "html_filename": "validations.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "validations.html#Ext-data-validations-property-presenceMessage", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/validations.js", - "private": false, - "name": "presenceMessage", - "owner": "Ext.data.validations", - "doc": "

The default error message used when a presence validation fails

\n", - "linenr": 13, - "html_filename": "validations.html" - } - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "singleton": false, - "alias": null, - "superclasses": [ - - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "validations.html#Ext-data-validations", - "subclasses": [ - - ], - "static": false, - "author": "Ed Spencer", - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/validations.js", - "private": false, - "alternateClassNames": [ - - ], - "name": "Ext.data.validations", - "doc": "

This singleton contains a set of validation functions that can be used to validate any type\nof data. They are most often used in Models, where they are automatically\nset up and executed.

\n\n", - "mixedInto": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "validations.html", - "extends": "Object" -}); \ No newline at end of file +Ext.data.JsonP.Ext_data_validations({"tagname":"class","html":"

Hierarchy

Ext.Base
Ext.data.validations

Files

This singleton contains a set of validation functions that can be used to validate any type of data. They are most\noften used in Models, where they are automatically set up and executed.

\n
Defined By

Properties

 

The default error message used when an email validation fails

\n

The default error message used when an email validation fails

\n
 

The regular expression used to validate email addresses

\n

The regular expression used to validate email addresses

\n
 

The default error message used when an exclusion validation fails.

\n

The default error message used when an exclusion validation fails.

\n
 

The default error message used when a format validation fails.

\n

The default error message used when a format validation fails.

\n
 

The default error message used when an inclusion validation fails.

\n

The default error message used when an inclusion validation fails.

\n
 

The default error message used when a length validation fails.

\n

The default error message used when a length validation fails.

\n
 

The default error message used when a presence validation fails.

\n

The default error message used when a presence validation fails.

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

Methods

( 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
Validates that an email string is in the correct format ...

Validates that an email string is in the correct format

\n

Parameters

  • config : Object

    Config object

    \n
  • email : String

    The email address

    \n

Returns

  • Boolean

    True if the value passes validation

    \n
Validates that the given value is present in the configured list. ...

Validates that the given value is present in the configured list.\nFor example:

\n\n
validations: [{type: 'exclusion', field: 'username', list: ['Admin', 'Operator']}]\n
\n

Parameters

  • config : Object

    Config object

    \n
  • value : String

    The value to validate

    \n

Returns

  • Boolean

    True if the value is not present in the list

    \n
Returns true if the given value passes validation against the configured matcher regex. ...

Returns true if the given value passes validation against the configured matcher regex.\nFor example:

\n\n
validations: [{type: 'format', field: 'username', matcher: /([a-z]+)[0-9]{2,3}/}]\n
\n

Parameters

  • config : Object

    Config object

    \n
  • value : String

    The value to validate

    \n

Returns

  • Boolean

    True if the value passes the format validation

    \n
Validates that the given value is present in the configured list. ...

Validates that the given value is present in the configured list.\nFor example:

\n\n
validations: [{type: 'inclusion', field: 'gender', list: ['Male', 'Female']}]\n
\n

Parameters

  • config : Object

    Config object

    \n
  • value : String

    The value to validate

    \n

Returns

  • Boolean

    True if the value is present in the list

    \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
Returns true if the given value is between the configured min and max values. ...

Returns true if the given value is between the configured min and max values.\nFor example:

\n\n
validations: [{type: 'length', field: 'name', min: 2}]\n
\n

Parameters

  • config : Object

    Config object

    \n
  • value : String

    The value to validate

    \n

Returns

  • Boolean

    True if the value passes validation

    \n
Validates that the given value is present. ...

Validates that the given value is present.\nFor example:

\n\n
validations: [{type: 'presence', field: 'age'}]\n
\n

Parameters

  • config : Object

    Config object

    \n
  • value : Object

    The value to validate

    \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

","allMixins":[],"meta":{"author":["Ed Spencer"]},"requires":[],"deprecated":null,"extends":"Ext.Base","inheritable":false,"static":false,"superclasses":["Ext.Base","Ext.data.validations"],"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.data.validations","template":null,"required":null,"protected":false,"name":"emailMessage","id":"property-emailMessage"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.validations","template":null,"required":null,"protected":false,"name":"emailRe","id":"property-emailRe"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.validations","template":null,"required":null,"protected":false,"name":"exclusionMessage","id":"property-exclusionMessage"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.validations","template":null,"required":null,"protected":false,"name":"formatMessage","id":"property-formatMessage"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.validations","template":null,"required":null,"protected":false,"name":"inclusionMessage","id":"property-inclusionMessage"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.validations","template":null,"required":null,"protected":false,"name":"lengthMessage","id":"property-lengthMessage"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.validations","template":null,"required":null,"protected":false,"name":"presenceMessage","id":"property-presenceMessage"},{"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":[],"method":[{"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.data.validations","template":false,"required":null,"protected":false,"name":"email","id":"method-email"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.data.validations","template":false,"required":null,"protected":false,"name":"exclusion","id":"method-exclusion"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.data.validations","template":false,"required":null,"protected":false,"name":"format","id":"method-format"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.data.validations","template":false,"required":null,"protected":false,"name":"inclusion","id":"method-inclusion"},{"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.data.validations","template":false,"required":null,"protected":false,"name":"length","id":"method-length"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.data.validations","template":false,"required":null,"protected":false,"name":"presence","id":"method-presence"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"statics","id":"method-statics"}],"event":[]},"private":false,"component":false,"name":"Ext.data.validations","alternateClassNames":[],"id":"class-Ext.data.validations","mixedInto":[],"xtypes":{},"files":[{"href":"validations.html#Ext-data-validations","filename":"validations.js"}]}); \ No newline at end of file