4 * base class for bootstrap elements.
8 Roo.bootstrap = Roo.bootstrap || {};
10 * @class Roo.bootstrap.Component
11 * @extends Roo.Component
13 * @children Roo.bootstrap.Component
14 * Bootstrap Component base class
15 * @cfg {String} cls css class
16 * @cfg {String} style any extra css
17 * @cfg {Object} xattr extra attributes to add to 'element' (used by builder to store stuff.)
18 * @cfg {Boolean} can_build_overlaid True if element can be rebuild from a HTML page
19 * @cfg {string} dataId cutomer id
20 * @cfg {string} name Specifies name attribute
21 * @cfg {string} tooltip Text for the tooltip
22 * @cfg {string} container_method method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)
23 * @cfg {string|object} visibilityEl (el|parent) What element to use for visibility (@see getVisibilityEl())
26 * Do not use directly - it does not do anything..
27 * @param {Object} config The config object
32 Roo.bootstrap.Component = function(config){
33 Roo.bootstrap.Component.superclass.constructor.call(this, config);
37 * @event childrenrendered
38 * Fires when the children have been rendered..
39 * @param {Roo.bootstrap.Component} this
41 "childrenrendered" : true
50 Roo.extend(Roo.bootstrap.Component, Roo.BoxComponent, {
53 allowDomMove : false, // to stop relocations in parent onRender...
63 * Initialize Events for the element
65 initEvents : function() { },
71 can_build_overlaid : true,
73 container_method : false,
80 // returns the parent component..
81 return Roo.ComponentMgr.get(this.parentId)
87 onRender : function(ct, position)
89 // Roo.log("Call onRender: " + this.xtype);
91 Roo.bootstrap.Component.superclass.onRender.call(this, ct, position);
94 if (this.el.attr('xtype')) {
95 this.el.attr('xtypex', this.el.attr('xtype'));
96 this.el.dom.removeAttribute('xtype');
106 var cfg = Roo.apply({}, this.getAutoCreate());
108 cfg.id = this.id || Roo.id();
110 // fill in the extra attributes
111 if (this.xattr && typeof(this.xattr) =='object') {
112 for (var i in this.xattr) {
113 cfg[i] = this.xattr[i];
118 cfg.dataId = this.dataId;
122 cfg.cls = (typeof(cfg.cls) == 'undefined' ? this.cls : cfg.cls) + ' ' + this.cls;
125 if (this.style) { // fixme needs to support more complex style data.
126 cfg.style = (typeof(cfg.style) == 'undefined' ? this.style : cfg.style) + '; ' + this.style;
130 cfg.name = this.name;
133 this.el = ct.createChild(cfg, position);
136 this.tooltipEl().attr('tooltip', this.tooltip);
139 if(this.tabIndex !== undefined){
140 this.el.dom.setAttribute('tabIndex', this.tabIndex);
147 * Fetch the element to add children to
148 * @return {Roo.Element} defaults to this.el
150 getChildContainer : function()
154 getDocumentBody : function() // used by menus - as they are attached to the body so zIndexes work
156 return Roo.get(document.body);
160 * Fetch the element to display the tooltip on.
161 * @return {Roo.Element} defaults to this.el
163 tooltipEl : function()
168 addxtype : function(tree,cntr)
172 cn = Roo.factory(tree);
173 //Roo.log(['addxtype', cn]);
175 cn.parentType = this.xtype; //??
176 cn.parentId = this.id;
178 cntr = (typeof(cntr) == 'undefined' ) ? 'getChildContainer' : cntr;
179 if (typeof(cn.container_method) == 'string') {
180 cntr = cn.container_method;
184 var has_flexy_each = (typeof(tree['flexy:foreach']) != 'undefined');
186 var has_flexy_if = (typeof(tree['flexy:if']) != 'undefined');
188 var build_from_html = Roo.XComponent.build_from_html;
190 var is_body = (tree.xtype == 'Body') ;
192 var page_has_body = (Roo.get(document.body).attr('xtype') == 'Roo.bootstrap.Body');
194 var self_cntr_el = Roo.get(this[cntr](false));
196 // do not try and build conditional elements
197 if ((has_flexy_each || has_flexy_if || this.can_build_overlaid == false ) && build_from_html) {
201 if (!has_flexy_each || !build_from_html || is_body || !page_has_body) {
202 if(!has_flexy_if || typeof(tree.name) == 'undefined' || !build_from_html || is_body || !page_has_body){
203 return this.addxtypeChild(tree,cntr, is_body);
206 var echild =self_cntr_el ? self_cntr_el.child('>*[name=' + tree.name + ']') : false;
209 return this.addxtypeChild(Roo.apply({}, tree),cntr);
212 Roo.log('skipping render');
218 if (!build_from_html) {
222 // this i think handles overlaying multiple children of the same type
223 // with the sam eelement.. - which might be buggy..
225 var echild =self_cntr_el ? self_cntr_el.child('>*[xtype]') : false;
231 if (echild && echild.attr('xtype').split('.').pop() != cn.xtype) {
235 ret = this.addxtypeChild(Roo.apply({}, tree),cntr);
242 addxtypeChild : function (tree, cntr, is_body)
244 Roo.debug && Roo.log('addxtypeChild:' + cntr);
246 cntr = (typeof(cntr) == 'undefined' ) ? 'getChildContainer' : cntr;
249 var has_flexy = (typeof(tree['flexy:if']) != 'undefined') ||
250 (typeof(tree['flexy:foreach']) != 'undefined');
254 skip_children = false;
255 // render the element if it's not BODY.
258 // if parent was disabled, then do not try and create the children..
259 if(!this[cntr](true)){
264 cn = Roo.factory(tree);
266 cn.parentType = this.xtype; //??
267 cn.parentId = this.id;
269 var build_from_html = Roo.XComponent.build_from_html;
272 // does the container contain child eleemnts with 'xtype' attributes.
273 // that match this xtype..
274 // note - when we render we create these as well..
275 // so we should check to see if body has xtype set.
276 if (build_from_html && Roo.get(document.body).attr('xtype') == 'Roo.bootstrap.Body') {
278 var self_cntr_el = Roo.get(this[cntr](false));
279 var echild =self_cntr_el ? self_cntr_el.child('>*[xtype]') : false;
281 //Roo.log(Roo.XComponent.build_from_html);
282 //Roo.log("got echild:");
285 // there is a scenario where some of the child elements are flexy:if (and all of the same type)
286 // and are not displayed -this causes this to use up the wrong element when matching.
287 // at present the only work around for this is to nest flexy:if elements in another element that is always rendered.
290 if (echild && echild.attr('xtype').split('.').pop() == cn.xtype) {
291 // Roo.log("found child for " + this.xtype +": " + echild.attr('xtype') );
297 //echild.dom.removeAttribute('xtype');
299 Roo.debug && Roo.log("MISSING " + cn.xtype + " on child of " + (this.el ? this.el.attr('xbuilderid') : 'no parent'));
300 Roo.debug && Roo.log(self_cntr_el);
301 Roo.debug && Roo.log(echild);
302 Roo.debug && Roo.log(cn);
308 // if object has flexy:if - then it may or may not be rendered.
309 if (build_from_html && has_flexy && !cn.el && cn.can_build_overlaid) {
310 // skip a flexy if element.
311 Roo.debug && Roo.log('skipping render');
312 Roo.debug && Roo.log(tree);
314 Roo.debug && Roo.log('skipping all children');
315 skip_children = true;
320 // actually if flexy:foreach is found, we really want to create
321 // multiple copies here...
323 //Roo.log(this[cntr]());
324 // some elements do not have render methods.. like the layouts...
326 if(this[cntr](true) === false){
331 cn.render && cn.render(this[cntr](true));
334 // then add the element..
341 if (typeof (tree.menu) != 'undefined') {
342 tree.menu.parentType = cn.xtype;
343 tree.menu.triggerEl = cn.el;
344 nitems.push(cn.addxtype(Roo.apply({}, tree.menu)));
348 if (!tree.items || !tree.items.length) {
350 //Roo.log(["no children", this]);
355 var items = tree.items;
358 //Roo.log(items.length);
360 if (!skip_children) {
361 for(var i =0;i < items.length;i++) {
362 // Roo.log(['add child', items[i]]);
363 nitems.push(cn.addxtype(items[i].xns == false ? items[i] : Roo.apply({}, items[i])));
369 //Roo.log("fire childrenrendered");
371 cn.fireEvent('childrenrendered', this);
377 * Set the element that will be used to show or hide
379 setVisibilityEl : function(el)
381 this.visibilityEl = el;
385 * Get the element that will be used to show or hide
387 getVisibilityEl : function()
389 if (typeof(this.visibilityEl) == 'object') {
390 return this.visibilityEl;
393 if (typeof(this.visibilityEl) == 'string') {
394 return this.visibilityEl == 'parent' ? this.parent().getEl() : this.getEl();
401 * Show a component - removes 'hidden' class
405 if(!this.getVisibilityEl()){
409 this.getVisibilityEl().removeClass(['hidden','d-none']);
411 this.fireEvent('show', this);
416 * Hide a component - adds 'hidden' class
420 if(!this.getVisibilityEl()){
424 this.getVisibilityEl().addClass(['hidden','d-none']);
426 this.fireEvent('hide', this);