dab335259642b09f9040626f6d454a4f0b911928
[roojs1] / docs / src / Roo_form_VTypes.js.html
1 <html><head><title>/home/edward/gitlive/roojs1/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  * @singleton
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
23     </span><span class="jsdoc-comment">// All these messages and functions are configurable
24     </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
25         </span><span class="jsdoc-comment">/**
26          * The function used to validate email addresses
27          * @param {String} value The email address
28          */
29         </span><span class="jsdoc-string">'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">){
30             </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">);
31         },
32         </span><span class="jsdoc-comment">/**
33          * The error text to display when the email validation function returns false
34          * @type String
35          */
36         </span><span class="jsdoc-string">'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">,
37         </span><span class="jsdoc-comment">/**
38          * The keystroke filter mask to be applied on email input
39          * @type RegExp
40          */
41         </span><span class="jsdoc-string">'emailMask' </span><span class="jsdoc-syntax">: /[a-z0-9_\.\-@]/i,
42
43         </span><span class="jsdoc-comment">/**
44          * The function used to validate URLs
45          * @param {String} value The URL
46          */
47         </span><span class="jsdoc-string">'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">){
48             </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">);
49         },
50         </span><span class="jsdoc-comment">/**
51          * The error text to display when the url validation function returns false
52          * @type String
53          */
54         </span><span class="jsdoc-string">'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">,
55
56         </span><span class="jsdoc-comment">/**
57          * The function used to validate alpha values
58          * @param {String} value The value
59          */
60         </span><span class="jsdoc-string">'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">){
61             </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">);
62         },
63         </span><span class="jsdoc-comment">/**
64          * The error text to display when the alpha validation function returns false
65          * @type String
66          */
67         </span><span class="jsdoc-string">'alphaText' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'This field should only contain letters and _'</span><span class="jsdoc-syntax">,
68         </span><span class="jsdoc-comment">/**
69          * The keystroke filter mask to be applied on alpha input
70          * @type RegExp
71          */
72         </span><span class="jsdoc-string">'alphaMask' </span><span class="jsdoc-syntax">: /[a-z_]/i,
73
74         </span><span class="jsdoc-comment">/**
75          * The function used to validate alphanumeric values
76          * @param {String} value The value
77          */
78         </span><span class="jsdoc-string">'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">){
79             </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">);
80         },
81         </span><span class="jsdoc-comment">/**
82          * The error text to display when the alphanumeric validation function returns false
83          * @type String
84          */
85         </span><span class="jsdoc-string">'alphanumText' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'This field should only contain letters, numbers and _'</span><span class="jsdoc-syntax">,
86         </span><span class="jsdoc-comment">/**
87          * The keystroke filter mask to be applied on alphanumeric input
88          * @type RegExp
89          */
90         </span><span class="jsdoc-string">'alphanumMask' </span><span class="jsdoc-syntax">: /[a-z0-9_]/i
91     };
92 }();</span></code></body></html>