git.roojs.org Git - roojs1/blob - Roo/XComponent.js

   1 /*
   2  * Original code for Roojs - LGPL
   3  * <script type="text/javascript">
   4  */
   5
   6 /**
   7  * @class Roo.XComponent
   8  * A delayed Element creator...
   9  * Or a way to group chunks of interface together.
  10  *
  11  * Mypart.xyx = new Roo.XComponent({
  12
  13     parent : 'Mypart.xyz', // empty == document.element.!!
  14     order : '001',
  15     name : 'xxxx'
  16     region : 'xxxx'
  17     disabled : function() {}
  18
  19     tree : function() { // return an tree of xtype declared components
  20         var MODULE = this;
  21         return
  22         {
  23             xtype : 'NestedLayoutPanel',
  24             // technicall
  25         }
  26      ]
  27  *})
  28  *
  29  *
  30  * It can be used to build a big heiracy, with parent etc.
  31  * or you can just use this to render a single compoent to a dom element
  32  * MYPART.render(Roo.Element | String(id) | dom_element )
  33  *
  34  * @extends Roo.util.Observable
  35  * @constructor
  36  * @param cfg {Object} configuration of component
  37  *
  38  */
  39 Roo.XComponent = function(cfg) {
  40     Roo.apply(this, cfg);
  41     this.addEvents({
  42         /**
  43              * @event built
  44              * Fires when this the componnt is built
  45              * @param {Roo.XComponent} c the component
  46              */
  47         'built' : true
  48
  49     });
  50     this.region = this.region || 'center'; // default..
  51     Roo.XComponent.register(this);
  52     this.modules = false;
  53     this.el = false; // where the layout goes..
  54
  55
  56 }
  57 Roo.extend(Roo.XComponent, Roo.util.Observable, {
  58     /**
  59      * @property el
  60      * The created element (with Roo.factory())
  61      * @type {Roo.Layout}
  62      */
  63     el  : false,
  64
  65     /**
  66      * @property el
  67      * for BC  - use el in new code
  68      * @type {Roo.Layout}
  69      */
  70     panel : false,
  71
  72     /**
  73      * @property layout
  74      * for BC  - use el in new code
  75      * @type {Roo.Layout}
  76      */
  77     layout : false,
  78
  79      /**
  80      * @cfg {Function|boolean} disabled
  81      * If this module is disabled by some rule, return true from the funtion
  82      */
  83     disabled : false,
  84
  85     /**
  86      * @cfg {String} parent
  87      * Name of parent element which it get xtype added to..
  88      */
  89     parent: false,
  90
  91     /**
  92      * @cfg {String} order
  93      * Used to set the order in which elements are created (usefull for multiple tabs)
  94      */
  95
  96     order : false,
  97     /**
  98      * @cfg {String} name
  99      * String to display while loading.
 100      */
 101     name : false,
 102     /**
 103      * @cfg {String} region
 104      * Region to render component to (defaults to center)
 105      */
 106     region : 'center',
 107
 108     /**
 109      * @cfg {Array} items
 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...
 112      */
 113     items : false,
 114
 115     /**
 116      * @property _tree
 117      * The method that retuns the tree of parts that make up this compoennt
 118      * @type {function}
 119      */
 120     _tree  : false,
 121
 122      /**
 123      * render
 124      * render element to dom or tree
 125      * @param {Roo.Element|String|DomElement} optional render to if parent is not set.
 126      */
 127
 128     render : function(el)
 129     {
 130
 131         el = el || false;
 132         var hp = this.parent ? 1 : 0;
 133
 134         if (!el && typeof(this.parent) == 'string' && this.parent.substring(0,1) == '#') {
 135             // if parent is a '#.....' string, then let's use that..
 136             var ename = this.parent.substr(1)
 137             this.parent = false;
 138             el = Roo.get(ename);
 139             if (!el) {
 140                 Roo.log("Warning - element can not be found :#" + ename );
 141                 return;
 142             }
 143         }
 144
 145
 146         if (!this.parent) {
 147
 148             el = el ? Roo.get(el) : false;
 149
 150             // it's a top level one..
 151             this.parent =  {
 152                 el : new Roo.BorderLayout(el || document.body, {
 153
 154                      center: {
 155                          titlebar: false,
 156                          autoScroll:false,
 157                          closeOnTab: true,
 158                          tabPosition: 'top',
 159                           //resizeTabs: true,
 160                          alwaysShowTabs: el && hp? false :  true,
 161                          hideTabs: el || !hp ? true :  false,
 162                          minTabWidth: 140
 163                      }
 164                  })
 165             }
 166         }
 167
 168
 169                 // The 'tree' method is  '_tree now'
 170
 171         var tree = this._tree ? this._tree() : this.tree();
 172         tree.region = tree.region || this.region;
 173         this.el = this.parent.el.addxtype(tree);
 174         this.fireEvent('built', this);
 175
 176         this.panel = this.el;
 177         this.layout = this.panel.layout;
 178                 this.parentLayout = this.parent.layout  || false;
 179
 180     }
 181
 182 });
 183
 184 Roo.apply(Roo.XComponent, {
 185     /**
 186      * @property  hideProgress
 187      * true to disable the building progress bar.. usefull on single page renders.
 188      * @type Boolean
 189      */
 190     hideProgress : false,
 191     /**
 192      * @property  buildCompleted
 193      * True when the builder has completed building the interface.
 194      * @type Boolean
 195      */
 196     buildCompleted : false,
 197
 198     /**
 199      * @property  topModule
 200      * the upper most module - uses document.element as it's constructor.
 201      * @type Object
 202      */
 203
 204     topModule  : false,
 205
 206     /**
 207      * @property  modules
 208      * array of modules to be created by registration system.
 209      * @type {Array} of Roo.XComponent
 210      */
 211
 212     modules : [],
 213     /**
 214      * @property  elmodules
 215      * array of modules to be created by which use #ID
 216      * @type {Array} of Roo.XComponent
 217      */
 218
 219     elmodules : [],
 220
 221
 222     /**
 223      * Register components to be built later.
 224      *
 225      * This solves the following issues
 226      * - Building is not done on page load, but after an authentication process has occured.
 227      * - Interface elements are registered on page load
 228      * - Parent Interface elements may not be loaded before child, so this handles that..
 229      *
 230      *
 231      * example:
 232      *
 233      * MyApp.register({
 234           order : '000001',
 235           module : 'Pman.Tab.projectMgr',
 236           region : 'center',
 237           parent : 'Pman.layout',
 238           disabled : false,  // or use a function..
 239         })
 240
 241      * * @param {Object} details about module
 242      */
 243     register : function(obj) {
 244
 245         Roo.XComponent.event.fireEvent('register', obj);
 246         switch(typeof(obj.disabled) ) {
 247
 248             case 'undefined':
 249                 break;
 250
 251             case 'function':
 252                 if ( obj.disabled() ) {
 253                         return;
 254                 }
 255                 break;
 256
 257             default:
 258                 if (obj.disabled) {
 259                         return;
 260                 }
 261                 break;
 262         }
 263
 264         this.modules.push(obj);
 265
 266     },
 267     /**
 268      * convert a string to an object..
 269      * eg. 'AAA.BBB' -> finds AAA.BBB
 270
 271      */
 272
 273     toObject : function(str)
 274     {
 275         if (!str || typeof(str) == 'object') {
 276             return str;
 277         }
 278         if (str.substring(0,1) == '#') {
 279             return str;
 280         }
 281
 282         var ar = str.split('.');
 283         var rt, o;
 284         rt = ar.shift();
 285             /** eval:var:o */
 286         try {
 287             eval('if (typeof ' + rt + ' == "undefined"){ o = false;} o = ' + rt + ';');
 288         } catch (e) {
 289             throw "Module not found : " + str;
 290         }
 291
 292         if (o === false) {
 293             throw "Module not found : " + str;
 294         }
 295         Roo.each(ar, function(e) {
 296             if (typeof(o[e]) == 'undefined') {
 297                 throw "Module not found : " + str;
 298             }
 299             o = o[e];
 300         });
 301
 302         return o;
 303
 304     },
 305
 306
 307     /**
 308      * move modules into their correct place in the tree..
 309      *
 310      */
 311     preBuild : function ()
 312     {
 313         var _t = this;
 314         Roo.each(this.modules , function (obj)
 315         {
 316             var opar = obj.parent;
 317             try {
 318                 obj.parent = this.toObject(opar);
 319             } catch(e) {
 320                 Roo.log("parent:toObject failed: " + e.toString());
 321                 return;
 322             }
 323
 324             if (!obj.parent) {
 325                 Roo.debug && Roo.log("GOT top level module");
 326                 Roo.debug && Roo.log(obj);
 327                 obj.modules = new Roo.util.MixedCollection(false,
 328                     function(o) { return o.order + '' }
 329                 );
 330                 this.topModule = obj;
 331                 return;
 332             }
 333                         // parent is a string (usually a dom element name..)
 334             if (typeof(obj.parent) == 'string') {
 335                 this.elmodules.push(obj);
 336                 return;
 337             }
 338             if (obj.parent.constructor != Roo.XComponent) {
 339                 Roo.log("Warning : Object Parent is not instance of XComponent:" + obj.name)
 340             }
 341             if (!obj.parent.modules) {
 342                 obj.parent.modules = new Roo.util.MixedCollection(false,
 343                     function(o) { return o.order + '' }
 344                 );
 345             }
 346
 347             obj.parent.modules.add(obj);
 348         }, this);
 349     },
 350
 351      /**
 352      * make a list of modules to build.
 353      * @return {Array} list of modules.
 354      */
 355
 356     buildOrder : function()
 357     {
 358         var _this = this;
 359         var cmp = function(a,b) {
 360             return String(a).toUpperCase() > String(b).toUpperCase() ? 1 : -1;
 361         };
 362         if ((!this.topModule || !this.topModule.modules) && !this.elmodules.length) {
 363             throw "No top level modules to build";
 364         }
 365
 366         // make a flat list in order of modules to build.
 367         var mods = this.topModule ? [ this.topModule ] : [];
 368
 369         // elmodules (is a list of DOM based modules )
 370         Roo.each(this.elmodules, function(e) {
 371             mods.push(e)
 372         });
 373
 374
 375         // add modules to their parents..
 376         var addMod = function(m) {
 377             Roo.debug && Roo.log("build Order: add: " + m.name);
 378
 379             mods.push(m);
 380             if (m.modules) {
 381                 Roo.debug && Roo.log("build Order: " + m.modules.length + " child modules");
 382                 m.modules.keySort('ASC',  cmp );
 383                 Roo.debug && Roo.log("build Order: " + m.modules.length + " child modules (after sort)");
 384
 385                 m.modules.each(addMod);
 386             } else {
 387                 Roo.debug && Roo.log("build Order: no child modules");
 388             }
 389             // not sure if this is used any more..
 390             if (m.finalize) {
 391                 m.finalize.name = m.name + " (clean up) ";
 392                 mods.push(m.finalize);
 393             }
 394
 395         }
 396         if (this.topModule) {
 397             this.topModule.modules.keySort('ASC',  cmp );
 398             this.topModule.modules.each(addMod);
 399         }
 400         return mods;
 401     },
 402
 403      /**
 404      * Build the registered modules.
 405      * @param {Object} parent element.
 406      * @param {Function} optional method to call after module has been added.
 407      *
 408      */
 409
 410     build : function()
 411     {
 412
 413         this.preBuild();
 414         var mods = this.buildOrder();
 415
 416         //this.allmods = mods;
 417         //Roo.debug && Roo.log(mods);
 418         //return;
 419         if (!mods.length) { // should not happen
 420             throw "NO modules!!!";
 421         }
 422
 423
 424         var msg = "Building Interface...";
 425         // flash it up as modal - so we store the mask!?
 426         if (!this.hideProgress) {
 427             Roo.MessageBox.show({ title: 'loading' });
 428             Roo.MessageBox.show({
 429                title: "Please wait...",
 430                msg: msg,
 431                width:450,
 432                progress:true,
 433                closable:false,
 434                modal: false
 435
 436             });
 437         }
 438         var total = mods.length;
 439
 440         var _this = this;
 441         var progressRun = function() {
 442             if (!mods.length) {
 443                 Roo.debug && Roo.log('hide?');
 444                 if (!this.hideProgress) {
 445                     Roo.MessageBox.hide();
 446                 }
 447                 Roo.XComponent.event.fireEvent('buildcomplete', _this.topModule);
 448
 449                 // THE END...
 450                 return false;
 451             }
 452
 453             var m = mods.shift();
 454
 455
 456             Roo.debug && Roo.log(m);
 457             // not sure if this is supported any more.. - modules that are are just function
 458             if (typeof(m) == 'function') {
 459                 m.call(this);
 460                 return progressRun.defer(10, _this);
 461             }
 462
 463
 464             msg = "Building Interface " + (total  - mods.length) +
 465                     " of " + total +
 466                     (m.name ? (' - ' + m.name) : '');
 467                         Roo.debug && Roo.log(msg);
 468             if (!this.hideProgress) {
 469                 Roo.MessageBox.updateProgress(  (total  - mods.length)/total, msg  );
 470             }
 471
 472
 473             // is the module disabled?
 474             var disabled = (typeof(m.disabled) == 'function') ?
 475                 m.disabled.call(m.module.disabled) : m.disabled;
 476
 477
 478             if (disabled) {
 479                 return progressRun(); // we do not update the display!
 480             }
 481
 482             // now build
 483
 484
 485
 486             m.render();
 487             // it's 10 on top level, and 1 on others??? why...
 488             return progressRun.defer(10, _this);
 489
 490         }
 491         progressRun.defer(1, _this);
 492
 493
 494
 495     },
 496
 497
 498         /**
 499          * Event Object.
 500          *
 501          *
 502          */
 503         event: false,
 504     /**
 505          * wrapper for event.on - aliased later..
 506          * Typically use to register a event handler for register:
 507          *
 508          * eg. Roo.XComponent.on('register', function(comp) { comp.disable = true } );
 509          *
 510          */
 511     on : false
 512
 513
 514
 515 });
 516
 517 Roo.XComponent.event = new Roo.util.Observable({
 518                 events : {
 519                         /**
 520                          * @event register
 521                          * Fires when an Component is registered,
 522                          * set the disable property on the Component to stop registration.
 523                          * @param {Roo.XComponent} c the component being registerd.
 524                          *
 525                          */
 526                         'register' : true,
 527             /**
 528                          * @event beforebuild
 529                          * Fires before Component is built
 530                          * can be used to apply permissions.
 531                          * @param {Roo.XComponent} c the component being registerd.
 532                          *
 533                          */
 534                         'beforebuild' : true,
 535                         /**
 536                          * @event buildcomplete
 537                          * Fires on the top level element when all elements have been built
 538                          * @param {Roo.XComponent} the top level component.
 539                          */
 540                         'buildcomplete' : true
 541
 542                 }
 543 });
 544
 545 Roo.XComponent.on = Roo.XComponent.event.on.createDelegate(Roo.XComponent.event);
 546