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