3c3df3e2d38b5850a77cc1bf4cb55787f7b0df62
[roojs1] / 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         
318         if (this.iframe) {
319             return this;
320         }
321         
322         var um = this.el.getUpdateManager();
323         um.update.apply(um, arguments);
324         return this;
325     },
326
327
328     /**
329      * 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.
330      * @param {String/Function} url The URL to load the content from or a function to call to get the URL
331      * @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)
332      * @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)
333      * @return {Roo.UpdateManager} The UpdateManager
334      */
335     setUrl : function(url, params, loadOnce){
336         if (this.iframe) {
337             this.iframeEl.dom.src = url;
338             return;
339         }
340         
341         if(this.refreshDelegate){
342             this.removeListener("activate", this.refreshDelegate);
343         }
344         this.refreshDelegate = this._handleRefresh.createDelegate(this, [url, params, loadOnce]);
345         this.on("activate", this.refreshDelegate);
346         return this.el.getUpdateManager();
347     },
348     
349     _handleRefresh : function(url, params, loadOnce){
350         if(!loadOnce || !this.loaded){
351             var updater = this.el.getUpdateManager();
352             updater.update(url, params, this._setLoaded.createDelegate(this));
353         }
354     },
355     
356     _setLoaded : function(){
357         this.loaded = true;
358     }, 
359     
360     /**
361      * Returns this panel's id
362      * @return {String} 
363      */
364     getId : function(){
365         return this.el.id;
366     },
367     
368     /** 
369      * Returns this panel's element - used by regiosn to add.
370      * @return {Roo.Element} 
371      */
372     getEl : function(){
373         return this.wrapEl || this.el;
374     },
375     
376    
377     
378     adjustForComponents : function(width, height)
379     {
380         //Roo.log('adjustForComponents ');
381         if(this.resizeEl != this.el){
382             width -= this.el.getFrameWidth('lr');
383             height -= this.el.getFrameWidth('tb');
384         }
385         if(this.toolbar){
386             var te = this.toolbar.getEl();
387             te.setWidth(width);
388             height -= te.getHeight();
389         }
390         if(this.footer){
391             var te = this.footer.getEl();
392             te.setWidth(width);
393             height -= te.getHeight();
394         }
395         
396         
397         if(this.adjustments){
398             width += this.adjustments[0];
399             height += this.adjustments[1];
400         }
401         return {"width": width, "height": height};
402     },
403     
404     setSize : function(width, height){
405         if(this.fitToFrame && !this.ignoreResize(width, height)){
406             if(this.fitContainer && this.resizeEl != this.el){
407                 this.el.setSize(width, height);
408             }
409             var size = this.adjustForComponents(width, height);
410             this.resizeEl.setSize(this.autoWidth ? "auto" : size.width, this.autoHeight ? "auto" : size.height);
411             this.fireEvent('resize', this, size.width, size.height);
412         }
413     },
414     
415     /**
416      * Returns this panel's title
417      * @return {String} 
418      */
419     getTitle : function(){
420         
421         if (typeof(this.title) != 'object') {
422             return this.title;
423         }
424         
425         var t = '';
426         for (var k in this.title) {
427             if (!this.title.hasOwnProperty(k)) {
428                 continue;
429             }
430             
431             if (k.indexOf('-') >= 0) {
432                 var s = k.split('-');
433                 for (var i = 0; i<s.length; i++) {
434                     t += "<span class='visible-"+s[i]+"'>"+this.title[k]+"</span>";
435                 }
436             } else {
437                 t += "<span class='visible-"+k+"'>"+this.title[k]+"</span>";
438             }
439         }
440         return t;
441     },
442     
443     /**
444      * Set this panel's title
445      * @param {String} title
446      */
447     setTitle : function(title){
448         this.title = title;
449         if(this.region){
450             this.region.updatePanelTitle(this, title);
451         }
452     },
453     
454     /**
455      * Returns true is this panel was configured to be closable
456      * @return {Boolean} 
457      */
458     isClosable : function(){
459         return this.closable;
460     },
461     
462     beforeSlide : function(){
463         this.el.clip();
464         this.resizeEl.clip();
465     },
466     
467     afterSlide : function(){
468         this.el.unclip();
469         this.resizeEl.unclip();
470     },
471     
472     /**
473      *   Force a content refresh from the URL specified in the {@link #setUrl} method.
474      *   Will fail silently if the {@link #setUrl} method has not been called.
475      *   This does not activate the panel, just updates its content.
476      */
477     refresh : function(){
478         if(this.refreshDelegate){
479            this.loaded = false;
480            this.refreshDelegate();
481         }
482     },
483     
484     /**
485      * Destroys this panel
486      */
487     destroy : function(){
488         this.el.removeAllListeners();
489         var tempEl = document.createElement("span");
490         tempEl.appendChild(this.el.dom);
491         tempEl.innerHTML = "";
492         this.el.remove();
493         this.el = null;
494     },
495     
496     /**
497      * form - if the content panel contains a form - this is a reference to it.
498      * @type {Roo.form.Form}
499      */
500     form : false,
501     /**
502      * view - if the content panel contains a view (Roo.DatePicker / Roo.View / Roo.JsonView)
503      *    This contains a reference to it.
504      * @type {Roo.View}
505      */
506     view : false,
507     
508       /**
509      * Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.
510      * <pre><code>
511
512 layout.addxtype({
513        xtype : 'Form',
514        items: [ .... ]
515    }
516 );
517
518 </code></pre>
519      * @param {Object} cfg Xtype definition of item to add.
520      */
521     
522     
523     getChildContainer: function () {
524         return this.getEl();
525     }
526     
527     
528     /*
529         var  ret = new Roo.factory(cfg);
530         return ret;
531         
532         
533         // add form..
534         if (cfg.xtype.match(/^Form$/)) {
535             
536             var el;
537             //if (this.footer) {
538             //    el = this.footer.container.insertSibling(false, 'before');
539             //} else {
540                 el = this.el.createChild();
541             //}
542
543             this.form = new  Roo.form.Form(cfg);
544             
545             
546             if ( this.form.allItems.length) {
547                 this.form.render(el.dom);
548             }
549             return this.form;
550         }
551         // should only have one of theses..
552         if ([ 'View', 'JsonView', 'DatePicker'].indexOf(cfg.xtype) > -1) {
553             // views.. should not be just added - used named prop 'view''
554             
555             cfg.el = this.el.appendChild(document.createElement("div"));
556             // factory?
557             
558             var ret = new Roo.factory(cfg);
559              
560              ret.render && ret.render(false, ''); // render blank..
561             this.view = ret;
562             return ret;
563         }
564         return false;
565     }
566     \*/
567 });
568