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