docs/output/Ext.data.validations.js

   1 Ext.data.JsonP.Ext_data_validations({
   2   "tagname": "class",
   3   "name": "Ext.data.validations",
   4   "doc": "<p>This singleton contains a set of validation functions that can be used to validate any type\nof data. They are most often used in <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Models</a>, where they are automatically\nset up and executed.</p>\n\n",
   5   "extends": "Object",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": "Ed Spencer",
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": false,
  17   "cfg": [
  18
  19   ],
  20   "method": [
  21     {
  22       "tagname": "method",
  23       "name": "exclusion",
  24       "member": "Ext.data.validations",
  25       "doc": "<p>Validates that the given value is present in the configured <a href=\"#/api/Ext.data.validations--list\" rel=\"Ext.data.validations--list\" class=\"docClass\">list</a></p>\n",
  26       "params": [
  27         {
  28           "type": "Object",
  29           "name": "config",
  30           "doc": "<p>Optional config object</p>\n",
  31           "optional": false
  32         },
  33         {
  34           "type": "String",
  35           "name": "value",
  36           "doc": "<p>The value to validate</p>\n",
  37           "optional": false
  38         }
  39       ],
  40       "return": {
  41         "type": "Boolean",
  42         "doc": "<p>True if the value is not present in the list</p>\n"
  43       },
  44       "private": false,
  45       "static": false,
  46       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/validations.js",
  47       "linenr": 103,
  48       "html_filename": "validations.html",
  49       "href": "validations.html#Ext-data-validations-method-exclusion",
  50       "shortDoc": "<p>Validates that the given value is present in the configured <a href=\"#/api/Ext.data.validations--list\" rel=\"Ext.data.validations--list\" class=\"docClass\">list</a></p>\n"
  51     },
  52     {
  53       "tagname": "method",
  54       "name": "format",
  55       "member": "Ext.data.validations",
  56       "doc": "<p>Returns true if the given value passes validation against the configured <a href=\"#/api/Ext.data.validations--matcher\" rel=\"Ext.data.validations--matcher\" class=\"docClass\">matcher</a> regex</p>\n",
  57       "params": [
  58         {
  59           "type": "Object",
  60           "name": "config",
  61           "doc": "<p>Optional config object</p>\n",
  62           "optional": false
  63         },
  64         {
  65           "type": "String",
  66           "name": "value",
  67           "doc": "<p>The value to validate</p>\n",
  68           "optional": false
  69         }
  70       ],
  71       "return": {
  72         "type": "Boolean",
  73         "doc": "<p>True if the value passes the format validation</p>\n"
  74       },
  75       "private": false,
  76       "static": false,
  77       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/validations.js",
  78       "linenr": 84,
  79       "html_filename": "validations.html",
  80       "href": "validations.html#Ext-data-validations-method-format",
  81       "shortDoc": "<p>Returns true if the given value passes validation against the configured <a href=\"#/api/Ext.data.validations--matcher\" rel=\"Ext.data.validations--matcher\" class=\"docClass\">matcher</a> regex</p>\n"
  82     },
  83     {
  84       "tagname": "method",
  85       "name": "inclusion",
  86       "member": "Ext.data.validations",
  87       "doc": "<p>Validates that the given value is present in the configured <a href=\"#/api/Ext.data.validations--list\" rel=\"Ext.data.validations--list\" class=\"docClass\">list</a></p>\n",
  88       "params": [
  89         {
  90           "type": "String",
  91           "name": "value",
  92           "doc": "<p>The value to validate</p>\n",
  93           "optional": false
  94         },
  95         {
  96           "type": "Object",
  97           "name": "value",
  98           "doc": "\n",
  99           "optional": false
 100         }
 101       ],
 102       "return": {
 103         "type": "Boolean",
 104         "doc": "<p>True if the value is present in the list</p>\n"
 105       },
 106       "private": false,
 107       "static": false,
 108       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/validations.js",
 109       "linenr": 94,
 110       "html_filename": "validations.html",
 111       "href": "validations.html#Ext-data-validations-method-inclusion",
 112       "shortDoc": "<p>Validates that the given value is present in the configured <a href=\"#/api/Ext.data.validations--list\" rel=\"Ext.data.validations--list\" class=\"docClass\">list</a></p>\n"
 113     },
 114     {
 115       "tagname": "method",
 116       "name": "length",
 117       "member": "Ext.data.validations",
 118       "doc": "<p>Returns true if the given value is between the configured min and max values</p>\n",
 119       "params": [
 120         {
 121           "type": "Object",
 122           "name": "config",
 123           "doc": "<p>Optional config object</p>\n",
 124           "optional": false
 125         },
 126         {
 127           "type": "String",
 128           "name": "value",
 129           "doc": "<p>The value to validate</p>\n",
 130           "optional": false
 131         }
 132       ],
 133       "return": {
 134         "type": "Boolean",
 135         "doc": "<p>True if the value passes validation</p>\n"
 136       },
 137       "private": false,
 138       "static": false,
 139       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/validations.js",
 140       "linenr": 62,
 141       "html_filename": "validations.html",
 142       "href": "validations.html#Ext-data-validations-method-length",
 143       "shortDoc": "<p>Returns true if the given value is between the configured min and max values</p>\n"
 144     },
 145     {
 146       "tagname": "method",
 147       "name": "presence",
 148       "member": "Ext.data.validations",
 149       "doc": "<p>Validates that the given value is present</p>\n",
 150       "params": [
 151         {
 152           "type": "Object",
 153           "name": "config",
 154           "doc": "<p>Optional config object</p>\n",
 155           "optional": false
 156         },
 157         {
 158           "type": "Mixed",
 159           "name": "value",
 160           "doc": "<p>The value to validate</p>\n",
 161           "optional": false
 162         }
 163       ],
 164       "return": {
 165         "type": "Boolean",
 166         "doc": "<p>True if validation passed</p>\n"
 167       },
 168       "private": false,
 169       "static": false,
 170       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/validations.js",
 171       "linenr": 48,
 172       "html_filename": "validations.html",
 173       "href": "validations.html#Ext-data-validations-method-presence",
 174       "shortDoc": "<p>Validates that the given value is present</p>\n"
 175     }
 176   ],
 177   "property": [
 178     {
 179       "tagname": "property",
 180       "name": "exclusionMessage",
 181       "member": "Ext.data.validations",
 182       "type": "String",
 183       "doc": "<p>The default error message used when an exclusion validation fails</p>\n",
 184       "private": false,
 185       "static": false,
 186       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/validations.js",
 187       "linenr": 41,
 188       "html_filename": "validations.html",
 189       "href": "validations.html#Ext-data-validations-property-exclusionMessage"
 190     },
 191     {
 192       "tagname": "property",
 193       "name": "formatMessage",
 194       "member": "Ext.data.validations",
 195       "type": "Boolean",
 196       "doc": "<p>The default error message used when a format validation fails</p>\n",
 197       "private": false,
 198       "static": false,
 199       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/validations.js",
 200       "linenr": 27,
 201       "html_filename": "validations.html",
 202       "href": "validations.html#Ext-data-validations-property-formatMessage"
 203     },
 204     {
 205       "tagname": "property",
 206       "name": "inclusionMessage",
 207       "member": "Ext.data.validations",
 208       "type": "String",
 209       "doc": "<p>The default error message used when an inclusion validation fails</p>\n",
 210       "private": false,
 211       "static": false,
 212       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/validations.js",
 213       "linenr": 34,
 214       "html_filename": "validations.html",
 215       "href": "validations.html#Ext-data-validations-property-inclusionMessage"
 216     },
 217     {
 218       "tagname": "property",
 219       "name": "lengthMessage",
 220       "member": "Ext.data.validations",
 221       "type": "String",
 222       "doc": "<p>The default error message used when a length validation fails</p>\n",
 223       "private": false,
 224       "static": false,
 225       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/validations.js",
 226       "linenr": 20,
 227       "html_filename": "validations.html",
 228       "href": "validations.html#Ext-data-validations-property-lengthMessage"
 229     },
 230     {
 231       "tagname": "property",
 232       "name": "presenceMessage",
 233       "member": "Ext.data.validations",
 234       "type": "String",
 235       "doc": "<p>The default error message used when a presence validation fails</p>\n",
 236       "private": false,
 237       "static": false,
 238       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/validations.js",
 239       "linenr": 13,
 240       "html_filename": "validations.html",
 241       "href": "validations.html#Ext-data-validations-property-presenceMessage"
 242     }
 243   ],
 244   "event": [
 245
 246   ],
 247   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/validations.js",
 248   "linenr": 1,
 249   "html_filename": "validations.html",
 250   "href": "validations.html#Ext-data-validations",
 251   "cssVar": [
 252
 253   ],
 254   "cssMixin": [
 255
 256   ],
 257   "component": false,
 258   "superclasses": [
 259
 260   ],
 261   "subclasses": [
 262
 263   ],
 264   "mixedInto": [
 265
 266   ],
 267   "allMixins": [
 268
 269   ]
 270 });