git.roojs.org Git - roojs1/blob - Roo/Editor.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.Editor
  14  * @extends Roo.Component
  15  * A base editor field that handles displaying/hiding on demand and has some built-in sizing and event handling logic.
  16  * @constructor
  17  * Create a new Editor
  18  * @param {Roo.form.Field} field The Field object (or descendant)
  19  * @param {Object} config The config object
  20  */
  21 Roo.Editor = function(field, config){
  22     Roo.Editor.superclass.constructor.call(this, config);
  23     this.field = field;
  24     this.addEvents({
  25         /**
  26              * @event beforestartedit
  27              * Fires when editing is initiated, but before the value changes.  Editing can be canceled by returning
  28              * false from the handler of this event.
  29              * @param {Editor} this
  30              * @param {Roo.Element} boundEl The underlying element bound to this editor
  31              * @param {Mixed} value The field value being set
  32              */
  33         "beforestartedit" : true,
  34         /**
  35              * @event startedit
  36              * Fires when this editor is displayed
  37              * @param {Roo.Element} boundEl The underlying element bound to this editor
  38              * @param {Mixed} value The starting field value
  39              */
  40         "startedit" : true,
  41         /**
  42              * @event beforecomplete
  43              * Fires after a change has been made to the field, but before the change is reflected in the underlying
  44              * field.  Saving the change to the field can be canceled by returning false from the handler of this event.
  45              * Note that if the value has not changed and ignoreNoChange = true, the editing will still end but this
  46              * event will not fire since no edit actually occurred.
  47              * @param {Editor} this
  48              * @param {Mixed} value The current field value
  49              * @param {Mixed} startValue The original field value
  50              */
  51         "beforecomplete" : true,
  52         /**
  53              * @event complete
  54              * Fires after editing is complete and any changed value has been written to the underlying field.
  55              * @param {Editor} this
  56              * @param {Mixed} value The current field value
  57              * @param {Mixed} startValue The original field value
  58              */
  59         "complete" : true,
  60         /**
  61          * @event specialkey
  62          * Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.  You can check
  63          * {@link Roo.EventObject#getKey} to determine which key was pressed.
  64          * @param {Roo.form.Field} this
  65          * @param {Roo.EventObject} e The event object
  66          */
  67         "specialkey" : true
  68     });
  69 };
  70
  71 Roo.extend(Roo.Editor, Roo.Component, {
  72     /**
  73      * @cfg {Boolean/String} autosize
  74      * True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only,
  75      * or "height" to adopt the height only (defaults to false)
  76      */
  77     /**
  78      * @cfg {Boolean} revertInvalid
  79      * True to automatically revert the field value and cancel the edit when the user completes an edit and the field
  80      * validation fails (defaults to true)
  81      */
  82     /**
  83      * @cfg {Boolean} ignoreNoChange
  84      * True to skip the the edit completion process (no save, no events fired) if the user completes an edit and
  85      * the value has not changed (defaults to false).  Applies only to string values - edits for other data types
  86      * will never be ignored.
  87      */
  88     /**
  89      * @cfg {Boolean} hideEl
  90      * False to keep the bound element visible while the editor is displayed (defaults to true)
  91      */
  92     /**
  93      * @cfg {Mixed} value
  94      * The data value of the underlying field (defaults to "")
  95      */
  96     value : "",
  97     /**
  98      * @cfg {String} alignment
  99      * The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to "c-c?").
 100      */
 101     alignment: "c-c?",
 102     /**
 103      * @cfg {Boolean/String} shadow "sides" for sides/bottom only, "frame" for 4-way shadow, and "drop"
 104      * for bottom-right shadow (defaults to "frame")
 105      */
 106     shadow : "frame",
 107     /**
 108      * @cfg {Boolean} constrain True to constrain the editor to the viewport
 109      */
 110     constrain : false,
 111     /**
 112      * @cfg {Boolean} completeOnEnter True to complete the edit when the enter key is pressed (defaults to false)
 113      */
 114     completeOnEnter : false,
 115     /**
 116      * @cfg {Boolean} cancelOnEsc True to cancel the edit when the escape key is pressed (defaults to false)
 117      */
 118     cancelOnEsc : false,
 119     /**
 120      * @cfg {Boolean} updateEl True to update the innerHTML of the bound element when the update completes (defaults to false)
 121      */
 122     updateEl : false,
 123
 124     // private
 125     onRender : function(ct, position){
 126         this.el = new Roo.Layer({
 127             shadow: this.shadow,
 128             cls: "x-editor",
 129             parentEl : ct,
 130             shim : this.shim,
 131             shadowOffset:4,
 132             id: this.id,
 133             constrain: this.constrain
 134         });
 135         this.el.setStyle("overflow", Roo.isGecko ? "auto" : "hidden");
 136         if(this.field.msgTarget != 'title'){
 137             this.field.msgTarget = 'qtip';
 138         }
 139         this.field.render(this.el);
 140         if(Roo.isGecko){
 141             this.field.el.dom.setAttribute('autocomplete', 'off');
 142         }
 143         this.field.on("specialkey", this.onSpecialKey, this);
 144         if(this.swallowKeys){
 145             this.field.el.swallowEvent(['keydown','keypress']);
 146         }
 147         this.field.show();
 148         this.field.on("blur", this.onBlur, this);
 149         if(this.field.grow){
 150             this.field.on("autosize", this.el.sync,  this.el, {delay:1});
 151         }
 152     },
 153
 154     onSpecialKey : function(field, e)
 155     {
 156         //Roo.log('editor onSpecialKey');
 157         if(this.completeOnEnter && e.getKey() == e.ENTER){
 158             e.stopEvent();
 159             this.completeEdit();
 160             return;
 161         }
 162         if(e.getKey() == e.ENTER){
 163             return;
 164         }
 165         if(this.cancelOnEsc && e.getKey() == e.ESC){
 166             this.cancelEdit();
 167             return;
 168         }
 169         this.fireEvent('specialkey', field, e);
 170
 171     },
 172
 173     /**
 174      * Starts the editing process and shows the editor.
 175      * @param {String/HTMLElement/Element} el The element to edit
 176      * @param {String} value (optional) A value to initialize the editor with. If a value is not provided, it defaults
 177       * to the innerHTML of el.
 178      */
 179     startEdit : function(el, value){
 180         if(this.editing){
 181             this.completeEdit();
 182         }
 183         this.boundEl = Roo.get(el);
 184         var v = value !== undefined ? value : this.boundEl.dom.innerHTML;
 185         if(!this.rendered){
 186             this.render(this.parentEl || document.body);
 187         }
 188         if(this.fireEvent("beforestartedit", this, this.boundEl, v) === false){
 189             return;
 190         }
 191         this.startValue = v;
 192         this.field.setValue(v);
 193         if(this.autoSize){
 194             var sz = this.boundEl.getSize();
 195             switch(this.autoSize){
 196                 case "width":
 197                 this.setSize(sz.width,  "");
 198                 break;
 199                 case "height":
 200                 this.setSize("",  sz.height);
 201                 break;
 202                 default:
 203                 this.setSize(sz.width,  sz.height);
 204             }
 205         }
 206         this.el.alignTo(this.boundEl, this.alignment);
 207         this.editing = true;
 208         if(Roo.QuickTips){
 209             Roo.QuickTips.disable();
 210         }
 211         this.show();
 212     },
 213
 214     /**
 215      * Sets the height and width of this editor.
 216      * @param {Number} width The new width
 217      * @param {Number} height The new height
 218      */
 219     setSize : function(w, h){
 220         this.field.setSize(w, h);
 221         if(this.el){
 222             this.el.sync();
 223         }
 224     },
 225
 226     /**
 227      * Realigns the editor to the bound field based on the current alignment config value.
 228      */
 229     realign : function(){
 230         this.el.alignTo(this.boundEl, this.alignment);
 231     },
 232
 233     /**
 234      * Ends the editing process, persists the changed value to the underlying field, and hides the editor.
 235      * @param {Boolean} remainVisible Override the default behavior and keep the editor visible after edit (defaults to false)
 236      */
 237     completeEdit : function(remainVisible){
 238         if(!this.editing){
 239             return;
 240         }
 241         var v = this.getValue();
 242         if(this.revertInvalid !== false && !this.field.isValid()){
 243             v = this.startValue;
 244             this.cancelEdit(true);
 245         }
 246         if(String(v) === String(this.startValue) && this.ignoreNoChange){
 247             this.editing = false;
 248             this.hide();
 249             return;
 250         }
 251         if(this.fireEvent("beforecomplete", this, v, this.startValue) !== false){
 252             this.editing = false;
 253             if(this.updateEl && this.boundEl){
 254                 this.boundEl.update(v);
 255             }
 256             if(remainVisible !== true){
 257                 this.hide();
 258             }
 259             this.fireEvent("complete", this, v, this.startValue);
 260         }
 261     },
 262
 263     // private
 264     onShow : function(){
 265         this.el.show();
 266         if(this.hideEl !== false){
 267             this.boundEl.hide();
 268         }
 269         this.field.show();
 270         if(Roo.isIE && !this.fixIEFocus){ // IE has problems with focusing the first time
 271             this.fixIEFocus = true;
 272             this.deferredFocus.defer(50, this);
 273         }else{
 274             this.field.focus();
 275         }
 276         this.fireEvent("startedit", this.boundEl, this.startValue);
 277     },
 278
 279     deferredFocus : function(){
 280         if(this.editing){
 281             this.field.focus();
 282         }
 283     },
 284
 285     /**
 286      * Cancels the editing process and hides the editor without persisting any changes.  The field value will be
 287      * reverted to the original starting value.
 288      * @param {Boolean} remainVisible Override the default behavior and keep the editor visible after
 289      * cancel (defaults to false)
 290      */
 291     cancelEdit : function(remainVisible){
 292         if(this.editing){
 293             this.setValue(this.startValue);
 294             if(remainVisible !== true){
 295                 this.hide();
 296             }
 297         }
 298     },
 299
 300     // private
 301     onBlur : function(){
 302         if(this.allowBlur !== true && this.editing){
 303             this.completeEdit();
 304         }
 305     },
 306
 307     // private
 308     onHide : function(){
 309         if(this.editing){
 310             this.completeEdit();
 311             return;
 312         }
 313         this.field.blur();
 314         if(this.field.collapse){
 315             this.field.collapse();
 316         }
 317         this.el.hide();
 318         if(this.hideEl !== false){
 319             this.boundEl.show();
 320         }
 321         if(Roo.QuickTips){
 322             Roo.QuickTips.enable();
 323         }
 324     },
 325
 326     /**
 327      * Sets the data value of the editor
 328      * @param {Mixed} value Any valid value supported by the underlying field
 329      */
 330     setValue : function(v){
 331         this.field.setValue(v);
 332     },
 333
 334     /**
 335      * Gets the data value of the editor
 336      * @return {Mixed} The data value
 337      */
 338     getValue : function(){
 339         return this.field.getValue();
 340     }
 341 });