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