2 * Original code for Roojs - LGPL
3 * <script type="text/javascript">
7 * @class Roo.XComponent
8 * A delayed Element creator...
9 * Or a way to group chunks of interface together.
10 * technically this is a wrapper around a tree of Roo elements (which defines a 'module'),
11 * used in conjunction with XComponent.build() it will create an instance of each element,
12 * then call addxtype() to build the User interface.
14 * Mypart.xyx = new Roo.XComponent({
16 parent : 'Mypart.xyz', // empty == document.element.!!
20 disabled : function() {}
22 tree : function() { // return an tree of xtype declared components
26 xtype : 'NestedLayoutPanel',
33 * It can be used to build a big heiracy, with parent etc.
34 * or you can just use this to render a single compoent to a dom element
35 * MYPART.render(Roo.Element | String(id) | dom_element )
42 * Roo is designed primarily as a single page application, so the UI build for a standard interface will
43 * expect a single 'TOP' level module normally indicated by the 'parent' of the XComponent definition being defined as false.
45 * Each sub module is expected to have a parent pointing to the class name of it's parent module.
47 * When the top level is false, a 'Roo.BorderLayout' is created and the element is flagged as 'topModule'
48 * - if mulitple topModules exist, the last one is defined as the top module.
52 * When the top level or multiple modules are to embedded into a existing HTML page,
53 * the parent element can container '#id' of the element where the module will be drawn.
57 * Unlike classic Roo, the bootstrap tends not to be used as a single page.
58 * it relies more on a include mechanism, where sub modules are included into an outer page.
59 * This is normally managed by the builder tools using Roo.apply( options, Included.Sub.Module )
61 * Bootstrap Roo Included elements
63 * Our builder application needs the ability to preview these sub compoennts. They will normally have parent=false set,
64 * hence confusing the component builder as it thinks there are multiple top level elements.
68 * @extends Roo.util.Observable
70 * @param cfg {Object} configuration of component
73 Roo.XComponent = function(cfg) {
78 * Fires when this the componnt is built
79 * @param {Roo.XComponent} c the component
84 this.region = this.region || 'center'; // default..
85 Roo.XComponent.register(this);
87 this.el = false; // where the layout goes..
91 Roo.extend(Roo.XComponent, Roo.util.Observable, {
94 * The created element (with Roo.factory())
101 * for BC - use el in new code
108 * for BC - use el in new code
114 * @cfg {Function|boolean} disabled
115 * If this module is disabled by some rule, return true from the funtion
120 * @cfg {String} parent
121 * Name of parent element which it get xtype added to..
126 * @cfg {String} order
127 * Used to set the order in which elements are created (usefull for multiple tabs)
133 * String to display while loading.
137 * @cfg {String} region
138 * Region to render component to (defaults to center)
144 * A single item array - the first element is the root of the tree..
145 * It's done this way to stay compatible with the Xtype system...
151 * The method that retuns the tree of parts that make up this compoennt
158 * render element to dom or tree
159 * @param {Roo.Element|String|DomElement} optional render to if parent is not set.
162 render : function(el)
164 Roo.log('render?????');
167 var hp = this.parent ? 1 : 0;
168 Roo.debug && Roo.log(this);
170 if (!el && typeof(this.parent) == 'string' && this.parent.substring(0,1) == '#') {
171 // if parent is a '#.....' string, then let's use that..
172 var ename = this.parent.substr(1);
174 Roo.debug && Roo.log(ename);
176 case 'bootstrap-body' :
177 if (typeof(Roo.bootstrap.Body) != 'undefined') {
178 this.parent = { el : new Roo.bootstrap.Body() };
179 Roo.debug && Roo.log("setting el to doc body");
182 throw "Container is bootstrap body, but Roo.bootstrap.Body is not defined";
186 this.parent = { el : true};
194 if (!el && !this.parent) {
195 Roo.debug && Roo.log("Warning - element can not be found :#" + ename );
199 Roo.debug && Roo.log("EL:");
200 Roo.debug && Roo.log(el);
201 Roo.debug && Roo.log("this.parent.el:");
202 Roo.debug && Roo.log(this.parent.el);
204 var tree = this._tree ? this._tree() : this.tree();
207 // altertive root elements ??? - we need a better way to indicate these.
208 var is_alt = (typeof(Roo.bootstrap) != 'undefined' && tree.xns == Roo.bootstrap) ||
209 (typeof(Roo.mailer) != 'undefined' && tree.xns == Roo.mailer) ;
211 if (!this.parent && is_alt) {
212 //el = Roo.get(document.body);
213 this.parent = { el : true };
220 Roo.debug && Roo.log("no parent - creating one");
222 el = el ? Roo.get(el) : false;
224 // it's a top level one..
226 el : new Roo.BorderLayout(el || document.body, {
234 alwaysShowTabs: el && hp? false : true,
235 hideTabs: el || !hp ? true : false,
241 Roo.log('parent el');
242 Roo.log(this.parent.el);
243 if (!this.parent.el) {
244 // probably an old style ctor, which has been disabled.
248 // The 'tree' method is '_tree now'
250 tree.region = tree.region || this.region;
252 if (this.parent.el === true) {
253 // bootstrap... - body..
254 this.parent.el = Roo.factory(tree);
257 this.el = this.parent.el.addxtype(tree);
258 this.fireEvent('built', this);
260 this.panel = this.el;
261 this.layout = this.panel.layout;
262 this.parentLayout = this.parent.layout || false;
268 Roo.apply(Roo.XComponent, {
270 * @property hideProgress
271 * true to disable the building progress bar.. usefull on single page renders.
274 hideProgress : false,
276 * @property buildCompleted
277 * True when the builder has completed building the interface.
280 buildCompleted : false,
283 * @property topModule
284 * the upper most module - uses document.element as it's constructor.
292 * array of modules to be created by registration system.
293 * @type {Array} of Roo.XComponent
298 * @property elmodules
299 * array of modules to be created by which use #ID
300 * @type {Array} of Roo.XComponent
306 * @property build_from_html
307 * Build elements from html - used by bootstrap HTML stuff
308 * - this is cleared after build is completed
309 * @type {boolean} true (default false)
312 build_from_html : false,
315 * Register components to be built later.
317 * This solves the following issues
318 * - Building is not done on page load, but after an authentication process has occured.
319 * - Interface elements are registered on page load
320 * - Parent Interface elements may not be loaded before child, so this handles that..
327 module : 'Pman.Tab.projectMgr',
329 parent : 'Pman.layout',
330 disabled : false, // or use a function..
333 * * @param {Object} details about module
335 register : function(obj) {
337 Roo.XComponent.event.fireEvent('register', obj);
338 switch(typeof(obj.disabled) ) {
344 if ( obj.disabled() ) {
356 this.modules.push(obj);
360 * convert a string to an object..
361 * eg. 'AAA.BBB' -> finds AAA.BBB
365 toObject : function(str)
367 if (!str || typeof(str) == 'object') {
370 if (str.substring(0,1) == '#') {
374 var ar = str.split('.');
379 eval('if (typeof ' + rt + ' == "undefined"){ o = false;} o = ' + rt + ';');
381 throw "Module not found : " + str;
385 throw "Module not found : " + str;
387 Roo.each(ar, function(e) {
388 if (typeof(o[e]) == 'undefined') {
389 throw "Module not found : " + str;
400 * move modules into their correct place in the tree..
403 preBuild : function ()
406 Roo.each(this.modules , function (obj)
408 Roo.XComponent.event.fireEvent('beforebuild', obj);
410 var opar = obj.parent;
412 obj.parent = this.toObject(opar);
414 Roo.debug && Roo.log("parent:toObject failed: " + e.toString());
419 Roo.debug && Roo.log("GOT top level module");
420 Roo.debug && Roo.log(obj);
421 obj.modules = new Roo.util.MixedCollection(false,
422 function(o) { return o.order + '' }
424 this.topModule = obj;
427 // parent is a string (usually a dom element name..)
428 if (typeof(obj.parent) == 'string') {
429 this.elmodules.push(obj);
432 if (obj.parent.constructor != Roo.XComponent) {
433 Roo.debug && Roo.log("Warning : Object Parent is not instance of XComponent:" + obj.name)
435 if (!obj.parent.modules) {
436 obj.parent.modules = new Roo.util.MixedCollection(false,
437 function(o) { return o.order + '' }
440 if (obj.parent.disabled) {
443 obj.parent.modules.add(obj);
448 * make a list of modules to build.
449 * @return {Array} list of modules.
452 buildOrder : function()
455 var cmp = function(a,b) {
456 return String(a).toUpperCase() > String(b).toUpperCase() ? 1 : -1;
458 if ((!this.topModule || !this.topModule.modules) && !this.elmodules.length) {
459 throw "No top level modules to build";
462 // make a flat list in order of modules to build.
463 var mods = this.topModule ? [ this.topModule ] : [];
466 // elmodules (is a list of DOM based modules )
467 Roo.each(this.elmodules, function(e) {
469 if (!this.topModule &&
470 typeof(e.parent) == 'string' &&
471 e.parent.substring(0,1) == '#' &&
472 Roo.get(e.parent.substr(1))
481 // add modules to their parents..
482 var addMod = function(m) {
483 Roo.debug && Roo.log("build Order: add: " + m.name);
486 if (m.modules && !m.disabled) {
487 Roo.debug && Roo.log("build Order: " + m.modules.length + " child modules");
488 m.modules.keySort('ASC', cmp );
489 Roo.debug && Roo.log("build Order: " + m.modules.length + " child modules (after sort)");
491 m.modules.each(addMod);
493 Roo.debug && Roo.log("build Order: no child modules");
495 // not sure if this is used any more..
497 m.finalize.name = m.name + " (clean up) ";
498 mods.push(m.finalize);
502 if (this.topModule && this.topModule.modules) {
503 this.topModule.modules.keySort('ASC', cmp );
504 this.topModule.modules.each(addMod);
510 * Build the registered modules.
511 * @param {Object} parent element.
512 * @param {Function} optional method to call after module has been added.
516 build : function(opts)
519 if (typeof(opts) != 'undefined') {
520 Roo.apply(this,opts);
524 var mods = this.buildOrder();
526 //this.allmods = mods;
527 //Roo.debug && Roo.log(mods);
529 if (!mods.length) { // should not happen
530 throw "NO modules!!!";
534 var msg = "Building Interface...";
535 // flash it up as modal - so we store the mask!?
536 if (!this.hideProgress && Roo.MessageBox) {
537 Roo.MessageBox.show({ title: 'loading' });
538 Roo.MessageBox.show({
539 title: "Please wait...",
548 var total = mods.length;
551 var progressRun = function() {
553 Roo.debug && Roo.log('hide?');
554 if (!this.hideProgress && Roo.MessageBox) {
555 Roo.MessageBox.hide();
557 Roo.XComponent.build_from_html = false; // reset, so dialogs will be build from javascript
559 Roo.XComponent.event.fireEvent('buildcomplete', _this.topModule);
565 var m = mods.shift();
568 Roo.debug && Roo.log(m);
569 // not sure if this is supported any more.. - modules that are are just function
570 if (typeof(m) == 'function') {
572 return progressRun.defer(10, _this);
576 msg = "Building Interface " + (total - mods.length) +
578 (m.name ? (' - ' + m.name) : '');
579 Roo.debug && Roo.log(msg);
580 if (!this.hideProgress && Roo.MessageBox) {
581 Roo.MessageBox.updateProgress( (total - mods.length)/total, msg );
585 // is the module disabled?
586 var disabled = (typeof(m.disabled) == 'function') ?
587 m.disabled.call(m.module.disabled) : m.disabled;
591 return progressRun(); // we do not update the display!
599 // it's 10 on top level, and 1 on others??? why...
600 return progressRun.defer(10, _this);
603 progressRun.defer(1, _this);
617 * wrapper for event.on - aliased later..
618 * Typically use to register a event handler for register:
620 * eg. Roo.XComponent.on('register', function(comp) { comp.disable = true } );
629 Roo.XComponent.event = new Roo.util.Observable({
633 * Fires when an Component is registered,
634 * set the disable property on the Component to stop registration.
635 * @param {Roo.XComponent} c the component being registerd.
641 * Fires before each Component is built
642 * can be used to apply permissions.
643 * @param {Roo.XComponent} c the component being registerd.
646 'beforebuild' : true,
648 * @event buildcomplete
649 * Fires on the top level element when all elements have been built
650 * @param {Roo.XComponent} the top level component.
652 'buildcomplete' : true
657 Roo.XComponent.on = Roo.XComponent.event.on.createDelegate(Roo.XComponent.event);