git.roojs.org Git - roojs1/blob - Roo/form/Field.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  * @class Roo.form.Field
  14  * @extends Roo.BoxComponent
  15  * Base class for form fields that provides default event handling, sizing, value handling and other functionality.
  16  * @constructor
  17  * Creates a new Field
  18  * @param {Object} config Configuration options
  19  */
  20 Roo.form.Field = function(config){
  21     Roo.form.Field.superclass.constructor.call(this, config);
  22 };
  23
  24 Roo.extend(Roo.form.Field, Roo.BoxComponent,  {
  25     /**
  26      * @cfg {String} fieldLabel Label to use when rendering a form.
  27      */
  28        /**
  29      * @cfg {String} qtip Mouse over tip
  30      */
  31
  32     /**
  33      * @cfg {String} invalidClass The CSS class to use when marking a field invalid (defaults to "x-form-invalid")
  34      */
  35     invalidClass : "x-form-invalid",
  36     /**
  37      * @cfg {String} invalidText The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")
  38      */
  39     invalidText : "The value in this field is invalid",
  40     /**
  41      * @cfg {String} focusClass The CSS class to use when the field receives focus (defaults to "x-form-focus")
  42      */
  43     focusClass : "x-form-focus",
  44     /**
  45      * @cfg {String/Boolean} validationEvent The event that should initiate field validation. Set to false to disable
  46       automatic validation (defaults to "keyup").
  47      */
  48     validationEvent : "keyup",
  49     /**
  50      * @cfg {Boolean} validateOnBlur Whether the field should validate when it loses focus (defaults to true).
  51      */
  52     validateOnBlur : true,
  53     /**
  54      * @cfg {Number} validationDelay The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
  55      */
  56     validationDelay : 250,
  57     /**
  58      * @cfg {String/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to
  59      * {tag: "input", type: "text", size: "20", autocomplete: "off"})
  60      */
  61     defaultAutoCreate : {tag: "input", type: "text", size: "20", autocomplete: "off"},
  62     /**
  63      * @cfg {String} fieldClass The default CSS class for the field (defaults to "x-form-field")
  64      */
  65     fieldClass : "x-form-field",
  66     /**
  67      * @cfg {String} msgTarget The location where error text should display.  Should be one of the following values (defaults to 'qtip'):
  68      *<pre>
  69 Value         Description
  70 -----------   ----------------------------------------------------------------------
  71 qtip          Display a quick tip when the user hovers over the field
  72 title         Display a default browser title attribute popup
  73 under         Add a block div beneath the field containing the error text
  74 side          Add an error icon to the right of the field with a popup on hover
  75 [element id]  Add the error text directly to the innerHTML of the specified element
  76 </pre>
  77      */
  78     msgTarget : 'qtip',
  79     /**
  80      * @cfg {String} msgFx <b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').
  81      */
  82     msgFx : 'normal',
  83
  84     /**
  85      * @cfg {Boolean} readOnly True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.
  86      */
  87     readOnly : false,
  88
  89     /**
  90      * @cfg {Boolean} disabled True to disable the field (defaults to false).
  91      */
  92     disabled : false,
  93
  94     /**
  95      * @cfg {String} inputType The type attribute for input fields -- e.g. radio, text, password (defaults to "text").
  96      */
  97     inputType : undefined,
  98
  99     /**
 100      * @cfg {Number} tabIndex The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).
 101          */
 102         tabIndex : undefined,
 103
 104     // private
 105     isFormField : true,
 106
 107     // private
 108     hasFocus : false,
 109     /**
 110      * @property {Roo.Element} fieldEl
 111      * Element Containing the rendered Field (with label etc.)
 112      */
 113     /**
 114      * @cfg {Mixed} value A value to initialize this field with.
 115      */
 116     value : undefined,
 117
 118     /**
 119      * @cfg {String} name The field's HTML name attribute.
 120      */
 121     /**
 122      * @cfg {String} cls A CSS class to apply to the field's underlying element.
 123      */
 124
 125         // private ??
 126         initComponent : function(){
 127         Roo.form.Field.superclass.initComponent.call(this);
 128         this.addEvents({
 129             /**
 130              * @event focus
 131              * Fires when this field receives input focus.
 132              * @param {Roo.form.Field} this
 133              */
 134             focus : true,
 135             /**
 136              * @event blur
 137              * Fires when this field loses input focus.
 138              * @param {Roo.form.Field} this
 139              */
 140             blur : true,
 141             /**
 142              * @event specialkey
 143              * Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.  You can check
 144              * {@link Roo.EventObject#getKey} to determine which key was pressed.
 145              * @param {Roo.form.Field} this
 146              * @param {Roo.EventObject} e The event object
 147              */
 148             specialkey : true,
 149             /**
 150              * @event change
 151              * Fires just before the field blurs if the field value has changed.
 152              * @param {Roo.form.Field} this
 153              * @param {Mixed} newValue The new value
 154              * @param {Mixed} oldValue The original value
 155              */
 156             change : true,
 157             /**
 158              * @event invalid
 159              * Fires after the field has been marked as invalid.
 160              * @param {Roo.form.Field} this
 161              * @param {String} msg The validation message
 162              */
 163             invalid : true,
 164             /**
 165              * @event valid
 166              * Fires after the field has been validated with no errors.
 167              * @param {Roo.form.Field} this
 168              */
 169             valid : true
 170         });
 171     },
 172
 173     /**
 174      * Returns the name attribute of the field if available
 175      * @return {String} name The field name
 176      */
 177     getName: function(){
 178          return this.rendered && this.el.dom.name ? this.el.dom.name : (this.hiddenName || '');
 179     },
 180
 181     // private
 182     onRender : function(ct, position){
 183         Roo.form.Field.superclass.onRender.call(this, ct, position);
 184         if(!this.el){
 185             var cfg = this.getAutoCreate();
 186             if(!cfg.name){
 187                 cfg.name = this.name || this.id;
 188             }
 189             if(this.inputType){
 190                 cfg.type = this.inputType;
 191             }
 192             this.el = ct.createChild(cfg, position);
 193         }
 194         var type = this.el.dom.type;
 195         if(type){
 196             if(type == 'password'){
 197                 type = 'text';
 198             }
 199             this.el.addClass('x-form-'+type);
 200         }
 201         if(this.readOnly){
 202             this.el.dom.readOnly = true;
 203         }
 204         if(this.tabIndex !== undefined){
 205             this.el.dom.setAttribute('tabIndex', this.tabIndex);
 206         }
 207
 208         this.el.addClass([this.fieldClass, this.cls]);
 209         this.initValue();
 210     },
 211
 212     /**
 213      * Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>
 214      * @param {String/HTMLElement/Element} el The id of the node, a DOM node or an existing Element
 215      * @return {Roo.form.Field} this
 216      */
 217     applyTo : function(target){
 218         this.allowDomMove = false;
 219         this.el = Roo.get(target);
 220         this.render(this.el.dom.parentNode);
 221         return this;
 222     },
 223
 224     // private
 225     initValue : function(){
 226         if(this.value !== undefined){
 227             this.setValue(this.value);
 228         }else if(this.el.dom.value.length > 0){
 229             this.setValue(this.el.dom.value);
 230         }
 231     },
 232
 233     /**
 234      * Returns true if this field has been changed since it was originally loaded and is not disabled.
 235      */
 236     isDirty : function() {
 237         if(this.disabled) {
 238             return false;
 239         }
 240         return String(this.getValue()) !== String(this.originalValue);
 241     },
 242
 243     // private
 244     afterRender : function(){
 245         Roo.form.Field.superclass.afterRender.call(this);
 246         this.initEvents();
 247     },
 248
 249     // private
 250     fireKey : function(e){
 251         if(e.isNavKeyPress()){
 252             this.fireEvent("specialkey", this, e);
 253         }
 254     },
 255
 256     /**
 257      * Resets the current field value to the originally loaded value and clears any validation messages
 258      */
 259     reset : function(){
 260         this.setValue(this.originalValue);
 261         this.clearInvalid();
 262     },
 263
 264     // private
 265     initEvents : function(){
 266         this.el.on(Roo.isIE ? "keydown" : "keypress", this.fireKey,  this);
 267         this.el.on("focus", this.onFocus,  this);
 268         this.el.on("blur", this.onBlur,  this);
 269
 270         // reference to original value for reset
 271         this.originalValue = this.getValue();
 272     },
 273
 274     // private
 275     onFocus : function(){
 276         if(!Roo.isOpera && this.focusClass){ // don't touch in Opera
 277             this.el.addClass(this.focusClass);
 278         }
 279         if(!this.hasFocus){
 280             this.hasFocus = true;
 281             this.startValue = this.getValue();
 282             this.fireEvent("focus", this);
 283         }
 284     },
 285
 286     beforeBlur : Roo.emptyFn,
 287
 288     // private
 289     onBlur : function(){
 290         this.beforeBlur();
 291         if(!Roo.isOpera && this.focusClass){ // don't touch in Opera
 292             this.el.removeClass(this.focusClass);
 293         }
 294         this.hasFocus = false;
 295         if(this.validationEvent !== false && this.validateOnBlur && this.validationEvent != "blur"){
 296             this.validate();
 297         }
 298         var v = this.getValue();
 299         if(String(v) !== String(this.startValue)){
 300             this.fireEvent('change', this, v, this.startValue);
 301         }
 302         this.fireEvent("blur", this);
 303     },
 304
 305     /**
 306      * Returns whether or not the field value is currently valid
 307      * @param {Boolean} preventMark True to disable marking the field invalid
 308      * @return {Boolean} True if the value is valid, else false
 309      */
 310     isValid : function(preventMark){
 311         if(this.disabled){
 312             return true;
 313         }
 314         var restore = this.preventMark;
 315         this.preventMark = preventMark === true;
 316         var v = this.validateValue(this.processValue(this.getRawValue()));
 317         this.preventMark = restore;
 318         return v;
 319     },
 320
 321     /**
 322      * Validates the field value
 323      * @return {Boolean} True if the value is valid, else false
 324      */
 325     validate : function(){
 326         if(this.disabled || this.validateValue(this.processValue(this.getRawValue()))){
 327             this.clearInvalid();
 328             return true;
 329         }
 330         return false;
 331     },
 332
 333     processValue : function(value){
 334         return value;
 335     },
 336
 337     // private
 338     // Subclasses should provide the validation implementation by overriding this
 339     validateValue : function(value){
 340         return true;
 341     },
 342
 343     /**
 344      * Mark this field as invalid
 345      * @param {String} msg The validation message
 346      */
 347     markInvalid : function(msg){
 348         if(!this.rendered || this.preventMark){ // not rendered
 349             return;
 350         }
 351         this.el.addClass(this.invalidClass);
 352         msg = msg || this.invalidText;
 353         switch(this.msgTarget){
 354             case 'qtip':
 355                 this.el.dom.qtip = msg;
 356                 this.el.dom.qclass = 'x-form-invalid-tip';
 357                 if(Roo.QuickTips){ // fix for floating editors interacting with DND
 358                     Roo.QuickTips.enable();
 359                 }
 360                 break;
 361             case 'title':
 362                 this.el.dom.title = msg;
 363                 break;
 364             case 'under':
 365                 if(!this.errorEl){
 366                     var elp = this.el.findParent('.x-form-element', 5, true);
 367                     this.errorEl = elp.createChild({cls:'x-form-invalid-msg'});
 368                     this.errorEl.setWidth(elp.getWidth(true)-20);
 369                 }
 370                 this.errorEl.update(msg);
 371                 Roo.form.Field.msgFx[this.msgFx].show(this.errorEl, this);
 372                 break;
 373             case 'side':
 374                 if(!this.errorIcon){
 375                     var elp = this.el.findParent('.x-form-element', 5, true);
 376                     this.errorIcon = elp.createChild({cls:'x-form-invalid-icon'});
 377                 }
 378                 this.alignErrorIcon();
 379                 this.errorIcon.dom.qtip = msg;
 380                 this.errorIcon.dom.qclass = 'x-form-invalid-tip';
 381                 this.errorIcon.show();
 382                 this.on('resize', this.alignErrorIcon, this);
 383                 break;
 384             default:
 385                 var t = Roo.getDom(this.msgTarget);
 386                 t.innerHTML = msg;
 387                 t.style.display = this.msgDisplay;
 388                 break;
 389         }
 390         this.fireEvent('invalid', this, msg);
 391     },
 392
 393     // private
 394     alignErrorIcon : function(){
 395         this.errorIcon.alignTo(this.el, 'tl-tr', [2, 0]);
 396     },
 397
 398     /**
 399      * Clear any invalid styles/messages for this field
 400      */
 401     clearInvalid : function(){
 402         if(!this.rendered || this.preventMark){ // not rendered
 403             return;
 404         }
 405         this.el.removeClass(this.invalidClass);
 406         switch(this.msgTarget){
 407             case 'qtip':
 408                 this.el.dom.qtip = '';
 409                 break;
 410             case 'title':
 411                 this.el.dom.title = '';
 412                 break;
 413             case 'under':
 414                 if(this.errorEl){
 415                     Roo.form.Field.msgFx[this.msgFx].hide(this.errorEl, this);
 416                 }
 417                 break;
 418             case 'side':
 419                 if(this.errorIcon){
 420                     this.errorIcon.dom.qtip = '';
 421                     this.errorIcon.hide();
 422                     this.un('resize', this.alignErrorIcon, this);
 423                 }
 424                 break;
 425             default:
 426                 var t = Roo.getDom(this.msgTarget);
 427                 t.innerHTML = '';
 428                 t.style.display = 'none';
 429                 break;
 430         }
 431         this.fireEvent('valid', this);
 432     },
 433
 434     /**
 435      * Returns the raw data value which may or may not be a valid, defined value.  To return a normalized value see {@link #getValue}.
 436      * @return {Mixed} value The field value
 437      */
 438     getRawValue : function(){
 439         var v = this.el.getValue();
 440         if(v === this.emptyText){
 441             v = '';
 442         }
 443         return v;
 444     },
 445
 446     /**
 447      * Returns the normalized data value (undefined or emptyText will be returned as '').  To return the raw value see {@link #getRawValue}.
 448      * @return {Mixed} value The field value
 449      */
 450     getValue : function(){
 451         var v = this.el.getValue();
 452         if(v === this.emptyText || v === undefined){
 453             v = '';
 454         }
 455         return v;
 456     },
 457
 458     /**
 459      * Sets the underlying DOM field's value directly, bypassing validation.  To set the value with validation see {@link #setValue}.
 460      * @param {Mixed} value The value to set
 461      */
 462     setRawValue : function(v){
 463         return this.el.dom.value = (v === null || v === undefined ? '' : v);
 464     },
 465
 466     /**
 467      * Sets a data value into the field and validates it.  To set the value directly without validation see {@link #setRawValue}.
 468      * @param {Mixed} value The value to set
 469      */
 470     setValue : function(v){
 471         this.value = v;
 472         if(this.rendered){
 473             this.el.dom.value = (v === null || v === undefined ? '' : v);
 474             this.validate();
 475         }
 476     },
 477
 478     adjustSize : function(w, h){
 479         var s = Roo.form.Field.superclass.adjustSize.call(this, w, h);
 480         s.width = this.adjustWidth(this.el.dom.tagName, s.width);
 481         return s;
 482     },
 483
 484     adjustWidth : function(tag, w){
 485         tag = tag.toLowerCase();
 486         if(typeof w == 'number' && Roo.isStrict && !Roo.isSafari){
 487             if(Roo.isIE && (tag == 'input' || tag == 'textarea')){
 488                 if(tag == 'input'){
 489                     return w + 2;
 490                 }
 491                 if(tag = 'textarea'){
 492                     return w-2;
 493                 }
 494             }else if(Roo.isOpera){
 495                 if(tag == 'input'){
 496                     return w + 2;
 497                 }
 498                 if(tag = 'textarea'){
 499                     return w-2;
 500                 }
 501             }
 502         }
 503         return w;
 504     }
 505 });
 506
 507
 508 // anything other than normal should be considered experimental
 509 Roo.form.Field.msgFx = {
 510     normal : {
 511         show: function(msgEl, f){
 512             msgEl.setDisplayed('block');
 513         },
 514
 515         hide : function(msgEl, f){
 516             msgEl.setDisplayed(false).update('');
 517         }
 518     },
 519
 520     slide : {
 521         show: function(msgEl, f){
 522             msgEl.slideIn('t', {stopFx:true});
 523         },
 524
 525         hide : function(msgEl, f){
 526             msgEl.slideOut('t', {stopFx:true,useDisplay:true});
 527         }
 528     },
 529
 530     slideRight : {
 531         show: function(msgEl, f){
 532             msgEl.fixDisplay();
 533             msgEl.alignTo(f.el, 'tl-tr');
 534             msgEl.slideIn('l', {stopFx:true});
 535         },
 536
 537         hide : function(msgEl, f){
 538             msgEl.slideOut('l', {stopFx:true,useDisplay:true});
 539         }
 540     }
 541 };