Uncommited changes synced
[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.bootstrap.paenl.Content
13  * @extends Roo.util.Observable
14  * @children Roo.bootstrap.Component
15  * @parent builder Roo.bootstrap.layout.Border
16  * A basic ContentPanel element. - a panel that contain any content (eg. forms etc.)
17  * @cfg {Boolean}   fitToFrame    True for this panel to adjust its size to fit when the region resizes  (defaults to false)
18  * @cfg {Boolean}   fitContainer   When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container  (defaults to false)
19  * @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
20  * @cfg {Boolean}   closable      True if the panel can be closed/removed
21  * @cfg {Boolean}   background    True if the panel should not be activated when it is added (defaults to false)
22  * @cfg {String/HTMLElement/Element} resizeEl An element to resize if {@link #fitToFrame} is true (instead of this panel's element)
23  * @cfg {Toolbar}   toolbar       A toolbar for this panel
24  * @cfg {Boolean} autoScroll    True to scroll overflow in this panel (use with {@link #fitToFrame})
25  * @cfg {String} title          The title for this panel
26  * @cfg {Array} adjustments     Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])
27  * @cfg {String} url            Calls {@link #setUrl} with this value
28  * @cfg {String} region  [required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)
29  * @cfg {String/Object} params  When used with {@link #url}, calls {@link #setUrl} with this value
30  * @cfg {Boolean} loadOnce      When used with {@link #url}, calls {@link #setUrl} with this value
31  * @cfg {String}    content        Raw content to fill content panel with (uses setContent on construction.)
32  * @cfg {Boolean} iframe      contents are an iframe - makes showing remote sources/CSS feasible..
33  * @cfg {Boolean} badges render the badges
34  * @cfg {String} cls  extra classes to use  
35  * @cfg {String} background (primary|secondary|success|info|warning|danger|light|dark)
36  
37  * @constructor
38  * Create a new ContentPanel.
39  * @param {String/Object} config A string to set only the title or a config object
40  
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 (config.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 (config.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          * @event scroll
179          * Fires when this content is scrolled
180          * @param {Roo.ContentPanel} this
181          * @param {Event} scrollEvent
182          */
183         "scroll" : true
184         
185         
186         
187     });
188     
189
190     
191     
192     if(this.autoScroll && !this.iframe){
193         this.resizeEl.setStyle("overflow", "auto");
194         this.resizeEl.on('scroll', this.onScroll, this);
195     } else {
196         // fix randome scrolling
197         //this.el.on('scroll', function() {
198         //    Roo.log('fix random scolling');
199         //    this.scrollTo('top',0); 
200         //});
201     }
202     content = content || this.content;
203     if(content){
204         this.setContent(content);
205     }
206     if(config && config.url){
207         this.setUrl(this.url, this.params, this.loadOnce);
208     }
209     
210     
211     
212     Roo.bootstrap.panel.Content.superclass.constructor.call(this);
213     
214     if (this.view && typeof(this.view.xtype) != 'undefined') {
215         this.view.el = this.el.appendChild(document.createElement("div"));
216         this.view = Roo.factory(this.view); 
217         this.view.render  &&  this.view.render(false, '');  
218     }
219     
220     
221     this.fireEvent('render', this);
222 };
223
224 Roo.extend(Roo.bootstrap.panel.Content, Roo.bootstrap.Component, {
225     
226     cls : '',
227     background : '',
228     
229     tabTip : '',
230     
231     iframe : false,
232     iframeEl : false,
233     
234     /* Resize Element - use this to work out scroll etc. */
235     resizeEl : false,
236     
237     setRegion : function(region){
238         this.region = region;
239         this.setActiveClass(region && !this.background);
240     },
241     
242     
243     setActiveClass: function(state)
244     {
245         if(state){
246            this.el.replaceClass("roo-layout-inactive-content", "roo-layout-active-content");
247            this.el.setStyle('position','relative');
248         }else{
249            this.el.replaceClass("roo-layout-active-content", "roo-layout-inactive-content");
250            this.el.setStyle('position', 'absolute');
251         } 
252     },
253     
254     /**
255      * Returns the toolbar for this Panel if one was configured. 
256      * @return {Roo.Toolbar} 
257      */
258     getToolbar : function(){
259         return this.toolbar;
260     },
261     
262     setActiveState : function(active)
263     {
264         this.active = active;
265         this.setActiveClass(active);
266         if(!active){
267             if(this.fireEvent("deactivate", this) === false){
268                 return false;
269             }
270             return true;
271         }
272         this.fireEvent("activate", this);
273         return true;
274     },
275     /**
276      * Updates this panel's element (not for iframe)
277      * @param {String} content The new content
278      * @param {Boolean} loadScripts (optional) true to look for and process scripts
279     */
280     setContent : function(content, loadScripts){
281         if (this.iframe) {
282             return;
283         }
284         
285         this.el.update(content, loadScripts);
286     },
287
288     ignoreResize : function(w, h)
289     {
290         return false; // always resize?
291         if(this.lastSize && this.lastSize.width == w && this.lastSize.height == h){
292             return true;
293         }else{
294             this.lastSize = {width: w, height: h};
295             return false;
296         }
297     },
298     /**
299      * Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.
300      * @return {Roo.UpdateManager} The UpdateManager
301      */
302     getUpdateManager : function(){
303         if (this.iframe) {
304             return false;
305         }
306         return this.el.getUpdateManager();
307     },
308      /**
309      * Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.
310      * Does not work with IFRAME contents
311      * @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:
312 <pre><code>
313 panel.load({
314     url: "your-url.php",
315     params: {param1: "foo", param2: "bar"}, // or a URL encoded string
316     callback: yourFunction,
317     scope: yourObject, //(optional scope)
318     discardUrl: false,
319     nocache: false,
320     text: "Loading...",
321     timeout: 30,
322     scripts: false
323 });
324 </code></pre>
325      
326      * The only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>
327      * 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.
328      * @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}
329      * @param {Function} callback (optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)
330      * @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.
331      * @return {Roo.ContentPanel} this
332      */
333     load : function(){
334         
335         if (this.iframe) {
336             return this;
337         }
338         
339         var um = this.el.getUpdateManager();
340         um.update.apply(um, arguments);
341         return this;
342     },
343
344
345     /**
346      * 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.
347      * @param {String/Function} url The URL to load the content from or a function to call to get the URL
348      * @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)
349      * @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)
350      * @return {Roo.UpdateManager|Boolean} The UpdateManager or false if IFRAME
351      */
352     setUrl : function(url, params, loadOnce){
353         if (this.iframe) {
354             this.iframeEl.dom.src = url;
355             return false;
356         }
357         
358         if(this.refreshDelegate){
359             this.removeListener("activate", this.refreshDelegate);
360         }
361         this.refreshDelegate = this._handleRefresh.createDelegate(this, [url, params, loadOnce]);
362         this.on("activate", this.refreshDelegate);
363         return this.el.getUpdateManager();
364     },
365     
366     _handleRefresh : function(url, params, loadOnce){
367         if(!loadOnce || !this.loaded){
368             var updater = this.el.getUpdateManager();
369             updater.update(url, params, this._setLoaded.createDelegate(this));
370         }
371     },
372     
373     _setLoaded : function(){
374         this.loaded = true;
375     }, 
376     
377     /**
378      * Returns this panel's id
379      * @return {String} 
380      */
381     getId : function(){
382         return this.el.id;
383     },
384     
385     /** 
386      * Returns this panel's element - used by regiosn to add.
387      * @return {Roo.Element} 
388      */
389     getEl : function(){
390         return this.wrapEl || this.el;
391     },
392     
393    
394     
395     adjustForComponents : function(width, height)
396     {
397         //Roo.log('adjustForComponents ');
398         if(this.resizeEl != this.el){
399             width -= this.el.getFrameWidth('lr');
400             height -= this.el.getFrameWidth('tb');
401         }
402         if(this.toolbar){
403             var te = this.toolbar.getEl();
404             te.setWidth(width);
405             height -= te.getHeight();
406         }
407         if(this.footer){
408             var te = this.footer.getEl();
409             te.setWidth(width);
410             height -= te.getHeight();
411         }
412         
413         
414         if(this.adjustments){
415             width += this.adjustments[0];
416             height += this.adjustments[1];
417         }
418         return {"width": width, "height": height};
419     },
420     
421     setSize : function(width, height){
422         if(this.fitToFrame && !this.ignoreResize(width, height)){
423             if(this.fitContainer && this.resizeEl != this.el){
424                 this.el.setSize(width, height);
425             }
426             var size = this.adjustForComponents(width, height);
427             if (this.iframe) {
428                 this.iframeEl.setSize(width,height);
429             }
430             
431             this.resizeEl.setSize(this.autoWidth ? "auto" : size.width, this.autoHeight ? "auto" : size.height);
432             this.fireEvent('resize', this, size.width, size.height);
433             
434             
435         }
436     },
437     
438     /**
439      * Returns this panel's title
440      * @return {String} 
441      */
442     getTitle : function(){
443         
444         if (typeof(this.title) != 'object') {
445             return this.title;
446         }
447         
448         var t = '';
449         for (var k in this.title) {
450             if (!this.title.hasOwnProperty(k)) {
451                 continue;
452             }
453             
454             if (k.indexOf('-') >= 0) {
455                 var s = k.split('-');
456                 for (var i = 0; i<s.length; i++) {
457                     t += "<span class='visible-"+s[i]+"'>"+this.title[k]+"</span>";
458                 }
459             } else {
460                 t += "<span class='visible-"+k+"'>"+this.title[k]+"</span>";
461             }
462         }
463         return t;
464     },
465     
466     /**
467      * Set this panel's title
468      * @param {String} title
469      */
470     setTitle : function(title){
471         this.title = title;
472         if(this.region){
473             this.region.updatePanelTitle(this, title);
474         }
475     },
476     
477     /**
478      * Returns true is this panel was configured to be closable
479      * @return {Boolean} 
480      */
481     isClosable : function(){
482         return this.closable;
483     },
484     
485     beforeSlide : function(){
486         this.el.clip();
487         this.resizeEl.clip();
488     },
489     
490     afterSlide : function(){
491         this.el.unclip();
492         this.resizeEl.unclip();
493     },
494     
495     /**
496      *   Force a content refresh from the URL specified in the {@link #setUrl} method.
497      *   Will fail silently if the {@link #setUrl} method has not been called.
498      *   This does not activate the panel, just updates its content.
499      */
500     refresh : function(){
501         if(this.refreshDelegate){
502            this.loaded = false;
503            this.refreshDelegate();
504         }
505     },
506     
507     /**
508      * Destroys this panel
509      */
510     destroy : function(){
511         this.el.removeAllListeners();
512         var tempEl = document.createElement("span");
513         tempEl.appendChild(this.el.dom);
514         tempEl.innerHTML = "";
515         this.el.remove();
516         this.el = null;
517     },
518     
519     /**
520      * form - if the content panel contains a form - this is a reference to it.
521      * @type {Roo.form.Form}
522      */
523     form : false,
524     /**
525      * view - if the content panel contains a view (Roo.DatePicker / Roo.View / Roo.JsonView)
526      *    This contains a reference to it.
527      * @type {Roo.View}
528      */
529     view : false,
530     
531       /**
532      * Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.
533      * <pre><code>
534
535 layout.addxtype({
536        xtype : 'Form',
537        items: [ .... ]
538    }
539 );
540
541 </code></pre>
542      * @param {Object} cfg Xtype definition of item to add.
543      */
544     
545     
546     getChildContainer: function () {
547         return this.getEl();
548     },
549     
550     
551     onScroll : function(e)
552     {
553         this.fireEvent('scroll', this, e);
554     }
555     
556     
557     /*
558         var  ret = new Roo.factory(cfg);
559         return ret;
560         
561         
562         // add form..
563         if (cfg.xtype.match(/^Form$/)) {
564             
565             var el;
566             //if (this.footer) {
567             //    el = this.footer.container.insertSibling(false, 'before');
568             //} else {
569                 el = this.el.createChild();
570             //}
571
572             this.form = new  Roo.form.Form(cfg);
573             
574             
575             if ( this.form.allItems.length) {
576                 this.form.render(el.dom);
577             }
578             return this.form;
579         }
580         // should only have one of theses..
581         if ([ 'View', 'JsonView', 'DatePicker'].indexOf(cfg.xtype) > -1) {
582             // views.. should not be just added - used named prop 'view''
583             
584             cfg.el = this.el.appendChild(document.createElement("div"));
585             // factory?
586             
587             var ret = new Roo.factory(cfg);
588              
589              ret.render && ret.render(false, ''); // render blank..
590             this.view = ret;
591             return ret;
592         }
593         return false;
594     }
595     \*/
596 });
597