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