Roo/ContentPanel.js
[roojs1] / Roo / ContentPanel.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
31  * @constructor
32  * Create a new ContentPanel.
33  * @param {String/HTMLElement/Roo.Element} el The container element for this panel
34  * @param {String/Object} config A string to set only the title or a config object
35  * @param {String} content (optional) Set the HTML content for this panel
36  * @param {String} region (optional) Used by xtype constructors to add to regions. (values center,east,west,south,north)
37  */
38 Roo.ContentPanel = function(el, config, content){
39     
40      
41     /*
42     if(el.autoCreate || el.xtype){ // xtype is available if this is called from factory
43         config = el;
44         el = Roo.id();
45     }
46     if (config && config.parentLayout) { 
47         el = config.parentLayout.el.createChild(); 
48     }
49     */
50     if(el.autoCreate){ // xtype is available if this is called from factory
51         config = el;
52         el = Roo.id();
53     }
54     this.el = Roo.get(el);
55     if(!this.el && config && config.autoCreate){
56         if(typeof config.autoCreate == "object"){
57             if(!config.autoCreate.id){
58                 config.autoCreate.id = config.id||el;
59             }
60             this.el = Roo.DomHelper.append(document.body,
61                         config.autoCreate, true);
62         }else{
63             this.el = Roo.DomHelper.append(document.body,
64                         {tag: "div", cls: "x-layout-inactive-content", id: config.id||el}, true);
65         }
66     }
67     this.closable = false;
68     this.loaded = false;
69     this.active = false;
70     if(typeof config == "string"){
71         this.title = config;
72     }else{
73         Roo.apply(this, config);
74     }
75     
76     if (this.toolbar && !this.toolbar.el && this.toolbar.xtype) {
77         this.wrapEl = this.el.wrap();
78         this.toolbar.container = this.el.insertSibling(false, 'before');
79         this.toolbar = new Roo.Toolbar(this.toolbar);
80     }
81     
82     // xtype created footer. - not sure if will work as we normally have to render first..
83     if (this.footer && !this.footer.el && this.footer.xtype) {
84         if (!this.wrapEl) {
85             this.wrapEl = this.el.wrap();
86         }
87     
88         this.footer.container = this.wrapEl.createChild();
89          
90         this.footer = Roo.factory(this.footer, Roo);
91         
92     }
93     
94     if(this.resizeEl){
95         this.resizeEl = Roo.get(this.resizeEl, true);
96     }else{
97         this.resizeEl = this.el;
98     }
99     this.addEvents({
100         /**
101          * @event activate
102          * Fires when this panel is activated. 
103          * @param {Roo.ContentPanel} this
104          */
105         "activate" : true,
106         /**
107          * @event deactivate
108          * Fires when this panel is activated. 
109          * @param {Roo.ContentPanel} this
110          */
111         "deactivate" : true,
112
113         /**
114          * @event resize
115          * Fires when this panel is resized if fitToFrame is true.
116          * @param {Roo.ContentPanel} this
117          * @param {Number} width The width after any component adjustments
118          * @param {Number} height The height after any component adjustments
119          */
120         "resize" : true,
121         
122          /**
123          * @event render
124          * Fires when this tab is created
125          * @param {Roo.ContentPanel} this
126          */
127         "render" : true
128         
129         
130         
131     });
132     if(this.autoScroll){
133         this.resizeEl.setStyle("overflow", "auto");
134     } else {
135         // fix randome scrolling
136         this.el.on('scroll', function() {
137             Roo.log('fix random scolling');
138             this.scrollTo('top',0); 
139         });
140     }
141     content = content || this.content;
142     if(content){
143         this.setContent(content);
144     }
145     if(config && config.url){
146         this.setUrl(this.url, this.params, this.loadOnce);
147     }
148     
149     
150     
151     Roo.ContentPanel.superclass.constructor.call(this);
152     
153     this.fireEvent('render', this);
154 };
155
156 Roo.extend(Roo.ContentPanel, Roo.util.Observable, {
157     tabTip:'',
158     setRegion : function(region){
159         this.region = region;
160         if(region){
161            this.el.replaceClass("x-layout-inactive-content", "x-layout-active-content");
162         }else{
163            this.el.replaceClass("x-layout-active-content", "x-layout-inactive-content");
164         } 
165     },
166     
167     /**
168      * Returns the toolbar for this Panel if one was configured. 
169      * @return {Roo.Toolbar} 
170      */
171     getToolbar : function(){
172         return this.toolbar;
173     },
174     
175     setActiveState : function(active){
176         this.active = active;
177         if(!active){
178             this.fireEvent("deactivate", this);
179         }else{
180             this.fireEvent("activate", this);
181         }
182     },
183     /**
184      * Updates this panel's element
185      * @param {String} content The new content
186      * @param {Boolean} loadScripts (optional) true to look for and process scripts
187     */
188     setContent : function(content, loadScripts){
189         this.el.update(content, loadScripts);
190     },
191
192     ignoreResize : function(w, h){
193         if(this.lastSize && this.lastSize.width == w && this.lastSize.height == h){
194             return true;
195         }else{
196             this.lastSize = {width: w, height: h};
197             return false;
198         }
199     },
200     /**
201      * Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.
202      * @return {Roo.UpdateManager} The UpdateManager
203      */
204     getUpdateManager : function(){
205         return this.el.getUpdateManager();
206     },
207      /**
208      * Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.
209      * @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:
210 <pre><code>
211 panel.load({
212     url: "your-url.php",
213     params: {param1: "foo", param2: "bar"}, // or a URL encoded string
214     callback: yourFunction,
215     scope: yourObject, //(optional scope)
216     discardUrl: false,
217     nocache: false,
218     text: "Loading...",
219     timeout: 30,
220     scripts: false
221 });
222 </code></pre>
223      * The only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>
224      * 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.
225      * @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}
226      * @param {Function} callback (optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)
227      * @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.
228      * @return {Roo.ContentPanel} this
229      */
230     load : function(){
231         var um = this.el.getUpdateManager();
232         um.update.apply(um, arguments);
233         return this;
234     },
235
236
237     /**
238      * 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.
239      * @param {String/Function} url The URL to load the content from or a function to call to get the URL
240      * @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)
241      * @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)
242      * @return {Roo.UpdateManager} The UpdateManager
243      */
244     setUrl : function(url, params, loadOnce){
245         if(this.refreshDelegate){
246             this.removeListener("activate", this.refreshDelegate);
247         }
248         this.refreshDelegate = this._handleRefresh.createDelegate(this, [url, params, loadOnce]);
249         this.on("activate", this.refreshDelegate);
250         return this.el.getUpdateManager();
251     },
252     
253     _handleRefresh : function(url, params, loadOnce){
254         if(!loadOnce || !this.loaded){
255             var updater = this.el.getUpdateManager();
256             updater.update(url, params, this._setLoaded.createDelegate(this));
257         }
258     },
259     
260     _setLoaded : function(){
261         this.loaded = true;
262     }, 
263     
264     /**
265      * Returns this panel's id
266      * @return {String} 
267      */
268     getId : function(){
269         return this.el.id;
270     },
271     
272     /** 
273      * Returns this panel's element - used by regiosn to add.
274      * @return {Roo.Element} 
275      */
276     getEl : function(){
277         return this.wrapEl || this.el;
278     },
279     
280     adjustForComponents : function(width, height){
281         if(this.resizeEl != this.el){
282             width -= this.el.getFrameWidth('lr');
283             height -= this.el.getFrameWidth('tb');
284         }
285         if(this.toolbar){
286             var te = this.toolbar.getEl();
287             height -= te.getHeight();
288             te.setWidth(width);
289         }
290         if(this.footer){
291             var te = this.footer.getEl();
292             Roo.log("footer:" + te.getHeight());
293             
294             height -= te.getHeight();
295             te.setWidth(width);
296         }
297         
298         
299         if(this.adjustments){
300             width += this.adjustments[0];
301             height += this.adjustments[1];
302         }
303         return {"width": width, "height": height};
304     },
305     
306     setSize : function(width, height){
307         if(this.fitToFrame && !this.ignoreResize(width, height)){
308             if(this.fitContainer && this.resizeEl != this.el){
309                 this.el.setSize(width, height);
310             }
311             var size = this.adjustForComponents(width, height);
312             this.resizeEl.setSize(this.autoWidth ? "auto" : size.width, this.autoHeight ? "auto" : size.height);
313             this.fireEvent('resize', this, size.width, size.height);
314         }
315     },
316     
317     /**
318      * Returns this panel's title
319      * @return {String} 
320      */
321     getTitle : function(){
322         return this.title;
323     },
324     
325     /**
326      * Set this panel's title
327      * @param {String} title
328      */
329     setTitle : function(title){
330         this.title = title;
331         if(this.region){
332             this.region.updatePanelTitle(this, title);
333         }
334     },
335     
336     /**
337      * Returns true is this panel was configured to be closable
338      * @return {Boolean} 
339      */
340     isClosable : function(){
341         return this.closable;
342     },
343     
344     beforeSlide : function(){
345         this.el.clip();
346         this.resizeEl.clip();
347     },
348     
349     afterSlide : function(){
350         this.el.unclip();
351         this.resizeEl.unclip();
352     },
353     
354     /**
355      *   Force a content refresh from the URL specified in the {@link #setUrl} method.
356      *   Will fail silently if the {@link #setUrl} method has not been called.
357      *   This does not activate the panel, just updates its content.
358      */
359     refresh : function(){
360         if(this.refreshDelegate){
361            this.loaded = false;
362            this.refreshDelegate();
363         }
364     },
365     
366     /**
367      * Destroys this panel
368      */
369     destroy : function(){
370         this.el.removeAllListeners();
371         var tempEl = document.createElement("span");
372         tempEl.appendChild(this.el.dom);
373         tempEl.innerHTML = "";
374         this.el.remove();
375         this.el = null;
376     },
377     
378     /**
379      * form - if the content panel contains a form - this is a reference to it.
380      * @type {Roo.form.Form}
381      */
382     form : false,
383     /**
384      * view - if the content panel contains a view (Roo.DatePicker / Roo.View / Roo.JsonView)
385      *    This contains a reference to it.
386      * @type {Roo.View}
387      */
388     view : false,
389     
390       /**
391      * Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.
392      * <pre><code>
393
394 layout.addxtype({
395        xtype : 'Form',
396        items: [ .... ]
397    }
398 );
399
400 </code></pre>
401      * @param {Object} cfg Xtype definition of item to add.
402      */
403     
404     addxtype : function(cfg) {
405         // add form..
406         if (cfg.xtype.match(/^Form$/)) {
407             
408             var el;
409             //if (this.footer) {
410             //    el = this.footer.container.insertSibling(false, 'before');
411             //} else {
412                 el = this.el.createChild();
413             //}
414
415             this.form = new  Roo.form.Form(cfg);
416             
417             
418             if ( this.form.allItems.length) this.form.render(el.dom);
419             return this.form;
420         }
421         // should only have one of theses..
422         if (['View', 'JsonView', 'DatePicker'].indexOf(cfg.xtype) > -1) {
423             // views..
424             cfg.el = this.el.appendChild(document.createElement("div"));
425             // factory?
426             
427             var ret = new Roo.factory(cfg);
428             ret.render && ret.render(false, ''); // render blank..
429             this.view = ret;
430             return ret;
431         }
432         return false;
433     }
434 });
435
436 /**
437  * @class Roo.GridPanel
438  * @extends Roo.ContentPanel
439  * @constructor
440  * Create a new GridPanel.
441  * @param {Roo.grid.Grid} grid The grid for this panel
442  * @param {String/Object} config A string to set only the panel's title, or a config object
443  */
444 Roo.GridPanel = function(grid, config){
445     
446   
447     this.wrapper = Roo.DomHelper.append(document.body, // wrapper for IE7 strict & safari scroll issue
448         {tag: "div", cls: "x-layout-grid-wrapper x-layout-inactive-content"}, true);
449         
450     this.wrapper.dom.appendChild(grid.getGridEl().dom);
451     
452     Roo.GridPanel.superclass.constructor.call(this, this.wrapper, config);
453     
454     if(this.toolbar){
455         this.toolbar.el.insertBefore(this.wrapper.dom.firstChild);
456     }
457     // xtype created footer. - not sure if will work as we normally have to render first..
458     if (this.footer && !this.footer.el && this.footer.xtype) {
459         
460         this.footer.container = this.grid.getView().getFooterPanel(true);
461         this.footer.dataSource = this.grid.dataSource;
462         this.footer = Roo.factory(this.footer, Roo);
463         
464     }
465     
466     grid.monitorWindowResize = false; // turn off autosizing
467     grid.autoHeight = false;
468     grid.autoWidth = false;
469     this.grid = grid;
470     this.grid.getGridEl().replaceClass("x-layout-inactive-content", "x-layout-component-panel");
471 };
472
473 Roo.extend(Roo.GridPanel, Roo.ContentPanel, {
474     getId : function(){
475         return this.grid.id;
476     },
477     
478     /**
479      * Returns the grid for this panel
480      * @return {Roo.grid.Grid} 
481      */
482     getGrid : function(){
483         return this.grid;    
484     },
485     
486     setSize : function(width, height){
487         if(!this.ignoreResize(width, height)){
488             var grid = this.grid;
489             var size = this.adjustForComponents(width, height);
490             grid.getGridEl().setSize(size.width, size.height);
491             grid.autoSize();
492         }
493     },
494     
495     beforeSlide : function(){
496         this.grid.getView().scroller.clip();
497     },
498     
499     afterSlide : function(){
500         this.grid.getView().scroller.unclip();
501     },
502     
503     destroy : function(){
504         this.grid.destroy();
505         delete this.grid;
506         Roo.GridPanel.superclass.destroy.call(this); 
507     }
508 });
509
510
511 /**
512  * @class Roo.NestedLayoutPanel
513  * @extends Roo.ContentPanel
514  * @constructor
515  * Create a new NestedLayoutPanel.
516  * 
517  * 
518  * @param {Roo.BorderLayout} layout The layout for this panel
519  * @param {String/Object} config A string to set only the title or a config object
520  */
521 Roo.NestedLayoutPanel = function(layout, config)
522 {
523     // construct with only one argument..
524     /* FIXME - implement nicer consturctors
525     if (layout.layout) {
526         config = layout;
527         layout = config.layout;
528         delete config.layout;
529     }
530     if (layout.xtype && !layout.getEl) {
531         // then layout needs constructing..
532         layout = Roo.factory(layout, Roo);
533     }
534     */
535     
536     
537     Roo.NestedLayoutPanel.superclass.constructor.call(this, layout.getEl(), config);
538     
539     layout.monitorWindowResize = false; // turn off autosizing
540     this.layout = layout;
541     this.layout.getEl().addClass("x-layout-nested-layout");
542     
543     
544     
545     
546 };
547
548 Roo.extend(Roo.NestedLayoutPanel, Roo.ContentPanel, {
549
550     setSize : function(width, height){
551         if(!this.ignoreResize(width, height)){
552             var size = this.adjustForComponents(width, height);
553             var el = this.layout.getEl();
554             el.setSize(size.width, size.height);
555             var touch = el.dom.offsetWidth;
556             this.layout.layout();
557             // ie requires a double layout on the first pass
558             if(Roo.isIE && !this.initialized){
559                 this.initialized = true;
560                 this.layout.layout();
561             }
562         }
563     },
564     
565     // activate all subpanels if not currently active..
566     
567     setActiveState : function(active){
568         this.active = active;
569         if(!active){
570             this.fireEvent("deactivate", this);
571             return;
572         }
573         
574         this.fireEvent("activate", this);
575         // not sure if this should happen before or after..
576         if (!this.layout) {
577             return; // should not happen..
578         }
579         var reg = false;
580         for (var r in this.layout.regions) {
581             reg = this.layout.getRegion(r);
582             if (reg.getActivePanel()) {
583                 //reg.showPanel(reg.getActivePanel()); // force it to activate.. 
584                 reg.setActivePanel(reg.getActivePanel());
585                 continue;
586             }
587             if (!reg.panels.length) {
588                 continue;
589             }
590             reg.showPanel(reg.getPanel(0));
591         }
592         
593         
594         
595         
596     },
597     
598     /**
599      * Returns the nested BorderLayout for this panel
600      * @return {Roo.BorderLayout} 
601      */
602     getLayout : function(){
603         return this.layout;
604     },
605     
606      /**
607      * Adds a xtype elements to the layout of the nested panel
608      * <pre><code>
609
610 panel.addxtype({
611        xtype : 'ContentPanel',
612        region: 'west',
613        items: [ .... ]
614    }
615 );
616
617 panel.addxtype({
618         xtype : 'NestedLayoutPanel',
619         region: 'west',
620         layout: {
621            center: { },
622            west: { }   
623         },
624         items : [ ... list of content panels or nested layout panels.. ]
625    }
626 );
627 </code></pre>
628      * @param {Object} cfg Xtype definition of item to add.
629      */
630     addxtype : function(cfg) {
631         return this.layout.addxtype(cfg);
632     
633     }
634 });
635
636 Roo.ScrollPanel = function(el, config, content){
637     config = config || {};
638     config.fitToFrame = true;
639     Roo.ScrollPanel.superclass.constructor.call(this, el, config, content);
640     
641     this.el.dom.style.overflow = "hidden";
642     var wrap = this.el.wrap({cls: "x-scroller x-layout-inactive-content"});
643     this.el.removeClass("x-layout-inactive-content");
644     this.el.on("mousewheel", this.onWheel, this);
645
646     var up = wrap.createChild({cls: "x-scroller-up", html: "&#160;"}, this.el.dom);
647     var down = wrap.createChild({cls: "x-scroller-down", html: "&#160;"});
648     up.unselectable(); down.unselectable();
649     up.on("click", this.scrollUp, this);
650     down.on("click", this.scrollDown, this);
651     up.addClassOnOver("x-scroller-btn-over");
652     down.addClassOnOver("x-scroller-btn-over");
653     up.addClassOnClick("x-scroller-btn-click");
654     down.addClassOnClick("x-scroller-btn-click");
655     this.adjustments = [0, -(up.getHeight() + down.getHeight())];
656
657     this.resizeEl = this.el;
658     this.el = wrap; this.up = up; this.down = down;
659 };
660
661 Roo.extend(Roo.ScrollPanel, Roo.ContentPanel, {
662     increment : 100,
663     wheelIncrement : 5,
664     scrollUp : function(){
665         this.resizeEl.scroll("up", this.increment, {callback: this.afterScroll, scope: this});
666     },
667
668     scrollDown : function(){
669         this.resizeEl.scroll("down", this.increment, {callback: this.afterScroll, scope: this});
670     },
671
672     afterScroll : function(){
673         var el = this.resizeEl;
674         var t = el.dom.scrollTop, h = el.dom.scrollHeight, ch = el.dom.clientHeight;
675         this.up[t == 0 ? "addClass" : "removeClass"]("x-scroller-btn-disabled");
676         this.down[h - t <= ch ? "addClass" : "removeClass"]("x-scroller-btn-disabled");
677     },
678
679     setSize : function(){
680         Roo.ScrollPanel.superclass.setSize.apply(this, arguments);
681         this.afterScroll();
682     },
683
684     onWheel : function(e){
685         var d = e.getWheelDelta();
686         this.resizeEl.dom.scrollTop -= (d*this.wheelIncrement);
687         this.afterScroll();
688         e.stopEvent();
689     },
690
691     setContent : function(content, loadScripts){
692         this.resizeEl.update(content, loadScripts);
693     }
694
695 });
696
697
698
699
700
701
702
703
704
705 /**
706  * @class Roo.TreePanel
707  * @extends Roo.ContentPanel
708  * @constructor
709  * Create a new TreePanel. - defaults to fit/scoll contents.
710  * @param {String/Object} config A string to set only the panel's title, or a config object
711  * @cfg {Roo.tree.TreePanel} tree The tree TreePanel, with config etc.
712  */
713 Roo.TreePanel = function(config){
714     var el = config.el;
715     var tree = config.tree;
716     delete config.tree; 
717     delete config.el; // hopefull!
718     
719     // wrapper for IE7 strict & safari scroll issue
720     
721     var treeEl = el.createChild();
722     config.resizeEl = treeEl;
723     
724     
725     
726     Roo.TreePanel.superclass.constructor.call(this, el, config);
727  
728  
729     this.tree = new Roo.tree.TreePanel(treeEl , tree);
730     //console.log(tree);
731     this.on('activate', function()
732     {
733         if (this.tree.rendered) {
734             return;
735         }
736         //console.log('render tree');
737         this.tree.render();
738     });
739     // this should not be needed.. - it's actually the 'el' that resizes?
740     // actuall it breaks the containerScroll - dragging nodes auto scroll at top
741     
742     //this.on('resize',  function (cp, w, h) {
743     //        this.tree.innerCt.setWidth(w);
744     //        this.tree.innerCt.setHeight(h);
745     //        //this.tree.innerCt.setStyle('overflow-y', 'auto');
746     //});
747
748         
749     
750 };
751
752 Roo.extend(Roo.TreePanel, Roo.ContentPanel, {   
753     fitToFrame : true,
754     autoScroll : true
755 });
756
757
758
759
760
761
762
763
764
765
766