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