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