2 * Original code for Roojs - LGPL
3 * <script type="text/javascript">
7 * @class Roo.XComponent
8 * A delayed Element creator...
10 * Mypart.xyx = new Roo.XComponent({
12 parent : 'Mypart.xyz', // empty == document.element.!!
16 disabled : function() {}
18 tree : function() { // return an tree of xtype declared components
22 xtype : 'NestedLayoutPanel',
29 * It can be used to build a big heiracy,
31 * MYPART.renderTo(Roo.Element | String(id) | dom_element )
34 * @extends Roo.util.Observable
36 * @param cfg {Object} configuration of component
39 Roo.XComponent = function(cfg) {
44 * Fires when this the componnt is built
45 * @param {Roo.XComponent} c the component
49 * @event buildcomplete
50 * Fires on the top level element when all elements have been built
51 * @param {Roo.XComponent} c the top level component.
53 'buildcomplete' : true
57 Roo.XComponent.register(this);
59 this.el = false; // where the layout goes..
63 Roo.extend(Roo.XComponent, Roo.util.Observable, {
66 * The created element (with Roo.factory())
73 * for BC - use el in new code
80 * for BC - use el in new code
86 * @cfg {Function|boolean} disabled
87 * If this module is disabled by some rule, return true from the funtion
92 * @cfg {String} parent
93 * Name of parent element which it get xtype added to..
99 * Used to set the order in which elements are created (usefull for multiple tabs)
105 * String to display while loading.
110 * A single item array - the first element is the root of the tree..
111 * It's done this way to stay compatible with the Xtype system...
119 Roo.apply(Roo.XComponent, {
122 * @property buildCompleted
123 * True when the builder has completed building the interface.
126 buildCompleted : false,
129 * @property topModule
130 * the upper most module - uses document.element as it's constructor.
138 * array of modules to be created by registration system.
139 * @type Roo.XComponent
146 * Register components to be built later.
148 * This solves the following issues
149 * - Building is not done on page load, but after an authentication process has occured.
150 * - Interface elements are registered on page load
151 * - Parent Interface elements may not be loaded before child, so this handles that..
158 module : 'Pman.Tab.projectMgr',
160 parent : 'Pman.layout',
161 disabled : false, // or use a function..
164 * * @param {Object} details about module
166 register : function(obj) {
167 this.modules.push(obj);
171 * convert a string to an object..
175 toObject : function(str)
177 if (!str || typeof(str) == 'object') {
180 var ar = str.split('.');
184 eval('if (typeof ' + rt + ' == "undefined"){ o = false;} o = ' + rt + ';');
186 throw "Module not found : " + str;
188 Roo.each(ar, function(e) {
189 if (typeof(o[e]) == 'undefined') {
190 throw "Module not found : " + str;
200 * move modules into their correct place in the tree..
203 preBuild : function ()
206 Roo.each(this.modules , function (obj)
208 obj.parent = this.toObject(obj.parent);
211 this.topModule = obj;
215 if (!obj.parent.modules) {
216 obj.parent.modules = new Roo.util.MixedCollection(false,
217 function(o) { return o.order + '' }
221 obj.parent.modules.add(obj);
226 * make a list of modules to build.
227 * @return {Array} list of modules.
230 buildOrder : function()
233 var cmp = function(a,b) {
234 return String(a).toUpperCase() > String(b).toUpperCase() ? 1 : -1;
237 if (!this.topModule || !this.topModule.modules) {
238 throw "No top level modules to build";
241 // make a flat list in order of modules to build.
242 var mods = [ this.topModule ];
245 // add modules to their parents..
246 var addMod = function(m) {
247 // Roo.debug && Roo.log(m.modKey);
251 m.modules.keySort('ASC', cmp );
252 m.modules.each(addMod);
254 // not sure if this is used any more..
256 m.finalize.name = m.name + " (clean up) ";
257 mods.push(m.finalize);
261 this.topModule.modules.keySort('ASC', cmp );
262 this.topModule.modules.each(addMod);
267 * Build the registered modules.
268 * @param {Object} parent element.
269 * @param {Function} optional method to call after module has been added.
277 var mods = this.buildOrder();
279 //this.allmods = mods;
280 //Roo.debug && Roo.log(mods);
282 if (!mods.length) { // should not happen
283 throw "NO modules!!!";
288 // flash it up as modal - so we store the mask!?
289 Roo.MessageBox.show({ title: 'loading' });
290 Roo.MessageBox.show({
291 title: "Please wait...",
292 msg: "Building Interface...",
299 var total = mods.length;
302 var progressRun = function() {
304 Roo.debug && Roo.log('hide?');
305 Roo.MessageBox.hide();
306 _this.topModule.fireEvent('buildcomplete', _this.topModule);
310 var m = mods.shift();
311 Roo.debug && Roo.log(m);
312 if (typeof(m) == 'function') { // not sure if this is supported any more..
314 return progressRun.defer(10, _this);
317 Roo.MessageBox.updateProgress(
318 (total - mods.length)/total, "Building Interface " + (total - mods.length) +
320 (m.name ? (' - ' + m.name) : '')
325 var disabled = (typeof(m.disabled) == 'function') ?
326 m.disabled.call(m.module.disabled) : m.disabled;
330 return progressRun(); // we do not update the display!
334 // it's a top level one..
335 var layoutbase = new Ext.BorderLayout(document.body, {
343 alwaysShowTabs: true,
348 tree.region = 'center';
349 m.el = layoutbase.addxtype(tree);
351 m.layout = m.panel.layout;
352 return progressRun.defer(10, _this);
356 tree.region = tree.region || m.region;
357 m.el = m.parent.el.addxtype(tree);
358 m.fireEvent('built', m);
360 m.layout = m.panel.layout;
361 progressRun.defer(10, _this);
364 progressRun.defer(1, _this);