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