Merge branch 'master' of http://git.roojs.com/roojs1
[roojs1] / docs / src / Roo_form_VTypes.js.html
1 <html><head><title>Roo/form/VTypes.js</title><link rel="stylesheet" type="text/css" href="../../css/highlight-js.css"/></head><body class="highlightpage"><code class="jsdoc-pretty"><span class="jsdoc-comment">/*
2  * Based on:
3  * Ext JS Library 1.1.1
4  * Copyright(c) 2006-2007, Ext JS, LLC.
5  *
6  * Originally Released Under LGPL - original licence link has changed is not relivant.
7  *
8  * Fork - LGPL
9  * &lt;script type=&quot;text/javascript&quot;&gt;
10  */
11 /**
12  * @class Roo.form.VTypes
13  * Overridable validation definitions. The validations provided are basic and intended to be easily customizable and extended.
14  * @static
15  */
16 </span><span class="jsdoc-var">Roo.form.VTypes </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
17     </span><span class="jsdoc-comment">// closure these in so they are only created once.
18     </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">alpha </span><span class="jsdoc-syntax">= /^[a-zA-Z_]+$/;
19     </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">alphanum </span><span class="jsdoc-syntax">= /^[a-zA-Z0-9_]+$/;
20     </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">email </span><span class="jsdoc-syntax">= /^([\w'-]+)(\.[\w'-]+)*@([\w-]+\.){1,5}([A-Za-z]){2,24}$/;
21     </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">url </span><span class="jsdoc-syntax">= /^(((https?)|(ftp)):\/\/([\-\w]+\.)+\w{2,3}(\/[%\-\w]+(\.\w{2,})?)*(([\w\-\.\?\\\/+@&amp;#;`~=%!]*)(\.\w{2,})?)*\/?)/i;
22     </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">urlWeb </span><span class="jsdoc-syntax">= /^((https?):\/\/([\-\w]+\.)+\w{2,3}(\/[%\-\w]+(\.\w{2,})?)*(([\w\-\.\?\\\/+@&amp;#;`~=%!]*)(\.\w{2,})?)*\/?)/i;
23
24     </span><span class="jsdoc-comment">// All these messages and functions are configurable
25     </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
26         </span><span class="jsdoc-comment">/**
27          * The function used to validate email addresses
28          * @param {String} value The email address
29          */
30         </span><span class="jsdoc-var">email </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">v</span><span class="jsdoc-syntax">){
31             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">email.test</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">v</span><span class="jsdoc-syntax">);
32         },
33         </span><span class="jsdoc-comment">/**
34          * The error text to display when the email validation function returns false
35          * @type String
36          */
37         </span><span class="jsdoc-var">emailText </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'This field should be an e-mail address in the format &quot;user@domain.com&quot;'</span><span class="jsdoc-syntax">,
38         </span><span class="jsdoc-comment">/**
39          * The keystroke filter mask to be applied on email input
40          * @type RegExp
41          */
42         </span><span class="jsdoc-var">emailMask </span><span class="jsdoc-syntax">: /[a-z0-9_\.\-@]/i,
43
44         </span><span class="jsdoc-comment">/**
45          * The function used to validate URLs
46          * @param {String} value The URL
47          */
48         </span><span class="jsdoc-var">url </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">v</span><span class="jsdoc-syntax">){
49             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">url.test</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">v</span><span class="jsdoc-syntax">);
50         },
51         </span><span class="jsdoc-comment">/**
52          * The funciton used to validate URLs (only allow schemes 'https' and 'http')
53          * @param {String} v The URL
54          */
55         </span><span class="jsdoc-var">urlWeb </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">v</span><span class="jsdoc-syntax">) {
56             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">urlWeb.test</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">v</span><span class="jsdoc-syntax">);
57         },
58         </span><span class="jsdoc-comment">/**
59          * The error text to display when the url validation function returns false
60          * @type String
61          */
62         </span><span class="jsdoc-var">urlText </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'This field should be a URL in the format &quot;http:/'</span><span class="jsdoc-syntax">+</span><span class="jsdoc-string">'/www.domain.com&quot;'</span><span class="jsdoc-syntax">,
63
64         </span><span class="jsdoc-comment">/**
65          * The function used to validate alpha values
66          * @param {String} value The value
67          */
68         </span><span class="jsdoc-var">alpha </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">v</span><span class="jsdoc-syntax">){
69             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">alpha.test</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">v</span><span class="jsdoc-syntax">);
70         },
71         </span><span class="jsdoc-comment">/**
72          * The error text to display when the alpha validation function returns false
73          * @type String
74          */
75         </span><span class="jsdoc-var">alphaText </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'This field should only contain letters and _'</span><span class="jsdoc-syntax">,
76         </span><span class="jsdoc-comment">/**
77          * The keystroke filter mask to be applied on alpha input
78          * @type RegExp
79          */
80         </span><span class="jsdoc-var">alphaMask </span><span class="jsdoc-syntax">: /[a-z_]/i,
81
82         </span><span class="jsdoc-comment">/**
83          * The function used to validate alphanumeric values
84          * @param {String} value The value
85          */
86         </span><span class="jsdoc-var">alphanum </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">v</span><span class="jsdoc-syntax">){
87             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">alphanum.test</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">v</span><span class="jsdoc-syntax">);
88         },
89         </span><span class="jsdoc-comment">/**
90          * The error text to display when the alphanumeric validation function returns false
91          * @type String
92          */
93         </span><span class="jsdoc-var">alphanumText </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'This field should only contain letters, numbers and _'</span><span class="jsdoc-syntax">,
94         </span><span class="jsdoc-comment">/**
95          * The keystroke filter mask to be applied on alphanumeric input
96          * @type RegExp
97          */
98         </span><span class="jsdoc-var">alphanumMask </span><span class="jsdoc-syntax">: /[a-z0-9_]/i
99     };
100 }();</span></code></body></html>