Roo/bootstrap/Component.js
[roojs1] / 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         cfg.id = Roo.id();
105         
106         // fill in the extra attributes 
107         if (this.xattr && typeof(this.xattr) =='object') {
108             for (var i in this.xattr) {
109                 cfg[i] = this.xattr[i];
110             }
111         }
112         
113         if(this.dataId){
114             cfg.dataId = this.dataId;
115         }
116         
117         if (this.cls) {
118             cfg.cls = (typeof(cfg.cls) == 'undefined') ? this.cls : cfg.cls + ' ' + this.cls;
119         }
120         
121         if (this.style) { // fixme needs to support more complex style data.
122             cfg.style = this.style;
123         }
124         
125         if(this.name){
126             cfg.name = this.name;
127         }
128         
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         this.initEvents();
141         
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     addxtype  : function(tree,cntr)
162     {
163         var cn = this;
164         
165         cn = Roo.factory(tree);
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);
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         
211         while (true) {
212             var echild =self_cntr_el ? self_cntr_el.child('>*[xtype]') : false;
213             
214             if (!echild) {
215                 break;
216             }
217             
218             if (echild && echild.attr('xtype').split('.').pop() != cn.xtype) {
219                 break;
220             }
221             
222             ret = this.addxtypeChild(Roo.apply({}, tree),cntr);
223         }
224         return ret;
225     },
226     
227     addxtypeChild : function (tree, cntr)
228     {
229         Roo.debug && Roo.log('addxtypeChild:' + cntr);
230         var cn = this;
231         cntr = (typeof(cntr) == 'undefined' ) ? 'getChildContainer' : cntr;
232         
233         
234         var has_flexy = (typeof(tree['flexy:if']) != 'undefined') ||
235                     (typeof(tree['flexy:foreach']) != 'undefined');
236           
237         
238         
239          skip_children = false;
240         // render the element if it's not BODY.
241         if (tree.xtype != 'Body') {
242            
243             cn = Roo.factory(tree);
244            
245             cn.parentType = this.xtype; //??
246             cn.parentId = this.id;
247             
248             var build_from_html =  Roo.XComponent.build_from_html;
249             
250             
251             // does the container contain child eleemnts with 'xtype' attributes.
252             // that match this xtype..
253             // note - when we render we create these as well..
254             // so we should check to see if body has xtype set.
255             if (build_from_html && Roo.get(document.body).attr('xtype') == 'Roo.bootstrap.Body') {
256                
257                 var self_cntr_el = Roo.get(this[cntr](false));
258                 var echild =self_cntr_el ? self_cntr_el.child('>*[xtype]') : false;
259                 Roo.log("got echild:");
260                 Roo.log(echild);
261                 // there is a scenario where some of the child elements are flexy:if (and all of the same type)
262                 // and are not displayed -this causes this to use up the wrong element when matching.
263                 // at present the only work around for this is to nest flexy:if elements in another element that is always rendered.
264                 
265                 
266                 if (echild && echild.attr('xtype').split('.').pop() == cn.xtype) {
267                   //  Roo.log("found child for " + this.xtype +": " + echild.attr('xtype') );
268                   
269                   
270                   
271                     cn.el = echild;
272                   //  Roo.log("GOT");
273                     //echild.dom.removeAttribute('xtype');
274                 } else {
275                     Roo.debug && Roo.log("MISSING " + cn.xtype + " on child of " + (this.el ? this.el.attr('xbuilderid') : 'no parent'));
276                     Roo.debug && Roo.log(self_cntr_el);
277                     Roo.debug && Roo.log(echild);
278                     Roo.debug && Roo.log(cn);
279                 }
280             }
281            
282             
283            
284             // if object has flexy:if - then it may or may not be rendered.
285             if (build_from_html && has_flexy && !cn.el &&  cn.can_build_overlaid) {
286                 // skip a flexy if element.
287                 Roo.debug && Roo.log('skipping render');
288                 Roo.debug && Roo.log(tree);
289                 if (!cn.el) {
290                     Roo.debug && Roo.log('skipping all children');
291                     skip_children = true;
292                 }
293                 
294              } else {
295                  
296                 // actually if flexy:foreach is found, we really want to create 
297                 // multiple copies here...
298                 //Roo.log('render');
299                 //Roo.log(this[cntr]());
300                 cn.render(this[cntr](true));
301              }
302             // then add the element..
303         }
304         
305         
306         // handle the kids..
307         
308         var nitems = [];
309         /*
310         if (typeof (tree.menu) != 'undefined') {
311             tree.menu.parentType = cn.xtype;
312             tree.menu.triggerEl = cn.el;
313             nitems.push(cn.addxtype(Roo.apply({}, tree.menu)));
314             
315         }
316         */
317         if (!tree.items || !tree.items.length) {
318             cn.items = nitems;
319             return cn;
320         }
321         var items = tree.items;
322         delete tree.items;
323         
324         //Roo.log(items.length);
325             // add the items..
326         if (!skip_children) {    
327             for(var i =0;i < items.length;i++) {
328                 nitems.push(cn.addxtype(Roo.apply({}, items[i])));
329             }
330         }
331         
332         cn.items = nitems;
333         
334         this.fireEvent('childrenrendered', this);
335         
336         return cn;
337     } 
338     
339     
340 });
341
342