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