2 * Original code for Roojs - LGPL
3 * <script type="text/javascript">
8 * This needs some more thought..
12 * @class Roo.XComponent
13 * @extends Roo.data.Observable
15 * A delayed Element creator...
17 * Mypart.xyx = new Roo.XComponent({
19 parent : 'Mypart.xyz', // empty == document.element.!!
23 disabled : function() {}
25 items : [ // technically only one component..
27 xtype : 'NestedLayoutPanel',
36 Roo.XComponent = function(cfg) {
41 * Fires when this the componnt is built
42 * @param {Roo.XComponent} c the component
46 * @event buildcomplete
47 * Fires on the top level element when all elements have been built
48 * @param {Roo.XComponent} c the top level component.
50 'buildcomplete' : true,
54 Roo.XComponent.register(this);
56 this.el = false; // where the layout goes..
60 Roo.extend(Roo.XComponent, Roo.util.Observable, {
63 * The created element (with Roo.factory())
70 * for BC - use el in new code
77 * for BC - use el in new code
83 * @cfg {Function|boolean} disabled
84 * If this module is disabled by some rule, return true from the funtion
89 * @cfg {String} parent
90 * Name of parent element which it get xtype added to..
96 * Used to set the order in which elements are created (usefull for multiple tabs)
102 * String to display while loading.
107 * A single item array - the first element is the root of the tree..
108 * It's done this way to stay compatible with the Xtype system...
113 Roo.apply(Roo.XComponent, {
116 * @property buildCompleted
117 * True when the builder has completed building the interface.
120 buildCompleted : false,
123 * @property topModule
124 * the upper most module - uses document.element as it's constructor.
132 * array of modules to be created by registration system.
133 * @type Roo.XComponent
140 * Register components to be built later.
141 * @param {Object} details about module
143 * This solves the following issues
144 * - Building is not done on page load, but after an authentication process has occured.
145 * - Interface elements are registered on page load
146 * - Parent Interface elements may not be loaded before child, so this handles that..
153 module : 'Pman.Tab.projectMgr',
155 parent : 'Pman.layout',
156 disabled : false, // or use a function..
160 register : function(obj) {
161 this.modules.push(obj);
165 * convert a string to an object..
169 toObject : function(str)
171 if (!str || typeof(str) == 'object') {
174 var ar = str.split('.');
178 eval('if (typeof ' + rt + ' == "undefined"){ o = false;} o = ' + rt + ';');
180 throw "Module not found : " + str;
182 Roo.each(ar, function(e) {
183 if (typeof(o[e]) == 'undefined') {
184 throw "Module not found : " + str;
194 * move modules into their correct place in the tree..
197 preBuild : function ()
200 Roo.each(this.modules , function (obj)
202 obj.parent = this.toObject(obj.parent);
205 this.topModule = obj;
209 if (!obj.parent.modules) {
210 obj.parent.modules = new Roo.util.MixedCollection(false,
211 function(o) { return o.order + '' }
215 obj.parent.modules.add(obj);
220 * make a list of modules to build.
221 * @return {Array} list of modules.
224 buildOrder : function()
227 var cmp = function(a,b) {
228 return String(a).toUpperCase() > String(b).toUpperCase() ? 1 : -1;
231 if (!this.topModule || !this.topModule.modules) {
232 throw "No top level modules to build";
235 // make a flat list in order of modules to build.
236 var mods = [ this.topModule ];
239 // add modules to their parents..
240 var addMod = function(m) {
241 // console.log(m.modKey);
245 m.modules.keySort('ASC', cmp );
246 m.modules.each(addMod);
248 // not sure if this is used any more..
250 m.finalize.name = m.name + " (clean up) ";
251 mods.push(m.finalize);
255 this.topModule.modules.keySort('ASC', cmp );
256 this.topModule.modules.each(addMod);
261 * Build the registered modules.
262 * @param {Object} parent element.
263 * @param {Function} optional method to call after module has been added.
271 var mods = this.buildOrder();
273 //this.allmods = mods;
276 if (!mods.length) { // should not happen
277 throw "NO modules!!!";
282 // flash it up as modal - so we store the mask!?
283 Roo.MessageBox.show({ title: 'loading' });
284 Roo.MessageBox.show({
285 title: "Please wait...",
286 msg: "Building Interface...",
293 var total = mods.length;
296 var progressRun = function() {
298 Roo.MessageBox.hide();
299 _this.topModule.fireEvent('buildcomplete', _this.topModule);
303 var m = mods.shift();
305 if (typeof(m) == 'function') { // not sure if this is supported any more..
307 return progressRun.defer(10, _this);
310 Roo.MessageBox.updateProgress(
311 (total - mods.length)/total, "Building Interface " + (total - mods.length) +
313 (m.name ? (' - ' + m.name) : '')
318 var disabled = (typeof(m.module.disabled) == 'function') ?
319 m.module.disabled.call(m.module.disabled) : m.module.disabled;
323 return progressRun(); // we do not update the display!
326 m.el = m.parent.el.addxtype(m.items[0]);
327 m.fireEvent('built', m);
329 m.layout = m.panel.layout;
333 progressRun.defer(1, _this);