add extjs 6.0.1 sources

[extjs.git] / extjs / classic / classic / src / form / field / VTypes.js

/**\r
 * @singleton\r
 * @alternateClassName Ext.form.VTypes\r
 *\r
 * This is a singleton object which contains a set of commonly used field validation functions\r
 * and provides a mechanism for creating reusable custom field validations.\r
 * The following field validation functions are provided out of the box:\r
 *\r
 * - {@link #alpha}\r
 * - {@link #alphanum}\r
 * - {@link #email}\r
 * - {@link #url}\r
 *\r
 * VTypes can be applied to a {@link Ext.form.field.Text Text Field} using the `{@link Ext.form.field.Text#vtype vtype}` configuration:\r
 *\r
 *     Ext.create('Ext.form.field.Text', {\r
 *         fieldLabel: 'Email Address',\r
 *         name: 'email',\r
 *         vtype: 'email' // applies email validation rules to this field\r
 *     });\r
 *\r
 * To create custom VTypes:\r
 *\r
 *     // custom Vtype for vtype:'time'\r
 *     Ext.define('Override.form.field.VTypes', {\r
 *         override: 'Ext.form.field.VTypes',\r
 *\r
 *         // vtype validation function\r
 *         time: function(value) {\r
 *             return this.timeRe.test(value);\r
 *         },\r
 *         // RegExp for the value to be tested against within the validation function\r
 *         timeRe: /^([1-9]|1[0-9]):([0-5][0-9])(\s[a|p]m)$/i,\r
 *         // vtype Text property: The error text to display when the validation function returns false\r
 *         timeText: 'Not a valid time.  Must be in the format "12:34 PM".',\r
 *         // vtype Mask property: The keystroke filter mask\r
 *         timeMask: /[\d\s:amp]/i\r
 *     });\r
 *\r
 * In the above example the `time` function is the validator that will run when field validation occurs,\r
 * `timeText` is the error message, and `timeMask` limits what characters can be typed into the field.\r
 * Note that the `Text` and `Mask` functions must begin with the same name as the validator function.\r
 *\r
 * Using a custom validator is the same as using one of the build-in validators - just use the name of the validator function\r
 * as the `{@link Ext.form.field.Text#vtype vtype}` configuration on a {@link Ext.form.field.Text Text Field}:\r
 *\r
 *     Ext.create('Ext.form.field.Text', {\r
 *         fieldLabel: 'Departure Time',\r
 *         name: 'departureTime',\r
 *         vtype: 'time' // applies custom time validation rules to this field\r
 *     });\r
 *\r
 * Another example of a custom validator:\r
 *\r
 *     // custom Vtype for vtype:'IPAddress'\r
 *     Ext.define('Override.form.field.VTypes', {\r
 *         override: 'Ext.form.field.VTypes',\r
 *\r
 *         IPAddress:  function(value) {\r
 *             return this.IPAddressRe.test(value);\r
 *         },\r
 *         IPAddressRe: /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/,\r
 *         IPAddressText: 'Must be a numeric IP address',\r
 *         IPAddressMask: /[\d\.]/i\r
 *     });\r
 *\r
 * It's important to note that using {@link Ext#define Ext.define()} with the {@link Ext.Class#override override} property\r
 * means that the custom validator function as well as `Text` and `Mask` fields are added as properties\r
 * of the `Ext.form.field.VTypes` singleton.\r
 */\r
Ext.define('Ext.form.field.VTypes', (function(){\r
    // closure these in so they are only created once.\r
    var alpha = /^[a-zA-Z_]+$/,\r
        alphanum = /^[a-zA-Z0-9_]+$/,\r
\r
        // http://en.wikipedia.org/wiki/Email_address#Local_part\r
        // http://stackoverflow.com/a/2049510\r
        // http://isemail.info/\r
        // http://blog.stevenlevithan.com/archives/capturing-vs-non-capturing-groups\r
        //\r
        // 1. Can begin with a double-quote ONLY IF the local part also ends in a double-quote.\r
        // 2. Can NOT BEGIN with a period.\r
        // 3. Can NOT END with a period.\r
        // 4. Can not have MORE THAN ONE period in a row.\r
        //\r
        // Let's break this down:\r
        //\r
        // ^(")?\r
        // The local part may begin with double-quotes, but only if it also ends with it.\r
        // See the back-reference.  Capturing.\r
        //\r
        // (?:[^\."])\r
        // Here we've defined that the local part cannot begin with a period or a double-quote.  Non-capturing.\r
        //\r
        // (?:(?:[\.])?(?:[\w\-!#$%&'*+/=?^_`{|}~]))*\r
        // After the first character is matched, the regex ensures that there is not more than one period\r
        // in a row.  Then, this nested grouping allows for zero or more of the accepted characters.\r
        // NOTE that this also ensures that any character not defined in the character class\r
        // is invalid as an ending character for the local part (such as the period).\r
        //\r
        // \1@\r
        // The local part of the address is a backreference to the first (and only) capturing group that allows\r
        // for a double-quote to wrap the local part of an email address.\r
        email = /^(")?(?:[^\."\s])(?:(?:[\.])?(?:[\w\-!#$%&'*+/=?^_`{|}~]))*\1@(\w[\-\w]*\.){1,5}([A-Za-z]){2,6}$/,\r
        url = /(((^https?)|(^ftp)):\/\/((([\-\w]+\.)+\w{2,3}(\/[%\-\w]+(\.\w{2,})?)*(([\w\-\.\?\\\/+@&#;`~=%!]*)(\.\w{2,})?)*)|(localhost|LOCALHOST))\/?)/i;\r
\r
    // All these messages and functions are configurable\r
    return {\r
        singleton: true,\r
        alternateClassName: 'Ext.form.VTypes',\r
\r
        /**\r
         * The function used to validate email addresses. Note that complete validation per the email RFC\r
         * specifications is very complex and beyond the scope of this class, although this function can be\r
         * overridden if a more comprehensive validation scheme is desired. See the validation section\r
         * of the [Wikipedia article on email addresses][1] for additional information. This implementation is\r
         * intended to validate the following types of emails:\r
         *\r
         * - `barney@example.de`\r
         * - `barney.rubble@example.com`\r
         * - `barney-rubble@example.coop`\r
         * - `barney+rubble@example.com`\r
         * - `barney'rubble@example.com`\r
         * - `b.arne.y_r.ubbl.e@example.com`\r
         * - `barney4rubble@example.com`\r
         * - `barney4rubble!@example.com`\r
         * - `_barney+rubble@example.com`\r
         * - `"barney+rubble"@example.com`\r
         *\r
         * [1]: http://en.wikipedia.org/wiki/E-mail_address\r
         *\r
         * @param {String} value The email address\r
         * @return {Boolean} true if the RegExp test passed, and false if not.\r
         */\r
        'email' : function(value){\r
            return email.test(value);\r
        },\r
        //<locale>\r
        /**\r
         * @property {String} emailText\r
         * The error text to display when the email validation function returns false.\r
         * Defaults to: 'This field should be an e-mail address in the format "user@example.com"'\r
         */\r
        'emailText' : 'This field should be an e-mail address in the format "user@example.com"',\r
        //</locale>\r
        /**\r
         * @property {RegExp} emailMask\r
         * The keystroke filter mask to be applied on email input. See the {@link #email} method for information about\r
         * more complex email validation. Defaults to: /[a-z0-9_\.\-@]/i\r
         */\r
        'emailMask' : /[\w.\-@'"!#$%&'*+/=?^_`{|}~]/i,\r
\r
        /**\r
         * The function used to validate URLs\r
         * @param {String} value The URL\r
         * @return {Boolean} true if the RegExp test passed, and false if not.\r
         */\r
        'url' : function(value){\r
            return url.test(value);\r
        },\r
        //<locale>\r
        /**\r
         * @property {String} urlText\r
         * The error text to display when the url validation function returns false.\r
         * Defaults to: 'This field should be a URL in the format "http:/'+'/www.example.com"'\r
         */\r
        'urlText' : 'This field should be a URL in the format "http:/'+'/www.example.com"',\r
        //</locale>\r
\r
        /**\r
         * The function used to validate alpha values\r
         * @param {String} value The value\r
         * @return {Boolean} true if the RegExp test passed, and false if not.\r
         */\r
        'alpha' : function(value){\r
            return alpha.test(value);\r
        },\r
        //<locale>\r
        /**\r
         * @property {String} alphaText\r
         * The error text to display when the alpha validation function returns false.\r
         * Defaults to: 'This field should only contain letters and _'\r
         */\r
        'alphaText' : 'This field should only contain letters and _',\r
        //</locale>\r
        /**\r
         * @property {RegExp} alphaMask\r
         * The keystroke filter mask to be applied on alpha input. Defaults to: /[a-z_]/i\r
         */\r
        'alphaMask' : /[a-z_]/i,\r
\r
        /**\r
         * The function used to validate alphanumeric values\r
         * @param {String} value The value\r
         * @return {Boolean} true if the RegExp test passed, and false if not.\r
         */\r
        'alphanum' : function(value){\r
            return alphanum.test(value);\r
        },\r
        //<locale>\r
        /**\r
         * @property {String} alphanumText\r
         * The error text to display when the alphanumeric validation function returns false.\r
         * Defaults to: 'This field should only contain letters, numbers and _'\r
         */\r
        'alphanumText' : 'This field should only contain letters, numbers and _',\r
        //</locale>\r
        /**\r
         * @property {RegExp} alphanumMask\r
         * The keystroke filter mask to be applied on alphanumeric input. Defaults to: /[a-z0-9_]/i\r
         */\r
        'alphanumMask' : /[a-z0-9_]/i\r
    };\r
}()));\r