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              * @event keyup
 172              * Fires after the key up
 173              * @param {Roo.form.Field} this
 174              * @param {Roo.EventObject}  e The event Object
 175              */
 176             keyup : true
 177         });
 178     },
 179
 180     /**
 181      * Returns the name attribute of the field if available
 182      * @return {String} name The field name
 183      */
 184     getName: function(){
 185          return this.rendered && this.el.dom.name ? this.el.dom.name : (this.hiddenName || '');
 186     },
 187
 188     // private
 189     onRender : function(ct, position){
 190         Roo.form.Field.superclass.onRender.call(this, ct, position);
 191         if(!this.el){
 192             var cfg = this.getAutoCreate();
 193             if(!cfg.name){
 194                 cfg.name = typeof(this.name) == 'undefined' ? this.id : this.name;
 195             }
 196             if (!cfg.name.length) {
 197                 delete cfg.name;
 198             }
 199             if(this.inputType){
 200                 cfg.type = this.inputType;
 201             }
 202             this.el = ct.createChild(cfg, position);
 203         }
 204         var type = this.el.dom.type;
 205         if(type){
 206             if(type == 'password'){
 207                 type = 'text';
 208             }
 209             this.el.addClass('x-form-'+type);
 210         }
 211         if(this.readOnly){
 212             this.el.dom.readOnly = true;
 213         }
 214         if(this.tabIndex !== undefined){
 215             this.el.dom.setAttribute('tabIndex', this.tabIndex);
 216         }
 217
 218         this.el.addClass([this.fieldClass, this.cls]);
 219         this.initValue();
 220     },
 221
 222     /**
 223      * Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>
 224      * @param {String/HTMLElement/Element} el The id of the node, a DOM node or an existing Element
 225      * @return {Roo.form.Field} this
 226      */
 227     applyTo : function(target){
 228         this.allowDomMove = false;
 229         this.el = Roo.get(target);
 230         this.render(this.el.dom.parentNode);
 231         return this;
 232     },
 233
 234     // private
 235     initValue : function(){
 236         if(this.value !== undefined){
 237             this.setValue(this.value);
 238         }else if(this.el.dom.value.length > 0){
 239             this.setValue(this.el.dom.value);
 240         }
 241     },
 242
 243     /**
 244      * Returns true if this field has been changed since it was originally loaded and is not disabled.
 245      */
 246     isDirty : function() {
 247         if(this.disabled) {
 248             return false;
 249         }
 250         return String(this.getValue()) !== String(this.originalValue);
 251     },
 252
 253     // private
 254     afterRender : function(){
 255         Roo.form.Field.superclass.afterRender.call(this);
 256         this.initEvents();
 257     },
 258
 259     // private
 260     fireKey : function(e){
 261         //Roo.log('field ' + e.getKey());
 262         if(e.isNavKeyPress()){
 263             this.fireEvent("specialkey", this, e);
 264         }
 265     },
 266
 267     /**
 268      * Resets the current field value to the originally loaded value and clears any validation messages
 269      */
 270     reset : function(){
 271         this.setValue(this.originalValue);
 272         this.clearInvalid();
 273     },
 274
 275     // private
 276     initEvents : function(){
 277         // safari killled keypress - so keydown is now used..
 278         this.el.on("keydown" , this.fireKey,  this);
 279         this.el.on("focus", this.onFocus,  this);
 280         this.el.on("blur", this.onBlur,  this);
 281         this.el.relayEvent('keyup', this);
 282
 283         // reference to original value for reset
 284         this.originalValue = this.getValue();
 285     },
 286
 287     // private
 288     onFocus : function(){
 289         if(!Roo.isOpera && this.focusClass){ // don't touch in Opera
 290             this.el.addClass(this.focusClass);
 291         }
 292         if(!this.hasFocus){
 293             this.hasFocus = true;
 294             this.startValue = this.getValue();
 295             this.fireEvent("focus", this);
 296         }
 297     },
 298
 299     beforeBlur : Roo.emptyFn,
 300
 301     // private
 302     onBlur : function(){
 303         this.beforeBlur();
 304         if(!Roo.isOpera && this.focusClass){ // don't touch in Opera
 305             this.el.removeClass(this.focusClass);
 306         }
 307         this.hasFocus = false;
 308         if(this.validationEvent !== false && this.validateOnBlur && this.validationEvent != "blur"){
 309             this.validate();
 310         }
 311         var v = this.getValue();
 312         if(String(v) !== String(this.startValue)){
 313             this.fireEvent('change', this, v, this.startValue);
 314         }
 315         this.fireEvent("blur", this);
 316     },
 317
 318     /**
 319      * Returns whether or not the field value is currently valid
 320      * @param {Boolean} preventMark True to disable marking the field invalid
 321      * @return {Boolean} True if the value is valid, else false
 322      */
 323     isValid : function(preventMark){
 324         if(this.disabled){
 325             return true;
 326         }
 327         var restore = this.preventMark;
 328         this.preventMark = preventMark === true;
 329         var v = this.validateValue(this.processValue(this.getRawValue()));
 330         this.preventMark = restore;
 331         return v;
 332     },
 333
 334     /**
 335      * Validates the field value
 336      * @return {Boolean} True if the value is valid, else false
 337      */
 338     validate : function(){
 339         if(this.disabled || this.validateValue(this.processValue(this.getRawValue()))){
 340             this.clearInvalid();
 341             return true;
 342         }
 343         return false;
 344     },
 345
 346     processValue : function(value){
 347         return value;
 348     },
 349
 350     // private
 351     // Subclasses should provide the validation implementation by overriding this
 352     validateValue : function(value){
 353         return true;
 354     },
 355
 356     /**
 357      * Mark this field as invalid
 358      * @param {String} msg The validation message
 359      */
 360     markInvalid : function(msg){
 361         if(!this.rendered || this.preventMark){ // not rendered
 362             return;
 363         }
 364         this.el.addClass(this.invalidClass);
 365         msg = msg || this.invalidText;
 366         switch(this.msgTarget){
 367             case 'qtip':
 368                 this.el.dom.qtip = msg;
 369                 this.el.dom.qclass = 'x-form-invalid-tip';
 370                 if(Roo.QuickTips){ // fix for floating editors interacting with DND
 371                     Roo.QuickTips.enable();
 372                 }
 373                 break;
 374             case 'title':
 375                 this.el.dom.title = msg;
 376                 break;
 377             case 'under':
 378                 if(!this.errorEl){
 379                     var elp = this.el.findParent('.x-form-element', 5, true);
 380                     this.errorEl = elp.createChild({cls:'x-form-invalid-msg'});
 381                     this.errorEl.setWidth(elp.getWidth(true)-20);
 382                 }
 383                 this.errorEl.update(msg);
 384                 Roo.form.Field.msgFx[this.msgFx].show(this.errorEl, this);
 385                 break;
 386             case 'side':
 387                 if(!this.errorIcon){
 388                     var elp = this.el.findParent('.x-form-element', 5, true);
 389                     this.errorIcon = elp.createChild({cls:'x-form-invalid-icon'});
 390                 }
 391                 this.alignErrorIcon();
 392                 this.errorIcon.dom.qtip = msg;
 393                 this.errorIcon.dom.qclass = 'x-form-invalid-tip';
 394                 this.errorIcon.show();
 395                 this.on('resize', this.alignErrorIcon, this);
 396                 break;
 397             default:
 398                 var t = Roo.getDom(this.msgTarget);
 399                 t.innerHTML = msg;
 400                 t.style.display = this.msgDisplay;
 401                 break;
 402         }
 403         this.fireEvent('invalid', this, msg);
 404     },
 405
 406     // private
 407     alignErrorIcon : function(){
 408         this.errorIcon.alignTo(this.el, 'tl-tr', [2, 0]);
 409     },
 410
 411     /**
 412      * Clear any invalid styles/messages for this field
 413      */
 414     clearInvalid : function(){
 415         if(!this.rendered || this.preventMark){ // not rendered
 416             return;
 417         }
 418         this.el.removeClass(this.invalidClass);
 419         switch(this.msgTarget){
 420             case 'qtip':
 421                 this.el.dom.qtip = '';
 422                 break;
 423             case 'title':
 424                 this.el.dom.title = '';
 425                 break;
 426             case 'under':
 427                 if(this.errorEl){
 428                     Roo.form.Field.msgFx[this.msgFx].hide(this.errorEl, this);
 429                 }
 430                 break;
 431             case 'side':
 432                 if(this.errorIcon){
 433                     this.errorIcon.dom.qtip = '';
 434                     this.errorIcon.hide();
 435                     this.un('resize', this.alignErrorIcon, this);
 436                 }
 437                 break;
 438             default:
 439                 var t = Roo.getDom(this.msgTarget);
 440                 t.innerHTML = '';
 441                 t.style.display = 'none';
 442                 break;
 443         }
 444         this.fireEvent('valid', this);
 445     },
 446
 447     /**
 448      * Returns the raw data value which may or may not be a valid, defined value.  To return a normalized value see {@link #getValue}.
 449      * @return {Mixed} value The field value
 450      */
 451     getRawValue : function(){
 452         var v = this.el.getValue();
 453
 454         return v;
 455     },
 456
 457     /**
 458      * Returns the normalized data value (undefined or emptyText will be returned as '').  To return the raw value see {@link #getRawValue}.
 459      * @return {Mixed} value The field value
 460      */
 461     getValue : function(){
 462         var v = this.el.getValue();
 463
 464         return v;
 465     },
 466
 467     /**
 468      * Sets the underlying DOM field's value directly, bypassing validation.  To set the value with validation see {@link #setValue}.
 469      * @param {Mixed} value The value to set
 470      */
 471     setRawValue : function(v){
 472         return this.el.dom.value = (v === null || v === undefined ? '' : v);
 473     },
 474
 475     /**
 476      * Sets a data value into the field and validates it.  To set the value directly without validation see {@link #setRawValue}.
 477      * @param {Mixed} value The value to set
 478      */
 479     setValue : function(v){
 480         this.value = v;
 481         if(this.rendered){
 482             this.el.dom.value = (v === null || v === undefined ? '' : v);
 483              this.validate();
 484         }
 485     },
 486
 487     adjustSize : function(w, h){
 488         var s = Roo.form.Field.superclass.adjustSize.call(this, w, h);
 489         s.width = this.adjustWidth(this.el.dom.tagName, s.width);
 490         return s;
 491     },
 492
 493     adjustWidth : function(tag, w){
 494         tag = tag.toLowerCase();
 495         if(typeof w == 'number' && Roo.isStrict && !Roo.isSafari){
 496             if(Roo.isIE && (tag == 'input' || tag == 'textarea')){
 497                 if(tag == 'input'){
 498                     return w + 2;
 499                 }
 500                 if(tag == 'textarea'){
 501                     return w-2;
 502                 }
 503             }else if(Roo.isOpera){
 504                 if(tag == 'input'){
 505                     return w + 2;
 506                 }
 507                 if(tag == 'textarea'){
 508                     return w-2;
 509                 }
 510             }
 511         }
 512         return w;
 513     }
 514 });
 515
 516
 517 // anything other than normal should be considered experimental
 518 Roo.form.Field.msgFx = {
 519     normal : {
 520         show: function(msgEl, f){
 521             msgEl.setDisplayed('block');
 522         },
 523
 524         hide : function(msgEl, f){
 525             msgEl.setDisplayed(false).update('');
 526         }
 527     },
 528
 529     slide : {
 530         show: function(msgEl, f){
 531             msgEl.slideIn('t', {stopFx:true});
 532         },
 533
 534         hide : function(msgEl, f){
 535             msgEl.slideOut('t', {stopFx:true,useDisplay:true});
 536         }
 537     },
 538
 539     slideRight : {
 540         show: function(msgEl, f){
 541             msgEl.fixDisplay();
 542             msgEl.alignTo(f.el, 'tl-tr');
 543             msgEl.slideIn('l', {stopFx:true});
 544         },
 545
 546         hide : function(msgEl, f){
 547             msgEl.slideOut('l', {stopFx:true,useDisplay:true});
 548         }
 549     }
 550 };