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