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