docs/source/VTypes.html

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