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 = (this.parent == '#bootstrap') ? { el : true}  : false; // flags it as a top module...
 138             el = Roo.get(ename);
 139             if (!el && !this.parent) {
 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                 if (!this.parent.el) {
 169                         // probably an old style ctor, which has been disabled.
 170                         return;
 171
 172                 }
 173                 // The 'tree' method is  '_tree now'
 174
 175         var tree = this._tree ? this._tree() : this.tree();
 176         Roo.log('tree');
 177         Roo.log(tree);
 178         tree.region = tree.region || this.region;
 179         if (this.parent.el === true) {
 180             // bootstrap... - body..
 181             this.parent.el = Roo.factory(tree);
 182         }
 183         this.el = this.parent.el.addxtype(tree);
 184         this.fireEvent('built', this);
 185
 186         this.panel = this.el;
 187         this.layout = this.panel.layout;
 188                 this.parentLayout = this.parent.layout  || false;
 189
 190     }
 191
 192 });
 193
 194 Roo.apply(Roo.XComponent, {
 195     /**
 196      * @property  hideProgress
 197      * true to disable the building progress bar.. usefull on single page renders.
 198      * @type Boolean
 199      */
 200     hideProgress : false,
 201     /**
 202      * @property  buildCompleted
 203      * True when the builder has completed building the interface.
 204      * @type Boolean
 205      */
 206     buildCompleted : false,
 207
 208     /**
 209      * @property  topModule
 210      * the upper most module - uses document.element as it's constructor.
 211      * @type Object
 212      */
 213
 214     topModule  : false,
 215
 216     /**
 217      * @property  modules
 218      * array of modules to be created by registration system.
 219      * @type {Array} of Roo.XComponent
 220      */
 221
 222     modules : [],
 223     /**
 224      * @property  elmodules
 225      * array of modules to be created by which use #ID
 226      * @type {Array} of Roo.XComponent
 227      */
 228
 229     elmodules : [],
 230
 231
 232     /**
 233      * Register components to be built later.
 234      *
 235      * This solves the following issues
 236      * - Building is not done on page load, but after an authentication process has occured.
 237      * - Interface elements are registered on page load
 238      * - Parent Interface elements may not be loaded before child, so this handles that..
 239      *
 240      *
 241      * example:
 242      *
 243      * MyApp.register({
 244           order : '000001',
 245           module : 'Pman.Tab.projectMgr',
 246           region : 'center',
 247           parent : 'Pman.layout',
 248           disabled : false,  // or use a function..
 249         })
 250
 251      * * @param {Object} details about module
 252      */
 253     register : function(obj) {
 254
 255         Roo.XComponent.event.fireEvent('register', obj);
 256         switch(typeof(obj.disabled) ) {
 257
 258             case 'undefined':
 259                 break;
 260
 261             case 'function':
 262                 if ( obj.disabled() ) {
 263                         return;
 264                 }
 265                 break;
 266
 267             default:
 268                 if (obj.disabled) {
 269                         return;
 270                 }
 271                 break;
 272         }
 273
 274         this.modules.push(obj);
 275
 276     },
 277     /**
 278      * convert a string to an object..
 279      * eg. 'AAA.BBB' -> finds AAA.BBB
 280
 281      */
 282
 283     toObject : function(str)
 284     {
 285         if (!str || typeof(str) == 'object') {
 286             return str;
 287         }
 288         if (str.substring(0,1) == '#') {
 289             return str;
 290         }
 291
 292         var ar = str.split('.');
 293         var rt, o;
 294         rt = ar.shift();
 295             /** eval:var:o */
 296         try {
 297             eval('if (typeof ' + rt + ' == "undefined"){ o = false;} o = ' + rt + ';');
 298         } catch (e) {
 299             throw "Module not found : " + str;
 300         }
 301
 302         if (o === false) {
 303             throw "Module not found : " + str;
 304         }
 305         Roo.each(ar, function(e) {
 306             if (typeof(o[e]) == 'undefined') {
 307                 throw "Module not found : " + str;
 308             }
 309             o = o[e];
 310         });
 311
 312         return o;
 313
 314     },
 315
 316
 317     /**
 318      * move modules into their correct place in the tree..
 319      *
 320      */
 321     preBuild : function ()
 322     {
 323         var _t = this;
 324         Roo.each(this.modules , function (obj)
 325         {
 326             Roo.XComponent.event.fireEvent('beforebuild', obj);
 327
 328             var opar = obj.parent;
 329             try {
 330                 obj.parent = this.toObject(opar);
 331             } catch(e) {
 332                 Roo.log("parent:toObject failed: " + e.toString());
 333                 return;
 334             }
 335
 336             if (!obj.parent) {
 337                 Roo.debug && Roo.log("GOT top level module");
 338                 Roo.debug && Roo.log(obj);
 339                 obj.modules = new Roo.util.MixedCollection(false,
 340                     function(o) { return o.order + '' }
 341                 );
 342                 this.topModule = obj;
 343                 return;
 344             }
 345                         // parent is a string (usually a dom element name..)
 346             if (typeof(obj.parent) == 'string') {
 347                 this.elmodules.push(obj);
 348                 return;
 349             }
 350             if (obj.parent.constructor != Roo.XComponent) {
 351                 Roo.log("Warning : Object Parent is not instance of XComponent:" + obj.name)
 352             }
 353             if (!obj.parent.modules) {
 354                 obj.parent.modules = new Roo.util.MixedCollection(false,
 355                     function(o) { return o.order + '' }
 356                 );
 357             }
 358             if (obj.parent.disabled) {
 359                 obj.disabled = true;
 360             }
 361             obj.parent.modules.add(obj);
 362         }, this);
 363     },
 364
 365      /**
 366      * make a list of modules to build.
 367      * @return {Array} list of modules.
 368      */
 369
 370     buildOrder : function()
 371     {
 372         var _this = this;
 373         var cmp = function(a,b) {
 374             return String(a).toUpperCase() > String(b).toUpperCase() ? 1 : -1;
 375         };
 376         if ((!this.topModule || !this.topModule.modules) && !this.elmodules.length) {
 377             throw "No top level modules to build";
 378         }
 379
 380         // make a flat list in order of modules to build.
 381         var mods = this.topModule ? [ this.topModule ] : [];
 382
 383
 384         // elmodules (is a list of DOM based modules )
 385         Roo.each(this.elmodules, function(e) {
 386             mods.push(e);
 387             if (!this.topModule &&
 388                 typeof(e.parent) == 'string' &&
 389                 e.parent.substring(0,1) == '#' &&
 390                 Roo.get(e.parent.substr(1))
 391                ) {
 392
 393                 _this.topModule = e;
 394             }
 395
 396         });
 397
 398
 399         // add modules to their parents..
 400         var addMod = function(m) {
 401             Roo.debug && Roo.log("build Order: add: " + m.name);
 402
 403             mods.push(m);
 404             if (m.modules && !m.disabled) {
 405                 Roo.debug && Roo.log("build Order: " + m.modules.length + " child modules");
 406                 m.modules.keySort('ASC',  cmp );
 407                 Roo.debug && Roo.log("build Order: " + m.modules.length + " child modules (after sort)");
 408
 409                 m.modules.each(addMod);
 410             } else {
 411                 Roo.debug && Roo.log("build Order: no child modules");
 412             }
 413             // not sure if this is used any more..
 414             if (m.finalize) {
 415                 m.finalize.name = m.name + " (clean up) ";
 416                 mods.push(m.finalize);
 417             }
 418
 419         }
 420         if (this.topModule && this.topModule.modules) {
 421             this.topModule.modules.keySort('ASC',  cmp );
 422             this.topModule.modules.each(addMod);
 423         }
 424         return mods;
 425     },
 426
 427      /**
 428      * Build the registered modules.
 429      * @param {Object} parent element.
 430      * @param {Function} optional method to call after module has been added.
 431      *
 432      */
 433
 434     build : function()
 435     {
 436
 437         this.preBuild();
 438         var mods = this.buildOrder();
 439
 440         //this.allmods = mods;
 441         //Roo.debug && Roo.log(mods);
 442         //return;
 443         if (!mods.length) { // should not happen
 444             throw "NO modules!!!";
 445         }
 446
 447
 448         var msg = "Building Interface...";
 449         // flash it up as modal - so we store the mask!?
 450         if (!this.hideProgress && Roo.MessageBox) {
 451             Roo.MessageBox.show({ title: 'loading' });
 452             Roo.MessageBox.show({
 453                title: "Please wait...",
 454                msg: msg,
 455                width:450,
 456                progress:true,
 457                closable:false,
 458                modal: false
 459
 460             });
 461         }
 462         var total = mods.length;
 463
 464         var _this = this;
 465         var progressRun = function() {
 466             if (!mods.length) {
 467                 Roo.debug && Roo.log('hide?');
 468                 if (!this.hideProgress && Roo.MessageBox) {
 469                     Roo.MessageBox.hide();
 470                 }
 471                 Roo.XComponent.event.fireEvent('buildcomplete', _this.topModule);
 472
 473                 // THE END...
 474                 return false;
 475             }
 476
 477             var m = mods.shift();
 478
 479
 480             Roo.debug && Roo.log(m);
 481             // not sure if this is supported any more.. - modules that are are just function
 482             if (typeof(m) == 'function') {
 483                 m.call(this);
 484                 return progressRun.defer(10, _this);
 485             }
 486
 487
 488             msg = "Building Interface " + (total  - mods.length) +
 489                     " of " + total +
 490                     (m.name ? (' - ' + m.name) : '');
 491                         Roo.debug && Roo.log(msg);
 492             if (!this.hideProgress &&  Roo.MessageBox) {
 493                 Roo.MessageBox.updateProgress(  (total  - mods.length)/total, msg  );
 494             }
 495
 496
 497             // is the module disabled?
 498             var disabled = (typeof(m.disabled) == 'function') ?
 499                 m.disabled.call(m.module.disabled) : m.disabled;
 500
 501
 502             if (disabled) {
 503                 return progressRun(); // we do not update the display!
 504             }
 505
 506             // now build
 507
 508
 509
 510             m.render();
 511             // it's 10 on top level, and 1 on others??? why...
 512             return progressRun.defer(10, _this);
 513
 514         }
 515         progressRun.defer(1, _this);
 516
 517
 518
 519     },
 520
 521
 522         /**
 523          * Event Object.
 524          *
 525          *
 526          */
 527         event: false,
 528     /**
 529          * wrapper for event.on - aliased later..
 530          * Typically use to register a event handler for register:
 531          *
 532          * eg. Roo.XComponent.on('register', function(comp) { comp.disable = true } );
 533          *
 534          */
 535     on : false
 536
 537
 538
 539 });
 540
 541 Roo.XComponent.event = new Roo.util.Observable({
 542                 events : {
 543                         /**
 544                          * @event register
 545                          * Fires when an Component is registered,
 546                          * set the disable property on the Component to stop registration.
 547                          * @param {Roo.XComponent} c the component being registerd.
 548                          *
 549                          */
 550                         'register' : true,
 551             /**
 552                          * @event beforebuild
 553                          * Fires before each Component is built
 554                          * can be used to apply permissions.
 555                          * @param {Roo.XComponent} c the component being registerd.
 556                          *
 557                          */
 558                         'beforebuild' : true,
 559                         /**
 560                          * @event buildcomplete
 561                          * Fires on the top level element when all elements have been built
 562                          * @param {Roo.XComponent} the top level component.
 563                          */
 564                         'buildcomplete' : true
 565
 566                 }
 567 });
 568
 569 Roo.XComponent.on = Roo.XComponent.event.on.createDelegate(Roo.XComponent.event);
 570