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