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         this.initEvents();
 140
 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
 166         cn.parentType = this.xtype; //??
 167         cn.parentId = this.id;
 168
 169         cntr = (typeof(cntr) == 'undefined' ) ? 'getChildContainer' : cntr;
 170         if (typeof(cn.container_method) == 'string') {
 171             cntr = cn.container_method;
 172         }
 173
 174
 175         var has_flexy_each =  (typeof(tree['flexy:foreach']) != 'undefined');
 176
 177         var has_flexy_if =  (typeof(tree['flexy:if']) != 'undefined');
 178
 179         var build_from_html =  Roo.XComponent.build_from_html;
 180
 181         var is_body  = (tree.xtype == 'Body') ;
 182
 183         var page_has_body = (Roo.get(document.body).attr('xtype') == 'Roo.bootstrap.Body');
 184
 185         var self_cntr_el = Roo.get(this[cntr](false));
 186
 187         // do not try and build conditional elements
 188         if ((has_flexy_each || has_flexy_if || this.can_build_overlaid == false ) && build_from_html) {
 189             return false;
 190         }
 191
 192         if (!has_flexy_each || !build_from_html || is_body || !page_has_body) {
 193             if(!has_flexy_if || typeof(tree.name) == 'undefined' || !build_from_html || is_body || !page_has_body){
 194                 return this.addxtypeChild(tree,cntr, is_body);
 195             }
 196
 197             var echild =self_cntr_el ? self_cntr_el.child('>*[name=' + tree.name + ']') : false;
 198
 199             if(echild){
 200                 return this.addxtypeChild(Roo.apply({}, tree),cntr);
 201             }
 202
 203             Roo.log('skipping render');
 204             return cn;
 205
 206         }
 207
 208         var ret = false;
 209         if (!build_from_html) {
 210             return false;
 211         }
 212
 213         // this i think handles overlaying multiple children of the same type
 214         // with the sam eelement.. - which might be buggy..
 215         while (true) {
 216             var echild =self_cntr_el ? self_cntr_el.child('>*[xtype]') : false;
 217
 218             if (!echild) {
 219                 break;
 220             }
 221
 222             if (echild && echild.attr('xtype').split('.').pop() != cn.xtype) {
 223                 break;
 224             }
 225
 226             ret = this.addxtypeChild(Roo.apply({}, tree),cntr);
 227         }
 228
 229         return ret;
 230     },
 231
 232     addxtypeChild : function (tree, cntr, is_body)
 233     {
 234         Roo.debug && Roo.log('addxtypeChild:' + cntr);
 235         var cn = this;
 236         cntr = (typeof(cntr) == 'undefined' ) ? 'getChildContainer' : cntr;
 237
 238
 239         var has_flexy = (typeof(tree['flexy:if']) != 'undefined') ||
 240                     (typeof(tree['flexy:foreach']) != 'undefined');
 241
 242
 243
 244          skip_children = false;
 245         // render the element if it's not BODY.
 246         if (!is_body) {
 247
 248             cn = Roo.factory(tree);
 249
 250             cn.parentType = this.xtype; //??
 251             cn.parentId = this.id;
 252
 253             var build_from_html =  Roo.XComponent.build_from_html;
 254
 255
 256             // does the container contain child eleemnts with 'xtype' attributes.
 257             // that match this xtype..
 258             // note - when we render we create these as well..
 259             // so we should check to see if body has xtype set.
 260             if (build_from_html && Roo.get(document.body).attr('xtype') == 'Roo.bootstrap.Body') {
 261
 262                 var self_cntr_el = Roo.get(this[cntr](false));
 263                 var echild =self_cntr_el ? self_cntr_el.child('>*[xtype]') : false;
 264                 if (echild) {
 265                     //Roo.log(Roo.XComponent.build_from_html);
 266                     //Roo.log("got echild:");
 267                     //Roo.log(echild);
 268                 }
 269                 // there is a scenario where some of the child elements are flexy:if (and all of the same type)
 270                 // and are not displayed -this causes this to use up the wrong element when matching.
 271                 // at present the only work around for this is to nest flexy:if elements in another element that is always rendered.
 272
 273
 274                 if (echild && echild.attr('xtype').split('.').pop() == cn.xtype) {
 275                   //  Roo.log("found child for " + this.xtype +": " + echild.attr('xtype') );
 276
 277
 278
 279                     cn.el = echild;
 280                   //  Roo.log("GOT");
 281                     //echild.dom.removeAttribute('xtype');
 282                 } else {
 283                     Roo.debug && Roo.log("MISSING " + cn.xtype + " on child of " + (this.el ? this.el.attr('xbuilderid') : 'no parent'));
 284                     Roo.debug && Roo.log(self_cntr_el);
 285                     Roo.debug && Roo.log(echild);
 286                     Roo.debug && Roo.log(cn);
 287                 }
 288             }
 289
 290
 291
 292             // if object has flexy:if - then it may or may not be rendered.
 293             if (build_from_html && has_flexy && !cn.el &&  cn.can_build_overlaid) {
 294                 // skip a flexy if element.
 295                 Roo.debug && Roo.log('skipping render');
 296                 Roo.debug && Roo.log(tree);
 297                 if (!cn.el) {
 298                     Roo.debug && Roo.log('skipping all children');
 299                     skip_children = true;
 300                 }
 301
 302              } else {
 303
 304                 // actually if flexy:foreach is found, we really want to create
 305                 // multiple copies here...
 306                 //Roo.log('render');
 307                 //Roo.log(this[cntr]());
 308                 cn.render(this[cntr](true));
 309              }
 310             // then add the element..
 311         }
 312
 313
 314         // handle the kids..
 315
 316         var nitems = [];
 317         /*
 318         if (typeof (tree.menu) != 'undefined') {
 319             tree.menu.parentType = cn.xtype;
 320             tree.menu.triggerEl = cn.el;
 321             nitems.push(cn.addxtype(Roo.apply({}, tree.menu)));
 322
 323         }
 324         */
 325         if (!tree.items || !tree.items.length) {
 326             cn.items = nitems;
 327             Roo.log(this);
 328             Roo.log("no children");
 329             return cn;
 330         }
 331
 332         var items = tree.items;
 333         delete tree.items;
 334
 335         //Roo.log(items.length);
 336             // add the items..
 337         if (!skip_children) {
 338             for(var i =0;i < items.length;i++) {
 339                 Roo.log(['add child', items[i]]);
 340                 nitems.push(cn.addxtype(Roo.apply({}, items[i])));
 341             }
 342         }
 343
 344         cn.items = nitems;
 345
 346         Roo.log("fire childrenrendered");
 347
 348         cn.fireEvent('childrenrendered', this);
 349
 350         return cn;
 351     },
 352     /**
 353      * Show a component - removes 'hidden' class
 354      */
 355     show : function()
 356     {
 357         if (this.el) {
 358             this.el.removeClass('hidden');
 359         }
 360     },
 361     /**
 362      * Hide a component - adds 'hidden' class
 363      */
 364     hide: function()
 365     {
 366         if (this.el && !this.el.hasClass('hidden')) {
 367             this.el.addClass('hidden');
 368         }
 369
 370     }
 371 });
 372
 373