3 * Copyright(c) 2006-2009 Ext JS, LLC
5 * http://www.extjs.com/license
8 * @class Ext.form.TextField
9 * @extends Ext.form.Field
10 * <p>Basic text field. Can be used as a direct replacement for traditional text inputs,
11 * or as the base class for more sophisticated input controls (like {@link Ext.form.TextArea}
12 * and {@link Ext.form.ComboBox}).</p>
13 * <p><b><u>Validation</u></b></p>
14 * <p>Field validation is processed in a particular order. If validation fails at any particular
15 * step the validation routine halts.</p>
16 * <div class="mdetail-params"><ul>
17 * <li><b>1. Field specific validator</b>
18 * <div class="sub-desc">
19 * <p>If a field is configured with a <code>{@link Ext.form.TextField#validator validator}</code> function,
20 * it will be passed the current field value. The <code>{@link Ext.form.TextField#validator validator}</code>
21 * function is expected to return boolean <tt>true</tt> if the value is valid or return a string to
22 * represent the invalid message if invalid.</p>
24 * <li><b>2. Built in Validation</b>
25 * <div class="sub-desc">
26 * <p>Basic validation is affected with the following configuration properties:</p>
28 * <u>Validation</u> <u>Invalid Message</u>
29 * <code>{@link Ext.form.TextField#allowBlank allowBlank} {@link Ext.form.TextField#emptyText emptyText}</code>
30 * <code>{@link Ext.form.TextField#minLength minLength} {@link Ext.form.TextField#minLengthText minLengthText}</code>
31 * <code>{@link Ext.form.TextField#maxLength maxLength} {@link Ext.form.TextField#maxLengthText maxLengthText}</code>
34 * <li><b>3. Preconfigured Validation Types (VTypes)</b>
35 * <div class="sub-desc">
36 * <p>Using VTypes offers a convenient way to reuse validation. If a field is configured with a
37 * <code>{@link Ext.form.TextField#vtype vtype}</code>, the corresponding {@link Ext.form.VTypes VTypes}
38 * validation function will be used for validation. If invalid, either the field's
39 * <code>{@link Ext.form.TextField#vtypeText vtypeText}</code> or the VTypes vtype Text property will be
40 * used for the invalid message. Keystrokes on the field will be filtered according to the VTypes
41 * vtype Mask property.</p>
43 * <li><b>4. Field specific regex test</b>
44 * <div class="sub-desc">
45 * <p>Each field may also specify a <code>{@link Ext.form.TextField#regex regex}</code> test.
46 * The invalid message for this test is configured with
47 * <code>{@link Ext.form.TextField#regexText regexText}</code>.</p>
49 * <li><b>Alter Validation Behavior</b>
50 * <div class="sub-desc">
51 * <p>Validation behavior for each field can be configured:</p><ul>
52 * <li><code>{@link Ext.form.TextField#invalidText invalidText}</code> : the default validation message to
53 * show if any validation step above does not provide a message when invalid</li>
54 * <li><code>{@link Ext.form.TextField#maskRe maskRe}</code> : filter out keystrokes before any validation occurs</li>
55 * <li><code>{@link Ext.form.TextField#stripCharsRe stripCharsRe}</code> : filter characters after being typed in,
56 * but before being validated</li>
57 * <li><code>{@link Ext.form.Field#invalidClass invalidClass}</code> : alternate style when invalid</li>
58 * <li><code>{@link Ext.form.Field#validateOnBlur validateOnBlur}</code>,
59 * <code>{@link Ext.form.Field#validationDelay validationDelay}</code>, and
60 * <code>{@link Ext.form.Field#validationEvent validationEvent}</code> : modify how/when validation is triggered</li>
65 * Creates a new TextField
66 * @param {Object} config Configuration options
69 Ext.form.TextField = Ext.extend(Ext.form.Field, {
71 * @cfg {String} vtypeText A custom error message to display in place of the default message provided
72 * for the <b><code>{@link #vtype}</code></b> currently set for this field (defaults to <tt>''</tt>). <b>Note</b>:
73 * only applies if <b><code>{@link #vtype}</code></b> is set, else ignored.
76 * @cfg {RegExp} stripCharsRe A JavaScript RegExp object used to strip unwanted content from the value
77 * before validation (defaults to <tt>null</tt>).
80 * @cfg {Boolean} grow <tt>true</tt> if this field should automatically grow and shrink to its content
81 * (defaults to <tt>false</tt>)
85 * @cfg {Number} growMin The minimum width to allow when <code><b>{@link #grow}</b> = true</code> (defaults
90 * @cfg {Number} growMax The maximum width to allow when <code><b>{@link #grow}</b> = true</code> (defaults
95 * @cfg {String} vtype A validation type name as defined in {@link Ext.form.VTypes} (defaults to <tt>null</tt>)
99 * @cfg {RegExp} maskRe An input mask regular expression that will be used to filter keystrokes that do
100 * not match (defaults to <tt>null</tt>)
104 * @cfg {Boolean} disableKeyFilter Specify <tt>true</tt> to disable input keystroke filtering (defaults
107 disableKeyFilter : false,
109 * @cfg {Boolean} allowBlank Specify <tt>false</tt> to validate that the value's length is > 0 (defaults to
114 * @cfg {Number} minLength Minimum input field length required (defaults to <tt>0</tt>)
118 * @cfg {Number} maxLength Maximum input field length allowed by validation (defaults to Number.MAX_VALUE).
119 * This behavior is intended to provide instant feedback to the user by improving usability to allow pasting
120 * and editing or overtyping and back tracking. To restrict the maximum number of characters that can be
121 * entered into the field use <tt><b>{@link Ext.form.Field#autoCreate autoCreate}</b></tt> to add
122 * any attributes you want to a field, for example:<pre><code>
123 var myField = new Ext.form.NumberField({
126 fieldLabel: 'Mobile',
127 maxLength: 16, // for validation
128 autoCreate: {tag: 'input', type: 'text', size: '20', autocomplete: 'off', maxlength: '10'}
132 maxLength : Number.MAX_VALUE,
134 * @cfg {String} minLengthText Error text to display if the <b><tt>{@link #minLength minimum length}</tt></b>
135 * validation fails (defaults to <tt>'The minimum length for this field is {minLength}'</tt>)
137 minLengthText : 'The minimum length for this field is {0}',
139 * @cfg {String} maxLengthText Error text to display if the <b><tt>{@link #maxLength maximum length}</tt></b>
140 * validation fails (defaults to <tt>'The maximum length for this field is {maxLength}'</tt>)
142 maxLengthText : 'The maximum length for this field is {0}',
144 * @cfg {Boolean} selectOnFocus <tt>true</tt> to automatically select any existing field text when the field
145 * receives input focus (defaults to <tt>false</tt>)
147 selectOnFocus : false,
149 * @cfg {String} blankText The error text to display if the <b><tt>{@link #allowBlank}</tt></b> validation
150 * fails (defaults to <tt>'This field is required'</tt>)
152 blankText : 'This field is required',
154 * @cfg {Function} validator A custom validation function to be called during field validation
155 * (defaults to <tt>null</tt>). If specified, this function will be called first, allowing the
156 * developer to override the default validation process. This function will be passed the current
157 * field value and expected to return boolean <tt>true</tt> if the value is valid or a string
158 * error message if invalid.
162 * @cfg {RegExp} regex A JavaScript RegExp object to be tested against the field value during validation
163 * (defaults to <tt>null</tt>). If the test fails, the field will be marked invalid using
164 * <b><tt>{@link #regexText}</tt></b>.
168 * @cfg {String} regexText The error text to display if <b><tt>{@link #regex}</tt></b> is used and the
169 * test fails during validation (defaults to <tt>''</tt>)
173 * @cfg {String} emptyText The default text to place into an empty field (defaults to <tt>null</tt>).
174 * <b>Note</b>: that this value will be submitted to the server if this field is enabled and configured
175 * with a {@link #name}.
179 * @cfg {String} emptyClass The CSS class to apply to an empty field to style the <b><tt>{@link #emptyText}</tt></b>
180 * (defaults to <tt>'x-form-empty-field'</tt>). This class is automatically added and removed as needed
181 * depending on the current field value.
183 emptyClass : 'x-form-empty-field',
186 * @cfg {Boolean} enableKeyEvents <tt>true</tt> to enable the proxying of key events for the HTML input
187 * field (defaults to <tt>false</tt>)
190 initComponent : function(){
191 Ext.form.TextField.superclass.initComponent.call(this);
195 * Fires when the <tt><b>{@link #autoSize}</b></tt> function is triggered. The field may or
196 * may not have actually changed size according to the default logic, but this event provides
197 * a hook for the developer to apply additional logic at runtime to resize the field if needed.
198 * @param {Ext.form.Field} this This text field
199 * @param {Number} width The new field width
205 * Keydown input field event. This event only fires if <tt><b>{@link #enableKeyEvents}</b></tt>
207 * @param {Ext.form.TextField} this This text field
208 * @param {Ext.EventObject} e
213 * Keyup input field event. This event only fires if <tt><b>{@link #enableKeyEvents}</b></tt>
215 * @param {Ext.form.TextField} this This text field
216 * @param {Ext.EventObject} e
221 * Keypress input field event. This event only fires if <tt><b>{@link #enableKeyEvents}</b></tt>
223 * @param {Ext.form.TextField} this This text field
224 * @param {Ext.EventObject} e
231 initEvents : function(){
232 Ext.form.TextField.superclass.initEvents.call(this);
233 if(this.validationEvent == 'keyup'){
234 this.validationTask = new Ext.util.DelayedTask(this.validate, this);
235 this.mon(this.el, 'keyup', this.filterValidation, this);
237 else if(this.validationEvent !== false){
238 this.mon(this.el, this.validationEvent, this.validate, this, {buffer: this.validationDelay});
240 if(this.selectOnFocus || this.emptyText){
241 this.on('focus', this.preFocus, this);
243 this.mon(this.el, 'mousedown', function(){
245 this.el.on('mouseup', function(e){
247 }, this, {single:true});
252 this.on('blur', this.postBlur, this);
253 this.applyEmptyText();
256 if(this.maskRe || (this.vtype && this.disableKeyFilter !== true && (this.maskRe = Ext.form.VTypes[this.vtype+'Mask']))){
257 this.mon(this.el, 'keypress', this.filterKeys, this);
260 this.mon(this.el, 'keyup', this.onKeyUpBuffered, this, {buffer: 50});
261 this.mon(this.el, 'click', this.autoSize, this);
263 if(this.enableKeyEvents){
264 this.mon(this.el, 'keyup', this.onKeyUp, this);
265 this.mon(this.el, 'keydown', this.onKeyDown, this);
266 this.mon(this.el, 'keypress', this.onKeyPress, this);
270 processValue : function(value){
271 if(this.stripCharsRe){
272 var newValue = value.replace(this.stripCharsRe, '');
273 if(newValue !== value){
274 this.setRawValue(newValue);
281 filterValidation : function(e){
282 if(!e.isNavKeyPress()){
283 this.validationTask.delay(this.validationDelay);
288 onDisable: function(){
289 Ext.form.TextField.superclass.onDisable.call(this);
291 this.el.dom.unselectable = 'on';
296 onEnable: function(){
297 Ext.form.TextField.superclass.onEnable.call(this);
299 this.el.dom.unselectable = '';
304 onKeyUpBuffered : function(e){
305 if(!e.isNavKeyPress()){
311 onKeyUp : function(e){
312 this.fireEvent('keyup', this, e);
316 onKeyDown : function(e){
317 this.fireEvent('keydown', this, e);
321 onKeyPress : function(e){
322 this.fireEvent('keypress', this, e);
326 * Resets the current field value to the originally-loaded value and clears any validation messages.
327 * Also adds <tt><b>{@link #emptyText}</b></tt> and <tt><b>{@link #emptyClass}</b></tt> if the
328 * original value was blank.
331 Ext.form.TextField.superclass.reset.call(this);
332 this.applyEmptyText();
335 applyEmptyText : function(){
336 if(this.rendered && this.emptyText && this.getRawValue().length < 1 && !this.hasFocus){
337 this.setRawValue(this.emptyText);
338 this.el.addClass(this.emptyClass);
343 preFocus : function(){
346 if(el.dom.value == this.emptyText){
347 this.setRawValue('');
349 el.removeClass(this.emptyClass);
351 if(this.selectOnFocus){
354 }).defer(this.inEditor && Ext.isIE ? 50 : 0);
359 postBlur : function(){
360 this.applyEmptyText();
364 filterKeys : function(e){
365 // special keys don't generate charCodes, so leave them alone
366 if(e.ctrlKey || e.isSpecialKey()){
370 if(!this.maskRe.test(String.fromCharCode(e.getCharCode()))){
375 setValue : function(v){
376 if(this.emptyText && this.el && !Ext.isEmpty(v)){
377 this.el.removeClass(this.emptyClass);
379 Ext.form.TextField.superclass.setValue.apply(this, arguments);
380 this.applyEmptyText();
386 * Validates a value according to the field's validation rules and marks the field as invalid
387 * if the validation fails
388 * @param {Mixed} value The value to validate
389 * @return {Boolean} True if the value is valid, else false
391 validateValue : function(value){
392 if(Ext.isFunction(this.validator)){
393 var msg = this.validator(value);
395 this.markInvalid(msg);
399 if(value.length < 1 || value === this.emptyText){ // if it's blank
404 this.markInvalid(this.blankText);
408 if(value.length < this.minLength){
409 this.markInvalid(String.format(this.minLengthText, this.minLength));
412 if(value.length > this.maxLength){
413 this.markInvalid(String.format(this.maxLengthText, this.maxLength));
417 var vt = Ext.form.VTypes;
418 if(!vt[this.vtype](value, this)){
419 this.markInvalid(this.vtypeText || vt[this.vtype +'Text']);
423 if(this.regex && !this.regex.test(value)){
424 this.markInvalid(this.regexText);
431 * Selects text in this field
432 * @param {Number} start (optional) The index where the selection should start (defaults to 0)
433 * @param {Number} end (optional) The index where the selection should end (defaults to the text length)
435 selectText : function(start, end){
436 var v = this.getRawValue();
439 start = start === undefined ? 0 : start;
440 end = end === undefined ? v.length : end;
442 if(d.setSelectionRange){
443 d.setSelectionRange(start, end);
444 }else if(d.createTextRange){
445 var range = d.createTextRange();
446 range.moveStart('character', start);
447 range.moveEnd('character', end-v.length);
450 doFocus = Ext.isGecko || Ext.isOpera;
460 * Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.
461 * This only takes effect if <tt><b>{@link #grow}</b> = true</tt>, and fires the {@link #autosize} event.
463 autoSize : function(){
464 if(!this.grow || !this.rendered){
468 this.metrics = Ext.util.TextMetrics.createInstance(this.el);
471 var v = el.dom.value;
472 var d = document.createElement('div');
473 d.appendChild(document.createTextNode(v));
478 var w = Math.min(this.growMax, Math.max(this.metrics.getWidth(v) + /* add extra padding */ 10, this.growMin));
480 this.fireEvent('autosize', this, w);
483 onDestroy: function(){
484 if(this.validationTask){
485 this.validationTask.cancel();
486 this.validationTask = null;
488 Ext.form.TextField.superclass.onDestroy.call(this);
491 Ext.reg('textfield', Ext.form.TextField);