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  * technically this is a wrapper around a tree of Roo elements (which defines a 'module'),
  11  *  used in conjunction with XComponent.build() it will create an instance of each element,
  12  *  then call addxtype() to build the User interface.
  13  *
  14  * Mypart.xyx = new Roo.XComponent({
  15
  16     parent : 'Mypart.xyz', // empty == document.element.!!
  17     order : '001',
  18     name : 'xxxx'
  19     region : 'xxxx'
  20     disabled : function() {}
  21
  22     tree : function() { // return an tree of xtype declared components
  23         var MODULE = this;
  24         return
  25         {
  26             xtype : 'NestedLayoutPanel',
  27             // technicall
  28         }
  29      ]
  30  *})
  31  *
  32  *
  33  * It can be used to build a big heiracy, with parent etc.
  34  * or you can just use this to render a single compoent to a dom element
  35  * MYPART.render(Roo.Element | String(id) | dom_element )
  36  *
  37  *
  38  * Usage patterns.
  39  *
  40  * Classic Roo
  41  *
  42  * Roo is designed primarily as a single page application, so the UI build for a standard interface will
  43  * expect a single 'TOP' level module normally indicated by the 'parent' of the XComponent definition being defined as false.
  44  *
  45  * Each sub module is expected to have a parent pointing to the class name of it's parent module.
  46  *
  47  * When the top level is false, a 'Roo.BorderLayout' is created and the element is flagged as 'topModule'
  48  * - if mulitple topModules exist, the last one is defined as the top module.
  49  *
  50  * Embeded Roo
  51  *
  52  * When the top level or multiple modules are to embedded into a existing HTML page,
  53  * the parent element can container '#id' of the element where the module will be drawn.
  54  *
  55  * Bootstrap Roo
  56  *
  57  * Unlike classic Roo, the bootstrap tends not to be used as a single page.
  58  * it relies more on a include mechanism, where sub modules are included into an outer page.
  59  * This is normally managed by the builder tools using Roo.apply( options, Included.Sub.Module )
  60  *
  61  * Bootstrap Roo Included elements
  62  *
  63  * Our builder application needs the ability to preview these sub compoennts. They will normally have parent=false set,
  64  * hence confusing the component builder as it thinks there are multiple top level elements.
  65  *
  66  *
  67  *
  68  * @extends Roo.util.Observable
  69  * @constructor
  70  * @param cfg {Object} configuration of component
  71  *
  72  */
  73 Roo.XComponent = function(cfg) {
  74     Roo.apply(this, cfg);
  75     this.addEvents({
  76         /**
  77              * @event built
  78              * Fires when this the componnt is built
  79              * @param {Roo.XComponent} c the component
  80              */
  81         'built' : true
  82
  83     });
  84     this.region = this.region || 'center'; // default..
  85     Roo.XComponent.register(this);
  86     this.modules = false;
  87     this.el = false; // where the layout goes..
  88
  89
  90 }
  91 Roo.extend(Roo.XComponent, Roo.util.Observable, {
  92     /**
  93      * @property el
  94      * The created element (with Roo.factory())
  95      * @type {Roo.Layout}
  96      */
  97     el  : false,
  98
  99     /**
 100      * @property el
 101      * for BC  - use el in new code
 102      * @type {Roo.Layout}
 103      */
 104     panel : false,
 105
 106     /**
 107      * @property layout
 108      * for BC  - use el in new code
 109      * @type {Roo.Layout}
 110      */
 111     layout : false,
 112
 113      /**
 114      * @cfg {Function|boolean} disabled
 115      * If this module is disabled by some rule, return true from the funtion
 116      */
 117     disabled : false,
 118
 119     /**
 120      * @cfg {String} parent
 121      * Name of parent element which it get xtype added to..
 122      */
 123     parent: false,
 124
 125     /**
 126      * @cfg {String} order
 127      * Used to set the order in which elements are created (usefull for multiple tabs)
 128      */
 129
 130     order : false,
 131     /**
 132      * @cfg {String} name
 133      * String to display while loading.
 134      */
 135     name : false,
 136     /**
 137      * @cfg {String} region
 138      * Region to render component to (defaults to center)
 139      */
 140     region : 'center',
 141
 142     /**
 143      * @cfg {Array} items
 144      * A single item array - the first element is the root of the tree..
 145      * It's done this way to stay compatible with the Xtype system...
 146      */
 147     items : false,
 148
 149     /**
 150      * @property _tree
 151      * The method that retuns the tree of parts that make up this compoennt
 152      * @type {function}
 153      */
 154     _tree  : false,
 155
 156      /**
 157      * render
 158      * render element to dom or tree
 159      * @param {Roo.Element|String|DomElement} optional render to if parent is not set.
 160      */
 161
 162     render : function(el)
 163     {
 164         Roo.log('render?????');
 165         Roo.log(el);
 166         Roo.log('parent el');
 167         Roo.log(this.parent.el);
 168         el = el || false;
 169         var hp = this.parent ? 1 : 0;
 170         Roo.debug &&  Roo.log(this);
 171
 172         if (!el && typeof(this.parent) == 'string' && this.parent.substring(0,1) == '#') {
 173             // if parent is a '#.....' string, then let's use that..
 174             var ename = this.parent.substr(1);
 175             this.parent = false;
 176             Roo.debug && Roo.log(ename);
 177             switch (ename) {
 178                 case 'bootstrap-body' :
 179                     if (typeof(Roo.bootstrap.Body) != 'undefined') {
 180                         this.parent = { el :  new  Roo.bootstrap.Body() };
 181                         Roo.debug && Roo.log("setting el to doc body");
 182
 183                     } else {
 184                         throw "Container is bootstrap body, but Roo.bootstrap.Body is not defined";
 185                     }
 186                     break;
 187                 case 'bootstrap':
 188                     this.parent = { el : true};
 189                     // fall through
 190                 default:
 191                     el = Roo.get(ename);
 192                     break;
 193             }
 194
 195
 196             if (!el && !this.parent) {
 197                 Roo.debug && Roo.log("Warning - element can not be found :#" + ename );
 198                 return;
 199             }
 200         }
 201         Roo.debug && Roo.log("EL:");
 202         Roo.debug && Roo.log(el);
 203         Roo.debug && Roo.log("this.parent.el:");
 204         Roo.debug && Roo.log(this.parent.el);
 205
 206         var tree = this._tree ? this._tree() : this.tree();
 207         Roo.log('tree??');
 208         Roo.log(tree);
 209         // altertive root elements ??? - we need a better way to indicate these.
 210         var is_alt = (typeof(Roo.bootstrap) != 'undefined' && tree.xns == Roo.bootstrap) ||
 211                         (typeof(Roo.mailer) != 'undefined' && tree.xns == Roo.mailer) ;
 212
 213         if (!this.parent && is_alt) {
 214             //el = Roo.get(document.body);
 215             this.parent = { el : true };
 216         }
 217
 218
 219
 220         if (!this.parent) {
 221
 222             Roo.debug && Roo.log("no parent - creating one");
 223
 224             el = el ? Roo.get(el) : false;
 225
 226             // it's a top level one..
 227             this.parent =  {
 228                 el : new Roo.BorderLayout(el || document.body, {
 229
 230                      center: {
 231                          titlebar: false,
 232                          autoScroll:false,
 233                          closeOnTab: true,
 234                          tabPosition: 'top',
 235                           //resizeTabs: true,
 236                          alwaysShowTabs: el && hp? false :  true,
 237                          hideTabs: el || !hp ? true :  false,
 238                          minTabWidth: 140
 239                      }
 240                  })
 241             }
 242         }
 243         Roo.log('parent el');
 244         Roo.log(this.parent.el);
 245         if (!this.parent.el) {
 246                 // probably an old style ctor, which has been disabled.
 247                 return;
 248
 249         }
 250                 // The 'tree' method is  '_tree now'
 251
 252         tree.region = tree.region || this.region;
 253
 254         if (this.parent.el === true) {
 255             // bootstrap... - body..
 256             this.parent.el = Roo.factory(tree);
 257         }
 258
 259         this.el = this.parent.el.addxtype(tree);
 260         this.fireEvent('built', this);
 261
 262         this.panel = this.el;
 263         this.layout = this.panel.layout;
 264         this.parentLayout = this.parent.layout  || false;
 265
 266     }
 267
 268 });
 269
 270 Roo.apply(Roo.XComponent, {
 271     /**
 272      * @property  hideProgress
 273      * true to disable the building progress bar.. usefull on single page renders.
 274      * @type Boolean
 275      */
 276     hideProgress : false,
 277     /**
 278      * @property  buildCompleted
 279      * True when the builder has completed building the interface.
 280      * @type Boolean
 281      */
 282     buildCompleted : false,
 283
 284     /**
 285      * @property  topModule
 286      * the upper most module - uses document.element as it's constructor.
 287      * @type Object
 288      */
 289
 290     topModule  : false,
 291
 292     /**
 293      * @property  modules
 294      * array of modules to be created by registration system.
 295      * @type {Array} of Roo.XComponent
 296      */
 297
 298     modules : [],
 299     /**
 300      * @property  elmodules
 301      * array of modules to be created by which use #ID
 302      * @type {Array} of Roo.XComponent
 303      */
 304
 305     elmodules : [],
 306
 307      /**
 308      * @property  build_from_html
 309      * Build elements from html - used by bootstrap HTML stuff
 310      *    - this is cleared after build is completed
 311      * @type {boolean} true  (default false)
 312      */
 313
 314     build_from_html : false,
 315
 316     /**
 317      * Register components to be built later.
 318      *
 319      * This solves the following issues
 320      * - Building is not done on page load, but after an authentication process has occured.
 321      * - Interface elements are registered on page load
 322      * - Parent Interface elements may not be loaded before child, so this handles that..
 323      *
 324      *
 325      * example:
 326      *
 327      * MyApp.register({
 328           order : '000001',
 329           module : 'Pman.Tab.projectMgr',
 330           region : 'center',
 331           parent : 'Pman.layout',
 332           disabled : false,  // or use a function..
 333         })
 334
 335      * * @param {Object} details about module
 336      */
 337     register : function(obj) {
 338
 339         Roo.XComponent.event.fireEvent('register', obj);
 340         switch(typeof(obj.disabled) ) {
 341
 342             case 'undefined':
 343                 break;
 344
 345             case 'function':
 346                 if ( obj.disabled() ) {
 347                         return;
 348                 }
 349                 break;
 350
 351             default:
 352                 if (obj.disabled) {
 353                         return;
 354                 }
 355                 break;
 356         }
 357
 358         this.modules.push(obj);
 359
 360     },
 361     /**
 362      * convert a string to an object..
 363      * eg. 'AAA.BBB' -> finds AAA.BBB
 364
 365      */
 366
 367     toObject : function(str)
 368     {
 369         if (!str || typeof(str) == 'object') {
 370             return str;
 371         }
 372         if (str.substring(0,1) == '#') {
 373             return str;
 374         }
 375
 376         var ar = str.split('.');
 377         var rt, o;
 378         rt = ar.shift();
 379             /** eval:var:o */
 380         try {
 381             eval('if (typeof ' + rt + ' == "undefined"){ o = false;} o = ' + rt + ';');
 382         } catch (e) {
 383             throw "Module not found : " + str;
 384         }
 385
 386         if (o === false) {
 387             throw "Module not found : " + str;
 388         }
 389         Roo.each(ar, function(e) {
 390             if (typeof(o[e]) == 'undefined') {
 391                 throw "Module not found : " + str;
 392             }
 393             o = o[e];
 394         });
 395
 396         return o;
 397
 398     },
 399
 400
 401     /**
 402      * move modules into their correct place in the tree..
 403      *
 404      */
 405     preBuild : function ()
 406     {
 407         var _t = this;
 408         Roo.each(this.modules , function (obj)
 409         {
 410             Roo.XComponent.event.fireEvent('beforebuild', obj);
 411
 412             var opar = obj.parent;
 413             try {
 414                 obj.parent = this.toObject(opar);
 415             } catch(e) {
 416                 Roo.debug && Roo.log("parent:toObject failed: " + e.toString());
 417                 return;
 418             }
 419
 420             if (!obj.parent) {
 421                 Roo.debug && Roo.log("GOT top level module");
 422                 Roo.debug && Roo.log(obj);
 423                 obj.modules = new Roo.util.MixedCollection(false,
 424                     function(o) { return o.order + '' }
 425                 );
 426                 this.topModule = obj;
 427                 return;
 428             }
 429                         // parent is a string (usually a dom element name..)
 430             if (typeof(obj.parent) == 'string') {
 431                 this.elmodules.push(obj);
 432                 return;
 433             }
 434             if (obj.parent.constructor != Roo.XComponent) {
 435                 Roo.debug && Roo.log("Warning : Object Parent is not instance of XComponent:" + obj.name)
 436             }
 437             if (!obj.parent.modules) {
 438                 obj.parent.modules = new Roo.util.MixedCollection(false,
 439                     function(o) { return o.order + '' }
 440                 );
 441             }
 442             if (obj.parent.disabled) {
 443                 obj.disabled = true;
 444             }
 445             obj.parent.modules.add(obj);
 446         }, this);
 447     },
 448
 449      /**
 450      * make a list of modules to build.
 451      * @return {Array} list of modules.
 452      */
 453
 454     buildOrder : function()
 455     {
 456         var _this = this;
 457         var cmp = function(a,b) {
 458             return String(a).toUpperCase() > String(b).toUpperCase() ? 1 : -1;
 459         };
 460         if ((!this.topModule || !this.topModule.modules) && !this.elmodules.length) {
 461             throw "No top level modules to build";
 462         }
 463
 464         // make a flat list in order of modules to build.
 465         var mods = this.topModule ? [ this.topModule ] : [];
 466
 467
 468         // elmodules (is a list of DOM based modules )
 469         Roo.each(this.elmodules, function(e) {
 470             mods.push(e);
 471             if (!this.topModule &&
 472                 typeof(e.parent) == 'string' &&
 473                 e.parent.substring(0,1) == '#' &&
 474                 Roo.get(e.parent.substr(1))
 475                ) {
 476
 477                 _this.topModule = e;
 478             }
 479
 480         });
 481
 482
 483         // add modules to their parents..
 484         var addMod = function(m) {
 485             Roo.debug && Roo.log("build Order: add: " + m.name);
 486
 487             mods.push(m);
 488             if (m.modules && !m.disabled) {
 489                 Roo.debug && Roo.log("build Order: " + m.modules.length + " child modules");
 490                 m.modules.keySort('ASC',  cmp );
 491                 Roo.debug && Roo.log("build Order: " + m.modules.length + " child modules (after sort)");
 492
 493                 m.modules.each(addMod);
 494             } else {
 495                 Roo.debug && Roo.log("build Order: no child modules");
 496             }
 497             // not sure if this is used any more..
 498             if (m.finalize) {
 499                 m.finalize.name = m.name + " (clean up) ";
 500                 mods.push(m.finalize);
 501             }
 502
 503         }
 504         if (this.topModule && this.topModule.modules) {
 505             this.topModule.modules.keySort('ASC',  cmp );
 506             this.topModule.modules.each(addMod);
 507         }
 508         return mods;
 509     },
 510
 511      /**
 512      * Build the registered modules.
 513      * @param {Object} parent element.
 514      * @param {Function} optional method to call after module has been added.
 515      *
 516      */
 517
 518     build : function(opts)
 519     {
 520
 521         if (typeof(opts) != 'undefined') {
 522             Roo.apply(this,opts);
 523         }
 524
 525         this.preBuild();
 526         var mods = this.buildOrder();
 527
 528         //this.allmods = mods;
 529         //Roo.debug && Roo.log(mods);
 530         //return;
 531         if (!mods.length) { // should not happen
 532             throw "NO modules!!!";
 533         }
 534
 535
 536         var msg = "Building Interface...";
 537         // flash it up as modal - so we store the mask!?
 538         if (!this.hideProgress && Roo.MessageBox) {
 539             Roo.MessageBox.show({ title: 'loading' });
 540             Roo.MessageBox.show({
 541                title: "Please wait...",
 542                msg: msg,
 543                width:450,
 544                progress:true,
 545                closable:false,
 546                modal: false
 547
 548             });
 549         }
 550         var total = mods.length;
 551
 552         var _this = this;
 553         var progressRun = function() {
 554             if (!mods.length) {
 555                 Roo.debug && Roo.log('hide?');
 556                 if (!this.hideProgress && Roo.MessageBox) {
 557                     Roo.MessageBox.hide();
 558                 }
 559                 Roo.XComponent.build_from_html = false; // reset, so dialogs will be build from javascript
 560
 561                 Roo.XComponent.event.fireEvent('buildcomplete', _this.topModule);
 562
 563                 // THE END...
 564                 return false;
 565             }
 566
 567             var m = mods.shift();
 568
 569
 570             Roo.debug && Roo.log(m);
 571             // not sure if this is supported any more.. - modules that are are just function
 572             if (typeof(m) == 'function') {
 573                 m.call(this);
 574                 return progressRun.defer(10, _this);
 575             }
 576
 577
 578             msg = "Building Interface " + (total  - mods.length) +
 579                     " of " + total +
 580                     (m.name ? (' - ' + m.name) : '');
 581                         Roo.debug && Roo.log(msg);
 582             if (!this.hideProgress &&  Roo.MessageBox) {
 583                 Roo.MessageBox.updateProgress(  (total  - mods.length)/total, msg  );
 584             }
 585
 586
 587             // is the module disabled?
 588             var disabled = (typeof(m.disabled) == 'function') ?
 589                 m.disabled.call(m.module.disabled) : m.disabled;
 590
 591
 592             if (disabled) {
 593                 return progressRun(); // we do not update the display!
 594             }
 595
 596             // now build
 597
 598
 599
 600             m.render();
 601             // it's 10 on top level, and 1 on others??? why...
 602             return progressRun.defer(10, _this);
 603
 604         }
 605         progressRun.defer(1, _this);
 606
 607
 608
 609     },
 610
 611
 612         /**
 613          * Event Object.
 614          *
 615          *
 616          */
 617         event: false,
 618     /**
 619          * wrapper for event.on - aliased later..
 620          * Typically use to register a event handler for register:
 621          *
 622          * eg. Roo.XComponent.on('register', function(comp) { comp.disable = true } );
 623          *
 624          */
 625     on : false
 626
 627
 628
 629 });
 630
 631 Roo.XComponent.event = new Roo.util.Observable({
 632                 events : {
 633                         /**
 634                          * @event register
 635                          * Fires when an Component is registered,
 636                          * set the disable property on the Component to stop registration.
 637                          * @param {Roo.XComponent} c the component being registerd.
 638                          *
 639                          */
 640                         'register' : true,
 641             /**
 642                          * @event beforebuild
 643                          * Fires before each Component is built
 644                          * can be used to apply permissions.
 645                          * @param {Roo.XComponent} c the component being registerd.
 646                          *
 647                          */
 648                         'beforebuild' : true,
 649                         /**
 650                          * @event buildcomplete
 651                          * Fires on the top level element when all elements have been built
 652                          * @param {Roo.XComponent} the top level component.
 653                          */
 654                         'buildcomplete' : true
 655
 656                 }
 657 });
 658
 659 Roo.XComponent.on = Roo.XComponent.event.on.createDelegate(Roo.XComponent.event);
 660