/** * @class Ext.form.TextField * @extends Ext.form.Field *

Basic text field. Can be used as a direct replacement for traditional text inputs, * or as the base class for more sophisticated input controls (like {@link Ext.form.TextArea} * and {@link Ext.form.ComboBox}).

*

Validation

*

The validation procedure is described in the documentation for {@link #validateValue}.

*

Alter Validation Behavior

*

Validation behavior for each field can be configured:

*
* * @constructor Creates a new TextField * @param {Object} config Configuration options * * @xtype textfield */ Ext.form.TextField = Ext.extend(Ext.form.Field, {
/** * @cfg {String} vtypeText A custom error message to display in place of the default message provided * for the {@link #vtype} currently set for this field (defaults to ''). Note: * only applies if {@link #vtype} is set, else ignored. */
/** * @cfg {RegExp} stripCharsRe A JavaScript RegExp object used to strip unwanted content from the value * before validation (defaults to null). */
/** * @cfg {Boolean} grow true if this field should automatically grow and shrink to its content * (defaults to false) */ grow : false,
/** * @cfg {Number} growMin The minimum width to allow when {@link #grow} = true (defaults * to 30) */ growMin : 30,
/** * @cfg {Number} growMax The maximum width to allow when {@link #grow} = true (defaults * to 800) */ growMax : 800,
/** * @cfg {String} vtype A validation type name as defined in {@link Ext.form.VTypes} (defaults to null) */ vtype : null,
/** * @cfg {RegExp} maskRe An input mask regular expression that will be used to filter keystrokes that do * not match (defaults to null) */ maskRe : null,
/** * @cfg {Boolean} disableKeyFilter Specify true to disable input keystroke filtering (defaults * to false) */ disableKeyFilter : false,
/** * @cfg {Boolean} allowBlank Specify false to validate that the value's length is > 0 (defaults to * true) */ allowBlank : true,
/** * @cfg {Number} minLength Minimum input field length required (defaults to 0) */ minLength : 0,
/** * @cfg {Number} maxLength Maximum input field length allowed by validation (defaults to Number.MAX_VALUE). * This behavior is intended to provide instant feedback to the user by improving usability to allow pasting * and editing or overtyping and back tracking. To restrict the maximum number of characters that can be * entered into the field use {@link Ext.form.Field#autoCreate autoCreate} to add * any attributes you want to a field, for example:

var myField = new Ext.form.NumberField({
    id: 'mobile',
    anchor:'90%',
    fieldLabel: 'Mobile',
    maxLength: 16, // for validation
    autoCreate: {tag: 'input', type: 'text', size: '20', autocomplete: 'off', maxlength: '10'}
});
*/ maxLength : Number.MAX_VALUE,
/** * @cfg {String} minLengthText Error text to display if the {@link #minLength minimum length} * validation fails (defaults to 'The minimum length for this field is {minLength}') */ minLengthText : 'The minimum length for this field is {0}',
/** * @cfg {String} maxLengthText Error text to display if the {@link #maxLength maximum length} * validation fails (defaults to 'The maximum length for this field is {maxLength}') */ maxLengthText : 'The maximum length for this field is {0}',
/** * @cfg {Boolean} selectOnFocus true to automatically select any existing field text when the field * receives input focus (defaults to false) */ selectOnFocus : false,
/** * @cfg {String} blankText The error text to display if the {@link #allowBlank} validation * fails (defaults to 'This field is required') */ blankText : 'This field is required',
/** * @cfg {Function} validator *

A custom validation function to be called during field validation ({@link #validateValue}) * (defaults to null). If specified, this function will be called first, allowing the * developer to override the default validation process.

*

This function will be passed the following Parameters:

*
*

This function is to Return:

*
*/ validator : null,
/** * @cfg {RegExp} regex A JavaScript RegExp object to be tested against the field value during validation * (defaults to null). If the test fails, the field will be marked invalid using * {@link #regexText}. */ regex : null,
/** * @cfg {String} regexText The error text to display if {@link #regex} is used and the * test fails during validation (defaults to '') */ regexText : '',
/** * @cfg {String} emptyText The default text to place into an empty field (defaults to null). * Note: that this value will be submitted to the server if this field is enabled and configured * with a {@link #name}. */ emptyText : null,
/** * @cfg {String} emptyClass The CSS class to apply to an empty field to style the {@link #emptyText} * (defaults to 'x-form-empty-field'). This class is automatically added and removed as needed * depending on the current field value. */ emptyClass : 'x-form-empty-field',
/** * @cfg {Boolean} enableKeyEvents true to enable the proxying of key events for the HTML input * field (defaults to false) */ initComponent : function(){ Ext.form.TextField.superclass.initComponent.call(this); this.addEvents(
/** * @event autosize * Fires when the {@link #autoSize} function is triggered. The field may or * may not have actually changed size according to the default logic, but this event provides * a hook for the developer to apply additional logic at runtime to resize the field if needed. * @param {Ext.form.Field} this This text field * @param {Number} width The new field width */ 'autosize',
/** * @event keydown * Keydown input field event. This event only fires if {@link #enableKeyEvents} * is set to true. * @param {Ext.form.TextField} this This text field * @param {Ext.EventObject} e */ 'keydown',
/** * @event keyup * Keyup input field event. This event only fires if {@link #enableKeyEvents} * is set to true. * @param {Ext.form.TextField} this This text field * @param {Ext.EventObject} e */ 'keyup',
/** * @event keypress * Keypress input field event. This event only fires if {@link #enableKeyEvents} * is set to true. * @param {Ext.form.TextField} this This text field * @param {Ext.EventObject} e */ 'keypress' ); }, // private initEvents : function(){ Ext.form.TextField.superclass.initEvents.call(this); if(this.validationEvent == 'keyup'){ this.validationTask = new Ext.util.DelayedTask(this.validate, this); this.mon(this.el, 'keyup', this.filterValidation, this); } else if(this.validationEvent !== false && this.validationEvent != 'blur'){ this.mon(this.el, this.validationEvent, this.validate, this, {buffer: this.validationDelay}); } if(this.selectOnFocus || this.emptyText){ this.mon(this.el, 'mousedown', this.onMouseDown, this); if(this.emptyText){ this.applyEmptyText(); } } if(this.maskRe || (this.vtype && this.disableKeyFilter !== true && (this.maskRe = Ext.form.VTypes[this.vtype+'Mask']))){ this.mon(this.el, 'keypress', this.filterKeys, this); } if(this.grow){ this.mon(this.el, 'keyup', this.onKeyUpBuffered, this, {buffer: 50}); this.mon(this.el, 'click', this.autoSize, this); } if(this.enableKeyEvents){ this.mon(this.el, { scope: this, keyup: this.onKeyUp, keydown: this.onKeyDown, keypress: this.onKeyPress }); } }, onMouseDown: function(e){ if(!this.hasFocus){ this.mon(this.el, 'mouseup', Ext.emptyFn, this, { single: true, preventDefault: true }); } }, processValue : function(value){ if(this.stripCharsRe){ var newValue = value.replace(this.stripCharsRe, ''); if(newValue !== value){ this.setRawValue(newValue); return newValue; } } return value; }, filterValidation : function(e){ if(!e.isNavKeyPress()){ this.validationTask.delay(this.validationDelay); } }, //private onDisable: function(){ Ext.form.TextField.superclass.onDisable.call(this); if(Ext.isIE){ this.el.dom.unselectable = 'on'; } }, //private onEnable: function(){ Ext.form.TextField.superclass.onEnable.call(this); if(Ext.isIE){ this.el.dom.unselectable = ''; } }, // private onKeyUpBuffered : function(e){ if(this.doAutoSize(e)){ this.autoSize(); } }, // private doAutoSize : function(e){ return !e.isNavKeyPress(); }, // private onKeyUp : function(e){ this.fireEvent('keyup', this, e); }, // private onKeyDown : function(e){ this.fireEvent('keydown', this, e); }, // private onKeyPress : function(e){ this.fireEvent('keypress', this, e); },
/** * Resets the current field value to the originally-loaded value and clears any validation messages. * Also adds {@link #emptyText} and {@link #emptyClass} if the * original value was blank. */ reset : function(){ Ext.form.TextField.superclass.reset.call(this); this.applyEmptyText(); }, applyEmptyText : function(){ if(this.rendered && this.emptyText && this.getRawValue().length < 1 && !this.hasFocus){ this.setRawValue(this.emptyText); this.el.addClass(this.emptyClass); } }, // private preFocus : function(){ var el = this.el; if(this.emptyText){ if(el.dom.value == this.emptyText){ this.setRawValue(''); } el.removeClass(this.emptyClass); } if(this.selectOnFocus){ el.dom.select(); } }, // private postBlur : function(){ this.applyEmptyText(); }, // private filterKeys : function(e){ if(e.ctrlKey){ return; } var k = e.getKey(); if(Ext.isGecko && (e.isNavKeyPress() || k == e.BACKSPACE || (k == e.DELETE && e.button == -1))){ return; } var cc = String.fromCharCode(e.getCharCode()); if(!Ext.isGecko && e.isSpecialKey() && !cc){ return; } if(!this.maskRe.test(cc)){ e.stopEvent(); } }, setValue : function(v){ if(this.emptyText && this.el && !Ext.isEmpty(v)){ this.el.removeClass(this.emptyClass); } Ext.form.TextField.superclass.setValue.apply(this, arguments); this.applyEmptyText(); this.autoSize(); return this; },
/** *

Validates a value according to the field's validation rules and marks the field as invalid * if the validation fails. Validation rules are processed in the following order:

*