VTypes.html
8.43 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The source code</title>
<link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
<script type="text/javascript" src="../resources/prettify/prettify.js"></script>
<style type="text/css">
.highlight { display: block; background-color: #ddd; }
</style>
<script type="text/javascript">
function highlight() {
document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
}
</script>
</head>
<body onload="prettyPrint(); highlight();">
<pre class="prettyprint lang-js"><span id='Ext-form-field-VTypes'>/**
</span> * @singleton
* @alternateClassName Ext.form.VTypes
*
* This is a singleton object which contains a set of commonly used field validation functions
* and provides a mechanism for creating reusable custom field validations.
* The following field validation functions are provided out of the box:
*
* - {@link #alpha}
* - {@link #alphanum}
* - {@link #email}
* - {@link #url}
*
* VTypes can be applied to a {@link Ext.form.field.Text Text Field} using the `{@link Ext.form.field.Text#vtype vtype}` configuration:
*
* Ext.create('Ext.form.field.Text', {
* fieldLabel: 'Email Address',
* name: 'email',
* vtype: 'email' // applies email validation rules to this field
* });
*
* To create custom VTypes:
*
* // custom Vtype for vtype:'time'
* var timeTest = /^([1-9]|1[0-9]):([0-5][0-9])(\s[a|p]m)$/i;
* Ext.apply(Ext.form.field.VTypes, {
* // vtype validation function
* time: function(val, field) {
* return timeTest.test(val);
* },
* // vtype Text property: The error text to display when the validation function returns false
* timeText: 'Not a valid time. Must be in the format "12:34 PM".',
* // vtype Mask property: The keystroke filter mask
* timeMask: /[\d\s:amp]/i
* });
*
* In the above example the `time` function is the validator that will run when field validation occurs,
* `timeText` is the error message, and `timeMask` limits what characters can be typed into the field.
* Note that the `Text` and `Mask` functions must begin with the same name as the validator function.
*
* Using a custom validator is the same as using one of the build-in validators - just use the name of the validator function
* as the `{@link Ext.form.field.Text#vtype vtype}` configuration on a {@link Ext.form.field.Text Text Field}:
*
* Ext.create('Ext.form.field.Text', {
* fieldLabel: 'Departure Time',
* name: 'departureTime',
* vtype: 'time' // applies custom time validation rules to this field
* });
*
* Another example of a custom validator:
*
* // custom Vtype for vtype:'IPAddress'
* Ext.apply(Ext.form.field.VTypes, {
* IPAddress: function(v) {
* return /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/.test(v);
* },
* IPAddressText: 'Must be a numeric IP address',
* IPAddressMask: /[\d\.]/i
* });
*
* It's important to note that using {@link Ext#apply Ext.apply()} means that the custom validator function
* as well as `Text` and `Mask` fields are added as properties of the `Ext.form.field.VTypes` singleton.
*/
Ext.define('Ext.form.field.VTypes', (function(){
// closure these in so they are only created once.
var alpha = /^[a-zA-Z_]+$/,
alphanum = /^[a-zA-Z0-9_]+$/,
email = /^(\w+)([\-+.][\w]+)*@(\w[\-\w]*\.){1,5}([A-Za-z]){2,6}$/,
url = /(((^https?)|(^ftp)):\/\/([\-\w]+\.)+\w{2,3}(\/[%\-\w]+(\.\w{2,})?)*(([\w\-\.\?\\\/+@&#;`~=%!]*)(\.\w{2,})?)*\/?)/i;
// All these messages and functions are configurable
return {
singleton: true,
alternateClassName: 'Ext.form.VTypes',
<span id='Ext-form-field-VTypes-method-email'> /**
</span> * The function used to validate email addresses. Note that this is a very basic validation - complete
* validation per the email RFC specifications is very complex and beyond the scope of this class, although this
* function can be overridden if a more comprehensive validation scheme is desired. See the validation section
* of the [Wikipedia article on email addresses][1] for additional information. This implementation is intended
* to validate the following emails:
*
* - `barney@example.de`
* - `barney.rubble@example.com`
* - `barney-rubble@example.coop`
* - `barney+rubble@example.com`
*
* [1]: http://en.wikipedia.org/wiki/E-mail_address
*
* @param {String} value The email address
* @return {Boolean} true if the RegExp test passed, and false if not.
*/
'email' : function(v){
return email.test(v);
},
//<locale>
<span id='Ext-form-field-VTypes-property-emailText'> /**
</span> * @property {String} emailText
* The error text to display when the email validation function returns false.
* Defaults to: 'This field should be an e-mail address in the format "user@example.com"'
*/
'emailText' : 'This field should be an e-mail address in the format "user@example.com"',
//</locale>
<span id='Ext-form-field-VTypes-property-emailMask'> /**
</span> * @property {RegExp} emailMask
* The keystroke filter mask to be applied on email input. See the {@link #email} method for information about
* more complex email validation. Defaults to: /[a-z0-9_\.\-@]/i
*/
'emailMask' : /[a-z0-9_\.\-@\+]/i,
<span id='Ext-form-field-VTypes-method-url'> /**
</span> * The function used to validate URLs
* @param {String} value The URL
* @return {Boolean} true if the RegExp test passed, and false if not.
*/
'url' : function(v){
return url.test(v);
},
//<locale>
<span id='Ext-form-field-VTypes-property-urlText'> /**
</span> * @property {String} urlText
* The error text to display when the url validation function returns false.
* Defaults to: 'This field should be a URL in the format "http:/'+'/www.example.com"'
*/
'urlText' : 'This field should be a URL in the format "http:/'+'/www.example.com"',
//</locale>
<span id='Ext-form-field-VTypes-method-alpha'> /**
</span> * The function used to validate alpha values
* @param {String} value The value
* @return {Boolean} true if the RegExp test passed, and false if not.
*/
'alpha' : function(v){
return alpha.test(v);
},
//<locale>
<span id='Ext-form-field-VTypes-property-alphaText'> /**
</span> * @property {String} alphaText
* The error text to display when the alpha validation function returns false.
* Defaults to: 'This field should only contain letters and _'
*/
'alphaText' : 'This field should only contain letters and _',
//</locale>
<span id='Ext-form-field-VTypes-property-alphaMask'> /**
</span> * @property {RegExp} alphaMask
* The keystroke filter mask to be applied on alpha input. Defaults to: /[a-z_]/i
*/
'alphaMask' : /[a-z_]/i,
<span id='Ext-form-field-VTypes-method-alphanum'> /**
</span> * The function used to validate alphanumeric values
* @param {String} value The value
* @return {Boolean} true if the RegExp test passed, and false if not.
*/
'alphanum' : function(v){
return alphanum.test(v);
},
//<locale>
<span id='Ext-form-field-VTypes-property-alphanumText'> /**
</span> * @property {String} alphanumText
* The error text to display when the alphanumeric validation function returns false.
* Defaults to: 'This field should only contain letters, numbers and _'
*/
'alphanumText' : 'This field should only contain letters, numbers and _',
//</locale>
<span id='Ext-form-field-VTypes-property-alphanumMask'> /**
</span> * @property {RegExp} alphanumMask
* The keystroke filter mask to be applied on alphanumeric input. Defaults to: /[a-z0-9_]/i
*/
'alphanumMask' : /[a-z0-9_]/i
};
}()));
</pre>
</body>
</html>