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 - placeholder... (defaults to null).
 108      */
 109     emptyText : null,
 110
 111
 112     // private
 113     initEvents : function()
 114     {
 115         if (this.emptyText) {
 116             this.el.attr('placeholder', this.emptyText);
 117         }
 118
 119         Roo.form.TextField.superclass.initEvents.call(this);
 120         if(this.validationEvent == 'keyup'){
 121             this.validationTask = new Roo.util.DelayedTask(this.validate, this);
 122             this.el.on('keyup', this.filterValidation, this);
 123         }
 124         else if(this.validationEvent !== false){
 125             this.el.on(this.validationEvent, this.validate, this, {buffer: this.validationDelay});
 126         }
 127         if(this.selectOnFocus || this.emptyText){
 128             this.on("focus", this.preFocus, this);
 129             if(this.emptyText){
 130                 this.on('blur', this.postBlur, this);
 131
 132             }
 133         }
 134         if(this.maskRe || (this.vtype && this.disableKeyFilter !== true && (this.maskRe = Roo.form.VTypes[this.vtype+'Mask']))){
 135             this.el.on("keypress", this.filterKeys, this);
 136         }
 137         if(this.grow){
 138             this.el.on("keyup", this.onKeyUp,  this, {buffer:50});
 139             this.el.on("click", this.autoSize,  this);
 140         }
 141         if(this.el.is('input[type=password]') && Roo.isSafari){
 142             this.el.on('keydown', this.SafariOnKeyDown, 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      *
 173      */
 174     reset : function(){
 175         Roo.form.TextField.superclass.reset.call(this);
 176
 177     },
 178
 179
 180     // private
 181     preFocus : function(){
 182
 183         if(this.selectOnFocus){
 184             this.el.dom.select();
 185         }
 186     },
 187
 188     // private
 189     postBlur : function(){
 190
 191     },
 192
 193     // private
 194     filterKeys : function(e){
 195         var k = e.getKey();
 196         if(!Roo.isIE && (e.isNavKeyPress() || k == e.BACKSPACE || (k == e.DELETE && e.button == -1))){
 197             return;
 198         }
 199         var c = e.getCharCode(), cc = String.fromCharCode(c);
 200         if(Roo.isIE && (e.isSpecialKey() || !cc)){
 201             return;
 202         }
 203         if(!this.maskRe.test(cc)){
 204             e.stopEvent();
 205         }
 206     },
 207
 208     setValue : function(v){
 209
 210         Roo.form.TextField.superclass.setValue.apply(this, arguments);
 211
 212         this.autoSize();
 213     },
 214
 215     /**
 216      * Validates a value according to the field's validation rules and marks the field as invalid
 217      * if the validation fails
 218      * @param {Mixed} value The value to validate
 219      * @return {Boolean} True if the value is valid, else false
 220      */
 221     validateValue : function(value){
 222         if(value.length < 1)  { // if it's blank
 223              if(this.allowBlank){
 224                 this.clearInvalid();
 225                 return true;
 226              }else{
 227                 this.markInvalid(this.blankText);
 228                 return false;
 229              }
 230         }
 231         if(value.length < this.minLength){
 232             this.markInvalid(String.format(this.minLengthText, this.minLength));
 233             return false;
 234         }
 235         if(value.length > this.maxLength){
 236             this.markInvalid(String.format(this.maxLengthText, this.maxLength));
 237             return false;
 238         }
 239         if(this.vtype){
 240             var vt = Roo.form.VTypes;
 241             if(!vt[this.vtype](value, this)){
 242                 this.markInvalid(this.vtypeText || vt[this.vtype +'Text']);
 243                 return false;
 244             }
 245         }
 246         if(typeof this.validator == "function"){
 247             var msg = this.validator(value);
 248             if(msg !== true){
 249                 this.markInvalid(msg);
 250                 return false;
 251             }
 252         }
 253         if(this.regex && !this.regex.test(value)){
 254             this.markInvalid(this.regexText);
 255             return false;
 256         }
 257         return true;
 258     },
 259
 260     /**
 261      * Selects text in this field
 262      * @param {Number} start (optional) The index where the selection should start (defaults to 0)
 263      * @param {Number} end (optional) The index where the selection should end (defaults to the text length)
 264      */
 265     selectText : function(start, end){
 266         var v = this.getRawValue();
 267         if(v.length > 0){
 268             start = start === undefined ? 0 : start;
 269             end = end === undefined ? v.length : end;
 270             var d = this.el.dom;
 271             if(d.setSelectionRange){
 272                 d.setSelectionRange(start, end);
 273             }else if(d.createTextRange){
 274                 var range = d.createTextRange();
 275                 range.moveStart("character", start);
 276                 range.moveEnd("character", v.length-end);
 277                 range.select();
 278             }
 279         }
 280     },
 281
 282     /**
 283      * Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.
 284      * This only takes effect if grow = true, and fires the autosize event.
 285      */
 286     autoSize : function(){
 287         if(!this.grow || !this.rendered){
 288             return;
 289         }
 290         if(!this.metrics){
 291             this.metrics = Roo.util.TextMetrics.createInstance(this.el);
 292         }
 293         var el = this.el;
 294         var v = el.dom.value;
 295         var d = document.createElement('div');
 296         d.appendChild(document.createTextNode(v));
 297         v = d.innerHTML;
 298         d = null;
 299         v += "&#160;";
 300         var w = Math.min(this.growMax, Math.max(this.metrics.getWidth(v) + /* add extra padding */ 10, this.growMin));
 301         this.el.setWidth(w);
 302         this.fireEvent("autosize", this, w);
 303     },
 304
 305     // private
 306     SafariOnKeyDown : function(event)
 307     {
 308         // this is a workaround for a password hang bug on chrome/ webkit.
 309
 310         var isSelectAll = false;
 311
 312         if(this.el.dom.selectionEnd > 0){
 313             isSelectAll = (this.el.dom.selectionEnd - this.el.dom.selectionStart - this.getValue().length == 0) ? true : false;
 314         }
 315         if(((event.getKey() == 8 || event.getKey() == 46) && this.getValue().length ==1)){ // backspace and delete key
 316             event.preventDefault();
 317             this.setValue('');
 318             return;
 319         }
 320
 321         if(isSelectAll){ // backspace and delete key
 322
 323             event.preventDefault();
 324             // this is very hacky as keydown always get's upper case.
 325             //
 326             var cc = String.fromCharCode(event.getCharCode());
 327             this.setValue( event.shiftKey ?  cc : cc.toLowerCase());
 328
 329         }
 330
 331
 332     }
 333 });