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