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
 165         el = el || false;
 166         var hp = this.parent ? 1 : 0;
 167         Roo.debug &&  Roo.log(this);
 168
 169         var tree = this._tree ? this._tree() : this.tree();
 170
 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(tree.el) != 'undefined' && tree.el == document.body)  {
 180                         // this is the BorderLayout standard?
 181                        this.parent = { el : true };
 182                        break;
 183                     }
 184                     if (["Nest", "Content", "Grid", "Tree"].indexOf(tree.xtype)  > -1)  {
 185                         // need to insert stuff...
 186                         this.parent =  {
 187                              el : new Roo.bootstrap.layout.Border({
 188                                  el : document.body,
 189
 190                                  center: {
 191                                     titlebar: false,
 192                                     autoScroll:false,
 193                                     closeOnTab: true,
 194                                     tabPosition: 'top',
 195                                       //resizeTabs: true,
 196                                     alwaysShowTabs: true,
 197                                     hideTabs: false
 198                                      //minTabWidth: 140
 199                                  }
 200                              })
 201
 202                          };
 203                          break;
 204                     }
 205
 206                     if (typeof(Roo.bootstrap.Body) != 'undefined' && tree['|xns'] == 'Roo.bootstrap') {
 207                         this.parent = { el :  new  Roo.bootstrap.Body() };
 208                         Roo.debug && Roo.log("setting el to doc body");
 209
 210                     } else {
 211                         throw "Container is bootstrap body, but Roo.bootstrap.Body is not defined";
 212                     }
 213                     break;
 214                 case 'bootstrap':
 215                     this.parent = { el : true};
 216                     // fall through
 217                 default:
 218                     el = Roo.get(ename);
 219                     if (typeof(Roo.bootstrap) != 'undefined') {
 220                         this.parent = { el : true};
 221                     }
 222
 223                     break;
 224             }
 225
 226
 227             if (!el && !this.parent) {
 228                 Roo.debug && Roo.log("Warning - element can not be found :#" + ename );
 229                 return;
 230             }
 231         }
 232
 233         Roo.debug && Roo.log("EL:");
 234         Roo.debug && Roo.log(el);
 235         Roo.debug && Roo.log("this.parent.el:");
 236         Roo.debug && Roo.log(this.parent.el);
 237
 238
 239         // altertive root elements ??? - we need a better way to indicate these.
 240         var is_alt = Roo.XComponent.is_alt ||
 241                     (typeof(tree.el) != 'undefined' && tree.el == document.body) ||
 242                     (typeof(Roo.bootstrap) != 'undefined' && tree.xns == Roo.bootstrap) ||
 243                     (typeof(Roo.mailer) != 'undefined' && tree.xns == Roo.mailer) ;
 244
 245
 246
 247         if (!this.parent && is_alt) {
 248             //el = Roo.get(document.body);
 249             this.parent = { el : true };
 250         }
 251
 252
 253
 254         if (!this.parent) {
 255
 256             Roo.debug && Roo.log("no parent - creating one");
 257
 258             el = el ? Roo.get(el) : false;
 259
 260             if (typeof(Roo.BorderLayout) == 'undefined' ) {
 261
 262                 this.parent =  {
 263                     el : new Roo.bootstrap.layout.Border({
 264                         el: el || document.body,
 265
 266                         center: {
 267                             titlebar: false,
 268                             autoScroll:false,
 269                             closeOnTab: true,
 270                             tabPosition: 'top',
 271                              //resizeTabs: true,
 272                             alwaysShowTabs: false,
 273                             hideTabs: true,
 274                             minTabWidth: 140,
 275                             overflow: 'visible'
 276                          }
 277                      })
 278                 };
 279             } else {
 280
 281                 // it's a top level one..
 282                 this.parent =  {
 283                     el : new Roo.BorderLayout(el || document.body, {
 284                         center: {
 285                             titlebar: false,
 286                             autoScroll:false,
 287                             closeOnTab: true,
 288                             tabPosition: 'top',
 289                              //resizeTabs: true,
 290                             alwaysShowTabs: el && hp? false :  true,
 291                             hideTabs: el || !hp ? true :  false,
 292                             minTabWidth: 140
 293                          }
 294                     })
 295                 };
 296             }
 297         }
 298
 299         if (!this.parent.el) {
 300                 // probably an old style ctor, which has been disabled.
 301                 return;
 302
 303         }
 304                 // The 'tree' method is  '_tree now'
 305
 306         tree.region = tree.region || this.region;
 307         var is_body = false;
 308         if (this.parent.el === true) {
 309             // bootstrap... - body..
 310             if (el) {
 311                 tree.el = el;
 312             }
 313             this.parent.el = Roo.factory(tree);
 314             is_body = true;
 315         }
 316
 317         this.el = this.parent.el.addxtype(tree, undefined, is_body);
 318         this.fireEvent('built', this);
 319
 320         this.panel = this.el;
 321         this.layout = this.panel.layout;
 322         this.parentLayout = this.parent.layout  || false;
 323
 324     }
 325
 326 });
 327
 328 Roo.apply(Roo.XComponent, {
 329     /**
 330      * @property  hideProgress
 331      * true to disable the building progress bar.. usefull on single page renders.
 332      * @type Boolean
 333      */
 334     hideProgress : false,
 335     /**
 336      * @property  buildCompleted
 337      * True when the builder has completed building the interface.
 338      * @type Boolean
 339      */
 340     buildCompleted : false,
 341
 342     /**
 343      * @property  topModule
 344      * the upper most module - uses document.element as it's constructor.
 345      * @type Object
 346      */
 347
 348     topModule  : false,
 349
 350     /**
 351      * @property  modules
 352      * array of modules to be created by registration system.
 353      * @type {Array} of Roo.XComponent
 354      */
 355
 356     modules : [],
 357     /**
 358      * @property  elmodules
 359      * array of modules to be created by which use #ID
 360      * @type {Array} of Roo.XComponent
 361      */
 362
 363     elmodules : [],
 364
 365      /**
 366      * @property  is_alt
 367      * Is an alternative Root - normally used by bootstrap or other systems,
 368      *    where the top element in the tree can wrap 'body'
 369      * @type {boolean}  (default false)
 370      */
 371
 372     is_alt : false,
 373     /**
 374      * @property  build_from_html
 375      * Build elements from html - used by bootstrap HTML stuff
 376      *    - this is cleared after build is completed
 377      * @type {boolean}    (default false)
 378      */
 379
 380     build_from_html : false,
 381     /**
 382      * Register components to be built later.
 383      *
 384      * This solves the following issues
 385      * - Building is not done on page load, but after an authentication process has occured.
 386      * - Interface elements are registered on page load
 387      * - Parent Interface elements may not be loaded before child, so this handles that..
 388      *
 389      *
 390      * example:
 391      *
 392      * MyApp.register({
 393           order : '000001',
 394           module : 'Pman.Tab.projectMgr',
 395           region : 'center',
 396           parent : 'Pman.layout',
 397           disabled : false,  // or use a function..
 398         })
 399
 400      * * @param {Object} details about module
 401      */
 402     register : function(obj) {
 403
 404         Roo.XComponent.event.fireEvent('register', obj);
 405         switch(typeof(obj.disabled) ) {
 406
 407             case 'undefined':
 408                 break;
 409
 410             case 'function':
 411                 if ( obj.disabled() ) {
 412                         return;
 413                 }
 414                 break;
 415
 416             default:
 417                 if (obj.disabled) {
 418                         return;
 419                 }
 420                 break;
 421         }
 422
 423         this.modules.push(obj);
 424
 425     },
 426     /**
 427      * convert a string to an object..
 428      * eg. 'AAA.BBB' -> finds AAA.BBB
 429
 430      */
 431
 432     toObject : function(str)
 433     {
 434         if (!str || typeof(str) == 'object') {
 435             return str;
 436         }
 437         if (str.substring(0,1) == '#') {
 438             return str;
 439         }
 440
 441         var ar = str.split('.');
 442         var rt, o;
 443         rt = ar.shift();
 444             /** eval:var:o */
 445         try {
 446             eval('if (typeof ' + rt + ' == "undefined"){ o = false;} o = ' + rt + ';');
 447         } catch (e) {
 448             throw "Module not found : " + str;
 449         }
 450
 451         if (o === false) {
 452             throw "Module not found : " + str;
 453         }
 454         Roo.each(ar, function(e) {
 455             if (typeof(o[e]) == 'undefined') {
 456                 throw "Module not found : " + str;
 457             }
 458             o = o[e];
 459         });
 460
 461         return o;
 462
 463     },
 464
 465
 466     /**
 467      * move modules into their correct place in the tree..
 468      *
 469      */
 470     preBuild : function ()
 471     {
 472         var _t = this;
 473         Roo.each(this.modules , function (obj)
 474         {
 475             Roo.XComponent.event.fireEvent('beforebuild', obj);
 476
 477             var opar = obj.parent;
 478             try {
 479                 obj.parent = this.toObject(opar);
 480             } catch(e) {
 481                 Roo.debug && Roo.log("parent:toObject failed: " + e.toString());
 482                 return;
 483             }
 484
 485             if (!obj.parent) {
 486                 Roo.debug && Roo.log("GOT top level module");
 487                 Roo.debug && Roo.log(obj);
 488                 obj.modules = new Roo.util.MixedCollection(false,
 489                     function(o) { return o.order + '' }
 490                 );
 491                 this.topModule = obj;
 492                 return;
 493             }
 494                         // parent is a string (usually a dom element name..)
 495             if (typeof(obj.parent) == 'string') {
 496                 this.elmodules.push(obj);
 497                 return;
 498             }
 499             if (obj.parent.constructor != Roo.XComponent) {
 500                 Roo.debug && Roo.log("Warning : Object Parent is not instance of XComponent:" + obj.name)
 501             }
 502             if (!obj.parent.modules) {
 503                 obj.parent.modules = new Roo.util.MixedCollection(false,
 504                     function(o) { return o.order + '' }
 505                 );
 506             }
 507             if (obj.parent.disabled) {
 508                 obj.disabled = true;
 509             }
 510             obj.parent.modules.add(obj);
 511         }, this);
 512     },
 513
 514      /**
 515      * make a list of modules to build.
 516      * @return {Array} list of modules.
 517      */
 518
 519     buildOrder : function()
 520     {
 521         var _this = this;
 522         var cmp = function(a,b) {
 523             return String(a).toUpperCase() > String(b).toUpperCase() ? 1 : -1;
 524         };
 525         if ((!this.topModule || !this.topModule.modules) && !this.elmodules.length) {
 526             throw "No top level modules to build";
 527         }
 528
 529         // make a flat list in order of modules to build.
 530         var mods = this.topModule ? [ this.topModule ] : [];
 531
 532
 533         // elmodules (is a list of DOM based modules )
 534         Roo.each(this.elmodules, function(e) {
 535             mods.push(e);
 536             if (!this.topModule &&
 537                 typeof(e.parent) == 'string' &&
 538                 e.parent.substring(0,1) == '#' &&
 539                 Roo.get(e.parent.substr(1))
 540                ) {
 541
 542                 _this.topModule = e;
 543             }
 544
 545         });
 546
 547
 548         // add modules to their parents..
 549         var addMod = function(m) {
 550             Roo.debug && Roo.log("build Order: add: " + m.name);
 551
 552             mods.push(m);
 553             if (m.modules && !m.disabled) {
 554                 Roo.debug && Roo.log("build Order: " + m.modules.length + " child modules");
 555                 m.modules.keySort('ASC',  cmp );
 556                 Roo.debug && Roo.log("build Order: " + m.modules.length + " child modules (after sort)");
 557
 558                 m.modules.each(addMod);
 559             } else {
 560                 Roo.debug && Roo.log("build Order: no child modules");
 561             }
 562             // not sure if this is used any more..
 563             if (m.finalize) {
 564                 m.finalize.name = m.name + " (clean up) ";
 565                 mods.push(m.finalize);
 566             }
 567
 568         }
 569         if (this.topModule && this.topModule.modules) {
 570             this.topModule.modules.keySort('ASC',  cmp );
 571             this.topModule.modules.each(addMod);
 572         }
 573         return mods;
 574     },
 575
 576      /**
 577      * Build the registered modules.
 578      * @param {Object} parent element.
 579      * @param {Function} optional method to call after module has been added.
 580      *
 581      */
 582
 583     build : function(opts)
 584     {
 585
 586         if (typeof(opts) != 'undefined') {
 587             Roo.apply(this,opts);
 588         }
 589
 590         this.preBuild();
 591         var mods = this.buildOrder();
 592
 593         //this.allmods = mods;
 594         //Roo.debug && Roo.log(mods);
 595         //return;
 596         if (!mods.length) { // should not happen
 597             throw "NO modules!!!";
 598         }
 599
 600
 601         var msg = "Building Interface...";
 602         // flash it up as modal - so we store the mask!?
 603         if (!this.hideProgress && Roo.MessageBox) {
 604             Roo.MessageBox.show({ title: 'loading' });
 605             Roo.MessageBox.show({
 606                title: "Please wait...",
 607                msg: msg,
 608                width:450,
 609                progress:true,
 610                closable:false,
 611                modal: false
 612
 613             });
 614         }
 615         var total = mods.length;
 616
 617         var _this = this;
 618         var progressRun = function() {
 619             if (!mods.length) {
 620                 Roo.debug && Roo.log('hide?');
 621                 if (!this.hideProgress && Roo.MessageBox) {
 622                     Roo.MessageBox.hide();
 623                 }
 624                 Roo.XComponent.build_from_html = false; // reset, so dialogs will be build from javascript
 625
 626                 Roo.XComponent.event.fireEvent('buildcomplete', _this.topModule);
 627
 628                 // THE END...
 629                 return false;
 630             }
 631
 632             var m = mods.shift();
 633
 634
 635             Roo.debug && Roo.log(m);
 636             // not sure if this is supported any more.. - modules that are are just function
 637             if (typeof(m) == 'function') {
 638                 m.call(this);
 639                 return progressRun.defer(10, _this);
 640             }
 641
 642
 643             msg = "Building Interface " + (total  - mods.length) +
 644                     " of " + total +
 645                     (m.name ? (' - ' + m.name) : '');
 646                         Roo.debug && Roo.log(msg);
 647             if (!this.hideProgress &&  Roo.MessageBox) {
 648                 Roo.MessageBox.updateProgress(  (total  - mods.length)/total, msg  );
 649             }
 650
 651
 652             // is the module disabled?
 653             var disabled = (typeof(m.disabled) == 'function') ?
 654                 m.disabled.call(m.module.disabled) : m.disabled;
 655
 656
 657             if (disabled) {
 658                 return progressRun(); // we do not update the display!
 659             }
 660
 661             // now build
 662
 663
 664
 665             m.render();
 666             // it's 10 on top level, and 1 on others??? why...
 667             return progressRun.defer(10, _this);
 668
 669         }
 670         progressRun.defer(1, _this);
 671
 672
 673
 674     },
 675
 676
 677         /**
 678          * Event Object.
 679          *
 680          *
 681          */
 682         event: false,
 683     /**
 684          * wrapper for event.on - aliased later..
 685          * Typically use to register a event handler for register:
 686          *
 687          * eg. Roo.XComponent.on('register', function(comp) { comp.disable = true } );
 688          *
 689          */
 690     on : false
 691
 692
 693
 694 });
 695
 696 Roo.XComponent.event = new Roo.util.Observable({
 697                 events : {
 698                         /**
 699                          * @event register
 700                          * Fires when an Component is registered,
 701                          * set the disable property on the Component to stop registration.
 702                          * @param {Roo.XComponent} c the component being registerd.
 703                          *
 704                          */
 705                         'register' : true,
 706             /**
 707                          * @event beforebuild
 708                          * Fires before each Component is built
 709                          * can be used to apply permissions.
 710                          * @param {Roo.XComponent} c the component being registerd.
 711                          *
 712                          */
 713                         'beforebuild' : true,
 714                         /**
 715                          * @event buildcomplete
 716                          * Fires on the top level element when all elements have been built
 717                          * @param {Roo.XComponent} the top level component.
 718                          */
 719                         'buildcomplete' : true
 720
 721                 }
 722 });
 723
 724 Roo.XComponent.on = Roo.XComponent.event.on.createDelegate(Roo.XComponent.event);
 725