docs/source/VTypes.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   5   <title>The source code</title>
   6   <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
   7   <script type="text/javascript" src="../prettify/prettify.js"></script>
   8   <style type="text/css">
   9     .highlight { display: block; background-color: #ddd; }
  10   </style>
  11   <script type="text/javascript">
  12     function highlight() {
  13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
  14     }
  15   </script>
  16 </head>
  17 <body onload="prettyPrint(); highlight();">
  18   <pre class="prettyprint lang-js"><span id='Ext-form-field-VTypes'>/**
  19 </span> * @class Ext.form.field.VTypes
  20  * &lt;p&gt;This is a singleton object which contains a set of commonly used field validation functions.
  21  * The validations provided are basic and intended to be easily customizable and extended.&lt;/p&gt;
  22  * &lt;p&gt;To add custom VTypes specify the &lt;code&gt;{@link Ext.form.field.Text#vtype vtype}&lt;/code&gt; validation
  23  * test function, and optionally specify any corresponding error text to display and any keystroke
  24  * filtering mask to apply. For example:&lt;/p&gt;
  25  * &lt;pre&gt;&lt;code&gt;
  26 // custom Vtype for vtype:'time'
  27 var timeTest = /^([1-9]|1[0-9]):([0-5][0-9])(\s[a|p]m)$/i;
  28 Ext.apply(Ext.form.field.VTypes, {
  29     //  vtype validation function
  30     time: function(val, field) {
  31         return timeTest.test(val);
  32     },
  33     // vtype Text property: The error text to display when the validation function returns false
  34     timeText: 'Not a valid time.  Must be in the format &quot;12:34 PM&quot;.',
  35     // vtype Mask property: The keystroke filter mask
  36     timeMask: /[\d\s:amp]/i
  37 });
  38  * &lt;/code&gt;&lt;/pre&gt;
  39  * Another example:
  40  * &lt;pre&gt;&lt;code&gt;
  41 // custom Vtype for vtype:'IPAddress'
  42 Ext.apply(Ext.form.field.VTypes, {
  43     IPAddress:  function(v) {
  44         return /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/.test(v);
  45     },
  46     IPAddressText: 'Must be a numeric IP address',
  47     IPAddressMask: /[\d\.]/i
  48 });
  49  * &lt;/code&gt;&lt;/pre&gt;
  50  * @singleton
  51  */
  52 Ext.define('Ext.form.field.VTypes', (function(){
  53     // closure these in so they are only created once.
  54     var alpha = /^[a-zA-Z_]+$/,
  55         alphanum = /^[a-zA-Z0-9_]+$/,
  56         email = /^(\w+)([\-+.][\w]+)*@(\w[\-\w]*\.){1,5}([A-Za-z]){2,6}$/,
  57         url = /(((^https?)|(^ftp)):\/\/([\-\w]+\.)+\w{2,3}(\/[%\-\w]+(\.\w{2,})?)*(([\w\-\.\?\\\/+@&amp;#;`~=%!]*)(\.\w{2,})?)*\/?)/i;
  58
  59     // All these messages and functions are configurable
  60     return {
  61         singleton: true,
  62         alternateClassName: 'Ext.form.VTypes',
  63
  64 <span id='Ext-form-field-VTypes-method-email'>        /**
  65 </span>         * The function used to validate email addresses.  Note that this is a very basic validation -- complete
  66          * validation per the email RFC specifications is very complex and beyond the scope of this class, although
  67          * this function can be overridden if a more comprehensive validation scheme is desired.  See the validation
  68          * section of the &lt;a href=&quot;http://en.wikipedia.org/wiki/E-mail_address&quot;&gt;Wikipedia article on email addresses&lt;/a&gt;
  69          * for additional information.  This implementation is intended to validate the following emails:&lt;tt&gt;
  70          * 'barney@example.de', 'barney.rubble@example.com', 'barney-rubble@example.coop', 'barney+rubble@example.com'
  71          * &lt;/tt&gt;.
  72          * @param {String} value The email address
  73          * @return {Boolean} true if the RegExp test passed, and false if not.
  74          */
  75         'email' : function(v){
  76             return email.test(v);
  77         },
  78 <span id='Ext-form-field-VTypes-property-emailText'>        /**
  79 </span>         * The error text to display when the email validation function returns false.  Defaults to:
  80          * &lt;tt&gt;'This field should be an e-mail address in the format &quot;user@example.com&quot;'&lt;/tt&gt;
  81          * @type String
  82          */
  83         'emailText' : 'This field should be an e-mail address in the format &quot;user@example.com&quot;',
  84 <span id='Ext-form-field-VTypes-property-emailMask'>        /**
  85 </span>         * The keystroke filter mask to be applied on email input.  See the {@link #email} method for
  86          * information about more complex email validation. Defaults to:
  87          * &lt;tt&gt;/[a-z0-9_\.\-@]/i&lt;/tt&gt;
  88          * @type RegExp
  89          */
  90         'emailMask' : /[a-z0-9_\.\-@\+]/i,
  91
  92 <span id='Ext-form-field-VTypes-method-url'>        /**
  93 </span>         * The function used to validate URLs
  94          * @param {String} value The URL
  95          * @return {Boolean} true if the RegExp test passed, and false if not.
  96          */
  97         'url' : function(v){
  98             return url.test(v);
  99         },
 100 <span id='Ext-form-field-VTypes-property-urlText'>        /**
 101 </span>         * The error text to display when the url validation function returns false.  Defaults to:
 102          * &lt;tt&gt;'This field should be a URL in the format &quot;http:/'+'/www.example.com&quot;'&lt;/tt&gt;
 103          * @type String
 104          */
 105         'urlText' : 'This field should be a URL in the format &quot;http:/'+'/www.example.com&quot;',
 106
 107 <span id='Ext-form-field-VTypes-method-alpha'>        /**
 108 </span>         * The function used to validate alpha values
 109          * @param {String} value The value
 110          * @return {Boolean} true if the RegExp test passed, and false if not.
 111          */
 112         'alpha' : function(v){
 113             return alpha.test(v);
 114         },
 115 <span id='Ext-form-field-VTypes-property-alphaText'>        /**
 116 </span>         * The error text to display when the alpha validation function returns false.  Defaults to:
 117          * &lt;tt&gt;'This field should only contain letters and _'&lt;/tt&gt;
 118          * @type String
 119          */
 120         'alphaText' : 'This field should only contain letters and _',
 121 <span id='Ext-form-field-VTypes-property-alphaMask'>        /**
 122 </span>         * The keystroke filter mask to be applied on alpha input.  Defaults to:
 123          * &lt;tt&gt;/[a-z_]/i&lt;/tt&gt;
 124          * @type RegExp
 125          */
 126         'alphaMask' : /[a-z_]/i,
 127
 128 <span id='Ext-form-field-VTypes-method-alphanum'>        /**
 129 </span>         * The function used to validate alphanumeric values
 130          * @param {String} value The value
 131          * @return {Boolean} true if the RegExp test passed, and false if not.
 132          */
 133         'alphanum' : function(v){
 134             return alphanum.test(v);
 135         },
 136 <span id='Ext-form-field-VTypes-property-alphanumText'>        /**
 137 </span>         * The error text to display when the alphanumeric validation function returns false.  Defaults to:
 138          * &lt;tt&gt;'This field should only contain letters, numbers and _'&lt;/tt&gt;
 139          * @type String
 140          */
 141         'alphanumText' : 'This field should only contain letters, numbers and _',
 142 <span id='Ext-form-field-VTypes-property-alphanumMask'>        /**
 143 </span>         * The keystroke filter mask to be applied on alphanumeric input.  Defaults to:
 144          * &lt;tt&gt;/[a-z0-9_]/i&lt;/tt&gt;
 145          * @type RegExp
 146          */
 147         'alphanumMask' : /[a-z0-9_]/i
 148     };
 149 })());
 150 </pre>
 151 </body>
 152 </html>