git.roojs.org Git - roojs1/blob - Roo/Component.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.Component
  14  * @extends Roo.util.Observable
  15  * Base class for all major Roo components.  All subclasses of Component can automatically participate in the standard
  16  * Roo component lifecycle of creation, rendering and destruction.  They also have automatic support for basic hide/show
  17  * and enable/disable behavior.  Component allows any subclass to be lazy-rendered into any {@link Roo.Container} and
  18  * to be automatically registered with the {@link Roo.ComponentMgr} so that it can be referenced at any time via {@link Roo.getCmp}.
  19  * All visual components (widgets) that require rendering into a layout should subclass Component.
  20  * @constructor
  21  * @param {Roo.Element/String/Object} config The configuration options.  If an element is passed, it is set as the internal
  22  * element and its id used as the component id.  If a string is passed, it is assumed to be the id of an existing element
  23  * and is used as the component id.  Otherwise, it is assumed to be a standard config object and is applied to the component.
  24  */
  25 Roo.Component = function(config){
  26     config = config || {};
  27     if(config.tagName || config.dom || typeof config == "string"){ // element object
  28         config = {el: config, id: config.id || config};
  29     }
  30     this.initialConfig = config;
  31
  32     Roo.apply(this, config);
  33     this.addEvents({
  34         /**
  35          * @event disable
  36          * Fires after the component is disabled.
  37              * @param {Roo.Component} this
  38              */
  39         disable : true,
  40         /**
  41          * @event enable
  42          * Fires after the component is enabled.
  43              * @param {Roo.Component} this
  44              */
  45         enable : true,
  46         /**
  47          * @event beforeshow
  48          * Fires before the component is shown.  Return false to stop the show.
  49              * @param {Roo.Component} this
  50              */
  51         beforeshow : true,
  52         /**
  53          * @event show
  54          * Fires after the component is shown.
  55              * @param {Roo.Component} this
  56              */
  57         show : true,
  58         /**
  59          * @event beforehide
  60          * Fires before the component is hidden. Return false to stop the hide.
  61              * @param {Roo.Component} this
  62              */
  63         beforehide : true,
  64         /**
  65          * @event hide
  66          * Fires after the component is hidden.
  67              * @param {Roo.Component} this
  68              */
  69         hide : true,
  70         /**
  71          * @event beforerender
  72          * Fires before the component is rendered. Return false to stop the render.
  73              * @param {Roo.Component} this
  74              */
  75         beforerender : true,
  76         /**
  77          * @event render
  78          * Fires after the component is rendered.
  79              * @param {Roo.Component} this
  80              */
  81         render : true,
  82         /**
  83          * @event beforedestroy
  84          * Fires before the component is destroyed. Return false to stop the destroy.
  85              * @param {Roo.Component} this
  86              */
  87         beforedestroy : true,
  88         /**
  89          * @event destroy
  90          * Fires after the component is destroyed.
  91              * @param {Roo.Component} this
  92              */
  93         destroy : true
  94     });
  95     if(!this.id){
  96         this.id = "ext-comp-" + (++Roo.Component.AUTO_ID);
  97     }
  98     Roo.ComponentMgr.register(this);
  99     Roo.Component.superclass.constructor.call(this);
 100     this.initComponent();
 101     if(this.renderTo){ // not supported by all components yet. use at your own risk!
 102         this.render(this.renderTo);
 103         delete this.renderTo;
 104     }
 105 };
 106
 107 /** @private */
 108 Roo.Component.AUTO_ID = 1000;
 109
 110 Roo.extend(Roo.Component, Roo.util.Observable, {
 111     /**
 112      * @scope Roo.Component.prototype
 113      * @type {Boolean}
 114      * true if this component is hidden. Read-only.
 115      */
 116     hidden : false,
 117     /**
 118      * @type {Boolean}
 119      * true if this component is disabled. Read-only.
 120      */
 121     disabled : false,
 122     /**
 123      * @type {Boolean}
 124      * true if this component has been rendered. Read-only.
 125      */
 126     rendered : false,
 127
 128     /** @cfg {String} disableClass
 129      * CSS class added to the component when it is disabled (defaults to "x-item-disabled").
 130      */
 131     disabledClass : "x-item-disabled",
 132         /** @cfg {Boolean} allowDomMove
 133          * Whether the component can move the Dom node when rendering (defaults to true).
 134          */
 135     allowDomMove : true,
 136     /** @cfg {String} hideMode
 137      * How this component should hidden. Supported values are
 138      * "visibility" (css visibility), "offsets" (negative offset position) and
 139      * "display" (css display) - defaults to "display".
 140      */
 141     hideMode: 'display',
 142
 143     /** @private */
 144     ctype : "Roo.Component",
 145
 146     /**
 147      * @cfg {String} actionMode
 148      * which property holds the element that used for  hide() / show() / disable() / enable()
 149      * default is 'el'
 150      */
 151     actionMode : "el",
 152
 153     /** @private */
 154     getActionEl : function(){
 155         return this[this.actionMode];
 156     },
 157
 158     initComponent : Roo.emptyFn,
 159     /**
 160      * If this is a lazy rendering component, render it to its container element.
 161      * @param {String/HTMLElement/Element} container (optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.
 162      */
 163     render : function(container, position){
 164         if(!this.rendered && this.fireEvent("beforerender", this) !== false){
 165             if(!container && this.el){
 166                 this.el = Roo.get(this.el);
 167                 container = this.el.dom.parentNode;
 168                 this.allowDomMove = false;
 169             }
 170             this.container = Roo.get(container);
 171             this.rendered = true;
 172             if(position !== undefined){
 173                 if(typeof position == 'number'){
 174                     position = this.container.dom.childNodes[position];
 175                 }else{
 176                     position = Roo.getDom(position);
 177                 }
 178             }
 179             this.onRender(this.container, position || null);
 180             if(this.cls){
 181                 this.el.addClass(this.cls);
 182                 delete this.cls;
 183             }
 184             if(this.style){
 185                 this.el.applyStyles(this.style);
 186                 delete this.style;
 187             }
 188             this.fireEvent("render", this);
 189             this.afterRender(this.container);
 190             if(this.hidden){
 191                 this.hide();
 192             }
 193             if(this.disabled){
 194                 this.disable();
 195             }
 196         }
 197         return this;
 198     },
 199
 200     /** @private */
 201     // default function is not really useful
 202     onRender : function(ct, position){
 203         if(this.el){
 204             this.el = Roo.get(this.el);
 205             if(this.allowDomMove !== false){
 206                 ct.dom.insertBefore(this.el.dom, position);
 207             }
 208         }
 209     },
 210
 211     /** @private */
 212     getAutoCreate : function(){
 213         var cfg = typeof this.autoCreate == "object" ?
 214                       this.autoCreate : Roo.apply({}, this.defaultAutoCreate);
 215         if(this.id && !cfg.id){
 216             cfg.id = this.id;
 217         }
 218         return cfg;
 219     },
 220
 221     /** @private */
 222     afterRender : Roo.emptyFn,
 223
 224     /**
 225      * Destroys this component by purging any event listeners, removing the component's element from the DOM,
 226      * removing the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.
 227      */
 228     destroy : function(){
 229         if(this.fireEvent("beforedestroy", this) !== false){
 230             this.purgeListeners();
 231             this.beforeDestroy();
 232             if(this.rendered){
 233                 this.el.removeAllListeners();
 234                 this.el.remove();
 235                 if(this.actionMode == "container"){
 236                     this.container.remove();
 237                 }
 238             }
 239             this.onDestroy();
 240             Roo.ComponentMgr.unregister(this);
 241             this.fireEvent("destroy", this);
 242         }
 243     },
 244
 245         /** @private */
 246     beforeDestroy : function(){
 247
 248     },
 249
 250         /** @private */
 251         onDestroy : function(){
 252
 253     },
 254
 255     /**
 256      * Returns the underlying {@link Roo.Element}.
 257      * @return {Roo.Element} The element
 258      */
 259     getEl : function(){
 260         return this.el;
 261     },
 262
 263     /**
 264      * Returns the id of this component.
 265      * @return {String}
 266      */
 267     getId : function(){
 268         return this.id;
 269     },
 270
 271     /**
 272      * Try to focus this component.
 273      * @param {Boolean} selectText True to also select the text in this component (if applicable)
 274      * @return {Roo.Component} this
 275      */
 276     focus : function(selectText){
 277         if(this.rendered){
 278             this.el.focus();
 279             if(selectText === true){
 280                 this.el.dom.select();
 281             }
 282         }
 283         return this;
 284     },
 285
 286     /** @private */
 287     blur : function(){
 288         if(this.rendered){
 289             this.el.blur();
 290         }
 291         return this;
 292     },
 293
 294     /**
 295      * Disable this component.
 296      * @return {Roo.Component} this
 297      */
 298     disable : function(){
 299         if(this.rendered){
 300             this.onDisable();
 301         }
 302         this.disabled = true;
 303         this.fireEvent("disable", this);
 304         return this;
 305     },
 306
 307         // private
 308     onDisable : function(){
 309         this.getActionEl().addClass(this.disabledClass);
 310         this.el.dom.disabled = true;
 311     },
 312
 313     /**
 314      * Enable this component.
 315      * @return {Roo.Component} this
 316      */
 317     enable : function(){
 318         if(this.rendered){
 319             this.onEnable();
 320         }
 321         this.disabled = false;
 322         this.fireEvent("enable", this);
 323         return this;
 324     },
 325
 326         // private
 327     onEnable : function(){
 328         this.getActionEl().removeClass(this.disabledClass);
 329         this.el.dom.disabled = false;
 330     },
 331
 332     /**
 333      * Convenience function for setting disabled/enabled by boolean.
 334      * @param {Boolean} disabled
 335      */
 336     setDisabled : function(disabled){
 337         this[disabled ? "disable" : "enable"]();
 338     },
 339
 340     /**
 341      * Show this component.
 342      * @return {Roo.Component} this
 343      */
 344     show: function(){
 345         if(this.fireEvent("beforeshow", this) !== false){
 346             this.hidden = false;
 347             if(this.rendered){
 348                 this.onShow();
 349             }
 350             this.fireEvent("show", this);
 351         }
 352         return this;
 353     },
 354
 355     // private
 356     onShow : function(){
 357         var ae = this.getActionEl();
 358         if(this.hideMode == 'visibility'){
 359             ae.dom.style.visibility = "visible";
 360         }else if(this.hideMode == 'offsets'){
 361             ae.removeClass('x-hidden');
 362         }else{
 363             ae.dom.style.display = "";
 364         }
 365     },
 366
 367     /**
 368      * Hide this component.
 369      * @return {Roo.Component} this
 370      */
 371     hide: function(){
 372         if(this.fireEvent("beforehide", this) !== false){
 373             this.hidden = true;
 374             if(this.rendered){
 375                 this.onHide();
 376             }
 377             this.fireEvent("hide", this);
 378         }
 379         return this;
 380     },
 381
 382     // private
 383     onHide : function(){
 384         var ae = this.getActionEl();
 385         if(this.hideMode == 'visibility'){
 386             ae.dom.style.visibility = "hidden";
 387         }else if(this.hideMode == 'offsets'){
 388             ae.addClass('x-hidden');
 389         }else{
 390             ae.dom.style.display = "none";
 391         }
 392     },
 393
 394     /**
 395      * Convenience function to hide or show this component by boolean.
 396      * @param {Boolean} visible True to show, false to hide
 397      * @return {Roo.Component} this
 398      */
 399     setVisible: function(visible){
 400         if(visible) {
 401             this.show();
 402         }else{
 403             this.hide();
 404         }
 405         return this;
 406     },
 407
 408     /**
 409      * Returns true if this component is visible.
 410      */
 411     isVisible : function(){
 412         return this.getActionEl().isVisible();
 413     },
 414
 415     cloneConfig : function(overrides){
 416         overrides = overrides || {};
 417         var id = overrides.id || Roo.id();
 418         var cfg = Roo.applyIf(overrides, this.initialConfig);
 419         cfg.id = id; // prevent dup id
 420         return new this.constructor(cfg);
 421     }
 422 });