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
 141         if(this.el.is('input[type=password]') && Roo.isSafari){
 142             this.el.on('keydown', this.SafariOnKeyDown, this);
 143             this.el.on("focus", function(){
 144                 this.setValue('');
 145             }, this);
 146         }
 147     },
 148
 149     processValue : function(value){
 150         if(this.stripCharsRe){
 151             var newValue = value.replace(this.stripCharsRe, '');
 152             if(newValue !== value){
 153                 this.setRawValue(newValue);
 154                 return newValue;
 155             }
 156         }
 157         return value;
 158     },
 159
 160     filterValidation : function(e){
 161         if(!e.isNavKeyPress()){
 162             this.validationTask.delay(this.validationDelay);
 163         }
 164     },
 165
 166     // private
 167     onKeyUp : function(e){
 168         if(!e.isNavKeyPress()){
 169             this.autoSize();
 170         }
 171     },
 172
 173     /**
 174      * Resets the current field value to the originally-loaded value and clears any validation messages.
 175      * Also adds emptyText and emptyClass if the original value was blank.
 176      */
 177     reset : function(){
 178         Roo.form.TextField.superclass.reset.call(this);
 179         this.applyEmptyText();
 180     },
 181
 182     applyEmptyText : function(){
 183         if(this.rendered && this.emptyText && this.getRawValue().length < 1){
 184             this.setRawValue(this.emptyText);
 185             this.el.addClass(this.emptyClass);
 186         }
 187     },
 188
 189     // private
 190     preFocus : function(){
 191         if(this.emptyText){
 192             if(this.el.dom.value == this.emptyText){
 193                 this.setRawValue('');
 194             }
 195             this.el.removeClass(this.emptyClass);
 196         }
 197         if(this.selectOnFocus){
 198             this.el.dom.select();
 199         }
 200     },
 201
 202     // private
 203     postBlur : function(){
 204         this.applyEmptyText();
 205     },
 206
 207     // private
 208     filterKeys : function(e){
 209         var k = e.getKey();
 210         if(!Roo.isIE && (e.isNavKeyPress() || k == e.BACKSPACE || (k == e.DELETE && e.button == -1))){
 211             return;
 212         }
 213         var c = e.getCharCode(), cc = String.fromCharCode(c);
 214         if(Roo.isIE && (e.isSpecialKey() || !cc)){
 215             return;
 216         }
 217         if(!this.maskRe.test(cc)){
 218             e.stopEvent();
 219         }
 220     },
 221
 222     setValue : function(v){
 223         if(this.emptyText && this.el && v !== undefined && v !== null && v !== ''){
 224             this.el.removeClass(this.emptyClass);
 225         }
 226         Roo.form.TextField.superclass.setValue.apply(this, arguments);
 227         this.applyEmptyText();
 228         this.autoSize();
 229     },
 230
 231     /**
 232      * Validates a value according to the field's validation rules and marks the field as invalid
 233      * if the validation fails
 234      * @param {Mixed} value The value to validate
 235      * @return {Boolean} True if the value is valid, else false
 236      */
 237     validateValue : function(value){
 238         if(value.length < 1 || value === this.emptyText){ // if it's blank
 239              if(this.allowBlank){
 240                 this.clearInvalid();
 241                 return true;
 242              }else{
 243                 this.markInvalid(this.blankText);
 244                 return false;
 245              }
 246         }
 247         if(value.length < this.minLength){
 248             this.markInvalid(String.format(this.minLengthText, this.minLength));
 249             return false;
 250         }
 251         if(value.length > this.maxLength){
 252             this.markInvalid(String.format(this.maxLengthText, this.maxLength));
 253             return false;
 254         }
 255         if(this.vtype){
 256             var vt = Roo.form.VTypes;
 257             if(!vt[this.vtype](value, this)){
 258                 this.markInvalid(this.vtypeText || vt[this.vtype +'Text']);
 259                 return false;
 260             }
 261         }
 262         if(typeof this.validator == "function"){
 263             var msg = this.validator(value);
 264             if(msg !== true){
 265                 this.markInvalid(msg);
 266                 return false;
 267             }
 268         }
 269         if(this.regex && !this.regex.test(value)){
 270             this.markInvalid(this.regexText);
 271             return false;
 272         }
 273         return true;
 274     },
 275
 276     /**
 277      * Selects text in this field
 278      * @param {Number} start (optional) The index where the selection should start (defaults to 0)
 279      * @param {Number} end (optional) The index where the selection should end (defaults to the text length)
 280      */
 281     selectText : function(start, end){
 282         var v = this.getRawValue();
 283         if(v.length > 0){
 284             start = start === undefined ? 0 : start;
 285             end = end === undefined ? v.length : end;
 286             var d = this.el.dom;
 287             if(d.setSelectionRange){
 288                 d.setSelectionRange(start, end);
 289             }else if(d.createTextRange){
 290                 var range = d.createTextRange();
 291                 range.moveStart("character", start);
 292                 range.moveEnd("character", v.length-end);
 293                 range.select();
 294             }
 295         }
 296     },
 297
 298     /**
 299      * Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.
 300      * This only takes effect if grow = true, and fires the autosize event.
 301      */
 302     autoSize : function(){
 303         if(!this.grow || !this.rendered){
 304             return;
 305         }
 306         if(!this.metrics){
 307             this.metrics = Roo.util.TextMetrics.createInstance(this.el);
 308         }
 309         var el = this.el;
 310         var v = el.dom.value;
 311         var d = document.createElement('div');
 312         d.appendChild(document.createTextNode(v));
 313         v = d.innerHTML;
 314         d = null;
 315         v += "&#160;";
 316         var w = Math.min(this.growMax, Math.max(this.metrics.getWidth(v) + /* add extra padding */ 10, this.growMin));
 317         this.el.setWidth(w);
 318         this.fireEvent("autosize", this, w);
 319     },
 320
 321     // private
 322     SafariOnKeyDown : function(event){
 323         if((event.getKey() == 8 || event.getKey() == 46) && this.getValue().length ==1){ // backspace and delete key
 324             event.preventDefault();
 325             this.setValue('');
 326         };
 327     }
 328 });