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