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