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)
166 var hp = this.parent ? 1 : 0;
168 if (!el && typeof(this.parent) == 'string' && this.parent.substring(0,1) == '#') {
169 // if parent is a '#.....' string, then let's use that..
170 var ename = this.parent.substr(1)
171 this.parent = (this.parent == '#bootstrap') ? { el : true} : false; // flags it as a top module...
173 if (!el && !this.parent) {
174 Roo.log("Warning - element can not be found :#" + ename );
178 var tree = this._tree ? this._tree() : this.tree();
180 // altertive root elements ??? - we need a better way to indicate these.
181 var is_alt = (typeof(Roo.bootstrap) != 'undefined' && tree.xns == Roo.bootstrap) ||
182 (typeof(Roo.mailer) != 'undefined' && tree.xns == Roo.mailer) ;
184 if (!this.parent && is_alt) {
185 //el = Roo.get(document.body);
186 this.parent = { el : true };
193 Roo.log("no parent - creating one");
195 el = el ? Roo.get(el) : false;
197 // it's a top level one..
199 el : new Roo.BorderLayout(el || document.body, {
207 alwaysShowTabs: el && hp? false : true,
208 hideTabs: el || !hp ? true : false,
215 if (!this.parent.el) {
216 // probably an old style ctor, which has been disabled.
220 // The 'tree' method is '_tree now'
222 tree.region = tree.region || this.region;
224 if (this.parent.el === true) {
225 // bootstrap... - body..
226 this.parent.el = Roo.factory(tree);
229 this.el = this.parent.el.addxtype(tree);
230 this.fireEvent('built', this);
232 this.panel = this.el;
233 this.layout = this.panel.layout;
234 this.parentLayout = this.parent.layout || false;
240 Roo.apply(Roo.XComponent, {
242 * @property hideProgress
243 * true to disable the building progress bar.. usefull on single page renders.
246 hideProgress : false,
248 * @property buildCompleted
249 * True when the builder has completed building the interface.
252 buildCompleted : false,
255 * @property topModule
256 * the upper most module - uses document.element as it's constructor.
264 * array of modules to be created by registration system.
265 * @type {Array} of Roo.XComponent
270 * @property elmodules
271 * array of modules to be created by which use #ID
272 * @type {Array} of Roo.XComponent
278 * @property build_from_html
279 * Build elements from html - used by bootstrap HTML stuff
280 * - this is cleared after build is completed
281 * @type {boolean} true (default false)
284 build_from_html : false,
287 * Register components to be built later.
289 * This solves the following issues
290 * - Building is not done on page load, but after an authentication process has occured.
291 * - Interface elements are registered on page load
292 * - Parent Interface elements may not be loaded before child, so this handles that..
299 module : 'Pman.Tab.projectMgr',
301 parent : 'Pman.layout',
302 disabled : false, // or use a function..
305 * * @param {Object} details about module
307 register : function(obj) {
309 Roo.XComponent.event.fireEvent('register', obj);
310 switch(typeof(obj.disabled) ) {
316 if ( obj.disabled() ) {
328 this.modules.push(obj);
332 * convert a string to an object..
333 * eg. 'AAA.BBB' -> finds AAA.BBB
337 toObject : function(str)
339 if (!str || typeof(str) == 'object') {
342 if (str.substring(0,1) == '#') {
346 var ar = str.split('.');
351 eval('if (typeof ' + rt + ' == "undefined"){ o = false;} o = ' + rt + ';');
353 throw "Module not found : " + str;
357 throw "Module not found : " + str;
359 Roo.each(ar, function(e) {
360 if (typeof(o[e]) == 'undefined') {
361 throw "Module not found : " + str;
372 * move modules into their correct place in the tree..
375 preBuild : function ()
378 Roo.each(this.modules , function (obj)
380 Roo.XComponent.event.fireEvent('beforebuild', obj);
382 var opar = obj.parent;
384 obj.parent = this.toObject(opar);
386 Roo.log("parent:toObject failed: " + e.toString());
391 Roo.debug && Roo.log("GOT top level module");
392 Roo.debug && Roo.log(obj);
393 obj.modules = new Roo.util.MixedCollection(false,
394 function(o) { return o.order + '' }
396 this.topModule = obj;
399 // parent is a string (usually a dom element name..)
400 if (typeof(obj.parent) == 'string') {
401 this.elmodules.push(obj);
404 if (obj.parent.constructor != Roo.XComponent) {
405 Roo.log("Warning : Object Parent is not instance of XComponent:" + obj.name)
407 if (!obj.parent.modules) {
408 obj.parent.modules = new Roo.util.MixedCollection(false,
409 function(o) { return o.order + '' }
412 if (obj.parent.disabled) {
415 obj.parent.modules.add(obj);
420 * make a list of modules to build.
421 * @return {Array} list of modules.
424 buildOrder : function()
427 var cmp = function(a,b) {
428 return String(a).toUpperCase() > String(b).toUpperCase() ? 1 : -1;
430 if ((!this.topModule || !this.topModule.modules) && !this.elmodules.length) {
431 throw "No top level modules to build";
434 // make a flat list in order of modules to build.
435 var mods = this.topModule ? [ this.topModule ] : [];
438 // elmodules (is a list of DOM based modules )
439 Roo.each(this.elmodules, function(e) {
441 if (!this.topModule &&
442 typeof(e.parent) == 'string' &&
443 e.parent.substring(0,1) == '#' &&
444 Roo.get(e.parent.substr(1))
453 // add modules to their parents..
454 var addMod = function(m) {
455 Roo.debug && Roo.log("build Order: add: " + m.name);
458 if (m.modules && !m.disabled) {
459 Roo.debug && Roo.log("build Order: " + m.modules.length + " child modules");
460 m.modules.keySort('ASC', cmp );
461 Roo.debug && Roo.log("build Order: " + m.modules.length + " child modules (after sort)");
463 m.modules.each(addMod);
465 Roo.debug && Roo.log("build Order: no child modules");
467 // not sure if this is used any more..
469 m.finalize.name = m.name + " (clean up) ";
470 mods.push(m.finalize);
474 if (this.topModule && this.topModule.modules) {
475 this.topModule.modules.keySort('ASC', cmp );
476 this.topModule.modules.each(addMod);
482 * Build the registered modules.
483 * @param {Object} parent element.
484 * @param {Function} optional method to call after module has been added.
488 build : function(opts)
491 if (typeof(opts) != 'undefined') {
492 Roo.apply(this,opts);
496 var mods = this.buildOrder();
498 //this.allmods = mods;
499 //Roo.debug && Roo.log(mods);
501 if (!mods.length) { // should not happen
502 throw "NO modules!!!";
506 var msg = "Building Interface...";
507 // flash it up as modal - so we store the mask!?
508 if (!this.hideProgress && Roo.MessageBox) {
509 Roo.MessageBox.show({ title: 'loading' });
510 Roo.MessageBox.show({
511 title: "Please wait...",
520 var total = mods.length;
523 var progressRun = function() {
525 Roo.debug && Roo.log('hide?');
526 if (!this.hideProgress && Roo.MessageBox) {
527 Roo.MessageBox.hide();
529 Roo.XComponent.build_from_html = false; // reset, so dialogs will be build from javascript
531 Roo.XComponent.event.fireEvent('buildcomplete', _this.topModule);
537 var m = mods.shift();
540 Roo.debug && Roo.log(m);
541 // not sure if this is supported any more.. - modules that are are just function
542 if (typeof(m) == 'function') {
544 return progressRun.defer(10, _this);
548 msg = "Building Interface " + (total - mods.length) +
550 (m.name ? (' - ' + m.name) : '');
551 Roo.debug && Roo.log(msg);
552 if (!this.hideProgress && Roo.MessageBox) {
553 Roo.MessageBox.updateProgress( (total - mods.length)/total, msg );
557 // is the module disabled?
558 var disabled = (typeof(m.disabled) == 'function') ?
559 m.disabled.call(m.module.disabled) : m.disabled;
563 return progressRun(); // we do not update the display!
571 // it's 10 on top level, and 1 on others??? why...
572 return progressRun.defer(10, _this);
575 progressRun.defer(1, _this);
589 * wrapper for event.on - aliased later..
590 * Typically use to register a event handler for register:
592 * eg. Roo.XComponent.on('register', function(comp) { comp.disable = true } );
601 Roo.XComponent.event = new Roo.util.Observable({
605 * Fires when an Component is registered,
606 * set the disable property on the Component to stop registration.
607 * @param {Roo.XComponent} c the component being registerd.
613 * Fires before each Component is built
614 * can be used to apply permissions.
615 * @param {Roo.XComponent} c the component being registerd.
618 'beforebuild' : true,
620 * @event buildcomplete
621 * Fires on the top level element when all elements have been built
622 * @param {Roo.XComponent} the top level component.
624 'buildcomplete' : true
629 Roo.XComponent.on = Roo.XComponent.event.on.createDelegate(Roo.XComponent.event);