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