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