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