git.roojs.org Git - roojs1/blob - Roo/form/TextField.js

   1 /*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * <script type="text/javascript">
  10  */
  11
  12
  13 /**
  14  * @class Roo.form.TextField
  15  * @extends Roo.form.Field
  16  * Basic text field.  Can be used as a direct replacement for traditional text inputs, or as the base
  17  * class for more sophisticated input controls (like {@link Roo.form.TextArea} and {@link Roo.form.ComboBox}).
  18  * @constructor
  19  * Creates a new TextField
  20  * @param {Object} config Configuration options
  21  */
  22 Roo.form.TextField = function(config){
  23     Roo.form.TextField.superclass.constructor.call(this, config);
  24     this.addEvents({
  25         /**
  26          * @event autosize
  27          * Fires when the autosize function is triggered.  The field may or may not have actually changed size
  28          * according to the default logic, but this event provides a hook for the developer to apply additional
  29          * logic at runtime to resize the field if needed.
  30              * @param {Roo.form.Field} this This text field
  31              * @param {Number} width The new field width
  32              */
  33         autosize : true
  34     });
  35 };
  36
  37 Roo.extend(Roo.form.TextField, Roo.form.Field,  {
  38     /**
  39      * @cfg {Boolean} grow True if this field should automatically grow and shrink to its content
  40      */
  41     grow : false,
  42     /**
  43      * @cfg {Number} growMin The minimum width to allow when grow = true (defaults to 30)
  44      */
  45     growMin : 30,
  46     /**
  47      * @cfg {Number} growMax The maximum width to allow when grow = true (defaults to 800)
  48      */
  49     growMax : 800,
  50     /**
  51      * @cfg {String} vtype A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)
  52      */
  53     vtype : null,
  54     /**
  55      * @cfg {String} maskRe An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)
  56      */
  57     maskRe : null,
  58     /**
  59      * @cfg {Boolean} disableKeyFilter True to disable input keystroke filtering (defaults to false)
  60      */
  61     disableKeyFilter : false,
  62     /**
  63      * @cfg {Boolean} allowBlank False to validate that the value length > 0 (defaults to true)
  64      */
  65     allowBlank : true,
  66     /**
  67      * @cfg {Number} minLength Minimum input field length required (defaults to 0)
  68      */
  69     minLength : 0,
  70     /**
  71      * @cfg {Number} maxLength Maximum input field length allowed (defaults to Number.MAX_VALUE)
  72      */
  73     maxLength : Number.MAX_VALUE,
  74     /**
  75      * @cfg {String} minLengthText Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minLength}")
  76      */
  77     minLengthText : "The minimum length for this field is {0}",
  78     /**
  79      * @cfg {String} maxLengthText Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxLength}")
  80      */
  81     maxLengthText : "The maximum length for this field is {0}",
  82     /**
  83      * @cfg {Boolean} selectOnFocus True to automatically select any existing field text when the field receives input focus (defaults to false)
  84      */
  85     selectOnFocus : false,
  86     /**
  87      * @cfg {String} blankText Error text to display if the allow blank validation fails (defaults to "This field is required")
  88      */
  89     blankText : "This field is required",
  90     /**
  91      * @cfg {Function} validator A custom validation function to be called during field validation (defaults to null).
  92      * If available, this function will be called only after the basic validators all return true, and will be passed the
  93      * current field value and expected to return boolean true if the value is valid or a string error message if invalid.
  94      */
  95     validator : null,
  96     /**
  97      * @cfg {RegExp} regex A JavaScript RegExp object to be tested against the field value during validation (defaults to null).
  98      * If available, this regex will be evaluated only after the basic validators all return true, and will be passed the
  99      * current field value.  If the test fails, the field will be marked invalid using {@link #regexText}.
 100      */
 101     regex : null,
 102     /**
 103      * @cfg {String} regexText The error text to display if {@link #regex} is used and the test fails during validation (defaults to "")
 104      */
 105     regexText : "",
 106     /**
 107      * @cfg {String} emptyText The default text to display in an empty field (defaults to null).
 108      */
 109     emptyText : null,
 110     /**
 111      * @cfg {String} emptyClass The CSS class to apply to an empty field to style the {@link #emptyText} (defaults to
 112      * 'x-form-empty-field').  This class is automatically added and removed as needed depending on the current field value.
 113      */
 114     emptyClass : 'x-form-empty-field',
 115
 116     // private
 117     initEvents : function(){
 118         Roo.form.TextField.superclass.initEvents.call(this);
 119         if(this.validationEvent == 'keyup'){
 120             this.validationTask = new Roo.util.DelayedTask(this.validate, this);
 121             this.el.on('keyup', this.filterValidation, this);
 122         }
 123         else if(this.validationEvent !== false){
 124             this.el.on(this.validationEvent, this.validate, this, {buffer: this.validationDelay});
 125         }
 126         if(this.selectOnFocus || this.emptyText){
 127             this.on("focus", this.preFocus, this);
 128             if(this.emptyText){
 129                 this.on('blur', this.postBlur, this);
 130                 this.applyEmptyText();
 131             }
 132         }
 133         if(this.maskRe || (this.vtype && this.disableKeyFilter !== true && (this.maskRe = Roo.form.VTypes[this.vtype+'Mask']))){
 134             this.el.on("keypress", this.filterKeys, this);
 135         }
 136         if(this.grow){
 137             this.el.on("keyup", this.onKeyUp,  this, {buffer:50});
 138             this.el.on("click", this.autoSize,  this);
 139         }
 140         if(this.el.is('input[type=password]') && Roo.isSafari){
 141             this.el.on('keydown', this.SafariOnKeyDown, this);
 142             this.el.on('keypress', this.SafariOnKeyPress, this);
 143         }
 144     },
 145
 146     processValue : function(value){
 147         if(this.stripCharsRe){
 148             var newValue = value.replace(this.stripCharsRe, '');
 149             if(newValue !== value){
 150                 this.setRawValue(newValue);
 151                 return newValue;
 152             }
 153         }
 154         return value;
 155     },
 156
 157     filterValidation : function(e){
 158         if(!e.isNavKeyPress()){
 159             this.validationTask.delay(this.validationDelay);
 160         }
 161     },
 162
 163     // private
 164     onKeyUp : function(e){
 165         if(!e.isNavKeyPress()){
 166             this.autoSize();
 167         }
 168     },
 169
 170     /**
 171      * Resets the current field value to the originally-loaded value and clears any validation messages.
 172      * Also adds emptyText and emptyClass if the original value was blank.
 173      */
 174     reset : function(){
 175         Roo.form.TextField.superclass.reset.call(this);
 176         this.applyEmptyText();
 177     },
 178
 179     applyEmptyText : function(){
 180         if(this.rendered && this.emptyText && this.getRawValue().length < 1){
 181             this.setRawValue(this.emptyText);
 182             this.el.addClass(this.emptyClass);
 183         }
 184     },
 185
 186     // private
 187     preFocus : function(){
 188         if(this.emptyText){
 189             if(this.el.dom.value == this.emptyText){
 190                 this.setRawValue('');
 191             }
 192             this.el.removeClass(this.emptyClass);
 193         }
 194         if(this.selectOnFocus){
 195             this.el.dom.select();
 196         }
 197     },
 198
 199     // private
 200     postBlur : function(){
 201         this.applyEmptyText();
 202     },
 203
 204     // private
 205     filterKeys : function(e){
 206         var k = e.getKey();
 207         if(!Roo.isIE && (e.isNavKeyPress() || k == e.BACKSPACE || (k == e.DELETE && e.button == -1))){
 208             return;
 209         }
 210         var c = e.getCharCode(), cc = String.fromCharCode(c);
 211         if(Roo.isIE && (e.isSpecialKey() || !cc)){
 212             return;
 213         }
 214         if(!this.maskRe.test(cc)){
 215             e.stopEvent();
 216         }
 217     },
 218
 219     setValue : function(v){
 220         if(this.emptyText && this.el && v !== undefined && v !== null && v !== ''){
 221             this.el.removeClass(this.emptyClass);
 222         }
 223         Roo.form.TextField.superclass.setValue.apply(this, arguments);
 224         this.applyEmptyText();
 225         this.autoSize();
 226     },
 227
 228     /**
 229      * Validates a value according to the field's validation rules and marks the field as invalid
 230      * if the validation fails
 231      * @param {Mixed} value The value to validate
 232      * @return {Boolean} True if the value is valid, else false
 233      */
 234     validateValue : function(value){
 235         if(value.length < 1 || value === this.emptyText){ // if it's blank
 236              if(this.allowBlank){
 237                 this.clearInvalid();
 238                 return true;
 239              }else{
 240                 this.markInvalid(this.blankText);
 241                 return false;
 242              }
 243         }
 244         if(value.length < this.minLength){
 245             this.markInvalid(String.format(this.minLengthText, this.minLength));
 246             return false;
 247         }
 248         if(value.length > this.maxLength){
 249             this.markInvalid(String.format(this.maxLengthText, this.maxLength));
 250             return false;
 251         }
 252         if(this.vtype){
 253             var vt = Roo.form.VTypes;
 254             if(!vt[this.vtype](value, this)){
 255                 this.markInvalid(this.vtypeText || vt[this.vtype +'Text']);
 256                 return false;
 257             }
 258         }
 259         if(typeof this.validator == "function"){
 260             var msg = this.validator(value);
 261             if(msg !== true){
 262                 this.markInvalid(msg);
 263                 return false;
 264             }
 265         }
 266         if(this.regex && !this.regex.test(value)){
 267             this.markInvalid(this.regexText);
 268             return false;
 269         }
 270         return true;
 271     },
 272
 273     /**
 274      * Selects text in this field
 275      * @param {Number} start (optional) The index where the selection should start (defaults to 0)
 276      * @param {Number} end (optional) The index where the selection should end (defaults to the text length)
 277      */
 278     selectText : function(start, end){
 279         var v = this.getRawValue();
 280         if(v.length > 0){
 281             start = start === undefined ? 0 : start;
 282             end = end === undefined ? v.length : end;
 283             var d = this.el.dom;
 284             if(d.setSelectionRange){
 285                 d.setSelectionRange(start, end);
 286             }else if(d.createTextRange){
 287                 var range = d.createTextRange();
 288                 range.moveStart("character", start);
 289                 range.moveEnd("character", v.length-end);
 290                 range.select();
 291             }
 292         }
 293     },
 294
 295     /**
 296      * Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.
 297      * This only takes effect if grow = true, and fires the autosize event.
 298      */
 299     autoSize : function(){
 300         if(!this.grow || !this.rendered){
 301             return;
 302         }
 303         if(!this.metrics){
 304             this.metrics = Roo.util.TextMetrics.createInstance(this.el);
 305         }
 306         var el = this.el;
 307         var v = el.dom.value;
 308         var d = document.createElement('div');
 309         d.appendChild(document.createTextNode(v));
 310         v = d.innerHTML;
 311         d = null;
 312         v += "&#160;";
 313         var w = Math.min(this.growMax, Math.max(this.metrics.getWidth(v) + /* add extra padding */ 10, this.growMin));
 314         this.el.setWidth(w);
 315         this.fireEvent("autosize", this, w);
 316     },
 317
 318     // private
 319     SafariOnKeyDown : function(event){
 320         var isSelectAll = false;
 321         if(this.el.dom.selectionEnd > 0){
 322             isSelectAll = (this.el.dom.selectionEnd - this.el.dom.selectionStart - this.getValue().length == 0) ? true : false;
 323         }
 324         if(((event.getKey() == 8 || event.getKey() == 46) && this.getValue().length ==1)){ // backspace and delete key
 325             event.preventDefault();
 326             this.setValue('');
 327             return;
 328          };
 329         if(isSelectAll){ // backspace and delete key
 330
 331             event.preventDefault();
 332             this.setValue(String.fromCharCode(event.getCharCode()));
 333         };
 334
 335
 336     }
 337 });