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 <tt><b>{@link Ext.Container#layout layout}</b></tt> 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 <tt>{@link Ext.Component#el el} 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 <tt>{@link Ext.Component#el el} 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 (<tt>baseCls</tt> will be
69 * replaced by <tt>{@link #baseCls}</tt>):</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 <tt>{@link #footer}</tt> 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 <tt>{@link #bodyCfg}</tt> 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 <tt>{@link #bodyCfg}</tt> 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 <tt>{@link #bodyCfg}</tt> 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 <tt>{@link #bodyCfg}</tt> 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 <tt>{@link #bodyCfg}</tt> 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 <tt>true</tt>
137 * to enable closing in such situations. Defaults to <tt>false</tt>.
140 * The Panel's footer {@link Ext.Element Element}. Read-only.
141 * <p>This Element is used to house the Panel's <tt>{@link #buttons}</tt> or <tt>{@link #fbar}</tt>.</p>
142 * <br><p><b>Note</b>: see the Note for <tt>{@link Ext.Component#el el} 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 <tt>applyTo</tt> 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 <tt>{@link #buttons}</tt> are specified, they will supersede the <tt>fbar</tt> configuration property.</p>
190 * The Panel's <tt>{@link #buttonAlign}</tt> 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 * <tt>true</tt> to create the Panel's header element explicitly, <tt>false</tt> to skip creating
219 * it. If a <tt>{@link #title}</tt> is set the header will be created automatically, otherwise it will not.
220 * If a <tt>{@link #title}</tt> is set but <tt>header</tt> is explicitly set to <tt>false</tt>, the header
221 * will not be rendered.
224 * @cfg {Boolean} footer
225 * <tt>true</tt> to create the footer element explicitly, false to skip creating it. The footer
226 * will be created automatically if <tt>{@link #buttons}</tt> or a <tt>{@link #fbar}</tt> have
227 * been configured. See <tt>{@link #bodyCfg}</tt> 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 * <tt>{@link #header}</tt> (defaults to ''). When a <tt>title</tt> is specified the
233 * <tt>{@link #header}</tt> element will automatically be created and displayed unless
234 * {@link #header} is explicitly set to <tt>false</tt>. If you do not want to specify a
235 * <tt>title</tt> at config time, but you may want one later, you must either specify a non-empty
236 * <tt>title</tt> (a blank space ' ' will do) or <tt>header:true</tt> so that the container
237 * element will get created.
240 * @cfg {Array} buttons
241 * <tt>buttons</tt> will be used as <tt>{@link Ext.Container#items items}</tt> for the toolbar in
242 * the footer (<tt>{@link #fbar}</tt>). 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 <tt>minWidth</tt> or the Panel is configured with <tt>minButtonWidth</tt>,
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 * <tt>false</tt> by default to render with plain 1px square borders. <tt>true</tt> 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 <tt><b></b>tools.<i><tool-type></i></tt>
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 <tt>x-tool-<i><tool-type></i></tt> 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><tt> toggle</tt> (Created by default when {@link #collapsible} is <tt>true</tt>)</div>
338 * <div class="x-tool x-tool-close" style="float:left; margin-right:5;"> </div><div><tt> close</tt></div>
339 * <div class="x-tool x-tool-minimize" style="float:left; margin-right:5;"> </div><div><tt> minimize</tt></div>
340 * <div class="x-tool x-tool-maximize" style="float:left; margin-right:5;"> </div><div><tt> maximize</tt></div>
341 * <div class="x-tool x-tool-restore" style="float:left; margin-right:5;"> </div><div><tt> restore</tt></div>
342 * <div class="x-tool x-tool-gear" style="float:left; margin-right:5;"> </div><div><tt> gear</tt></div>
343 * <div class="x-tool x-tool-pin" style="float:left; margin-right:5;"> </div><div><tt> pin</tt></div>
344 * <div class="x-tool x-tool-unpin" style="float:left; margin-right:5;"> </div><div><tt> unpin</tt></div>
345 * <div class="x-tool x-tool-right" style="float:left; margin-right:5;"> </div><div><tt> right</tt></div>
346 * <div class="x-tool x-tool-left" style="float:left; margin-right:5;"> </div><div><tt> left</tt></div>
347 * <div class="x-tool x-tool-up" style="float:left; margin-right:5;"> </div><div><tt> up</tt></div>
348 * <div class="x-tool x-tool-down" style="float:left; margin-right:5;"> </div><div><tt> down</tt></div>
349 * <div class="x-tool x-tool-refresh" style="float:left; margin-right:5;"> </div><div><tt> refresh</tt></div>
350 * <div class="x-tool x-tool-minus" style="float:left; margin-right:5;"> </div><div><tt> minus</tt></div>
351 * <div class="x-tool x-tool-plus" style="float:left; margin-right:5;"> </div><div><tt> plus</tt></div>
352 * <div class="x-tool x-tool-help" style="float:left; margin-right:5;"> </div><div><tt> help</tt></div>
353 * <div class="x-tool x-tool-search" style="float:left; margin-right:5;"> </div><div><tt> search</tt></div>
354 * <div class="x-tool x-tool-save" style="float:left; margin-right:5;"> </div><div><tt> save</tt></div>
355 * <div class="x-tool x-tool-print" style="float:left; margin-right:5;"> </div><div><tt> print</tt></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> : Ext.Panel<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 <tt>'help'</tt> 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 * <tt>true</tt> to hide the expand/collapse toggle button when <code>{@link #collapsible} == true</code>,
437 * <tt>false</tt> to display it (defaults to <tt>false</tt>).
440 * @cfg {Boolean} titleCollapse
441 * <tt>true</tt> to allow expanding and collapsing the panel (when <tt>{@link #collapsible} = true</tt>)
442 * by clicking anywhere in the header bar, <tt>false</tt>) to allow it only by clicking to tool button
443 * (defaults to <tt>false</tt>)). If this panel is a child item of a border layout also see the
444 * {@link Ext.layout.BorderLayout.Region BorderLayout.Region}
445 * <tt>{@link Ext.layout.BorderLayout.Region#floatable floatable}</tt> config option.
448 * @cfg {Boolean} autoScroll
449 * <tt>true</tt> to use overflow:'auto' on the panel's body element and show scroll bars automatically when
450 * necessary, <tt>false</tt> to clip any overflowing content (defaults to <tt>false</tt>).
453 * @cfg {Mixed} floating
454 * <p>This property is used to configure the underlying {@link Ext.Layer}. Acceptable values for this
455 * configuration property are:</p><div class="mdetail-params"><ul>
456 * <li><b><tt>false</tt></b> : <b>Default.</b><div class="sub-desc">Display the panel inline where it is
457 * rendered.</div></li>
458 * <li><b><tt>true</tt></b> : <div class="sub-desc">Float the panel (absolute position it with automatic
459 * shimming and shadow).<ul>
460 * <div class="sub-desc">Setting floating to true will create an Ext.Layer for this panel and display the
461 * panel at negative offsets so that it is hidden.</div>
462 * <div class="sub-desc">Since the panel will be absolute positioned, the position must be set explicitly
463 * <i>after</i> render (e.g., <tt>myPanel.setPosition(100,100);</tt>).</div>
464 * <div class="sub-desc"><b>Note</b>: when floating a panel you should always assign a fixed width,
465 * otherwise it will be auto width and will expand to fill to the right edge of the viewport.</div>
467 * <li><b><tt>{@link Ext.Layer object}</tt></b> : <div class="sub-desc">The specified object will be used
468 * as the configuration object for the {@link Ext.Layer} that will be created.</div></li>
472 * @cfg {Boolean/String} shadow
473 * <tt>true</tt> (or a valid Ext.Shadow {@link Ext.Shadow#mode} value) to display a shadow behind the
474 * panel, <tt>false</tt> to display no shadow (defaults to <tt>'sides'</tt>). Note that this option
475 * only applies when <tt>{@link #floating} = true</tt>.
478 * @cfg {Number} shadowOffset
479 * The number of pixels to offset the shadow if displayed (defaults to <tt>4</tt>). Note that this
480 * option only applies when <tt>{@link #floating} = true</tt>.
483 * @cfg {Boolean} shim
484 * <tt>false</tt> to disable the iframe shim in browsers which need one (defaults to <tt>true</tt>).
485 * Note that this option only applies when <tt>{@link #floating} = true</tt>.
488 * @cfg {String/Object} html
489 * An HTML fragment, or a {@link Ext.DomHelper DomHelper} specification to use as the panel's body
490 * content (defaults to ''). The HTML content is added by the Panel's {@link #afterRender} method,
491 * and so the document will not contain this HTML at the time the {@link #render} event is fired.
492 * This content is inserted into the body <i>before</i> any configured {@link #contentEl} is appended.
495 * @cfg {String} contentEl
496 * <p>Specify the <tt>id</tt> of an existing HTML node to use as the panel's body content
497 * (defaults to '').</p><div><ul>
498 * <li><b>Description</b> : <ul>
499 * <div class="sub-desc">This config option is used to take an existing HTML element and place it in the body
500 * of a new panel (it simply moves the specified DOM element into the body element of the Panel
501 * <i>when the Panel is rendered</i> to use as the content (it is not going to be the
502 * actual panel itself).</div>
504 * <li><b>Notes</b> : <ul>
505 * <div class="sub-desc">The specified HTML Element is appended to the Panel's {@link #body} Element by the
506 * Panel's {@link #afterRender} method <i>after any configured {@link #html HTML} has
507 * been inserted</i>, and so the document will not contain this HTML at the time the
508 * {@link #render} event is fired.</div>
509 * <div class="sub-desc">The specified HTML element used will not participate in any layout scheme that the
510 * Panel may use. It's just HTML. Layouts operate on child items.</div>
511 * <div class="sub-desc">Add either the <tt>x-hidden</tt> or the <tt>x-hide-display</tt> CSS class to
512 * prevent a brief flicker of the content before it is rendered to the panel.</div>
517 * @cfg {Object/Array} keys
518 * A {@link Ext.KeyMap} config object (in the format expected by {@link Ext.KeyMap#addBinding}
519 * used to assign custom key handling to this panel (defaults to <tt>null</tt>).
522 * @cfg {Boolean/Object} draggable
523 * <p><tt>true</tt> to enable dragging of this Panel (defaults to <tt>false</tt>).</p>
524 * <p>For custom drag/drop implementations, an <b>Ext.Panel.DD</b> config could also be passed
525 * in this config instead of <tt>true</tt>. Ext.Panel.DD is an internal, undocumented class which
526 * moves a proxy Element around in place of the Panel's element, but provides no other behaviour
527 * during dragging or on drop. It is a subclass of {@link Ext.dd.DragSource}, so behaviour may be
528 * added by implementing the interface methods of {@link Ext.dd.DragDrop} e.g.:
534 renderTo: Ext.getBody(),
540 // Config option of Ext.Panel.DD class.
541 // It's a floating Panel, so do not show a placeholder proxy in the original position.
544 // Called for each mousemove event while dragging the DD object.
545 onDrag : function(e){
546 // Record the x,y position of the drag proxy so that we can
547 // position the Panel at end of drag.
548 var pel = this.proxy.getEl();
549 this.x = pel.getLeft(true);
550 this.y = pel.getTop(true);
552 // Keep the Shadow aligned if there is one.
553 var s = this.panel.getEl().shadow;
555 s.realign(this.x, this.y, pel.getWidth(), pel.getHeight());
559 // Called on the mouseup event.
560 endDrag : function(e){
561 this.panel.setPosition(this.x, this.y);
568 * @cfg {String} tabTip
569 * A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over
570 * the tab of a Ext.Panel which is an item of a {@link Ext.TabPanel}. {@link Ext.QuickTips}.init()
571 * must be called in order for the tips to render.
574 * @cfg {Boolean} disabled
575 * Render this panel disabled (default is <tt>false</tt>). An important note when using the disabled
576 * config on panels is that IE will often fail to initialize the disabled mask element correectly if
577 * the panel's layout has not yet completed by the time the Panel is disabled during the render process.
578 * If you experience this issue, you may need to instead use the {@link #afterlayout} event to initialize
579 * the disabled state:
588 single: true // important, as many layouts can occur
595 * @cfg {Boolean} autoHeight
596 * <tt>true</tt> to use height:'auto', <tt>false</tt> to use fixed height (defaults to <tt>false</tt>).
597 * <b>Note</b>: Setting <tt>autoHeight:true</tt> means that the browser will manage the panel's height
598 * based on its contents, and that Ext will not manage it at all. If the panel is within a layout that
599 * manages dimensions (<tt>fit</tt>, <tt>border</tt>, etc.) then setting <tt>autoHeight:true</tt>
600 * can cause issues with scrolling and will not generally work as expected since the panel will take
601 * on the height of its contents rather than the height required by the Ext layout.
606 * @cfg {String} baseCls
607 * The base CSS class to apply to this panel's element (defaults to <tt>'x-panel'</tt>).
608 * <p>Another option available by default is to specify <tt>'x-plain'</tt> which strips all styling
609 * except for required attributes for Ext layouts to function (e.g. overflow:hidden).
610 * See <tt>{@link #unstyled}</tt> also.</p>
614 * @cfg {String} collapsedCls
615 * A CSS class to add to the panel's element after it has been collapsed (defaults to
616 * <tt>'x-panel-collapsed'</tt>).
618 collapsedCls : 'x-panel-collapsed',
620 * @cfg {Boolean} maskDisabled
621 * <tt>true</tt> to mask the panel when it is {@link #disabled}, <tt>false</tt> to not mask it (defaults
622 * to <tt>true</tt>). Either way, the panel will always tell its contained elements to disable themselves
623 * when it is disabled, but masking the panel can provide an additional visual cue that the panel is
628 * @cfg {Boolean} animCollapse
629 * <tt>true</tt> to animate the transition when the panel is collapsed, <tt>false</tt> to skip the
630 * animation (defaults to <tt>true</tt> if the {@link Ext.Fx} class is available, otherwise <tt>false</tt>).
632 animCollapse : Ext.enableFx,
634 * @cfg {Boolean} headerAsText
635 * <tt>true</tt> to display the panel <tt>{@link #title}</tt> in the <tt>{@link #header}</tt>,
636 * <tt>false</tt> to hide it (defaults to <tt>true</tt>).
640 * @cfg {String} buttonAlign
641 * The alignment of any {@link #buttons} added to this panel. Valid values are <tt>'right'</tt>,
642 * <tt>'left'</tt> and <tt>'center'</tt> (defaults to <tt>'right'</tt>).
644 buttonAlign : 'right',
646 * @cfg {Boolean} collapsed
647 * <tt>true</tt> to render the panel collapsed, <tt>false</tt> to render it expanded (defaults to
652 * @cfg {Boolean} collapseFirst
653 * <tt>true</tt> to make sure the collapse/expand toggle button always renders first (to the left of)
654 * any other tools in the panel's title bar, <tt>false</tt> to render it last (defaults to <tt>true</tt>).
656 collapseFirst : true,
658 * @cfg {Number} minButtonWidth
659 * Minimum width in pixels of all {@link #buttons} in this panel (defaults to <tt>75</tt>)
663 * @cfg {Boolean} unstyled
664 * Overrides the <tt>{@link #baseCls}</tt> setting to <tt>{@link #baseCls} = 'x-plain'</tt> which renders
665 * the panel unstyled except for required attributes for Ext layouts to function (e.g. overflow:hidden).
668 * @cfg {String} elements
669 * A comma-delimited list of panel elements to initialize when the panel is rendered. Normally, this list will be
670 * generated automatically based on the items added to the panel at config time, but sometimes it might be useful to
671 * make sure a structural element is rendered even if not specified at config time (for example, you may want
672 * to add a button or toolbar dynamically after the panel has been rendered). Adding those elements to this
673 * list will allocate the required placeholders in the panel when it is rendered. Valid values are<div class="mdetail-params"><ul>
674 * <li><tt>header</tt></li>
675 * <li><tt>tbar</tt> (top bar)</li>
676 * <li><tt>body</tt></li>
677 * <li><tt>bbar</tt> (bottom bar)</li>
678 * <li><tt>footer</tt></li>
680 * Defaults to '<tt>body</tt>'.
684 * @cfg {Boolean} preventBodyReset
685 * Defaults to <tt>false</tt>. When set to <tt>true</tt>, an extra css class <tt>'x-panel-normal'</tt>
686 * will be added to the panel's element, effectively applying css styles suggested by the W3C
687 * (see http://www.w3.org/TR/CSS21/sample.html) to the Panel's <b>body</b> element (not the header,
690 preventBodyReset : false,
692 // protected - these could be used to customize the behavior of the window,
693 // but changing them would not be useful without further mofifications and
694 // could lead to unexpected or undesirable results.
695 toolTarget : 'header',
696 collapseEl : 'bwrap',
700 // private, notify box this class will handle heights
712 initComponent : function(){
713 Ext.Panel.superclass.initComponent.call(this);
718 * Fires after the Panel has been resized.
719 * @param {Ext.Panel} p the Panel which has been resized.
720 * @param {Number} width The Panel's new width.
721 * @param {Number} height The Panel's new height.
726 * Fires after the Panel title has been {@link #title set} or {@link #setTitle changed}.
727 * @param {Ext.Panel} p the Panel which has had its title changed.
728 * @param {String} The new title.
733 * Fires after the Panel icon class has been {@link #iconCls set} or {@link #setIconClass changed}.
734 * @param {Ext.Panel} p the Panel which has had its {@link #iconCls icon class} changed.
735 * @param {String} The new icon class.
736 * @param {String} The old icon class.
741 * Fires after the Panel has been collapsed.
742 * @param {Ext.Panel} p the Panel that has been collapsed.
747 * Fires after the Panel has been expanded.
748 * @param {Ext.Panel} p The Panel that has been expanded.
752 * @event beforecollapse
753 * Fires before the Panel is collapsed. A handler can return false to cancel the collapse.
754 * @param {Ext.Panel} p the Panel being collapsed.
755 * @param {Boolean} animate True if the collapse is animated, else false.
759 * @event beforeexpand
760 * Fires before the Panel is expanded. A handler can return false to cancel the expand.
761 * @param {Ext.Panel} p The Panel being expanded.
762 * @param {Boolean} animate True if the expand is animated, else false.
767 * Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
768 * Panel subclasses do (like {@link Ext.Window}) or a Panel within a Ext.TabPanel. This event only
769 * applies to such subclasses.
770 * A handler can return false to cancel the close.
771 * @param {Ext.Panel} p The Panel being closed.
776 * Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
777 * Panel subclasses do (like {@link Ext.Window}) or a Panel within a Ext.TabPanel.
778 * @param {Ext.Panel} p The Panel that has been closed.
783 * Fires after the Panel has been visually activated.
784 * Note that Panels do not directly support being activated, but some Panel subclasses
785 * do (like {@link Ext.Window}). Panels which are child Components of a TabPanel fire the
786 * activate and deactivate events under the control of the TabPanel.
787 * @param {Ext.Panel} p The Panel that has been activated.
792 * Fires after the Panel has been visually deactivated.
793 * Note that Panels do not directly support being deactivated, but some Panel subclasses
794 * do (like {@link Ext.Window}). Panels which are child Components of a TabPanel fire the
795 * activate and deactivate events under the control of the TabPanel.
796 * @param {Ext.Panel} p The Panel that has been deactivated.
802 this.baseCls = 'x-plain';
807 this.elements += ',tbar';
808 if(Ext.isObject(this.tbar)){
809 this.topToolbar = this.tbar;
814 this.elements += ',bbar';
815 if(Ext.isObject(this.bbar)){
816 this.bottomToolbar = this.bbar;
821 if(this.header === true){
822 this.elements += ',header';
824 }else if(this.headerCfg || (this.title && this.header !== false)){
825 this.elements += ',header';
828 if(this.footerCfg || this.footer === true){
829 this.elements += ',footer';
834 this.elements += ',footer';
835 var btns = this.buttons;
837 * This Panel's Array of buttons as created from the <tt>{@link #buttons}</tt>
838 * config property. Read only.
843 for(var i = 0, len = btns.length; i < len; i++) {
844 if(btns[i].render){ // button instance
845 this.buttons.push(btns[i]);
846 }else if(btns[i].xtype){
847 this.buttons.push(Ext.create(btns[i], 'button'));
849 this.addButton(btns[i]);
854 this.elements += ',footer';
857 this.on('render', this.doAutoLoad, this, {delay:10});
862 createElement : function(name, pnode){
864 pnode.appendChild(this[name].dom);
868 if(name === 'bwrap' || this.elements.indexOf(name) != -1){
869 if(this[name+'Cfg']){
870 this[name] = Ext.fly(pnode).createChild(this[name+'Cfg']);
872 var el = document.createElement('div');
873 el.className = this[name+'Cls'];
874 this[name] = Ext.get(pnode.appendChild(el));
876 if(this[name+'CssClass']){
877 this[name].addClass(this[name+'CssClass']);
879 if(this[name+'Style']){
880 this[name].applyStyles(this[name+'Style']);
886 onRender : function(ct, position){
887 Ext.Panel.superclass.onRender.call(this, ct, position);
888 this.createClasses();
893 el.addClass(this.baseCls);
894 if(d.firstChild){ // existing markup
895 this.header = el.down('.'+this.headerCls);
896 this.bwrap = el.down('.'+this.bwrapCls);
897 var cp = this.bwrap ? this.bwrap : el;
898 this.tbar = cp.down('.'+this.tbarCls);
899 this.body = cp.down('.'+this.bodyCls);
900 this.bbar = cp.down('.'+this.bbarCls);
901 this.footer = cp.down('.'+this.footerCls);
902 this.fromMarkup = true;
904 if (this.preventBodyReset === true) {
905 el.addClass('x-panel-reset');
908 el.addClass(this.cls);
912 this.elements += ',footer';
915 // This block allows for maximum flexibility and performance when using existing markup
917 // framing requires special markup
919 el.insertHtml('afterBegin', String.format(Ext.Element.boxMarkup, this.baseCls));
921 this.createElement('header', d.firstChild.firstChild.firstChild);
922 this.createElement('bwrap', d);
924 // append the mid and bottom frame to the bwrap
926 var ml = d.childNodes[1], bl = d.childNodes[2];
930 var mc = bw.firstChild.firstChild.firstChild;
931 this.createElement('tbar', mc);
932 this.createElement('body', mc);
933 this.createElement('bbar', mc);
934 this.createElement('footer', bw.lastChild.firstChild.firstChild);
937 this.bwrap.dom.lastChild.className += ' x-panel-nofooter';
940 this.createElement('header', d);
941 this.createElement('bwrap', d);
943 // append the mid and bottom frame to the bwrap
945 this.createElement('tbar', bw);
946 this.createElement('body', bw);
947 this.createElement('bbar', bw);
948 this.createElement('footer', bw);
951 this.body.addClass(this.bodyCls + '-noheader');
953 this.tbar.addClass(this.tbarCls + '-noheader');
958 if(this.padding !== undefined) {
959 this.body.setStyle('padding', this.body.addUnits(this.padding));
962 if(this.border === false){
963 this.el.addClass(this.baseCls + '-noborder');
964 this.body.addClass(this.bodyCls + '-noborder');
966 this.header.addClass(this.headerCls + '-noborder');
969 this.footer.addClass(this.footerCls + '-noborder');
972 this.tbar.addClass(this.tbarCls + '-noborder');
975 this.bbar.addClass(this.bbarCls + '-noborder');
979 if(this.bodyBorder === false){
980 this.body.addClass(this.bodyCls + '-noborder');
983 this.bwrap.enableDisplayMode('block');
986 this.header.unselectable();
988 // for tools, we need to wrap any existing header markup
989 if(this.headerAsText){
990 this.header.dom.innerHTML =
991 '<span class="' + this.headerTextCls + '">'+this.header.dom.innerHTML+'</span>';
994 this.setIconClass(this.iconCls);
1000 this.makeFloating(this.floating);
1003 if(this.collapsible){
1004 this.tools = this.tools ? this.tools.slice(0) : [];
1005 if(!this.hideCollapseTool){
1006 this.tools[this.collapseFirst?'unshift':'push']({
1008 handler : this.toggleCollapse,
1012 if(this.titleCollapse && this.header){
1013 this.mon(this.header, 'click', this.toggleCollapse, this);
1014 this.header.setStyle('cursor', 'pointer');
1018 var ts = this.tools;
1020 this.addTool.apply(this, ts);
1025 if(this.buttons && this.buttons.length > 0){
1026 this.fbar = new Ext.Toolbar({
1027 items: this.buttons,
1028 toolbarCls: 'x-panel-fbar'
1033 this.fbar = Ext.create(this.fbar, 'toolbar');
1034 this.fbar.enableOverflow = false;
1035 if(this.fbar.items){
1036 this.fbar.items.each(function(c){
1037 c.minWidth = c.minWidth || this.minButtonWidth;
1040 this.fbar.toolbarCls = 'x-panel-fbar';
1042 var bct = this.footer.createChild({cls: 'x-panel-btns x-panel-btns-'+this.buttonAlign});
1043 this.fbar.ownerCt = this;
1044 this.fbar.render(bct);
1045 bct.createChild({cls:'x-clear'});
1046 this.toolbars.push(this.fbar);
1049 if(this.tbar && this.topToolbar){
1050 if(Ext.isArray(this.topToolbar)){
1051 this.topToolbar = new Ext.Toolbar(this.topToolbar);
1052 }else if(!this.topToolbar.events){
1053 this.topToolbar = Ext.create(this.topToolbar, 'toolbar');
1055 this.topToolbar.ownerCt = this;
1056 this.topToolbar.render(this.tbar);
1057 this.toolbars.push(this.topToolbar);
1059 if(this.bbar && this.bottomToolbar){
1060 if(Ext.isArray(this.bottomToolbar)){
1061 this.bottomToolbar = new Ext.Toolbar(this.bottomToolbar);
1062 }else if(!this.bottomToolbar.events){
1063 this.bottomToolbar = Ext.create(this.bottomToolbar, 'toolbar');
1065 this.bottomToolbar.ownerCt = this;
1066 this.bottomToolbar.render(this.bbar);
1067 this.toolbars.push(this.bottomToolbar);
1069 Ext.each(this.toolbars, function(tb){
1072 afterlayout: this.syncHeight,
1073 remove: this.syncHeight
1079 * Sets the CSS class that provides the icon image for this panel. This method will replace any existing
1080 * icon class if one has already been set and fire the {@link #iconchange} event after completion.
1081 * @param {String} cls The new CSS class name
1083 setIconClass : function(cls){
1084 var old = this.iconCls;
1086 if(this.rendered && this.header){
1088 this.header.addClass('x-panel-icon');
1089 this.header.replaceClass(old, this.iconCls);
1091 var hd = this.header.dom;
1092 var img = hd.firstChild && String(hd.firstChild.tagName).toLowerCase() == 'img' ? hd.firstChild : null;
1094 Ext.fly(img).replaceClass(old, this.iconCls);
1096 Ext.DomHelper.insertBefore(hd.firstChild, {
1097 tag:'img', src: Ext.BLANK_IMAGE_URL, cls:'x-panel-inline-icon '+this.iconCls
1102 this.fireEvent('iconchange', this, cls, old);
1106 makeFloating : function(cfg){
1107 this.floating = true;
1108 this.el = new Ext.Layer(
1109 Ext.isObject(cfg) ? cfg : {
1110 shadow: this.shadow !== undefined ? this.shadow : 'sides',
1111 shadowOffset: this.shadowOffset,
1113 shim: this.shim === false ? false : undefined
1119 * Returns the {@link Ext.Toolbar toolbar} from the top (<tt>{@link #tbar}</tt>) section of the panel.
1120 * @return {Ext.Toolbar} The toolbar
1122 getTopToolbar : function(){
1123 return this.topToolbar;
1127 * Returns the {@link Ext.Toolbar toolbar} from the bottom (<tt>{@link #bbar}</tt>) section of the panel.
1128 * @return {Ext.Toolbar} The toolbar
1130 getBottomToolbar : function(){
1131 return this.bottomToolbar;
1135 * Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
1136 * approach is to add buttons via the {@link #buttons} config.
1137 * @param {String/Object} config A valid {@link Ext.Button} config. A string will become the text for a default
1138 * button config, an object will be treated as a button config object.
1139 * @param {Function} handler The function to be called on button {@link Ext.Button#click}
1140 * @param {Object} scope The scope to use for the button handler function
1141 * @return {Ext.Button} The button that was added
1143 addButton : function(config, handler, scope){
1147 minWidth: this.minButtonWidth,
1150 if(typeof config == "string"){
1153 Ext.apply(bc, config);
1155 var btn = new Ext.Button(bc);
1159 this.buttons.push(btn);
1164 addTool : function(){
1165 if(!this[this.toolTarget]) { // no where to render tools!
1168 if(!this.toolTemplate){
1169 // initialize the global tool template on first use
1170 var tt = new Ext.Template(
1171 '<div class="x-tool x-tool-{id}"> </div>'
1173 tt.disableFormats = true;
1175 Ext.Panel.prototype.toolTemplate = tt;
1177 for(var i = 0, a = arguments, len = a.length; i < len; i++) {
1179 if(!this.tools[tc.id]){
1180 var overCls = 'x-tool-'+tc.id+'-over';
1181 var t = this.toolTemplate.insertFirst((tc.align !== 'left') ? this[this.toolTarget] : this[this.toolTarget].child('span'), tc, true);
1182 this.tools[tc.id] = t;
1183 t.enableDisplayMode('block');
1184 this.mon(t, 'click', this.createToolHandler(t, tc, overCls, this));
1192 if(Ext.isObject(tc.qtip)){
1193 Ext.QuickTips.register(Ext.apply({
1197 t.dom.qtip = tc.qtip;
1200 t.addClassOnOver(overCls);
1205 onLayout : function(){
1206 if(this.toolbars.length > 0){
1207 this.duringLayout = true;
1208 Ext.each(this.toolbars, function(tb){
1211 delete this.duringLayout;
1216 syncHeight : function(){
1217 if(!(this.autoHeight || this.duringLayout)){
1218 var last = this.lastSize;
1219 if(last && !Ext.isEmpty(last.height)){
1220 var old = last.height, h = this.el.getHeight();
1221 if(old != 'auto' && old != h){
1222 var bd = this.body, bdh = bd.getHeight();
1223 h = Math.max(bdh + old - h, 0);
1224 if(bdh > 0 && bdh != h){
1226 if(Ext.isIE && h <= 0){
1229 var sz = bd.getSize();
1230 this.fireEvent('bodyresize', sz.width, sz.height);
1238 onShow : function(){
1240 return this.el.show();
1242 Ext.Panel.superclass.onShow.call(this);
1246 onHide : function(){
1248 return this.el.hide();
1250 Ext.Panel.superclass.onHide.call(this);
1254 createToolHandler : function(t, tc, overCls, panel){
1256 t.removeClass(overCls);
1257 if(tc.stopEvent !== false){
1261 tc.handler.call(tc.scope || t, e, t, panel, tc);
1267 afterRender : function(){
1268 if(this.floating && !this.hidden){
1272 this.setTitle(this.title);
1274 this.setAutoScroll();
1276 this.body.update(Ext.isObject(this.html) ?
1277 Ext.DomHelper.markup(this.html) :
1282 var ce = Ext.getDom(this.contentEl);
1283 Ext.fly(ce).removeClass(['x-hidden', 'x-hide-display']);
1284 this.body.dom.appendChild(ce);
1287 this.collapsed = false;
1288 this.collapse(false);
1290 Ext.Panel.superclass.afterRender.call(this); // do sizing calcs last
1295 setAutoScroll : function(){
1296 if(this.rendered && this.autoScroll){
1297 var el = this.body || this.el;
1299 el.setOverflow('auto');
1305 getKeyMap : function(){
1307 this.keyMap = new Ext.KeyMap(this.el, this.keys);
1313 initEvents : function(){
1318 this.initDraggable();
1323 initDraggable : function(){
1325 * <p>If this Panel is configured {@link #draggable}, this property will contain
1326 * an instance of {@link Ext.dd.DragSource} which handles dragging the Panel.</p>
1327 * The developer must provide implementations of the abstract methods of {@link Ext.dd.DragSource}
1328 * in order to supply behaviour for each stage of the drag/drop process. See {@link #draggable}.
1329 * @type Ext.dd.DragSource.
1332 this.dd = new Ext.Panel.DD(this, typeof this.draggable == 'boolean' ? null : this.draggable);
1336 beforeEffect : function(){
1338 this.el.beforeAction();
1340 this.el.addClass('x-panel-animated');
1344 afterEffect : function(){
1346 this.el.removeClass('x-panel-animated');
1349 // private - wraps up an animation param with internal callbacks
1350 createEffect : function(a, cb, scope){
1358 }else if(!a.callback){
1360 }else { // wrap it up
1361 o.callback = function(){
1363 Ext.callback(a.callback, a.scope);
1366 return Ext.applyIf(o, a);
1370 * Collapses the panel body so that it becomes hidden. Fires the {@link #beforecollapse} event which will
1371 * cancel the collapse action if it returns false.
1372 * @param {Boolean} animate True to animate the transition, else false (defaults to the value of the
1373 * {@link #animCollapse} panel config)
1374 * @return {Ext.Panel} this
1376 collapse : function(animate){
1377 if(this.collapsed || this.el.hasFxBlock() || this.fireEvent('beforecollapse', this, animate) === false){
1380 var doAnim = animate === true || (animate !== false && this.animCollapse);
1381 this.beforeEffect();
1382 this.onCollapse(doAnim, animate);
1387 onCollapse : function(doAnim, animArg){
1389 this[this.collapseEl].slideOut(this.slideAnchor,
1390 Ext.apply(this.createEffect(animArg||true, this.afterCollapse, this),
1391 this.collapseDefaults));
1393 this[this.collapseEl].hide();
1394 this.afterCollapse();
1399 afterCollapse : function(){
1400 this.collapsed = true;
1401 this.el.addClass(this.collapsedCls);
1403 this.fireEvent('collapse', this);
1407 * Expands the panel body so that it becomes visible. Fires the {@link #beforeexpand} event which will
1408 * cancel the expand action if it returns false.
1409 * @param {Boolean} animate True to animate the transition, else false (defaults to the value of the
1410 * {@link #animCollapse} panel config)
1411 * @return {Ext.Panel} this
1413 expand : function(animate){
1414 if(!this.collapsed || this.el.hasFxBlock() || this.fireEvent('beforeexpand', this, animate) === false){
1417 var doAnim = animate === true || (animate !== false && this.animCollapse);
1418 this.el.removeClass(this.collapsedCls);
1419 this.beforeEffect();
1420 this.onExpand(doAnim, animate);
1425 onExpand : function(doAnim, animArg){
1427 this[this.collapseEl].slideIn(this.slideAnchor,
1428 Ext.apply(this.createEffect(animArg||true, this.afterExpand, this),
1429 this.expandDefaults));
1431 this[this.collapseEl].show();
1437 afterExpand : function(){
1438 this.collapsed = false;
1440 if(this.deferLayout !== undefined){
1441 this.doLayout(true);
1443 this.fireEvent('expand', this);
1447 * Shortcut for performing an {@link #expand} or {@link #collapse} based on the current state of the panel.
1448 * @param {Boolean} animate True to animate the transition, else false (defaults to the value of the
1449 * {@link #animCollapse} panel config)
1450 * @return {Ext.Panel} this
1452 toggleCollapse : function(animate){
1453 this[this.collapsed ? 'expand' : 'collapse'](animate);
1458 onDisable : function(){
1459 if(this.rendered && this.maskDisabled){
1462 Ext.Panel.superclass.onDisable.call(this);
1466 onEnable : function(){
1467 if(this.rendered && this.maskDisabled){
1470 Ext.Panel.superclass.onEnable.call(this);
1474 onResize : function(w, h){
1475 if(w !== undefined || h !== undefined){
1476 if(!this.collapsed){
1477 if(typeof w == 'number'){
1478 w = this.adjustBodyWidth(w - this.getFrameWidth());
1480 this.tbar.setWidth(w);
1481 if(this.topToolbar){
1482 this.topToolbar.setSize(w);
1486 this.bbar.setWidth(w);
1487 if(this.bottomToolbar){
1488 this.bottomToolbar.setSize(w);
1494 strict = Ext.isStrict;
1495 if(this.buttonAlign == 'left'){
1496 fWidth = w - f.container.getFrameWidth('lr');
1498 //center/right alignment off in webkit
1499 if(Ext.isIE || Ext.isWebKit){
1500 //center alignment ok on webkit.
1501 //right broken in both, center on IE
1502 if(!(this.buttonAlign == 'center' && Ext.isWebKit) && (!strict || (!Ext.isIE8 && strict))){
1504 f.setWidth(f.getEl().child('.x-toolbar-ct').getWidth());
1515 this.body.setWidth(w);
1516 }else if(w == 'auto'){
1517 this.body.setWidth(w);
1520 if(typeof h == 'number'){
1521 h = Math.max(0, this.adjustBodyHeight(h - this.getFrameHeight()));
1522 this.body.setHeight(h);
1523 }else if(h == 'auto'){
1524 this.body.setHeight(h);
1527 if(this.disabled && this.el._mask){
1528 this.el._mask.setSize(this.el.dom.clientWidth, this.el.getHeight());
1531 this.queuedBodySize = {width: w, height: h};
1532 if(!this.queuedExpand && this.allowQueuedExpand !== false){
1533 this.queuedExpand = true;
1534 this.on('expand', function(){
1535 delete this.queuedExpand;
1536 this.onResize(this.queuedBodySize.width, this.queuedBodySize.height);
1538 }, this, {single:true});
1541 this.fireEvent('bodyresize', this, w, h);
1547 adjustBodyHeight : function(h){
1552 adjustBodyWidth : function(w){
1557 onPosition : function(){
1562 * Returns the width in pixels of the framing elements of this panel (not including the body width). To
1563 * retrieve the body width see {@link #getInnerWidth}.
1564 * @return {Number} The frame width
1566 getFrameWidth : function(){
1567 var w = this.el.getFrameWidth('lr')+this.bwrap.getFrameWidth('lr');
1570 var l = this.bwrap.dom.firstChild;
1571 w += (Ext.fly(l).getFrameWidth('l') + Ext.fly(l.firstChild).getFrameWidth('r'));
1572 var mc = this.bwrap.dom.firstChild.firstChild.firstChild;
1573 w += Ext.fly(mc).getFrameWidth('lr');
1579 * Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
1580 * header and footer elements, but not including the body height). To retrieve the body height see {@link #getInnerHeight}.
1581 * @return {Number} The frame height
1583 getFrameHeight : function(){
1584 var h = this.el.getFrameWidth('tb')+this.bwrap.getFrameWidth('tb');
1585 h += (this.tbar ? this.tbar.getHeight() : 0) +
1586 (this.bbar ? this.bbar.getHeight() : 0);
1589 var hd = this.el.dom.firstChild;
1590 var ft = this.bwrap.dom.lastChild;
1591 h += (hd.offsetHeight + ft.offsetHeight);
1592 var mc = this.bwrap.dom.firstChild.firstChild.firstChild;
1593 h += Ext.fly(mc).getFrameWidth('tb');
1595 h += (this.header ? this.header.getHeight() : 0) +
1596 (this.footer ? this.footer.getHeight() : 0);
1602 * Returns the width in pixels of the body element (not including the width of any framing elements).
1603 * For the frame width see {@link #getFrameWidth}.
1604 * @return {Number} The body width
1606 getInnerWidth : function(){
1607 return this.getSize().width - this.getFrameWidth();
1611 * Returns the height in pixels of the body element (not including the height of any framing elements).
1612 * For the frame height see {@link #getFrameHeight}.
1613 * @return {Number} The body height
1615 getInnerHeight : function(){
1616 return this.getSize().height - this.getFrameHeight();
1620 syncShadow : function(){
1627 getLayoutTarget : function(){
1632 * <p>Sets the title text for the panel and optionally the {@link #iconCls icon class}.</p>
1633 * <p>In order to be able to set the title, a header element must have been created
1634 * for the Panel. This is triggered either by configuring the Panel with a non-blank <tt>{@link #title}</tt>,
1635 * or configuring it with <tt><b>{@link #header}: true</b></tt>.</p>
1636 * @param {String} title The title text to set
1637 * @param {String} iconCls (optional) {@link #iconCls iconCls} A user-defined CSS class that provides the icon image for this panel
1639 setTitle : function(title, iconCls){
1641 if(this.header && this.headerAsText){
1642 this.header.child('span').update(title);
1645 this.setIconClass(iconCls);
1647 this.fireEvent('titlechange', this, title);
1652 * Get the {@link Ext.Updater} for this panel. Enables you to perform Ajax updates of this panel's body.
1653 * @return {Ext.Updater} The Updater
1655 getUpdater : function(){
1656 return this.body.getUpdater();
1660 * Loads this content panel immediately with content returned from an XHR call.
1661 * @param {Object/String/Function} config A config object containing any of the following options:
1664 url: "your-url.php",
1665 params: {param1: "foo", param2: "bar"}, // or a URL encoded string
1666 callback: yourFunction,
1667 scope: yourObject, // optional scope for the callback
1675 * The only required property is url. The optional properties nocache, text and scripts
1676 * are shorthand for disableCaching, indicatorText and loadScripts and are used to set their
1677 * associated property on this panel Updater instance.
1678 * @return {Ext.Panel} this
1681 var um = this.body.getUpdater();
1682 um.update.apply(um, arguments);
1687 beforeDestroy : function(){
1689 this.header.removeAllListeners();
1690 if(this.headerAsText){
1691 Ext.Element.uncache(this.header.child('span'));
1694 Ext.Element.uncache(
1703 for(var k in this.tools){
1704 Ext.destroy(this.tools[k]);
1708 for(var b in this.buttons){
1709 Ext.destroy(this.buttons[b]);
1712 Ext.destroy(this.toolbars);
1713 Ext.Panel.superclass.beforeDestroy.call(this);
1717 createClasses : function(){
1718 this.headerCls = this.baseCls + '-header';
1719 this.headerTextCls = this.baseCls + '-header-text';
1720 this.bwrapCls = this.baseCls + '-bwrap';
1721 this.tbarCls = this.baseCls + '-tbar';
1722 this.bodyCls = this.baseCls + '-body';
1723 this.bbarCls = this.baseCls + '-bbar';
1724 this.footerCls = this.baseCls + '-footer';
1728 createGhost : function(cls, useShim, appendTo){
1729 var el = document.createElement('div');
1730 el.className = 'x-panel-ghost ' + (cls ? cls : '');
1732 el.appendChild(this.el.dom.firstChild.cloneNode(true));
1734 Ext.fly(el.appendChild(document.createElement('ul'))).setHeight(this.bwrap.getHeight());
1735 el.style.width = this.el.dom.offsetWidth + 'px';;
1737 this.container.dom.appendChild(el);
1739 Ext.getDom(appendTo).appendChild(el);
1741 if(useShim !== false && this.el.useShim !== false){
1742 var layer = new Ext.Layer({shadow:false, useDisplay:true, constrain:false}, el);
1746 return new Ext.Element(el);
1751 doAutoLoad : function(){
1752 var u = this.body.getUpdater();
1754 u.setRenderer(this.renderer);
1756 u.update(Ext.isObject(this.autoLoad) ? this.autoLoad : {url: this.autoLoad});
1760 * Retrieve a tool by id.
1761 * @param {String} id
1762 * @return {Object} tool
1764 getTool : function(id) {
1765 return this.tools[id];
1769 * @cfg {String} autoEl @hide
1772 Ext.reg('panel', Ext.Panel);