X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6a7e4474cba9d8be4b2ec445e10f1691f7277c50..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/source/VTypes.html diff --git a/docs/source/VTypes.html b/docs/source/VTypes.html index 27f532fd..a38438a2 100644 --- a/docs/source/VTypes.html +++ b/docs/source/VTypes.html @@ -1,145 +1,152 @@ + - + The source code - - + + + + - -
/*!
- * Ext JS Library 3.2.0
- * Copyright(c) 2006-2010 Ext JS, Inc.
- * licensing@extjs.com
- * http://www.extjs.com/license
- */
-
/** - * @class Ext.form.VTypes - *

This 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 + +

/**
+ * @class Ext.form.field.VTypes
+ * <p>This 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.</p>
+ * <p>To add custom VTypes specify the <code>{@link Ext.form.field.Text#vtype vtype}</code> validation
  * test function, and optionally specify any corresponding error text to display and any keystroke
- * filtering mask to apply. For example:

- *

+ * filtering mask to apply. For example:</p>
+ * <pre><code>
 // 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, {
+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".',
+    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
 });
- * 
- * Another example: - *

+ * </code></pre>
+ * Another example:
+ * <pre><code>
 // custom Vtype for vtype:'IPAddress'
-Ext.apply(Ext.form.VTypes, {
+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
 });
- * 
+ * </code></pre> * @singleton */ -Ext.form.VTypes = function(){ +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; + 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 + singleton: true, + alternateClassName: 'Ext.form.VTypes', + + /** + * 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: + * section of the <a href="http://en.wikipedia.org/wiki/E-mail_address">Wikipedia article on email addresses</a> + * for additional information. This implementation is intended to validate the following emails:<tt> * 'barney@example.de', 'barney.rubble@example.com', 'barney-rubble@example.coop', 'barney+rubble@example.com' - * . + * </tt>. * @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"' + /** + * The error text to display when the email validation function returns false. Defaults to: + * <tt>'This field should be an e-mail address in the format "user@example.com"'</tt> * @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 + '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 + * <tt>/[a-z0-9_\.\-@]/i</tt> * @type RegExp */ - 'emailMask' : /[a-z0-9_\.\-@]/i, + 'emailMask' : /[a-z0-9_\.\-@\+]/i, -
/** - * The function used to validate URLs + /** + * 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"' + /** + * The error text to display when the url validation function returns false. Defaults to: + * <tt>'This field should be a URL in the format "http:/'+'/www.example.com"'</tt> * @type String */ - 'urlText' : 'This field should be a URL in the format "http:/'+'/www.example.com"', - -
/** - * The function used to validate alpha values + '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 _' + /** + * The error text to display when the alpha validation function returns false. Defaults to: + * <tt>'This field should only contain letters and _'</tt> * @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 + /** + * The keystroke filter mask to be applied on alpha input. Defaults to: + * <tt>/[a-z_]/i</tt> * @type RegExp */ 'alphaMask' : /[a-z_]/i, -
/** - * The function used to validate alphanumeric values + /** + * 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 _' + /** + * The error text to display when the alphanumeric validation function returns false. Defaults to: + * <tt>'This field should only contain letters, numbers and _'</tt> * @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 + /** + * The keystroke filter mask to be applied on alphanumeric input. Defaults to: + * <tt>/[a-z0-9_]/i</tt> * @type RegExp */ 'alphanumMask' : /[a-z0-9_]/i }; -}();
+})()); +
- \ No newline at end of file +