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