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