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