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         Roo.log('render the component');
 198         Roo.log(this);
 199         return this;
 200     },
 201
 202     /** @private */
 203     // default function is not really useful
 204     onRender : function(ct, position){
 205         if(this.el){
 206             this.el = Roo.get(this.el);
 207             if(this.allowDomMove !== false){
 208                 ct.dom.insertBefore(this.el.dom, position);
 209             }
 210         }
 211     },
 212
 213     /** @private */
 214     getAutoCreate : function(){
 215         var cfg = typeof this.autoCreate == "object" ?
 216                       this.autoCreate : Roo.apply({}, this.defaultAutoCreate);
 217         if(this.id && !cfg.id){
 218             cfg.id = this.id;
 219         }
 220         return cfg;
 221     },
 222
 223     /** @private */
 224     afterRender : Roo.emptyFn,
 225
 226     /**
 227      * Destroys this component by purging any event listeners, removing the component's element from the DOM,
 228      * removing the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.
 229      */
 230     destroy : function(){
 231         if(this.fireEvent("beforedestroy", this) !== false){
 232             this.purgeListeners();
 233             this.beforeDestroy();
 234             if(this.rendered){
 235                 this.el.removeAllListeners();
 236                 this.el.remove();
 237                 if(this.actionMode == "container"){
 238                     this.container.remove();
 239                 }
 240             }
 241             this.onDestroy();
 242             Roo.ComponentMgr.unregister(this);
 243             this.fireEvent("destroy", this);
 244         }
 245     },
 246
 247         /** @private */
 248     beforeDestroy : function(){
 249
 250     },
 251
 252         /** @private */
 253         onDestroy : function(){
 254
 255     },
 256
 257     /**
 258      * Returns the underlying {@link Roo.Element}.
 259      * @return {Roo.Element} The element
 260      */
 261     getEl : function(){
 262         return this.el;
 263     },
 264
 265     /**
 266      * Returns the id of this component.
 267      * @return {String}
 268      */
 269     getId : function(){
 270         return this.id;
 271     },
 272
 273     /**
 274      * Try to focus this component.
 275      * @param {Boolean} selectText True to also select the text in this component (if applicable)
 276      * @return {Roo.Component} this
 277      */
 278     focus : function(selectText){
 279         if(this.rendered){
 280             this.el.focus();
 281             if(selectText === true){
 282                 this.el.dom.select();
 283             }
 284         }
 285         return this;
 286     },
 287
 288     /** @private */
 289     blur : function(){
 290         if(this.rendered){
 291             this.el.blur();
 292         }
 293         return this;
 294     },
 295
 296     /**
 297      * Disable this component.
 298      * @return {Roo.Component} this
 299      */
 300     disable : function(){
 301         if(this.rendered){
 302             this.onDisable();
 303         }
 304         this.disabled = true;
 305         this.fireEvent("disable", this);
 306         return this;
 307     },
 308
 309         // private
 310     onDisable : function(){
 311         this.getActionEl().addClass(this.disabledClass);
 312         this.el.dom.disabled = true;
 313     },
 314
 315     /**
 316      * Enable this component.
 317      * @return {Roo.Component} this
 318      */
 319     enable : function(){
 320         if(this.rendered){
 321             this.onEnable();
 322         }
 323         this.disabled = false;
 324         this.fireEvent("enable", this);
 325         return this;
 326     },
 327
 328         // private
 329     onEnable : function(){
 330         this.getActionEl().removeClass(this.disabledClass);
 331         this.el.dom.disabled = false;
 332     },
 333
 334     /**
 335      * Convenience function for setting disabled/enabled by boolean.
 336      * @param {Boolean} disabled
 337      */
 338     setDisabled : function(disabled){
 339         this[disabled ? "disable" : "enable"]();
 340     },
 341
 342     /**
 343      * Show this component.
 344      * @return {Roo.Component} this
 345      */
 346     show: function(){
 347         if(this.fireEvent("beforeshow", this) !== false){
 348             this.hidden = false;
 349             if(this.rendered){
 350                 this.onShow();
 351             }
 352             this.fireEvent("show", this);
 353         }
 354         return this;
 355     },
 356
 357     // private
 358     onShow : function(){
 359         var ae = this.getActionEl();
 360         if(this.hideMode == 'visibility'){
 361             ae.dom.style.visibility = "visible";
 362         }else if(this.hideMode == 'offsets'){
 363             ae.removeClass('x-hidden');
 364         }else{
 365             ae.dom.style.display = "";
 366         }
 367     },
 368
 369     /**
 370      * Hide this component.
 371      * @return {Roo.Component} this
 372      */
 373     hide: function(){
 374         if(this.fireEvent("beforehide", this) !== false){
 375             this.hidden = true;
 376             if(this.rendered){
 377                 this.onHide();
 378             }
 379             this.fireEvent("hide", this);
 380         }
 381         return this;
 382     },
 383
 384     // private
 385     onHide : function(){
 386         var ae = this.getActionEl();
 387         if(this.hideMode == 'visibility'){
 388             ae.dom.style.visibility = "hidden";
 389         }else if(this.hideMode == 'offsets'){
 390             ae.addClass('x-hidden');
 391         }else{
 392             ae.dom.style.display = "none";
 393         }
 394     },
 395
 396     /**
 397      * Convenience function to hide or show this component by boolean.
 398      * @param {Boolean} visible True to show, false to hide
 399      * @return {Roo.Component} this
 400      */
 401     setVisible: function(visible){
 402         if(visible) {
 403             this.show();
 404         }else{
 405             this.hide();
 406         }
 407         return this;
 408     },
 409
 410     /**
 411      * Returns true if this component is visible.
 412      */
 413     isVisible : function(){
 414         return this.getActionEl().isVisible();
 415     },
 416
 417     cloneConfig : function(overrides){
 418         overrides = overrides || {};
 419         var id = overrides.id || Roo.id();
 420         var cfg = Roo.applyIf(overrides, this.initialConfig);
 421         cfg.id = id; // prevent dup id
 422         return new this.constructor(cfg);
 423     }
 424 });