git.roojs.org Git - roojs1/blob - Roo/bootstrap/Component.js

   1 /*
   2  * - LGPL
   3  *
   4  * base class for bootstrap elements.
   5  *
   6  */
   7
   8 Roo.bootstrap = Roo.bootstrap || {};
   9 /**
  10  * @class Roo.bootstrap.Component
  11  * @extends Roo.Component
  12  * @abstract
  13  * @children Roo.bootstrap.Component
  14  * Bootstrap Component base class
  15  * @cfg {String} cls css class
  16  * @cfg {String} style any extra css
  17  * @cfg {Object} xattr extra attributes to add to 'element' (used by builder to store stuff.)
  18  * @cfg {Boolean} can_build_overlaid  True if element can be rebuild from a HTML page
  19  * @cfg {string} dataId cutomer id
  20  * @cfg {string} name Specifies name attribute
  21  * @cfg {string} tooltip  Text for the tooltip
  22  * @cfg {string} container_method method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)
  23  * @cfg {string|object} visibilityEl (el|parent) What element to use for visibility (@see getVisibilityEl())
  24
  25  * @constructor
  26  * Do not use directly - it does not do anything..
  27  * @param {Object} config The config object
  28  */
  29
  30
  31
  32 Roo.bootstrap.Component = function(config){
  33     Roo.bootstrap.Component.superclass.constructor.call(this, config);
  34
  35     this.addEvents({
  36         /**
  37          * @event childrenrendered
  38          * Fires when the children have been rendered..
  39          * @param {Roo.bootstrap.Component} this
  40          */
  41         "childrenrendered" : true
  42
  43
  44
  45     });
  46
  47
  48 };
  49
  50 Roo.extend(Roo.bootstrap.Component, Roo.BoxComponent,  {
  51
  52
  53     allowDomMove : false, // to stop relocations in parent onRender...
  54
  55     cls : false,
  56
  57     style : false,
  58
  59     autoCreate : false,
  60
  61     tooltip : null,
  62     /**
  63      * Initialize Events for the element
  64      */
  65     initEvents : function() { },
  66
  67     xattr : false,
  68
  69     parentId : false,
  70
  71     can_build_overlaid : true,
  72
  73     container_method : false,
  74
  75     dataId : false,
  76
  77     name : false,
  78
  79     parent: function() {
  80         // returns the parent component..
  81         return Roo.ComponentMgr.get(this.parentId)
  82
  83
  84     },
  85
  86     // private
  87     onRender : function(ct, position)
  88     {
  89        // Roo.log("Call onRender: " + this.xtype);
  90
  91         Roo.bootstrap.Component.superclass.onRender.call(this, ct, position);
  92
  93         if(this.el){
  94             if (this.el.attr('xtype')) {
  95                 this.el.attr('xtypex', this.el.attr('xtype'));
  96                 this.el.dom.removeAttribute('xtype');
  97
  98                 this.initEvents();
  99             }
 100
 101             return;
 102         }
 103
 104
 105
 106         var cfg = Roo.apply({},  this.getAutoCreate());
 107
 108         cfg.id = this.id || Roo.id();
 109
 110         // fill in the extra attributes
 111         if (this.xattr && typeof(this.xattr) =='object') {
 112             for (var i in this.xattr) {
 113                 cfg[i] = this.xattr[i];
 114             }
 115         }
 116
 117         if(this.dataId){
 118             cfg.dataId = this.dataId;
 119         }
 120
 121         if (this.cls) {
 122             cfg.cls = (typeof(cfg.cls) == 'undefined' ? this.cls : cfg.cls) + ' ' + this.cls;
 123         }
 124
 125         if (this.style) { // fixme needs to support more complex style data.
 126             cfg.style = (typeof(cfg.style) == 'undefined' ? this.style : cfg.style) + '; ' + this.style;
 127         }
 128
 129         if(this.name){
 130             cfg.name = this.name;
 131         }
 132
 133         this.el = ct.createChild(cfg, position);
 134
 135         if (this.tooltip) {
 136             this.tooltipEl().attr('tooltip', this.tooltip);
 137         }
 138
 139         if(this.tabIndex !== undefined){
 140             this.el.dom.setAttribute('tabIndex', this.tabIndex);
 141         }
 142
 143         this.initEvents();
 144
 145     },
 146     /**
 147      * Fetch the element to add children to
 148      * @return {Roo.Element} defaults to this.el
 149      */
 150     getChildContainer : function()
 151     {
 152         return this.el;
 153     },
 154     getDocumentBody : function() // used by menus - as they are attached to the body so zIndexes work
 155     {
 156         return Roo.get(document.body);
 157     },
 158
 159     /**
 160      * Fetch the element to display the tooltip on.
 161      * @return {Roo.Element} defaults to this.el
 162      */
 163     tooltipEl : function()
 164     {
 165         return this.el;
 166     },
 167
 168     addxtype  : function(tree,cntr)
 169     {
 170         var cn = this;
 171
 172         cn = Roo.factory(tree);
 173         //Roo.log(['addxtype', cn]);
 174
 175         cn.parentType = this.xtype; //??
 176         cn.parentId = this.id;
 177
 178         cntr = (typeof(cntr) == 'undefined' ) ? 'getChildContainer' : cntr;
 179         if (typeof(cn.container_method) == 'string') {
 180             cntr = cn.container_method;
 181         }
 182
 183
 184         var has_flexy_each =  (typeof(tree['flexy:foreach']) != 'undefined');
 185
 186         var has_flexy_if =  (typeof(tree['flexy:if']) != 'undefined');
 187
 188         var build_from_html =  Roo.XComponent.build_from_html;
 189
 190         var is_body  = (tree.xtype == 'Body') ;
 191
 192         var page_has_body = (Roo.get(document.body).attr('xtype') == 'Roo.bootstrap.Body');
 193
 194         var self_cntr_el = Roo.get(this[cntr](false));
 195
 196         // do not try and build conditional elements
 197         if ((has_flexy_each || has_flexy_if || this.can_build_overlaid == false ) && build_from_html) {
 198             return false;
 199         }
 200
 201         if (!has_flexy_each || !build_from_html || is_body || !page_has_body) {
 202             if(!has_flexy_if || typeof(tree.name) == 'undefined' || !build_from_html || is_body || !page_has_body){
 203                 return this.addxtypeChild(tree,cntr, is_body);
 204             }
 205
 206             var echild =self_cntr_el ? self_cntr_el.child('>*[name=' + tree.name + ']') : false;
 207
 208             if(echild){
 209                 return this.addxtypeChild(Roo.apply({}, tree),cntr);
 210             }
 211
 212             Roo.log('skipping render');
 213             return cn;
 214
 215         }
 216
 217         var ret = false;
 218         if (!build_from_html) {
 219             return false;
 220         }
 221
 222         // this i think handles overlaying multiple children of the same type
 223         // with the sam eelement.. - which might be buggy..
 224         while (true) {
 225             var echild =self_cntr_el ? self_cntr_el.child('>*[xtype]') : false;
 226             Roo.log(echild);
 227             Roo.log(cn);
 228             if (!echild) {
 229                 break;
 230             }
 231
 232             if (echild && echild.attr('xtype').split('.').pop() != cn.xtype) {
 233                 break;
 234             }
 235
 236             ret = this.addxtypeChild(Roo.apply({}, tree),cntr);
 237         }
 238
 239         return ret;
 240     },
 241
 242
 243     addxtypeChild : function (tree, cntr, is_body)
 244     {
 245         Roo.debug && Roo.log('addxtypeChild:' + cntr);
 246         var cn = this;
 247         cntr = (typeof(cntr) == 'undefined' ) ? 'getChildContainer' : cntr;
 248
 249
 250         var has_flexy = (typeof(tree['flexy:if']) != 'undefined') ||
 251                     (typeof(tree['flexy:foreach']) != 'undefined');
 252
 253
 254
 255         skip_children = false;
 256         // render the element if it's not BODY.
 257         if (!is_body) {
 258
 259             // if parent was disabled, then do not try and create the children..
 260             if(!this[cntr](true)){
 261                 tree.items = [];
 262                 return tree;
 263             }
 264
 265             cn = Roo.factory(tree);
 266
 267             cn.parentType = this.xtype; //??
 268             cn.parentId = this.id;
 269
 270             var build_from_html =  Roo.XComponent.build_from_html;
 271
 272
 273             // does the container contain child eleemnts with 'xtype' attributes.
 274             // that match this xtype..
 275             // note - when we render we create these as well..
 276             // so we should check to see if body has xtype set.
 277             if (build_from_html && Roo.get(document.body).attr('xtype') == 'Roo.bootstrap.Body') {
 278
 279                 var self_cntr_el = Roo.get(this[cntr](false));
 280                 var echild =self_cntr_el ? self_cntr_el.child('>*[xtype]') : false;
 281                 if (echild) {
 282                     //Roo.log(Roo.XComponent.build_from_html);
 283                     //Roo.log("got echild:");
 284                     //Roo.log(echild);
 285                 }
 286                 // there is a scenario where some of the child elements are flexy:if (and all of the same type)
 287                 // and are not displayed -this causes this to use up the wrong element when matching.
 288                 // at present the only work around for this is to nest flexy:if elements in another element that is always rendered.
 289
 290
 291                 if (echild && echild.attr('xtype').split('.').pop() == cn.xtype) {
 292                   //  Roo.log("found child for " + this.xtype +": " + echild.attr('xtype') );
 293
 294
 295
 296                     cn.el = echild;
 297                   //  Roo.log("GOT");
 298                     //echild.dom.removeAttribute('xtype');
 299                 } else {
 300                     Roo.debug && Roo.log("MISSING " + cn.xtype + " on child of " + (this.el ? this.el.attr('xbuilderid') : 'no parent'));
 301                     Roo.debug && Roo.log(self_cntr_el);
 302                     Roo.debug && Roo.log(echild);
 303                     Roo.debug && Roo.log(cn);
 304                 }
 305             }
 306
 307
 308
 309             // if object has flexy:if - then it may or may not be rendered.
 310             if (build_from_html && has_flexy && !cn.el &&  cn.can_build_overlaid) {
 311                 // skip a flexy if element.
 312                 Roo.debug && Roo.log('skipping render');
 313                 Roo.debug && Roo.log(tree);
 314                 if (!cn.el) {
 315                     Roo.debug && Roo.log('skipping all children');
 316                     skip_children = true;
 317                 }
 318
 319              } else {
 320
 321                 // actually if flexy:foreach is found, we really want to create
 322                 // multiple copies here...
 323                 //Roo.log('render');
 324                 //Roo.log(this[cntr]());
 325                 // some elements do not have render methods.. like the layouts...
 326                 /*
 327                 if(this[cntr](true) === false){
 328                     cn.items = [];
 329                     return cn;
 330                 }
 331                 */
 332                 cn.render && cn.render(this[cntr](true));
 333
 334              }
 335             // then add the element..
 336         }
 337
 338         // handle the kids..
 339
 340         var nitems = [];
 341         /*
 342         if (typeof (tree.menu) != 'undefined') {
 343             tree.menu.parentType = cn.xtype;
 344             tree.menu.triggerEl = cn.el;
 345             nitems.push(cn.addxtype(Roo.apply({}, tree.menu)));
 346
 347         }
 348         */
 349         if (!tree.items || !tree.items.length) {
 350             cn.items = nitems;
 351             //Roo.log(["no children", this]);
 352
 353             return cn;
 354         }
 355
 356         var items = tree.items;
 357         delete tree.items;
 358
 359         //Roo.log(items.length);
 360             // add the items..
 361         if (!skip_children) {
 362             for(var i =0;i < items.length;i++) {
 363               //  Roo.log(['add child', items[i]]);
 364                 nitems.push(cn.addxtype(Roo.apply({}, items[i])));
 365             }
 366         }
 367
 368         cn.items = nitems;
 369
 370         //Roo.log("fire childrenrendered");
 371
 372         cn.fireEvent('childrenrendered', this);
 373
 374         return cn;
 375     },
 376
 377     /**
 378      * Set the element that will be used to show or hide
 379      */
 380     setVisibilityEl : function(el)
 381     {
 382         this.visibilityEl = el;
 383     },
 384
 385      /**
 386      * Get the element that will be used to show or hide
 387      */
 388     getVisibilityEl : function()
 389     {
 390         if (typeof(this.visibilityEl) == 'object') {
 391             return this.visibilityEl;
 392         }
 393
 394         if (typeof(this.visibilityEl) == 'string') {
 395             return this.visibilityEl == 'parent' ? this.parent().getEl() : this.getEl();
 396         }
 397
 398         return this.getEl();
 399     },
 400
 401     /**
 402      * Show a component - removes 'hidden' class
 403      */
 404     show : function()
 405     {
 406         if(!this.getVisibilityEl()){
 407             return;
 408         }
 409
 410         this.getVisibilityEl().removeClass(['hidden','d-none']);
 411
 412         this.fireEvent('show', this);
 413
 414
 415     },
 416     /**
 417      * Hide a component - adds 'hidden' class
 418      */
 419     hide: function()
 420     {
 421         if(!this.getVisibilityEl()){
 422             return;
 423         }
 424
 425         this.getVisibilityEl().addClass(['hidden','d-none']);
 426
 427         this.fireEvent('hide', this);
 428
 429     }
 430 });
 431
 432