*/
/**
- * @class Roo.Documents
- * @extends Roo.data.Observable
*
- * Document and interface builder class..
+ * This needs some more thought..
*
- * MyApp = new Roo.Document({
- * loadingIndicator : 'loading',
- * listeners : Roo.Login.onLoad();
- * });
*
- * MyApp.on('beforeload', function() {
- * MyApp.register()
-
*
+ * @class Roo.XComponent
+ * @extends Roo.data.Observable
*
+ * A delayed Element creator...
*
- */
-Roo.Document = function(cfg) {
+ * Mypart.xyx = new Roo.XComponent({
+
+ parent : 'Mypart.xyz', // empty == document.element.!!
+ order : '001',
+ name : 'xxxx'
+ region : 'xxxx'
+ disabled : function() {}
+ items : [ // technically only one component..
+ {
+ xtype : 'NestedLayoutPanel',
+ // technicall
+ }
+ ]
+ *})
+ *
+ *
+ *
+ */
+Roo.XComponent = function(cfg) {
+ Roo.apply(this, cfg);
this.addEvents({
- 'ready' : true,
- 'beforeload' : true, // fired after page ready, before module building.
- 'load' : true, // fired after module building
- 'authrefreshed' : true // fire on auth updated?? - should be on Login?!?!?
+ /**
+ * @event built
+ * Fires when this the componnt is built
+ * @param {Roo.XComponent} c the component
+ */
+ 'built' : true,
+ /**
+ * @event buildcomplete
+ * Fires on the top level element when all elements have been built
+ * @param {Roo.XComponent} c the top level component.
+ */
+ 'buildcomplete' : true,
});
- Roo.util.Observable.call(this,cfg);
- var _this = this;
- Roo.onReady(function() {
- _this.fireEvent('ready');
- },null,false);
+
+ Roo.XComponent.register(this);
+ this.modules = [];
+ this.el = false; // where the layout goes..
- this.on('ready', onReady, this);
- this.on('load', onLoad, this);
}
-Roo.extend(Roo.Document, Roo.util.Observable, {
+Roo.extend(Roo.XComponent, Roo.util.Observable {
+ /**
+ * @property el
+ * The created element (with Roo.factory())
+ * @type {Roo.Layout}
+ */
+ el : false,
+
+ /**
+ * @property el
+ * for BC - use el in new code
+ * @type {Roo.Layout}
+ */
+ panel : false,
+
+ /**
+ * @property layout
+ * for BC - use el in new code
+ * @type {Roo.Layout}
+ */
+ layout : false,
+
+ /**
+ * @cfg {Function|boolean} disabled
+ * If this module is disabled by some rule, return true from the funtion
+ */
+ disabled : false,
+
+ /**
+ * @cfg {String} parent
+ * Name of parent element which it get xtype added to..
+ */
+ parent: false,
+
+ /**
+ * @cfg {String} order
+ * Used to set the order in which elements are created (usefull for multiple tabs)
+ */
+
+ order : false,
+ /**
+ * @cfg {String} name
+ * String to display while loading.
+ */
+ name : false,
+ /**
+ * @cfg {Array} items
+ * A single item array - the first element is the root of the tree..
+ * It's done this way to stay compatible with the Xtype system...
+ */
+ items : false,
+});
+
+Roo.apply(Roo.XComponent,
/**
* @property buildCompleted
* True when the builder has completed building the interface.
* @type Boolean
*/
buildCompleted : false,
- /**
- * @property loadingIndicator
- * ID of loading indictor element.
- * @type String
+
+ /**
+ * @property topModule
+ * the upper most module - uses document.element as it's constructor.
+ * @type Object
+ */
+
+ topModule : false,
+
+ /**
+ * @property modules
+ * array of modules to be created by registration system.
+ * @type Roo.XComponent
*/
- loadingIndicator : false,
+ modules : [],
- // protected - on Ready handler.
- onReady : function()
+
+ /**
+ * Register components to be built later.
+ * @param {Object} details about module
+ *
+ * This solves the following issues
+ * - Building is not done on page load, but after an authentication process has occured.
+ * - Interface elements are registered on page load
+ * - Parent Interface elements may not be loaded before child, so this handles that..
+ *
+ *
+ * example:
+ *
+ * MyApp.register({
+ order : '000001',
+ module : 'Pman.Tab.projectMgr',
+ region : 'center',
+ parent : 'Pman.layout',
+ disabled : false, // or use a function..
+ })
+ *
+ */
+ register : function(obj) {
+ this.modules.push(obj);
+
+ },
+ /**
+ * convert a string to an object..
+ *
+ */
+
+ toObject : function(str)
{
- // kludge to fix firebug debugger
- if (typeof(console) == 'undefined') {
- console = { log : function() { } };
+ if (typeof(str) == 'object') {
+ return str;
+ }
+ var ar = str.split('.');
+ var rt, o;
+ rt = ar.unshift();
+ /** eval:var:o */
+ eval('if (typeof ' + rt + ' == "undefined"){ o = false;} o = ' + rt + ';');
+ if (o === false) {
+ throw "Module not found : " + str;
}
+ Roo.each(ar, function(e) {
+ if (typeof(o[e]) == 'undefined') {
+ throw "Module not found : " + str;
+ }
+ o = o[e];
+ });
+ return o;
+ }
- // init cookies..
- Ext.state.Manager.setProvider(new Ext.state.CookieProvider());
+
+ /**
+ * move modules into their correct place in the tree..
+ *
+ */
+ preBuild : function ()
+ {
+ var modules = this.modules;
+ this.modules = false;
+
+ Roo.each(modules , function (obj)
+ {
+ obj.parent = this.toObject(obj.parent);
+
+ if (!obj.parent) {
+ this.topModule = obj;
+ return;
+ }
+ obj.parent = toObject(obj.parent);
+ if (!obj.parent.modules) {
+ obj.parent.modules = new Roo.util.MixedCollection(false,
+ function(o) { return o.order + '' }
+ );
+ }
- // link errors...
+ obj.parent.modules.add(obj);
+ }, this);
+ }
+
+ /**
+ * make a list of modules to build.
+ * @return {Array} list of modules.
+ */
+
+ buildOrder : function()
+ {
+ var _this = this;
+ var cmp = function(a,b) {
+ return String(a).toUpperCase() > String(b).toUpperCase() ? 1 : -1;
+ };
-
+ if (!this.topModule || !this.topModule.modules) {
+ throw "No top level modules to build";
+ }
+ // make a flat list in order of modules to build.
+ var mods = [ this.topModule ];
+
+
+ // add modules to their parents..
+ var addMod = function(m) {
+ // console.log(m.modKey);
- },
+ mods.push(m);
+ if (m.module.modules) {
+ m.module.modules.keySort('ASC', cmp );
+ m.module.modules.each(addMod);
+ }
+ if (m.finalize) {
+ m.finalize.name = m.name + " (clean up) ";
+ mods.push(m.finalize);
+ }
+
+ }
+ this.topModule.modules.keySort('ASC', cmp );
+ this.topModule.modules.each(addMod);
+ }
+
+ /**
+ * Build the registered modules.
+ * @param {Object} parent element.
+ * @param {Function} optional method to call after module has been added.
+ *
+ */
+
+ build : function()
+ {
+
+ this.preBuild();
+ var mods = this.buildOrder();
+
+ //this.allmods = mods;
+ //console.log(mods);
+ //return;
+ if (!mods.length) { // should not happen
+ throw "NO modules!!!";
+ }
+
+
+
+ // flash it up as modal - so we store the mask!?
+ Roo.MessageBox.show({ title: 'loading' });
+ Roo.MessageBox.show({
+ title: "Please wait...",
+ msg: "Building Interface...",
+ width:450,
+ progress:true,
+ closable:false,
+ modal: false
+
+ });
+ var total = mods.length();
+
+ var _this = this;
+ var progressRun = function() {
+ if (mods.length) {
+ Roo.MessageBox.hide();
+ _this.topModule.fireEvent('buildcomplete', _this.topModule);
+ return;
+ }
+
+ var m = mods.unshift();
+
+ if (typeof(m) == 'function') { // not sure if this is supported any more..
+ m.call(this);
+ return progressRun.defer(10, _this);
+ }
+
+ Roo.MessageBox.updateProgress(
+ (total - mods.length)/total, "Building Interface " + (total - mods.length) +
+ " of " + total +
+ (m.name ? (' - ' + m.name) : '')
+ );
+
+
+
+ var disabled = (typeof(m.module.disabled) == 'function') ?
+ m.module.disabled.call(m.module.disabled) : m.module.disabled;
+ }
+
+ if (disabled) {
+ return progressRun(); // we do not update the display!
+ }
+
+ m.el = m.parent.el.addxtype(m.items[0]);
+ m.fireEvent('built', m);
+ m.panel = this.el;
+ m.layout = m.panel.layout;
+
+
+ }
+ progressRun.defer(1, _this);
+
+
+
+ }
-},
projects / roojs1 / blobdiff