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