📄 panel.js
字号:
/*
* Ext JS Library 2.2.1
* Copyright(c) 2006-2009, Ext JS, LLC.
* licensing@extjs.com
*
* http://extjs.com/license
*/
/**
* @class Ext.Panel
* @extends Ext.Container
* Panel is a container that has specific functionality and structural components that make it the perfect building
* block for application-oriented user interfaces. The Panel contains bottom and top toolbars, along with separate
* header, footer and body sections. It also provides built-in expandable and collapsible behavior, along with a
* variety of prebuilt tool buttons that can be wired up to provide other customized behavior. Panels can be easily
* dropped into any Container or layout, and the layout and rendering pipeline is completely managed by the framework.
* @constructor
* @param {Object} config The config object
*/
Ext.Panel = Ext.extend(Ext.Container, {
/**
* The Panel's header {@link Ext.Element Element}. Read-only.
* <p>This Element is used to house the {@link #title} and {@link #tools}</p>
* @type Ext.Element
* @property header
*/
/**
* The Panel's body {@link Ext.Element Element} which may be used to contain HTML content.
* The content may be specified in the {@link #html} config, or it may be loaded using the
* {@link autoLoad} config, or through the Panel's {@link #getUpdater Updater}. Read-only.
* <p>If this is used to load visible HTML elements in either way, then
* the Panel may not be used as a Layout for hosting nested Panels.</p>
* <p>If this Panel is intended to be used as the host of a Layout (See {@link #layout}
* then the body Element must not be loaded or changed - it is under the control
* of the Panel's Layout.
* @type Ext.Element
* @property body
*/
/**
* @cfg {Object} bodyCfg
* <p>A {@link Ext.DomHelper DomHelper} configuration object specifying the element structure
* of this Panel's {@link #body} Element.</p>
* <p>This may be used to force the body Element to use a different form of markup than
* is created automatically. An example of this might be to create a child Panel containing
* custom content, such as a header, or forcing centering of all Panel
* content by having the body be a <center> element:</p><code><pre>
new Ext.Panel({
title: 'New Message',
collapsible: true,
renderTo: Ext.getBody(),
width: 400,
bodyCfg: {
tag: 'center',
cls: 'x-panel-body'
},
items: [{
border: false,
header: false,
bodyCfg: {tag: 'h2', html: 'Message'}
}, {
xtype: 'textarea',
style: {
width: '95%',
marginBottom: '10px'
}
},
new Ext.Button({
text: 'Send',
minWidth: '100',
style: {
marginBottom: '10px'
}
})
]
});</pre></code>
*/
/**
* The Panel's footer {@link Ext.Element Element}. Read-only.
* <p>This Element is used to house the Panel's {@link #buttons}.</p>
* @type Ext.Element
* @property footer
*/
/**
* @cfg {Mixed} applyTo
* The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in
* the document that specifies some panel-specific structural markup. When applyTo is used, constituent parts of
* the panel can be specified by CSS class name within the main element, and the panel will automatically create those
* components from that markup. Any required components not specified in the markup will be autogenerated if necessary.
* The following class names are supported (baseCls will be replaced by {@link #baseCls}):
* <ul><li>baseCls + '-header'</li>
* <li>baseCls + '-header-text'</li>
* <li>baseCls + '-bwrap'</li>
* <li>baseCls + '-tbar'</li>
* <li>baseCls + '-body'</li>
* <li>baseCls + '-bbar'</li>
* <li>baseCls + '-footer'</li></ul>
* Using this config, a call to render() is not required. If applyTo is specified, any value passed for
* {@link #renderTo} will be ignored and the target element's parent node will automatically be used as the panel's container.
*/
/**
* @cfg {Object/Array} tbar
* The top toolbar of the panel. This can be either an {@link Ext.Toolbar} object or an array of
* buttons/button configs to be added to the toolbar. Note that this is not available as a property after render.
* To access the top toolbar after render, use {@link #getTopToolbar}.
*/
/**
* @cfg {Object/Array} bbar
* The bottom toolbar of the panel. This can be either an {@link Ext.Toolbar} object or an array of
* buttons/button configs to be added to the toolbar. Note that this is not available as a property after render.
* To access the bottom toolbar after render, use {@link #getBottomToolbar}.
*/
/**
* @cfg {Boolean} header
* True to create the header element explicitly, false to skip creating it. By default, when header is not
* specified, if a {@link #title} is set the header will be created automatically, otherwise it will not. If
* a title is set but header is explicitly set to false, the header will not be rendered.
*/
/**
* @cfg {Boolean} footer
* True to create the footer element explicitly, false to skip creating it. By default, when footer is not
* specified, if one or more buttons have been added to the panel the footer will be created automatically,
* otherwise it will not.
*/
/**
* @cfg {String} title
* The title text to display in the panel header (defaults to ''). When a title is specified the header
* element will automatically be created and displayed unless {@link #header} is explicitly set to false. If
* you don't want to specify a title at config time, but you may want one later, you must either specify a
* non-empty title (a blank space ' ' will do) or header:true so that the container element will get created.
*/
/**
* @cfg {Array} buttons
* An array of {@link Ext.Button}s or {@link Ext.Button} configs used to add buttons to the footer of this panel.
*/
/**
* @cfg {Object/String/Function} autoLoad
* A valid url spec according to the Updater {@link Ext.Updater#update} method.
* If autoLoad is not null, the panel will attempt to load its contents
* immediately upon render.<p>
* The URL will become the default URL for this panel's {@link #body} element,
* so it may be {@link Ext.Element#refresh refresh}ed at any time.</p>
*/
/**
* @cfg {Boolean} frame
* True to render the panel with custom rounded borders, false to render with plain 1px square borders (defaults to false).
*/
/**
* @cfg {Boolean} border
* True to display the borders of the panel's body element, false to hide them (defaults to true). By default,
* the border is a 2px wide inset border, but this can be further altered by setting {@link #bodyBorder} to false.
*/
/**
* @cfg {Boolean} bodyBorder
* True to display an interior border on the body element of the panel, false to hide it (defaults to true).
* This only applies when {@link #border} == true. If border == true and bodyBorder == false, the border will display
* as a 1px wide inset border, giving the entire body element an inset appearance.
*/
/**
* @cfg {String/Object/Function} bodyStyle
* Custom CSS styles to be applied to the body element in the format expected by {@link Ext.Element#applyStyles}
* (defaults to null).
*/
/**
* @cfg {String} iconCls
* A CSS class that will provide a background image to be used as the header icon (defaults to ''). An example
* custom icon class would be something like: .my-icon { background: url(../images/my-icon.gif) 0 6px no-repeat !important;}
*/
/**
* @cfg {Boolean} collapsible
* True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into
* the header tool button area, false to keep the panel statically sized with no button (defaults to false).
*/
/**
* @cfg {Array} tools
* An array of tool button configs to be added to the header tool area. When rendered, each tool is
* stored as an {@link Ext.Element Element} referenced by a public property called <tt><b></b>tools.<i><tool-type></i></tt>
* <p>Each tool config may contain the following properties:
* <div class="mdetail-params"><ul>
* <li><b>id</b> : String<div class="sub-desc"><b>Required.</b> The type
* of tool to create. Values may be<ul>
* <li><tt>toggle</tt> (Created by default when {@link #collapsible} is <tt>true</tt>)</li>
* <li><tt>close</tt></li>
* <li><tt>minimize</tt></li>
* <li><tt>maximize</tt></li>
* <li><tt>restore</tt></li>
* <li><tt>gear</tt></li>
* <li><tt>pin</tt></li>
* <li><tt>unpin</tt></li>
* <li><tt>right</tt></li>
* <li><tt>left</tt></li>
* <li><tt>up</tt></li>
* <li><tt>down</tt></li>
* <li><tt>refresh</tt></li>
* <li><tt>minus</tt></li>
* <li><tt>plus</tt></li>
* <li><tt>help</tt></li>
* <li><tt>search</tt></li>
* <li><tt>save</tt></li>
* <li><tt>print</tt></li>
* </ul></div></li>
* <li><b>handler</b> : Function<div class="sub-desc"><b>Required.</b> The function to
* call when clicked. Arguments passed are:<ul>
* <li><b>event</b> : Ext.EventObject<div class="sub-desc">The click event.</div></li>
* <li><b>toolEl</b> : Ext.Element<div class="sub-desc">The tool Element.</div></li>
* <li><b>Panel</b> : Ext.Panel<div class="sub-desc">The host Panel</div></li>
* </ul></div></li>
* <li><b>scope</b> : Object<div class="sub-desc">The scope in which to call the handler.</div></li>
* <li><b>qtip</b> : String/Object<div class="sub-desc">A tip string, or
* a config argument to {@link Ext.QuickTip#register}</div></li>
* <li><b>hidden</b> : Boolean<div class="sub-desc">True to initially render hidden.</div></li>
* <li><b>on</b> : Object<div class="sub-desc">A listener config object specifiying
* event listeners in the format of an argument to {@link #addListener}</div></li>
* </ul></div>
* Example usage:
* <pre><code>
tools:[{
id:'refresh',
qtip: 'Refresh form Data',
// hidden:true,
handler: function(event, toolEl, panel){
// refresh logic
}
}]
</code></pre>
* Note that apart from the toggle tool which is provided when a panel is
* collapsible, these tools only provide the visual button. Any required
* functionality must be provided by adding handlers that implement the
* necessary behavior.
*/
/**
* @cfg {Boolean} hideCollapseTool
* True to hide the expand/collapse toggle button when {@link #collapsible} = true, false to display it (defaults to false).
*/
/**
* @cfg {Boolean} titleCollapse
* True to allow expanding and collapsing the panel (when {@link #collapsible} = true) by clicking anywhere in the
* header bar, false to allow it only by clicking to tool button (defaults to false).
*/
/**
* @cfg {Boolean} autoScroll
* True to use overflow:'auto' on the panel's body element and show scroll bars automatically when necessary,
* false to clip any overflowing content (defaults to false).
*/
/**
* @cfg {Boolean} floating
* True to float the panel (absolute position it with automatic shimming and shadow), false to display it
* inline where it is rendered (defaults to false). Note that by default, setting floating to true will cause the
* panel to display at negative offsets so that it is hidden -- because the panel is absolute positioned, the
* position must be set explicitly after render (e.g., myPanel.setPosition(100,100);). Also, when floating a
* panel you should always assign a fixed width, otherwise it will be auto width and will expand to fill to the
* right edge of the viewport.
*/
/**
* @cfg {Boolean/String} shadow
* True (or a valid Ext.Shadow {@link Ext.Shadow#mode} value) to display a shadow behind the panel, false to
* display no shadow (defaults to 'sides'). Note that this option only applies when floating = true.
*/
/**
* @cfg {Number} shadowOffset
* The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies
* when floating = true.
*/
/**
* @cfg {Boolean} shim
* False to disable the iframe shim in browsers which need one (defaults to true). Note that this option
* only applies when floating = true.
*/
/**
* @cfg {String/Object} html
* An HTML fragment, or a {@link Ext.DomHelper DomHelper} specification to use
* as the panel's body content (defaults to ''). The HTML content is added by the Panel's
* afterRender method, and so the document will not contain this HTML at the time the render
* event is fired. This content is inserted into the body <i>before</i> any configured
* {@link #contentEl} is appended.
*/
/**
* @cfg {String} contentEl
* The id of an existing HTML node to use as the panel's body content (defaults to ''). The
* specified Element is appended to the Panel's body Element by the Panel's afterRender method
* <i>after any configured {@link #html HTML} has been inserted</i>, and so the document will
* not contain this HTML at the time the render event is fired.
*/
/**
* @cfg {Object/Array} keys
* A KeyMap config object (in the format expected by {@link Ext.KeyMap#addBinding} used to assign custom key
* handling to this panel (defaults to null).
*/
/**
* @cfg {Boolean} draggable
* <p>True to enable dragging of this Panel (defaults to false).</p>
* <p>For custom drag/drop implementations, an Ext.Panel.DD
* config could also be passed in this config instead of true. Ext.Panel.DD is an internal,
* undocumented class which moves a proxy Element around in place of the Panel's element, but
* provides no other behaviour during dragging or on drop. It is a subclass of
* {@link Ext.dd.DragSource}, so behaviour may be added by implementing the interface methods
* of {@link Ext.dd.DragDrop} eg:
* <pre><code>
new Ext.Panel({
title: 'Drag me',
x: 100,
y: 100,
renderTo: Ext.getBody(),
floating: true,
frame: true,
width: 400,
height: 200,
draggable: {
// Config option of Ext.Panel.DD class.
// It's a floating Panel, so do not show a placeholder proxy in the original position.
insertProxy: false,
// Called for each mousemove event while dragging the DD object.
onDrag : function(e){
// Record the x,y position of the drag proxy so that we can
// position the Panel at end of drag.
var pel = this.proxy.getEl();
this.x = pel.getLeft(true);
this.y = pel.getTop(true);
// Keep the Shadow aligned if there is one.
var s = this.panel.getEl().shadow;
if (s) {
s.realign(this.x, this.y, pel.getWidth(), pel.getHeight());
}
},
// Called on the mouseup event.
endDrag : function(e){
this.panel.setPosition(this.x, this.y);
}
}
}).show();
</code></pre>
*/
/**
* @cfg {String} tabTip
* Adds a tooltip when mousing over the tab of a Ext.Panel which is an item of a Ext.TabPanel. Ext.QuickTips.init()
* must be called in order for the tips to render.
*/
/**
* @cfg {Boolean} disabled
* Render this panel disabled (default is false). An important note when using the disabled config on panels is
* that IE will often fail to initialize the disabled mask element correectly if the panel's layout has not yet
* completed by the time the Panel is disabled during the render process. If you experience this issue, you may
* need to instead use the {@link afterlayout} event to initialize the disabled state:
* <pre><code>
new Ext.Panel({
...
listeners: {
'afterlayout': {
fn: function(p){
p.disable();
},
single: true // important, as many layouts can occur
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -