X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/ee06f37b0f6f6d94cd05a6ffae556660f7c4a2bc..c930e9176a5a85509c5b0230e2bff5c22a591432:/docs/source/VTypes.html diff --git a/docs/source/VTypes.html b/docs/source/VTypes.html new file mode 100644 index 00000000..887a0435 --- /dev/null +++ b/docs/source/VTypes.html @@ -0,0 +1,138 @@ + +
+/** + * @class Ext.form.VTypes + *+ + \ No newline at end of fileThis is a singleton object which contains a set of commonly used field validation functions. + * The validations provided are basic and intended to be easily customizable and extended.
+ *To add custom VTypes specify the
+ *{@link Ext.form.TextField#vtype vtype}
validation + * test function, and optionally specify any corresponding error text to display and any keystroke + * filtering mask to apply. For example:+ * Another example: + *+// 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.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 +}); + *
+ * @singleton + */ +Ext.form.VTypes = function(){ + // closure these in so they are only created once. + var alpha = /^[a-zA-Z_]+$/; + var alphanum = /^[a-zA-Z0-9_]+$/; + var email = /^(\w+)([-+.][\w]+)*@(\w[-\w]*\.){1,5}([A-Za-z]){2,4}$/; + var url = /(((https?)|(ftp)):\/\/([\-\w]+\.)+\w{2,3}(\/[%\-\w]+(\.\w{2,})?)*(([\w\-\.\?\\\/+@`~=%!]*)(\.\w{2,})?)*\/?)/i; + + // All these messages and functions are configurable + return { + /** + * 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 + * 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' + * . + * @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); + }, + /** + * 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"' + * @type String + */ + 'emailText' : 'This field should be an e-mail address in the format "user@example.com"', + /** + * 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 + * @type RegExp + */ + 'emailMask' : /[a-z0-9_\.\-@]/i, + + /** + * 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); + }, + /** + * 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"' + * @type String + */ + 'urlText' : 'This field should be a URL in the format "http:/'+'/www.example.com"', + + /** + * 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); + }, + /** + * The error text to display when the alpha validation function returns false. Defaults to: + * 'This field should only contain letters and _' + * @type String + */ + 'alphaText' : 'This field should only contain letters and _', + /** + * The keystroke filter mask to be applied on alpha input. Defaults to: + * /[a-z_]/i + * @type RegExp + */ + 'alphaMask' : /[a-z_]/i, + + /** + * 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); + }, + /** + * The error text to display when the alphanumeric validation function returns false. Defaults to: + * 'This field should only contain letters, numbers and _' + * @type String + */ + 'alphanumText' : 'This field should only contain letters, numbers and _', + /** + * The keystroke filter mask to be applied on alphanumeric input. Defaults to: + * /[a-z0-9_]/i + * @type RegExp + */ + 'alphanumMask' : /[a-z0-9_]/i + }; +}();+// custom Vtype for vtype:'IPAddress' +Ext.apply(Ext.form.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 +}); + *