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