docs/source/VTypes.html

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