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