git.roojs.org Git - roojs1/blob - Roo/bootstrap/panel/Content.js

   1 /*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * <script type="text/javascript">
  10  */
  11 /**
  12  * @class Roo.ContentPanel
  13  * @extends Roo.util.Observable
  14  * A basic ContentPanel element.
  15  * @cfg {Boolean}   fitToFrame    True for this panel to adjust its size to fit when the region resizes  (defaults to false)
  16  * @cfg {Boolean}   fitContainer   When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container  (defaults to false)
  17  * @cfg {Boolean/Object} autoCreate True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create
  18  * @cfg {Boolean}   closable      True if the panel can be closed/removed
  19  * @cfg {Boolean}   background    True if the panel should not be activated when it is added (defaults to false)
  20  * @cfg {String/HTMLElement/Element} resizeEl An element to resize if {@link #fitToFrame} is true (instead of this panel's element)
  21  * @cfg {Toolbar}   toolbar       A toolbar for this panel
  22  * @cfg {Boolean} autoScroll    True to scroll overflow in this panel (use with {@link #fitToFrame})
  23  * @cfg {String} title          The title for this panel
  24  * @cfg {Array} adjustments     Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])
  25  * @cfg {String} url            Calls {@link #setUrl} with this value
  26  * @cfg {String} region         (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)
  27  * @cfg {String/Object} params  When used with {@link #url}, calls {@link #setUrl} with this value
  28  * @cfg {Boolean} loadOnce      When used with {@link #url}, calls {@link #setUrl} with this value
  29  * @cfg {String}    content        Raw content to fill content panel with (uses setContent on construction.)
  30  * @cfg {Boolean} iframe      contents are an iframe - makes showing remote sources/CSS feasible..
  31  * @cfg {Boolean} badges render the badges
  32  * @cfg {String} cls  extra classes to use
  33  * @cfg {String} background (primary|secondary|success|info|warning|danger|light|dark)
  34
  35  * @constructor
  36  * Create a new ContentPanel.
  37  * @param {String/HTMLElement/Roo.Element} el The container element for this panel
  38  * @param {String/Object} config A string to set only the title or a config object
  39  * @param {String} content (optional) Set the HTML content for this panel
  40  * @param {String} region (optional) Used by xtype constructors to add to regions. (values center,east,west,south,north)
  41  */
  42 Roo.bootstrap.panel.Content = function( config){
  43
  44     this.tpl = config.tpl || false;
  45
  46     var el = config.el;
  47     var content = config.content;
  48
  49     if(config.autoCreate){ // xtype is available if this is called from factory
  50         el = Roo.id();
  51     }
  52     this.el = Roo.get(el);
  53     if(!this.el && config && config.autoCreate){
  54         if(typeof config.autoCreate == "object"){
  55             if(!config.autoCreate.id){
  56                 config.autoCreate.id = config.id||el;
  57             }
  58             this.el = Roo.DomHelper.append(document.body,
  59                         config.autoCreate, true);
  60         }else{
  61             var elcfg =  {
  62                 tag: "div",
  63                 cls: (config.cls || '') +
  64                     (config.background ? ' bg-' + config.background : '') +
  65                     " roo-layout-inactive-content",
  66                 id: config.id||el
  67             };
  68             if (this.iframe) {
  69                 elcfg.cn = [
  70                     {
  71                         tag : 'iframe',
  72                         style : 'border 0px',
  73                         src : 'about:blank'
  74                     }
  75                 ];
  76             }
  77
  78             if (config.html) {
  79                 elcfg.html = config.html;
  80
  81             }
  82
  83             this.el = Roo.DomHelper.append(document.body, elcfg , true);
  84             if (this.iframe) {
  85                 this.iframeEl = this.el.select('iframe',true).first();
  86             }
  87
  88         }
  89     }
  90     this.closable = false;
  91     this.loaded = false;
  92     this.active = false;
  93
  94
  95     if (config.toolbar && !config.toolbar.el && config.toolbar.xtype) {
  96
  97         this.toolbar = new config.toolbar.xns[config.toolbar.xtype](config.toolbar);
  98
  99         this.wrapEl = this.el; //this.el.wrap();
 100         var ti = [];
 101         if (config.toolbar.items) {
 102             ti = config.toolbar.items ;
 103             delete config.toolbar.items ;
 104         }
 105
 106         var nitems = [];
 107         this.toolbar.render(this.wrapEl, 'before');
 108         for(var i =0;i < ti.length;i++) {
 109           //  Roo.log(['add child', items[i]]);
 110             nitems.push(this.toolbar.addxtype(Roo.apply({}, ti[i])));
 111         }
 112         this.toolbar.items = nitems;
 113         this.toolbar.el.insertBefore(this.wrapEl.dom.firstChild);
 114         delete config.toolbar;
 115
 116     }
 117     /*
 118     // xtype created footer. - not sure if will work as we normally have to render first..
 119     if (this.footer && !this.footer.el && this.footer.xtype) {
 120         if (!this.wrapEl) {
 121             this.wrapEl = this.el.wrap();
 122         }
 123
 124         this.footer.container = this.wrapEl.createChild();
 125
 126         this.footer = Roo.factory(this.footer, Roo);
 127
 128     }
 129     */
 130
 131      if(typeof config == "string"){
 132         this.title = config;
 133     }else{
 134         Roo.apply(this, config);
 135     }
 136
 137     if(this.resizeEl){
 138         this.resizeEl = Roo.get(this.resizeEl, true);
 139     }else{
 140         this.resizeEl = this.el;
 141     }
 142     // handle view.xtype
 143
 144
 145
 146
 147     this.addEvents({
 148         /**
 149          * @event activate
 150          * Fires when this panel is activated.
 151          * @param {Roo.ContentPanel} this
 152          */
 153         "activate" : true,
 154         /**
 155          * @event deactivate
 156          * Fires when this panel is activated.
 157          * @param {Roo.ContentPanel} this
 158          */
 159         "deactivate" : true,
 160
 161         /**
 162          * @event resize
 163          * Fires when this panel is resized if fitToFrame is true.
 164          * @param {Roo.ContentPanel} this
 165          * @param {Number} width The width after any component adjustments
 166          * @param {Number} height The height after any component adjustments
 167          */
 168         "resize" : true,
 169
 170          /**
 171          * @event render
 172          * Fires when this tab is created
 173          * @param {Roo.ContentPanel} this
 174          */
 175         "render" : true
 176
 177
 178
 179     });
 180
 181
 182
 183
 184     if(this.autoScroll && !this.iframe){
 185         this.resizeEl.setStyle("overflow", "auto");
 186     } else {
 187         // fix randome scrolling
 188         //this.el.on('scroll', function() {
 189         //    Roo.log('fix random scolling');
 190         //    this.scrollTo('top',0);
 191         //});
 192     }
 193     content = content || this.content;
 194     if(content){
 195         this.setContent(content);
 196     }
 197     if(config && config.url){
 198         this.setUrl(this.url, this.params, this.loadOnce);
 199     }
 200
 201
 202
 203     Roo.bootstrap.panel.Content.superclass.constructor.call(this);
 204
 205     if (this.view && typeof(this.view.xtype) != 'undefined') {
 206         this.view.el = this.el.appendChild(document.createElement("div"));
 207         this.view = Roo.factory(this.view);
 208         this.view.render  &&  this.view.render(false, '');
 209     }
 210
 211
 212     this.fireEvent('render', this);
 213 };
 214
 215 Roo.extend(Roo.bootstrap.panel.Content, Roo.bootstrap.Component, {
 216
 217     cls : '',
 218     background : '',
 219
 220     tabTip : '',
 221
 222     iframe : false,
 223
 224     setRegion : function(region){
 225         this.region = region;
 226         this.setActiveClass(region && !this.background);
 227     },
 228
 229
 230     setActiveClass: function(state)
 231     {
 232         if(state){
 233            this.el.replaceClass("roo-layout-inactive-content", "roo-layout-active-content");
 234            this.el.setStyle('position','relative');
 235         }else{
 236            this.el.replaceClass("roo-layout-active-content", "roo-layout-inactive-content");
 237            this.el.setStyle('position', 'absolute');
 238         }
 239     },
 240
 241     /**
 242      * Returns the toolbar for this Panel if one was configured.
 243      * @return {Roo.Toolbar}
 244      */
 245     getToolbar : function(){
 246         return this.toolbar;
 247     },
 248
 249     setActiveState : function(active)
 250     {
 251         this.active = active;
 252         this.setActiveClass(active);
 253         if(!active){
 254             if(this.fireEvent("deactivate", this) === false){
 255                 return false;
 256             }
 257             return true;
 258         }
 259         this.fireEvent("activate", this);
 260         return true;
 261     },
 262     /**
 263      * Updates this panel's element (not for iframe)
 264      * @param {String} content The new content
 265      * @param {Boolean} loadScripts (optional) true to look for and process scripts
 266     */
 267     setContent : function(content, loadScripts){
 268         if (this.iframe) {
 269             return;
 270         }
 271
 272         this.el.update(content, loadScripts);
 273     },
 274
 275     ignoreResize : function(w, h){
 276         if(this.lastSize && this.lastSize.width == w && this.lastSize.height == h){
 277             return true;
 278         }else{
 279             this.lastSize = {width: w, height: h};
 280             return false;
 281         }
 282     },
 283     /**
 284      * Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.
 285      * @return {Roo.UpdateManager} The UpdateManager
 286      */
 287     getUpdateManager : function(){
 288         if (this.iframe) {
 289             return false;
 290         }
 291         return this.el.getUpdateManager();
 292     },
 293      /**
 294      * Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.
 295      * @param {Object/String/Function} url The url for this request or a function to call to get the url or a config object containing any of the following options:
 296 <pre><code>
 297 panel.load({
 298     url: "your-url.php",
 299     params: {param1: "foo", param2: "bar"}, // or a URL encoded string
 300     callback: yourFunction,
 301     scope: yourObject, //(optional scope)
 302     discardUrl: false,
 303     nocache: false,
 304     text: "Loading...",
 305     timeout: 30,
 306     scripts: false
 307 });
 308 </code></pre>
 309      * The only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>
 310      * are shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.
 311      * @param {String/Object} params (optional) The parameters to pass as either a URL encoded string "param1=1&amp;param2=2" or an object {param1: 1, param2: 2}
 312      * @param {Function} callback (optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)
 313      * @param {Boolean} discardUrl (optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.
 314      * @return {Roo.ContentPanel} this
 315      */
 316     load : function(){
 317         var um = this.el.getUpdateManager();
 318         um.update.apply(um, arguments);
 319         return this;
 320     },
 321
 322
 323     /**
 324      * Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.
 325      * @param {String/Function} url The URL to load the content from or a function to call to get the URL
 326      * @param {String/Object} params (optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)
 327      * @param {Boolean} loadOnce (optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)
 328      * @return {Roo.UpdateManager} The UpdateManager
 329      */
 330     setUrl : function(url, params, loadOnce){
 331         if(this.refreshDelegate){
 332             this.removeListener("activate", this.refreshDelegate);
 333         }
 334         this.refreshDelegate = this._handleRefresh.createDelegate(this, [url, params, loadOnce]);
 335         this.on("activate", this.refreshDelegate);
 336         return this.el.getUpdateManager();
 337     },
 338
 339     _handleRefresh : function(url, params, loadOnce){
 340         if(!loadOnce || !this.loaded){
 341             var updater = this.el.getUpdateManager();
 342             updater.update(url, params, this._setLoaded.createDelegate(this));
 343         }
 344     },
 345
 346     _setLoaded : function(){
 347         this.loaded = true;
 348     },
 349
 350     /**
 351      * Returns this panel's id
 352      * @return {String}
 353      */
 354     getId : function(){
 355         return this.el.id;
 356     },
 357
 358     /**
 359      * Returns this panel's element - used by regiosn to add.
 360      * @return {Roo.Element}
 361      */
 362     getEl : function(){
 363         return this.wrapEl || this.el;
 364     },
 365
 366
 367
 368     adjustForComponents : function(width, height)
 369     {
 370         //Roo.log('adjustForComponents ');
 371         if(this.resizeEl != this.el){
 372             width -= this.el.getFrameWidth('lr');
 373             height -= this.el.getFrameWidth('tb');
 374         }
 375         if(this.toolbar){
 376             var te = this.toolbar.getEl();
 377             te.setWidth(width);
 378             height -= te.getHeight();
 379         }
 380         if(this.footer){
 381             var te = this.footer.getEl();
 382             te.setWidth(width);
 383             height -= te.getHeight();
 384         }
 385
 386
 387         if(this.adjustments){
 388             width += this.adjustments[0];
 389             height += this.adjustments[1];
 390         }
 391         return {"width": width, "height": height};
 392     },
 393
 394     setSize : function(width, height){
 395         if(this.fitToFrame && !this.ignoreResize(width, height)){
 396             if(this.fitContainer && this.resizeEl != this.el){
 397                 this.el.setSize(width, height);
 398             }
 399             var size = this.adjustForComponents(width, height);
 400             this.resizeEl.setSize(this.autoWidth ? "auto" : size.width, this.autoHeight ? "auto" : size.height);
 401             this.fireEvent('resize', this, size.width, size.height);
 402         }
 403     },
 404
 405     /**
 406      * Returns this panel's title
 407      * @return {String}
 408      */
 409     getTitle : function(){
 410
 411         if (typeof(this.title) != 'object') {
 412             return this.title;
 413         }
 414
 415         var t = '';
 416         for (var k in this.title) {
 417             if (!this.title.hasOwnProperty(k)) {
 418                 continue;
 419             }
 420
 421             if (k.indexOf('-') >= 0) {
 422                 var s = k.split('-');
 423                 for (var i = 0; i<s.length; i++) {
 424                     t += "<span class='visible-"+s[i]+"'>"+this.title[k]+"</span>";
 425                 }
 426             } else {
 427                 t += "<span class='visible-"+k+"'>"+this.title[k]+"</span>";
 428             }
 429         }
 430         return t;
 431     },
 432
 433     /**
 434      * Set this panel's title
 435      * @param {String} title
 436      */
 437     setTitle : function(title){
 438         this.title = title;
 439         if(this.region){
 440             this.region.updatePanelTitle(this, title);
 441         }
 442     },
 443
 444     /**
 445      * Returns true is this panel was configured to be closable
 446      * @return {Boolean}
 447      */
 448     isClosable : function(){
 449         return this.closable;
 450     },
 451
 452     beforeSlide : function(){
 453         this.el.clip();
 454         this.resizeEl.clip();
 455     },
 456
 457     afterSlide : function(){
 458         this.el.unclip();
 459         this.resizeEl.unclip();
 460     },
 461
 462     /**
 463      *   Force a content refresh from the URL specified in the {@link #setUrl} method.
 464      *   Will fail silently if the {@link #setUrl} method has not been called.
 465      *   This does not activate the panel, just updates its content.
 466      */
 467     refresh : function(){
 468         if(this.refreshDelegate){
 469            this.loaded = false;
 470            this.refreshDelegate();
 471         }
 472     },
 473
 474     /**
 475      * Destroys this panel
 476      */
 477     destroy : function(){
 478         this.el.removeAllListeners();
 479         var tempEl = document.createElement("span");
 480         tempEl.appendChild(this.el.dom);
 481         tempEl.innerHTML = "";
 482         this.el.remove();
 483         this.el = null;
 484     },
 485
 486     /**
 487      * form - if the content panel contains a form - this is a reference to it.
 488      * @type {Roo.form.Form}
 489      */
 490     form : false,
 491     /**
 492      * view - if the content panel contains a view (Roo.DatePicker / Roo.View / Roo.JsonView)
 493      *    This contains a reference to it.
 494      * @type {Roo.View}
 495      */
 496     view : false,
 497
 498       /**
 499      * Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.
 500      * <pre><code>
 501
 502 layout.addxtype({
 503        xtype : 'Form',
 504        items: [ .... ]
 505    }
 506 );
 507
 508 </code></pre>
 509      * @param {Object} cfg Xtype definition of item to add.
 510      */
 511
 512
 513     getChildContainer: function () {
 514         return this.getEl();
 515     }
 516
 517
 518     /*
 519         var  ret = new Roo.factory(cfg);
 520         return ret;
 521
 522
 523         // add form..
 524         if (cfg.xtype.match(/^Form$/)) {
 525
 526             var el;
 527             //if (this.footer) {
 528             //    el = this.footer.container.insertSibling(false, 'before');
 529             //} else {
 530                 el = this.el.createChild();
 531             //}
 532
 533             this.form = new  Roo.form.Form(cfg);
 534
 535
 536             if ( this.form.allItems.length) {
 537                 this.form.render(el.dom);
 538             }
 539             return this.form;
 540         }
 541         // should only have one of theses..
 542         if ([ 'View', 'JsonView', 'DatePicker'].indexOf(cfg.xtype) > -1) {
 543             // views.. should not be just added - used named prop 'view''
 544
 545             cfg.el = this.el.appendChild(document.createElement("div"));
 546             // factory?
 547
 548             var ret = new Roo.factory(cfg);
 549
 550              ret.render && ret.render(false, ''); // render blank..
 551             this.view = ret;
 552             return ret;
 553         }
 554         return false;
 555     }
 556     \*/
 557 });
 558