3 * Copyright(c) 2006-2009 Ext JS, LLC
5 * http://www.extjs.com/license
9 * @extends Ext.Container
10 * <p>Panel is a container that has specific functionality and structural components that make
11 * it the perfect building block for application-oriented user interfaces.</p>
12 * <p>Panels are, by virtue of their inheritance from {@link Ext.Container}, capable
13 * of being configured with a {@link Ext.Container#layout layout}, and containing child Components.</p>
14 * <p>When either specifying child {@link Ext.Component#items items} of a Panel, or dynamically {@link Ext.Container#add adding} Components
15 * to a Panel, remember to consider how you wish the Panel to arrange those child elements, and whether
16 * those child elements need to be sized using one of Ext's built-in <code><b>{@link Ext.Container#layout layout}</b></code> schemes. By
17 * default, Panels use the {@link Ext.layout.ContainerLayout ContainerLayout} scheme. This simply renders
18 * child components, appending them one after the other inside the Container, and <b>does not apply any sizing</b>
20 * <p>A Panel may also contain {@link #bbar bottom} and {@link #tbar top} toolbars, along with separate
21 * {@link #header}, {@link #footer} and {@link #body} sections (see {@link #frame} for additional
23 * <p>Panel also provides built-in {@link #collapsible expandable and collapsible behavior}, along with
24 * a variety of {@link #tools prebuilt tool buttons} that can be wired up to provide other customized
25 * behavior. Panels can be easily dropped into any {@link Ext.Container Container} or layout, and the
26 * layout and rendering pipeline is {@link Ext.Container#add completely managed by the framework}.</p>
28 * @param {Object} config The config object
31 Ext.Panel = Ext.extend(Ext.Container, {
33 * The Panel's header {@link Ext.Element Element}. Read-only.
34 * <p>This Element is used to house the {@link #title} and {@link #tools}</p>
35 * <br><p><b>Note</b>: see the Note for <code>{@link Ext.Component#el el}</code> also.</p>
40 * The Panel's body {@link Ext.Element Element} which may be used to contain HTML content.
41 * The content may be specified in the {@link #html} config, or it may be loaded using the
42 * {@link autoLoad} config, or through the Panel's {@link #getUpdater Updater}. Read-only.
43 * <p>If this is used to load visible HTML elements in either way, then
44 * the Panel may not be used as a Layout for hosting nested Panels.</p>
45 * <p>If this Panel is intended to be used as the host of a Layout (See {@link #layout}
46 * then the body Element must not be loaded or changed - it is under the control
47 * of the Panel's Layout.
48 * <br><p><b>Note</b>: see the Note for <code>{@link Ext.Component#el el}</code> also.</p>
53 * The Panel's bwrap {@link Ext.Element Element} used to contain other Panel elements
54 * (tbar, body, bbar, footer). See {@link #bodyCfg}. Read-only.
59 * True if this panel is collapsed. Read-only.
64 * @cfg {Object} bodyCfg
65 * <p>A {@link Ext.DomHelper DomHelper} element specification object may be specified for any
67 * <p>By default, the Default element in the table below will be used for the html markup to
68 * create a child element with the commensurate Default class name (<code>baseCls</code> will be
69 * replaced by <code>{@link #baseCls}</code>):</p>
71 * Panel Default Default Custom Additional Additional
72 * Element element class element class style
73 * ======== ========================== ========= ============== ===========
74 * {@link #header} div {@link #baseCls}+'-header' {@link #headerCfg} headerCssClass headerStyle
75 * {@link #bwrap} div {@link #baseCls}+'-bwrap' {@link #bwrapCfg} bwrapCssClass bwrapStyle
76 * + tbar div {@link #baseCls}+'-tbar' {@link #tbarCfg} tbarCssClass tbarStyle
77 * + {@link #body} div {@link #baseCls}+'-body' {@link #bodyCfg} {@link #bodyCssClass} {@link #bodyStyle}
78 * + bbar div {@link #baseCls}+'-bbar' {@link #bbarCfg} bbarCssClass bbarStyle
79 * + {@link #footer} div {@link #baseCls}+'-footer' {@link #footerCfg} footerCssClass footerStyle
81 * <p>Configuring a Custom element may be used, for example, to force the {@link #body} Element
82 * to use a different form of markup than is created by default. An example of this might be
83 * to {@link Ext.Element#createChild create a child} Panel containing a custom content, such as
84 * a header, or forcing centering of all Panel content by having the body be a <center>
88 title: 'Message Title',
89 renderTo: Ext.getBody(),
90 width: 200, height: 130,
93 cls: 'x-panel-body', // Default class not applied if Custom element specified
98 cls: 'x-panel-footer' // same as the Default class
101 footerCssClass: 'custom-footer', // additional css class, see {@link Ext.element#addClass addClass}
102 footerStyle: 'background-color:red' // see {@link #bodyStyle}
105 * <p>The example above also explicitly creates a <code>{@link #footer}</code> with custom markup and
106 * styling applied.</p>
109 * @cfg {Object} headerCfg
110 * <p>A {@link Ext.DomHelper DomHelper} element specification object specifying the element structure
111 * of this Panel's {@link #header} Element. See <code>{@link #bodyCfg}</code> also.</p>
114 * @cfg {Object} bwrapCfg
115 * <p>A {@link Ext.DomHelper DomHelper} element specification object specifying the element structure
116 * of this Panel's {@link #bwrap} Element. See <code>{@link #bodyCfg}</code> also.</p>
119 * @cfg {Object} tbarCfg
120 * <p>A {@link Ext.DomHelper DomHelper} element specification object specifying the element structure
121 * of this Panel's {@link #tbar} Element. See <code>{@link #bodyCfg}</code> also.</p>
124 * @cfg {Object} bbarCfg
125 * <p>A {@link Ext.DomHelper DomHelper} element specification object specifying the element structure
126 * of this Panel's {@link #bbar} Element. See <code>{@link #bodyCfg}</code> also.</p>
129 * @cfg {Object} footerCfg
130 * <p>A {@link Ext.DomHelper DomHelper} element specification object specifying the element structure
131 * of this Panel's {@link #footer} Element. See <code>{@link #bodyCfg}</code> also.</p>
134 * @cfg {Boolean} closable
135 * Panels themselves do not directly support being closed, but some Panel subclasses do (like
136 * {@link Ext.Window}) or a Panel Class within an {@link Ext.TabPanel}. Specify <code>true</code>
137 * to enable closing in such situations. Defaults to <code>false</code>.
140 * The Panel's footer {@link Ext.Element Element}. Read-only.
141 * <p>This Element is used to house the Panel's <code>{@link #buttons}</code> or <code>{@link #fbar}</code>.</p>
142 * <br><p><b>Note</b>: see the Note for <code>{@link Ext.Component#el el}</code> also.</p>
147 * @cfg {Mixed} applyTo
148 * <p>The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in
149 * the document that specifies some panel-specific structural markup. When <code>applyTo</code> is used,
150 * constituent parts of the panel can be specified by CSS class name within the main element, and the panel
151 * will automatically create those components from that markup. Any required components not specified in the
152 * markup will be autogenerated if necessary.</p>
153 * <p>The following class names are supported (baseCls will be replaced by {@link #baseCls}):</p>
154 * <ul><li>baseCls + '-header'</li>
155 * <li>baseCls + '-header-text'</li>
156 * <li>baseCls + '-bwrap'</li>
157 * <li>baseCls + '-tbar'</li>
158 * <li>baseCls + '-body'</li>
159 * <li>baseCls + '-bbar'</li>
160 * <li>baseCls + '-footer'</li></ul>
161 * <p>Using this config, a call to render() is not required. If applyTo is specified, any value passed for
162 * {@link #renderTo} will be ignored and the target element's parent node will automatically be used as the
163 * panel's container.</p>
166 * @cfg {Object/Array} tbar
167 * <p>The top toolbar of the panel. This can be a {@link Ext.Toolbar} object, a toolbar config, or an array of
168 * buttons/button configs to be added to the toolbar. Note that this is not available as a property after render.
169 * To access the top toolbar after render, use {@link #getTopToolbar}.</p>
170 * <p><b>Note:</b> Although a Toolbar may contain Field components, these will <b>not</b> be updated by a load
171 * of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and
172 * so are not scanned to collect form items. However, the values <b>will</b> be submitted because form
173 * submission parameters are collected from the DOM tree.</p>
176 * @cfg {Object/Array} bbar
177 * <p>The bottom toolbar of the panel. This can be a {@link Ext.Toolbar} object, a toolbar config, or an array of
178 * buttons/button configs to be added to the toolbar. Note that this is not available as a property after render.
179 * To access the bottom toolbar after render, use {@link #getBottomToolbar}.</p>
180 * <p><b>Note:</b> Although a Toolbar may contain Field components, these will <b>not</b> be updated by a load
181 * of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and
182 * so are not scanned to collect form items. However, the values <b>will</b> be submitted because form
183 * submission parameters are collected from the DOM tree.</p>
185 /** @cfg {Object/Array} fbar
186 * <p>A {@link Ext.Toolbar Toolbar} object, a Toolbar config, or an array of
187 * {@link Ext.Button Button}s/{@link Ext.Button Button} configs, describing a {@link Ext.Toolbar Toolbar} to be rendered into this Panel's footer element.</p>
188 * <p>After render, the <code>fbar</code> property will be an {@link Ext.Toolbar Toolbar} instance.</p>
189 * <p>If <code>{@link #buttons}</code> are specified, they will supersede the <code>fbar</code> configuration property.</p>
190 * The Panel's <code>{@link #buttonAlign}</code> configuration affects the layout of these items, for example:
192 var w = new Ext.Window({
195 bbar: new Ext.Toolbar({
202 {@link #buttonAlign}: 'left', // anything but 'center' or 'right' and you can use '-', and '->'
203 // to control the alignment of fbar items
211 * <p><b>Note:</b> Although a Toolbar may contain Field components, these will <b>not</b> be updated by a load
212 * of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and
213 * so are not scanned to collect form items. However, the values <b>will</b> be submitted because form
214 * submission parameters are collected from the DOM tree.</p>
217 * @cfg {Boolean} header
218 * <code>true</code> to create the Panel's header element explicitly, <code>false</code> to skip creating
219 * it. If a <code>{@link #title}</code> is set the header will be created automatically, otherwise it will not.
220 * If a <code>{@link #title}</code> is set but <code>header</code> is explicitly set to <code>false</code>, the header
221 * will not be rendered.
224 * @cfg {Boolean} footer
225 * <code>true</code> to create the footer element explicitly, false to skip creating it. The footer
226 * will be created automatically if <code>{@link #buttons}</code> or a <code>{@link #fbar}</code> have
227 * been configured. See <code>{@link #bodyCfg}</code> for an example.
230 * @cfg {String} title
231 * The title text to be used as innerHTML (html tags are accepted) to display in the panel
232 * <code>{@link #header}</code> (defaults to ''). When a <code>title</code> is specified the
233 * <code>{@link #header}</code> element will automatically be created and displayed unless
234 * {@link #header} is explicitly set to <code>false</code>. If you do not want to specify a
235 * <code>title</code> at config time, but you may want one later, you must either specify a non-empty
236 * <code>title</code> (a blank space ' ' will do) or <code>header:true</code> so that the container
237 * element will get created.
240 * @cfg {Array} buttons
241 * <code>buttons</code> will be used as <code>{@link Ext.Container#items items}</code> for the toolbar in
242 * the footer (<code>{@link #fbar}</code>). Typically the value of this configuration property will be
243 * an array of {@link Ext.Button}s or {@link Ext.Button} configuration objects.
244 * If an item is configured with <code>minWidth</code> or the Panel is configured with <code>minButtonWidth</code>,
245 * that width will be applied to the item.
248 * @cfg {Object/String/Function} autoLoad
249 * A valid url spec according to the Updater {@link Ext.Updater#update} method.
250 * If autoLoad is not null, the panel will attempt to load its contents
251 * immediately upon render.<p>
252 * The URL will become the default URL for this panel's {@link #body} element,
253 * so it may be {@link Ext.Element#refresh refresh}ed at any time.</p>
256 * @cfg {Boolean} frame
257 * <code>false</code> by default to render with plain 1px square borders. <code>true</code> to render with
258 * 9 elements, complete with custom rounded corners (also see {@link Ext.Element#boxWrap}).
259 * <p>The template generated for each condition is depicted below:</p><pre><code>
262 <div id="developer-specified-id-goes-here" class="x-panel">
264 <div class="x-panel-header"><span class="x-panel-header-text">Title: (frame:false)</span></div>
266 <div class="x-panel-bwrap">
267 <div class="x-panel-body"><p>html value goes here</p></div>
271 // frame = true (create 9 elements)
272 <div id="developer-specified-id-goes-here" class="x-panel">
273 <div class="x-panel-tl"><div class="x-panel-tr"><div class="x-panel-tc">
274 <div class="x-panel-header"><span class="x-panel-header-text">Title: (frame:true)</span></div>
275 </div></div></div>
277 <div class="x-panel-bwrap">
278 <div class="x-panel-ml"><div class="x-panel-mr"><div class="x-panel-mc">
279 <div class="x-panel-body"><p>html value goes here</p></div>
280 </div></div></div>
282 <div class="x-panel-bl"><div class="x-panel-br"><div class="x-panel-bc"/>
283 </div></div></div>
288 * @cfg {Boolean} border
289 * True to display the borders of the panel's body element, false to hide them (defaults to true). By default,
290 * the border is a 2px wide inset border, but this can be further altered by setting {@link #bodyBorder} to false.
293 * @cfg {Boolean} bodyBorder
294 * True to display an interior border on the body element of the panel, false to hide it (defaults to true).
295 * This only applies when {@link #border} == true. If border == true and bodyBorder == false, the border will display
296 * as a 1px wide inset border, giving the entire body element an inset appearance.
299 * @cfg {String/Object/Function} bodyCssClass
300 * Additional css class selector to be applied to the {@link #body} element in the format expected by
301 * {@link Ext.Element#addClass} (defaults to null). See {@link #bodyCfg}.
304 * @cfg {String/Object/Function} bodyStyle
305 * Custom CSS styles to be applied to the {@link #body} element in the format expected by
306 * {@link Ext.Element#applyStyles} (defaults to null). See {@link #bodyCfg}.
309 * @cfg {String} iconCls
310 * The CSS class selector that specifies a background image to be used as the header icon (defaults to '').
311 * <p>An example of specifying a custom icon class would be something like:
313 // specify the property in the config for the class:
317 // css class that specifies background image to be used as the icon image:
318 .my-icon { background-image: url(../images/my-icon.gif) 0 6px no-repeat !important; }
322 * @cfg {Boolean} collapsible
323 * True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into
324 * the header tool button area, false to keep the panel statically sized with no button (defaults to false).
328 * An array of tool button configs to be added to the header tool area. When rendered, each tool is
329 * stored as an {@link Ext.Element Element} referenced by a public property called <code><b></b>tools.<i><tool-type></i></code>
330 * <p>Each tool config may contain the following properties:
331 * <div class="mdetail-params"><ul>
332 * <li><b>id</b> : String<div class="sub-desc"><b>Required.</b> The type
333 * of tool to create. By default, this assigns a CSS class of the form <code>x-tool-<i><tool-type></i></code> to the
334 * resulting tool Element. Ext provides CSS rules, and an icon sprite containing images for the tool types listed below.
335 * The developer may implement custom tools by supplying alternate CSS rules and background images:
337 * <div class="x-tool x-tool-toggle" style="float:left; margin-right:5;"> </div><div><code> toggle</code> (Created by default when {@link #collapsible} is <code>true</code>)</div>
338 * <div class="x-tool x-tool-close" style="float:left; margin-right:5;"> </div><div><code> close</code></div>
339 * <div class="x-tool x-tool-minimize" style="float:left; margin-right:5;"> </div><div><code> minimize</code></div>
340 * <div class="x-tool x-tool-maximize" style="float:left; margin-right:5;"> </div><div><code> maximize</code></div>
341 * <div class="x-tool x-tool-restore" style="float:left; margin-right:5;"> </div><div><code> restore</code></div>
342 * <div class="x-tool x-tool-gear" style="float:left; margin-right:5;"> </div><div><code> gear</code></div>
343 * <div class="x-tool x-tool-pin" style="float:left; margin-right:5;"> </div><div><code> pin</code></div>
344 * <div class="x-tool x-tool-unpin" style="float:left; margin-right:5;"> </div><div><code> unpin</code></div>
345 * <div class="x-tool x-tool-right" style="float:left; margin-right:5;"> </div><div><code> right</code></div>
346 * <div class="x-tool x-tool-left" style="float:left; margin-right:5;"> </div><div><code> left</code></div>
347 * <div class="x-tool x-tool-up" style="float:left; margin-right:5;"> </div><div><code> up</code></div>
348 * <div class="x-tool x-tool-down" style="float:left; margin-right:5;"> </div><div><code> down</code></div>
349 * <div class="x-tool x-tool-refresh" style="float:left; margin-right:5;"> </div><div><code> refresh</code></div>
350 * <div class="x-tool x-tool-minus" style="float:left; margin-right:5;"> </div><div><code> minus</code></div>
351 * <div class="x-tool x-tool-plus" style="float:left; margin-right:5;"> </div><div><code> plus</code></div>
352 * <div class="x-tool x-tool-help" style="float:left; margin-right:5;"> </div><div><code> help</code></div>
353 * <div class="x-tool x-tool-search" style="float:left; margin-right:5;"> </div><div><code> search</code></div>
354 * <div class="x-tool x-tool-save" style="float:left; margin-right:5;"> </div><div><code> save</code></div>
355 * <div class="x-tool x-tool-print" style="float:left; margin-right:5;"> </div><div><code> print</code></div>
357 * <li><b>handler</b> : Function<div class="sub-desc"><b>Required.</b> The function to
358 * call when clicked. Arguments passed are:<ul>
359 * <li><b>event</b> : Ext.EventObject<div class="sub-desc">The click event.</div></li>
360 * <li><b>toolEl</b> : Ext.Element<div class="sub-desc">The tool Element.</div></li>
361 * <li><b>panel</b> : Ext.Panel<div class="sub-desc">The host Panel</div></li>
362 * <li><b>tc</b> : Object<div class="sub-desc">The tool configuration object</div></li>
364 * <li><b>stopEvent</b> : Boolean<div class="sub-desc">Defaults to true. Specify as false to allow click event to propagate.</div></li>
365 * <li><b>scope</b> : Object<div class="sub-desc">The scope in which to call the handler.</div></li>
366 * <li><b>qtip</b> : String/Object<div class="sub-desc">A tip string, or
367 * a config argument to {@link Ext.QuickTip#register}</div></li>
368 * <li><b>hidden</b> : Boolean<div class="sub-desc">True to initially render hidden.</div></li>
369 * <li><b>on</b> : Object<div class="sub-desc">A listener config object specifiying
370 * event listeners in the format of an argument to {@link #addListener}</div></li>
372 * <p>Note that, apart from the toggle tool which is provided when a panel is collapsible, these
373 * tools only provide the visual button. Any required functionality must be provided by adding
374 * handlers that implement the necessary behavior.</p>
375 * <p>Example usage:</p>
379 qtip: 'Refresh form Data',
381 handler: function(event, toolEl, panel){
388 handler: function(event, toolEl, panel){
393 * <p>For the custom id of <code>'help'</code> define two relevant css classes with a link to
396 .x-tool-help {background-image: url(images/help.png);}
397 .x-tool-help-over {background-image: url(images/help_over.png);}
398 // if using an image sprite:
399 .x-tool-help {background-image: url(images/help.png) no-repeat 0 0;}
400 .x-tool-help-over {background-position:-15px 0;}
404 * @cfg {Ext.Template/Ext.XTemplate} toolTemplate
405 * <p>A Template used to create {@link #tools} in the {@link #header} Element. Defaults to:</p><pre><code>
406 new Ext.Template('<div class="x-tool x-tool-{id}">&#160;</div>')</code></pre>
407 * <p>This may may be overridden to provide a custom DOM structure for tools based upon a more
408 * complex XTemplate. The template's data is a single tool configuration object (Not the entire Array)
409 * as specified in {@link #tools}. In the following example an <a> tag is used to provide a
410 * visual indication when hovering over the tool:</p><pre><code>
411 var win = new Ext.Window({
414 href: '/MyPdfDoc.pdf'
416 toolTemplate: new Ext.XTemplate(
417 '<tpl if="id==\'download\'">',
418 '<a class="x-tool x-tool-pdf" href="{href}"></a>',
420 '<tpl if="id!=\'download\'">',
421 '<div class="x-tool x-tool-{id}">&#160;</div>',
428 * <p>Note that the CSS class 'x-tool-pdf' should have an associated style rule which provides an
429 * appropriate background image, something like:</p>
431 a.x-tool-pdf {background-image: url(../shared/extjs/images/pdf.gif)!important;}
435 * @cfg {Boolean} hideCollapseTool
436 * <code>true</code> to hide the expand/collapse toggle button when <code>{@link #collapsible} == true</code>,
437 * <code>false</code> to display it (defaults to <code>false</code>).
440 * @cfg {Boolean} titleCollapse
441 * <code>true</code> to allow expanding and collapsing the panel (when <code>{@link #collapsible} = true</code>)
442 * by clicking anywhere in the header bar, <code>false</code>) to allow it only by clicking to tool button
443 * (defaults to <code>false</code>)). If this panel is a child item of a border layout also see the
444 * {@link Ext.layout.BorderLayout.Region BorderLayout.Region}
445 * <code>{@link Ext.layout.BorderLayout.Region#floatable floatable}</code> config option.
449 * @cfg {Mixed} floating
450 * <p>This property is used to configure the underlying {@link Ext.Layer}. Acceptable values for this
451 * configuration property are:</p><div class="mdetail-params"><ul>
452 * <li><b><code>false</code></b> : <b>Default.</b><div class="sub-desc">Display the panel inline where it is
453 * rendered.</div></li>
454 * <li><b><code>true</code></b> : <div class="sub-desc">Float the panel (absolute position it with automatic
455 * shimming and shadow).<ul>
456 * <div class="sub-desc">Setting floating to true will create an Ext.Layer for this panel and display the
457 * panel at negative offsets so that it is hidden.</div>
458 * <div class="sub-desc">Since the panel will be absolute positioned, the position must be set explicitly
459 * <i>after</i> render (e.g., <code>myPanel.setPosition(100,100);</code>).</div>
460 * <div class="sub-desc"><b>Note</b>: when floating a panel you should always assign a fixed width,
461 * otherwise it will be auto width and will expand to fill to the right edge of the viewport.</div>
463 * <li><b><code>{@link Ext.Layer object}</code></b> : <div class="sub-desc">The specified object will be used
464 * as the configuration object for the {@link Ext.Layer} that will be created.</div></li>
468 * @cfg {Boolean/String} shadow
469 * <code>true</code> (or a valid Ext.Shadow {@link Ext.Shadow#mode} value) to display a shadow behind the
470 * panel, <code>false</code> to display no shadow (defaults to <code>'sides'</code>). Note that this option
471 * only applies when <code>{@link #floating} = true</code>.
474 * @cfg {Number} shadowOffset
475 * The number of pixels to offset the shadow if displayed (defaults to <code>4</code>). Note that this
476 * option only applies when <code>{@link #floating} = true</code>.
479 * @cfg {Boolean} shim
480 * <code>false</code> to disable the iframe shim in browsers which need one (defaults to <code>true</code>).
481 * Note that this option only applies when <code>{@link #floating} = true</code>.
484 * @cfg {Object/Array} keys
485 * A {@link Ext.KeyMap} config object (in the format expected by {@link Ext.KeyMap#addBinding}
486 * used to assign custom key handling to this panel (defaults to <code>null</code>).
489 * @cfg {Boolean/Object} draggable
490 * <p><code>true</code> to enable dragging of this Panel (defaults to <code>false</code>).</p>
491 * <p>For custom drag/drop implementations, an <b>Ext.Panel.DD</b> config could also be passed
492 * in this config instead of <code>true</code>. Ext.Panel.DD is an internal, undocumented class which
493 * moves a proxy Element around in place of the Panel's element, but provides no other behaviour
494 * during dragging or on drop. It is a subclass of {@link Ext.dd.DragSource}, so behaviour may be
495 * added by implementing the interface methods of {@link Ext.dd.DragDrop} e.g.:
501 renderTo: Ext.getBody(),
507 // Config option of Ext.Panel.DD class.
508 // It's a floating Panel, so do not show a placeholder proxy in the original position.
511 // Called for each mousemove event while dragging the DD object.
512 onDrag : function(e){
513 // Record the x,y position of the drag proxy so that we can
514 // position the Panel at end of drag.
515 var pel = this.proxy.getEl();
516 this.x = pel.getLeft(true);
517 this.y = pel.getTop(true);
519 // Keep the Shadow aligned if there is one.
520 var s = this.panel.getEl().shadow;
522 s.realign(this.x, this.y, pel.getWidth(), pel.getHeight());
526 // Called on the mouseup event.
527 endDrag : function(e){
528 this.panel.setPosition(this.x, this.y);
535 * @cfg {Boolean} disabled
536 * Render this panel disabled (default is <code>false</code>). An important note when using the disabled
537 * config on panels is that IE will often fail to initialize the disabled mask element correectly if
538 * the panel's layout has not yet completed by the time the Panel is disabled during the render process.
539 * If you experience this issue, you may need to instead use the {@link #afterlayout} event to initialize
540 * the disabled state:
549 single: true // important, as many layouts can occur
556 * @cfg {Boolean} autoHeight
557 * <code>true</code> to use height:'auto', <code>false</code> to use fixed height (defaults to <code>false</code>).
558 * <b>Note</b>: Setting <code>autoHeight: true</code> means that the browser will manage the panel's height
559 * based on its contents, and that Ext will not manage it at all. If the panel is within a layout that
560 * manages dimensions (<code>fit</code>, <code>border</code>, etc.) then setting <code>autoHeight: true</code>
561 * can cause issues with scrolling and will not generally work as expected since the panel will take
562 * on the height of its contents rather than the height required by the Ext layout.
567 * @cfg {String} baseCls
568 * The base CSS class to apply to this panel's element (defaults to <code>'x-panel'</code>).
569 * <p>Another option available by default is to specify <code>'x-plain'</code> which strips all styling
570 * except for required attributes for Ext layouts to function (e.g. overflow:hidden).
571 * See <code>{@link #unstyled}</code> also.</p>
575 * @cfg {String} collapsedCls
576 * A CSS class to add to the panel's element after it has been collapsed (defaults to
577 * <code>'x-panel-collapsed'</code>).
579 collapsedCls : 'x-panel-collapsed',
581 * @cfg {Boolean} maskDisabled
582 * <code>true</code> to mask the panel when it is {@link #disabled}, <code>false</code> to not mask it (defaults
583 * to <code>true</code>). Either way, the panel will always tell its contained elements to disable themselves
584 * when it is disabled, but masking the panel can provide an additional visual cue that the panel is
589 * @cfg {Boolean} animCollapse
590 * <code>true</code> to animate the transition when the panel is collapsed, <code>false</code> to skip the
591 * animation (defaults to <code>true</code> if the {@link Ext.Fx} class is available, otherwise <code>false</code>).
593 animCollapse : Ext.enableFx,
595 * @cfg {Boolean} headerAsText
596 * <code>true</code> to display the panel <code>{@link #title}</code> in the <code>{@link #header}</code>,
597 * <code>false</code> to hide it (defaults to <code>true</code>).
601 * @cfg {String} buttonAlign
602 * The alignment of any {@link #buttons} added to this panel. Valid values are <code>'right'</code>,
603 * <code>'left'</code> and <code>'center'</code> (defaults to <code>'right'</code>).
605 buttonAlign : 'right',
607 * @cfg {Boolean} collapsed
608 * <code>true</code> to render the panel collapsed, <code>false</code> to render it expanded (defaults to
609 * <code>false</code>).
613 * @cfg {Boolean} collapseFirst
614 * <code>true</code> to make sure the collapse/expand toggle button always renders first (to the left of)
615 * any other tools in the panel's title bar, <code>false</code> to render it last (defaults to <code>true</code>).
617 collapseFirst : true,
619 * @cfg {Number} minButtonWidth
620 * Minimum width in pixels of all {@link #buttons} in this panel (defaults to <code>75</code>)
624 * @cfg {Boolean} unstyled
625 * Overrides the <code>{@link #baseCls}</code> setting to <code>{@link #baseCls} = 'x-plain'</code> which renders
626 * the panel unstyled except for required attributes for Ext layouts to function (e.g. overflow:hidden).
629 * @cfg {String} elements
630 * A comma-delimited list of panel elements to initialize when the panel is rendered. Normally, this list will be
631 * generated automatically based on the items added to the panel at config time, but sometimes it might be useful to
632 * make sure a structural element is rendered even if not specified at config time (for example, you may want
633 * to add a button or toolbar dynamically after the panel has been rendered). Adding those elements to this
634 * list will allocate the required placeholders in the panel when it is rendered. Valid values are<div class="mdetail-params"><ul>
635 * <li><code>header</code></li>
636 * <li><code>tbar</code> (top bar)</li>
637 * <li><code>body</code></li>
638 * <li><code>bbar</code> (bottom bar)</li>
639 * <li><code>footer</code></li>
641 * Defaults to '<code>body</code>'.
645 * @cfg {Boolean} preventBodyReset
646 * Defaults to <code>false</code>. When set to <code>true</code>, an extra css class <code>'x-panel-normal'</code>
647 * will be added to the panel's element, effectively applying css styles suggested by the W3C
648 * (see http://www.w3.org/TR/CSS21/sample.html) to the Panel's <b>body</b> element (not the header,
651 preventBodyReset : false,
654 * @cfg {Number/String} padding
655 * A shortcut for setting a padding style on the body element. The value can either be
656 * a number to be applied to all sides, or a normal css string describing padding.
657 * Defaults to <tt>undefined</tt>.
662 /** @cfg {String} resizeEvent
663 * The event to listen to for resizing in layouts. Defaults to <tt>'bodyresize'</tt>.
665 resizeEvent: 'bodyresize',
667 // protected - these could be used to customize the behavior of the window,
668 // but changing them would not be useful without further mofifications and
669 // could lead to unexpected or undesirable results.
670 toolTarget : 'header',
671 collapseEl : 'bwrap',
675 // private, notify box this class will handle heights
687 initComponent : function(){
688 Ext.Panel.superclass.initComponent.call(this);
693 * Fires after the Panel has been resized.
694 * @param {Ext.Panel} p the Panel which has been resized.
695 * @param {Number} width The Panel's new width.
696 * @param {Number} height The Panel's new height.
701 * Fires after the Panel title has been {@link #title set} or {@link #setTitle changed}.
702 * @param {Ext.Panel} p the Panel which has had its title changed.
703 * @param {String} The new title.
708 * Fires after the Panel icon class has been {@link #iconCls set} or {@link #setIconClass changed}.
709 * @param {Ext.Panel} p the Panel which has had its {@link #iconCls icon class} changed.
710 * @param {String} The new icon class.
711 * @param {String} The old icon class.
716 * Fires after the Panel has been collapsed.
717 * @param {Ext.Panel} p the Panel that has been collapsed.
722 * Fires after the Panel has been expanded.
723 * @param {Ext.Panel} p The Panel that has been expanded.
727 * @event beforecollapse
728 * Fires before the Panel is collapsed. A handler can return false to cancel the collapse.
729 * @param {Ext.Panel} p the Panel being collapsed.
730 * @param {Boolean} animate True if the collapse is animated, else false.
734 * @event beforeexpand
735 * Fires before the Panel is expanded. A handler can return false to cancel the expand.
736 * @param {Ext.Panel} p The Panel being expanded.
737 * @param {Boolean} animate True if the expand is animated, else false.
742 * Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
743 * Panel subclasses do (like {@link Ext.Window}) or a Panel within a Ext.TabPanel. This event only
744 * applies to such subclasses.
745 * A handler can return false to cancel the close.
746 * @param {Ext.Panel} p The Panel being closed.
751 * Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
752 * Panel subclasses do (like {@link Ext.Window}) or a Panel within a Ext.TabPanel.
753 * @param {Ext.Panel} p The Panel that has been closed.
758 * Fires after the Panel has been visually activated.
759 * Note that Panels do not directly support being activated, but some Panel subclasses
760 * do (like {@link Ext.Window}). Panels which are child Components of a TabPanel fire the
761 * activate and deactivate events under the control of the TabPanel.
762 * @param {Ext.Panel} p The Panel that has been activated.
767 * Fires after the Panel has been visually deactivated.
768 * Note that Panels do not directly support being deactivated, but some Panel subclasses
769 * do (like {@link Ext.Window}). Panels which are child Components of a TabPanel fire the
770 * activate and deactivate events under the control of the TabPanel.
771 * @param {Ext.Panel} p The Panel that has been deactivated.
777 this.baseCls = 'x-plain';
784 this.elements += ',tbar';
785 this.topToolbar = this.createToolbar(this.tbar);
790 this.elements += ',bbar';
791 this.bottomToolbar = this.createToolbar(this.bbar);
795 if(this.header === true){
796 this.elements += ',header';
798 }else if(this.headerCfg || (this.title && this.header !== false)){
799 this.elements += ',header';
802 if(this.footerCfg || this.footer === true){
803 this.elements += ',footer';
808 this.fbar = this.buttons;
812 this.createFbar(this.fbar);
815 this.on('render', this.doAutoLoad, this, {delay:10});
820 createFbar : function(fbar){
821 var min = this.minButtonWidth;
822 this.elements += ',footer';
823 this.fbar = this.createToolbar(fbar, {
824 buttonAlign: this.buttonAlign,
825 toolbarCls: 'x-panel-fbar',
826 enableOverflow: false,
827 defaults: function(c){
829 minWidth: c.minWidth || min
833 //@compat addButton and buttons could possibly be removed
836 * This Panel's Array of buttons as created from the <code>{@link #buttons}</code>
837 * config property. Read only.
841 this.fbar.items.each(function(c){
842 c.minWidth = c.minWidth || this.minButtonWidth;
844 this.buttons = this.fbar.items.items;
848 createToolbar: function(tb, options){
850 // Convert array to proper toolbar config
856 result = tb.events ? Ext.apply(tb, options) : this.createComponent(Ext.apply({}, tb, options), 'toolbar');
857 result.ownerCt = this;
858 result.bufferResize = false;
859 this.toolbars.push(result);
864 createElement : function(name, pnode){
866 pnode.appendChild(this[name].dom);
870 if(name === 'bwrap' || this.elements.indexOf(name) != -1){
871 if(this[name+'Cfg']){
872 this[name] = Ext.fly(pnode).createChild(this[name+'Cfg']);
874 var el = document.createElement('div');
875 el.className = this[name+'Cls'];
876 this[name] = Ext.get(pnode.appendChild(el));
878 if(this[name+'CssClass']){
879 this[name].addClass(this[name+'CssClass']);
881 if(this[name+'Style']){
882 this[name].applyStyles(this[name+'Style']);
888 onRender : function(ct, position){
889 Ext.Panel.superclass.onRender.call(this, ct, position);
890 this.createClasses();
898 if(this.collapsible && !this.hideCollapseTool){
899 this.tools = this.tools ? this.tools.slice(0) : [];
900 this.tools[this.collapseFirst?'unshift':'push']({
902 handler : this.toggleCollapse,
909 this.elements += (this.header !== false) ? ',header' : '';
913 el.addClass(this.baseCls);
914 if(d.firstChild){ // existing markup
915 this.header = el.down('.'+this.headerCls);
916 this.bwrap = el.down('.'+this.bwrapCls);
917 var cp = this.bwrap ? this.bwrap : el;
918 this.tbar = cp.down('.'+this.tbarCls);
919 this.body = cp.down('.'+this.bodyCls);
920 this.bbar = cp.down('.'+this.bbarCls);
921 this.footer = cp.down('.'+this.footerCls);
922 this.fromMarkup = true;
924 if (this.preventBodyReset === true) {
925 el.addClass('x-panel-reset');
928 el.addClass(this.cls);
932 this.elements += ',footer';
935 // This block allows for maximum flexibility and performance when using existing markup
937 // framing requires special markup
939 el.insertHtml('afterBegin', String.format(Ext.Element.boxMarkup, this.baseCls));
941 this.createElement('header', d.firstChild.firstChild.firstChild);
942 this.createElement('bwrap', d);
944 // append the mid and bottom frame to the bwrap
946 var ml = d.childNodes[1], bl = d.childNodes[2];
950 var mc = bw.firstChild.firstChild.firstChild;
951 this.createElement('tbar', mc);
952 this.createElement('body', mc);
953 this.createElement('bbar', mc);
954 this.createElement('footer', bw.lastChild.firstChild.firstChild);
957 this.bwrap.dom.lastChild.className += ' x-panel-nofooter';
960 * Store a reference to this element so:
961 * a) We aren't looking it up all the time
962 * b) The last element is reported incorrectly when using a loadmask
964 this.ft = Ext.get(this.bwrap.dom.lastChild);
965 this.mc = Ext.get(mc);
967 this.createElement('header', d);
968 this.createElement('bwrap', d);
970 // append the mid and bottom frame to the bwrap
972 this.createElement('tbar', bw);
973 this.createElement('body', bw);
974 this.createElement('bbar', bw);
975 this.createElement('footer', bw);
978 this.body.addClass(this.bodyCls + '-noheader');
980 this.tbar.addClass(this.tbarCls + '-noheader');
985 if(Ext.isDefined(this.padding)){
986 this.body.setStyle('padding', this.body.addUnits(this.padding));
989 if(this.border === false){
990 this.el.addClass(this.baseCls + '-noborder');
991 this.body.addClass(this.bodyCls + '-noborder');
993 this.header.addClass(this.headerCls + '-noborder');
996 this.footer.addClass(this.footerCls + '-noborder');
999 this.tbar.addClass(this.tbarCls + '-noborder');
1002 this.bbar.addClass(this.bbarCls + '-noborder');
1006 if(this.bodyBorder === false){
1007 this.body.addClass(this.bodyCls + '-noborder');
1010 this.bwrap.enableDisplayMode('block');
1013 this.header.unselectable();
1015 // for tools, we need to wrap any existing header markup
1016 if(this.headerAsText){
1017 this.header.dom.innerHTML =
1018 '<span class="' + this.headerTextCls + '">'+this.header.dom.innerHTML+'</span>';
1021 this.setIconClass(this.iconCls);
1027 this.makeFloating(this.floating);
1030 if(this.collapsible && this.titleCollapse && this.header){
1031 this.mon(this.header, 'click', this.toggleCollapse, this);
1032 this.header.setStyle('cursor', 'pointer');
1035 this.addTool.apply(this, ts);
1038 this.footer.addClass('x-panel-btns');
1039 this.fbar.render(this.footer);
1040 this.footer.createChild({cls:'x-clear'});
1043 if(this.tbar && this.topToolbar){
1044 this.topToolbar.render(this.tbar);
1046 if(this.bbar && this.bottomToolbar){
1047 this.bottomToolbar.render(this.bbar);
1053 * Sets the CSS class that provides the icon image for this panel. This method will replace any existing
1054 * icon class if one has already been set and fire the {@link #iconchange} event after completion.
1055 * @param {String} cls The new CSS class name
1057 setIconClass : function(cls){
1058 var old = this.iconCls;
1060 if(this.rendered && this.header){
1062 this.header.addClass('x-panel-icon');
1063 this.header.replaceClass(old, this.iconCls);
1065 var hd = this.header,
1066 img = hd.child('img.x-panel-inline-icon');
1068 Ext.fly(img).replaceClass(old, this.iconCls);
1070 Ext.DomHelper.insertBefore(hd.dom.firstChild, {
1071 tag:'img', src: Ext.BLANK_IMAGE_URL, cls:'x-panel-inline-icon '+this.iconCls
1076 this.fireEvent('iconchange', this, cls, old);
1080 makeFloating : function(cfg){
1081 this.floating = true;
1082 this.el = new Ext.Layer(Ext.apply({}, cfg, {
1083 shadow: Ext.isDefined(this.shadow) ? this.shadow : 'sides',
1084 shadowOffset: this.shadowOffset,
1086 shim: this.shim === false ? false : undefined
1091 * Returns the {@link Ext.Toolbar toolbar} from the top (<code>{@link #tbar}</code>) section of the panel.
1092 * @return {Ext.Toolbar} The toolbar
1094 getTopToolbar : function(){
1095 return this.topToolbar;
1099 * Returns the {@link Ext.Toolbar toolbar} from the bottom (<code>{@link #bbar}</code>) section of the panel.
1100 * @return {Ext.Toolbar} The toolbar
1102 getBottomToolbar : function(){
1103 return this.bottomToolbar;
1107 * Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
1108 * approach is to add buttons via the {@link #buttons} config.
1109 * @param {String/Object} config A valid {@link Ext.Button} config. A string will become the text for a default
1110 * button config, an object will be treated as a button config object.
1111 * @param {Function} handler The function to be called on button {@link Ext.Button#click}
1112 * @param {Object} scope The scope (<code>this</code> reference) in which the button handler function is executed. Defaults to the Button.
1113 * @return {Ext.Button} The button that was added
1115 addButton : function(config, handler, scope){
1117 this.createFbar([]);
1120 if(Ext.isString(config)){
1121 config = {text: config};
1123 config = Ext.apply({
1128 return this.fbar.add(config);
1132 addTool : function(){
1137 Ext.each(arguments, function(arg){
1138 this.tools.push(arg)
1142 // nowhere to render tools!
1143 if(!this[this.toolTarget]){
1146 if(!this.toolTemplate){
1147 // initialize the global tool template on first use
1148 var tt = new Ext.Template(
1149 '<div class="x-tool x-tool-{id}"> </div>'
1151 tt.disableFormats = true;
1153 Ext.Panel.prototype.toolTemplate = tt;
1155 for(var i = 0, a = arguments, len = a.length; i < len; i++) {
1157 if(!this.tools[tc.id]){
1158 var overCls = 'x-tool-'+tc.id+'-over';
1159 var t = this.toolTemplate.insertFirst((tc.align !== 'left') ? this[this.toolTarget] : this[this.toolTarget].child('span'), tc, true);
1160 this.tools[tc.id] = t;
1161 t.enableDisplayMode('block');
1162 this.mon(t, 'click', this.createToolHandler(t, tc, overCls, this));
1170 if(Ext.isObject(tc.qtip)){
1171 Ext.QuickTips.register(Ext.apply({
1175 t.dom.qtip = tc.qtip;
1178 t.addClassOnOver(overCls);
1183 onLayout : function(shallow, force){
1184 if(this.hasLayout && this.toolbars.length > 0){
1185 Ext.each(this.toolbars, function(tb){
1186 tb.doLayout(undefined, force);
1192 syncHeight : function(){
1193 var h = this.toolbarHeight,
1195 lsh = this.lastSize.height,
1198 if(this.autoHeight || !Ext.isDefined(lsh) || lsh == 'auto'){
1203 if(h != this.getToolbarHeight()){
1204 h = Math.max(0, this.adjustBodyHeight(lsh - this.getFrameHeight()));
1207 this.toolbarHeight = this.getToolbarHeight();
1208 this.onBodyResize(sz.width, sz.height);
1213 onShow : function(){
1215 return this.el.show();
1217 Ext.Panel.superclass.onShow.call(this);
1221 onHide : function(){
1223 return this.el.hide();
1225 Ext.Panel.superclass.onHide.call(this);
1229 createToolHandler : function(t, tc, overCls, panel){
1231 t.removeClass(overCls);
1232 if(tc.stopEvent !== false){
1236 tc.handler.call(tc.scope || t, e, t, panel, tc);
1242 afterRender : function(){
1243 if(this.floating && !this.hidden){
1247 this.setTitle(this.title);
1250 this.collapsed = false;
1251 this.collapse(false);
1253 Ext.Panel.superclass.afterRender.call(this); // do sizing calcs last
1258 getKeyMap : function(){
1260 this.keyMap = new Ext.KeyMap(this.el, this.keys);
1266 initEvents : function(){
1271 this.initDraggable();
1273 if(this.toolbars.length > 0){
1274 Ext.each(this.toolbars, function(tb){
1278 afterlayout: this.syncHeight,
1279 remove: this.syncHeight
1290 initDraggable : function(){
1292 * <p>If this Panel is configured {@link #draggable}, this property will contain
1293 * an instance of {@link Ext.dd.DragSource} which handles dragging the Panel.</p>
1294 * The developer must provide implementations of the abstract methods of {@link Ext.dd.DragSource}
1295 * in order to supply behaviour for each stage of the drag/drop process. See {@link #draggable}.
1296 * @type Ext.dd.DragSource.
1299 this.dd = new Ext.Panel.DD(this, Ext.isBoolean(this.draggable) ? null : this.draggable);
1303 beforeEffect : function(anim){
1305 this.el.beforeAction();
1308 this.el.addClass('x-panel-animated');
1313 afterEffect : function(anim){
1316 this.el.removeClass('x-panel-animated');
1320 // private - wraps up an animation param with internal callbacks
1321 createEffect : function(a, cb, scope){
1329 }else if(!a.callback){
1331 }else { // wrap it up
1332 o.callback = function(){
1334 Ext.callback(a.callback, a.scope);
1337 return Ext.applyIf(o, a);
1341 * Collapses the panel body so that it becomes hidden. Fires the {@link #beforecollapse} event which will
1342 * cancel the collapse action if it returns false.
1343 * @param {Boolean} animate True to animate the transition, else false (defaults to the value of the
1344 * {@link #animCollapse} panel config)
1345 * @return {Ext.Panel} this
1347 collapse : function(animate){
1348 if(this.collapsed || this.el.hasFxBlock() || this.fireEvent('beforecollapse', this, animate) === false){
1351 var doAnim = animate === true || (animate !== false && this.animCollapse);
1352 this.beforeEffect(doAnim);
1353 this.onCollapse(doAnim, animate);
1358 onCollapse : function(doAnim, animArg){
1360 this[this.collapseEl].slideOut(this.slideAnchor,
1361 Ext.apply(this.createEffect(animArg||true, this.afterCollapse, this),
1362 this.collapseDefaults));
1364 this[this.collapseEl].hide();
1365 this.afterCollapse(false);
1370 afterCollapse : function(anim){
1371 this.collapsed = true;
1372 this.el.addClass(this.collapsedCls);
1373 this.afterEffect(anim);
1374 this.fireEvent('collapse', this);
1378 * Expands the panel body so that it becomes visible. Fires the {@link #beforeexpand} event which will
1379 * cancel the expand action if it returns false.
1380 * @param {Boolean} animate True to animate the transition, else false (defaults to the value of the
1381 * {@link #animCollapse} panel config)
1382 * @return {Ext.Panel} this
1384 expand : function(animate){
1385 if(!this.collapsed || this.el.hasFxBlock() || this.fireEvent('beforeexpand', this, animate) === false){
1388 var doAnim = animate === true || (animate !== false && this.animCollapse);
1389 this.el.removeClass(this.collapsedCls);
1390 this.beforeEffect(doAnim);
1391 this.onExpand(doAnim, animate);
1396 onExpand : function(doAnim, animArg){
1398 this[this.collapseEl].slideIn(this.slideAnchor,
1399 Ext.apply(this.createEffect(animArg||true, this.afterExpand, this),
1400 this.expandDefaults));
1402 this[this.collapseEl].show();
1403 this.afterExpand(false);
1408 afterExpand : function(anim){
1409 this.collapsed = false;
1410 this.afterEffect(anim);
1411 if(Ext.isDefined(this.deferLayout)){
1412 this.doLayout(true);
1414 this.fireEvent('expand', this);
1418 * Shortcut for performing an {@link #expand} or {@link #collapse} based on the current state of the panel.
1419 * @param {Boolean} animate True to animate the transition, else false (defaults to the value of the
1420 * {@link #animCollapse} panel config)
1421 * @return {Ext.Panel} this
1423 toggleCollapse : function(animate){
1424 this[this.collapsed ? 'expand' : 'collapse'](animate);
1429 onDisable : function(){
1430 if(this.rendered && this.maskDisabled){
1433 Ext.Panel.superclass.onDisable.call(this);
1437 onEnable : function(){
1438 if(this.rendered && this.maskDisabled){
1441 Ext.Panel.superclass.onEnable.call(this);
1445 onResize : function(w, h){
1446 if(Ext.isDefined(w) || Ext.isDefined(h)){
1447 if(!this.collapsed){
1448 // First, set the the Panel's body width.
1449 // If we have auto-widthed it, get the resulting full offset width so we can size the Toolbars to match
1450 // The Toolbars must not buffer this resize operation because we need to know their heights.
1452 if(Ext.isNumber(w)){
1453 this.body.setWidth(w = this.adjustBodyWidth(w - this.getFrameWidth()));
1454 } else if (w == 'auto') {
1455 w = this.body.setWidth('auto').dom.offsetWidth;
1457 w = this.body.dom.offsetWidth;
1461 this.tbar.setWidth(w);
1462 if(this.topToolbar){
1463 this.topToolbar.setSize(w);
1467 this.bbar.setWidth(w);
1468 if(this.bottomToolbar){
1469 this.bottomToolbar.setSize(w);
1470 // The bbar does not move on resize without this.
1472 this.bbar.setStyle('position', 'static');
1473 this.bbar.setStyle('position', '');
1478 this.footer.setWidth(w);
1480 this.fbar.setSize(Ext.isIE ? (w - this.footer.getFrameWidth('lr')) : 'auto');
1484 // At this point, the Toolbars must be layed out for getFrameHeight to find a result.
1485 if(Ext.isNumber(h)){
1486 h = Math.max(0, this.adjustBodyHeight(h - this.getFrameHeight()));
1487 this.body.setHeight(h);
1488 }else if(h == 'auto'){
1489 this.body.setHeight(h);
1492 if(this.disabled && this.el._mask){
1493 this.el._mask.setSize(this.el.dom.clientWidth, this.el.getHeight());
1496 this.queuedBodySize = {width: w, height: h};
1497 if(!this.queuedExpand && this.allowQueuedExpand !== false){
1498 this.queuedExpand = true;
1499 this.on('expand', function(){
1500 delete this.queuedExpand;
1501 this.onResize(this.queuedBodySize.width, this.queuedBodySize.height);
1502 }, this, {single:true});
1505 this.onBodyResize(w, h);
1508 Ext.Panel.superclass.onResize.call(this);
1512 onBodyResize: function(w, h){
1513 this.fireEvent('bodyresize', this, w, h);
1517 getToolbarHeight: function(){
1520 Ext.each(this.toolbars, function(tb){
1521 h += tb.getHeight();
1528 adjustBodyHeight : function(h){
1533 adjustBodyWidth : function(w){
1538 onPosition : function(){
1543 * Returns the width in pixels of the framing elements of this panel (not including the body width). To
1544 * retrieve the body width see {@link #getInnerWidth}.
1545 * @return {Number} The frame width
1547 getFrameWidth : function(){
1548 var w = this.el.getFrameWidth('lr') + this.bwrap.getFrameWidth('lr');
1551 var l = this.bwrap.dom.firstChild;
1552 w += (Ext.fly(l).getFrameWidth('l') + Ext.fly(l.firstChild).getFrameWidth('r'));
1553 w += this.mc.getFrameWidth('lr');
1559 * Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
1560 * header and footer elements, but not including the body height). To retrieve the body height see {@link #getInnerHeight}.
1561 * @return {Number} The frame height
1563 getFrameHeight : function(){
1564 var h = this.el.getFrameWidth('tb') + this.bwrap.getFrameWidth('tb');
1565 h += (this.tbar ? this.tbar.getHeight() : 0) +
1566 (this.bbar ? this.bbar.getHeight() : 0);
1569 h += this.el.dom.firstChild.offsetHeight + this.ft.dom.offsetHeight + this.mc.getFrameWidth('tb');
1571 h += (this.header ? this.header.getHeight() : 0) +
1572 (this.footer ? this.footer.getHeight() : 0);
1578 * Returns the width in pixels of the body element (not including the width of any framing elements).
1579 * For the frame width see {@link #getFrameWidth}.
1580 * @return {Number} The body width
1582 getInnerWidth : function(){
1583 return this.getSize().width - this.getFrameWidth();
1587 * Returns the height in pixels of the body element (not including the height of any framing elements).
1588 * For the frame height see {@link #getFrameHeight}.
1589 * @return {Number} The body height
1591 getInnerHeight : function(){
1592 return this.getSize().height - this.getFrameHeight();
1596 syncShadow : function(){
1603 getLayoutTarget : function(){
1608 getContentTarget : function(){
1613 * <p>Sets the title text for the panel and optionally the {@link #iconCls icon class}.</p>
1614 * <p>In order to be able to set the title, a header element must have been created
1615 * for the Panel. This is triggered either by configuring the Panel with a non-blank <code>{@link #title}</code>,
1616 * or configuring it with <code><b>{@link #header}: true</b></code>.</p>
1617 * @param {String} title The title text to set
1618 * @param {String} iconCls (optional) {@link #iconCls iconCls} A user-defined CSS class that provides the icon image for this panel
1620 setTitle : function(title, iconCls){
1622 if(this.header && this.headerAsText){
1623 this.header.child('span').update(title);
1626 this.setIconClass(iconCls);
1628 this.fireEvent('titlechange', this, title);
1633 * Get the {@link Ext.Updater} for this panel. Enables you to perform Ajax updates of this panel's body.
1634 * @return {Ext.Updater} The Updater
1636 getUpdater : function(){
1637 return this.body.getUpdater();
1641 * Loads this content panel immediately with content returned from an XHR call.
1642 * @param {Object/String/Function} config A config object containing any of the following options:
1645 url: 'your-url.php',
1646 params: {param1: 'foo', param2: 'bar'}, // or a URL encoded string
1647 callback: yourFunction,
1648 scope: yourObject, // optional scope for the callback
1656 * The only required property is url. The optional properties nocache, text and scripts
1657 * are shorthand for disableCaching, indicatorText and loadScripts and are used to set their
1658 * associated property on this panel Updater instance.
1659 * @return {Ext.Panel} this
1662 var um = this.body.getUpdater();
1663 um.update.apply(um, arguments);
1668 beforeDestroy : function(){
1669 Ext.Panel.superclass.beforeDestroy.call(this);
1671 this.header.removeAllListeners();
1674 for(var k in this.tools){
1675 Ext.destroy(this.tools[k]);
1678 if(Ext.isArray(this.buttons)){
1679 while(this.buttons.length) {
1680 Ext.destroy(this.buttons[0]);
1710 createClasses : function(){
1711 this.headerCls = this.baseCls + '-header';
1712 this.headerTextCls = this.baseCls + '-header-text';
1713 this.bwrapCls = this.baseCls + '-bwrap';
1714 this.tbarCls = this.baseCls + '-tbar';
1715 this.bodyCls = this.baseCls + '-body';
1716 this.bbarCls = this.baseCls + '-bbar';
1717 this.footerCls = this.baseCls + '-footer';
1721 createGhost : function(cls, useShim, appendTo){
1722 var el = document.createElement('div');
1723 el.className = 'x-panel-ghost ' + (cls ? cls : '');
1725 el.appendChild(this.el.dom.firstChild.cloneNode(true));
1727 Ext.fly(el.appendChild(document.createElement('ul'))).setHeight(this.bwrap.getHeight());
1728 el.style.width = this.el.dom.offsetWidth + 'px';;
1730 this.container.dom.appendChild(el);
1732 Ext.getDom(appendTo).appendChild(el);
1734 if(useShim !== false && this.el.useShim !== false){
1735 var layer = new Ext.Layer({shadow:false, useDisplay:true, constrain:false}, el);
1739 return new Ext.Element(el);
1744 doAutoLoad : function(){
1745 var u = this.body.getUpdater();
1747 u.setRenderer(this.renderer);
1749 u.update(Ext.isObject(this.autoLoad) ? this.autoLoad : {url: this.autoLoad});
1753 * Retrieve a tool by id.
1754 * @param {String} id
1755 * @return {Object} tool
1757 getTool : function(id) {
1758 return this.tools[id];
1762 * @cfg {String} autoEl @hide
1765 Ext.reg('panel', Ext.Panel);