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