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