Properties

Methods

Events

Config Options

Direct Link

Observable
  Component
    BoxComponent
      Container
        Panel
          Window

Class Ext.Window

Package:	Ext
Defined In:	Window.js
Class:	Window
Extends:	Panel

* A specialized panel intended for use as an application window. Windows are floated and draggable by default, and also provide specific behavior like the ability to maximize and restore (with an event for minimizing, since the minimize behavior is application-specific). Windows can also be linked to a Ext.WindowGroup or managed by the Ext.WindowMgr to provide grouping, activation, to front/back and other application-specific behavior.

Config Options

Config Options		Defined By
	activeItem : String/Number A string component id or the numeric index of the component that should be initially activated within the container's... A string component id or the numeric index of the component that should be initially activated within the container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first item in the container's collection). activeItem only applies to layout styles that can display items one at a time (like Ext.layout.Accordion, Ext.layout.CardLayout and Ext.layout.FitLayout). Related to Ext.layout.ContainerLayout.activeItem.	Container
	allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true).	Component
	animCollapse : Boolean True to animate the transition when the panel is collapsed, false to skip the animation (defaults to true if the Ext.... True to animate the transition when the panel is collapsed, false to skip the animation (defaults to true if the Ext.Fx class is available, otherwise false).	Panel
	animateTarget : String/Element Id or element from which the window should animate while opening (defaults to null with no animation).	Window
	applyTo : Mixed The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document ... 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 structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. If applyTo is specified, any value passed for renderTo will be ignored and the target element's parent node will automatically be used as the component's container.	Component
	autoDestroy : Boolean If true the container will automatically destroy any contained component that is removed from it, else destruction mu... If true the container will automatically destroy any contained component that is removed from it, else destruction must be handled manually (defaults to true).	Container
	autoEl : String/Object A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inlin... A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inline via JSON. It should not be used for higher level components which already create their own elements. Example usage: `{xtype:'box', autoEl: 'div', cls:'my-class'} {xtype:'box', autoEl: {tag:'blockquote', html:'autoEl is cool!'}} // with DomHelper`	Component
	autoHeight : Boolean True to use height:'auto', false to use fixed height (defaults to false). Note: Although many components inherit this... True to use height:'auto', false to use fixed height (defaults to false). Note: Although many components inherit this config option, not all will function as expected with a height of 'auto'. Setting autoHeight:true means that the browser will manage height based on the element's contents, and that Ext will not manage it at all.	BoxComponent
	autoLoad : Object/String/Function A valid url spec according to the Updater Ext.Updater.update method. If autoLoad is not null, the panel will attempt ... A valid url spec according to the Updater Ext.Updater.update method. If autoLoad is not null, the panel will attempt to load its contents immediately upon render. The URL will become the default URL for this panel's body element, so it may be refreshed at any time.	Panel
	autoScroll : Boolean True to use overflow:'auto' on the panel's body element and show scroll bars automatically when necessary, false to c... 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).	Panel
	autoShow : Boolean True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render... True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false).	Component
	baseCls : String The base CSS class to apply to this panel's element (defaults to 'x-window').	Window
	bbar : Object/Array The bottom toolbar of the panel. This can be either an Ext.Toolbar object or an array of buttons/button configs to be... The bottom toolbar of the panel. This can be either an 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 getBottomToolbar.	Panel
	bodyBorder : Boolean True to display an interior border on the body element of the panel, false to hide it (defaults to true). This only a... True to display an interior border on the body element of the panel, false to hide it (defaults to true). This only applies when 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.	Panel
	bodyCfg : Object A DomHelper configuration object specifying the element structure of this Panel's body Element. This may be used to f... A DomHelper configuration object specifying the element structure of this Panel's body Element. 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: `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' } }) ] });`	Panel
	bodyStyle : String/Object/Function Custom CSS styles to be applied to the body element in the format expected by Ext.Element.applyStyles (defaults to nu... Custom CSS styles to be applied to the body element in the format expected by Ext.Element.applyStyles (defaults to null).	Panel
	border : Boolean True to display the borders of the panel's body element, false to hide them (defaults to true). By default, the borde... 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 bodyBorder to false.	Panel
	bufferResize : Boolean/Number When set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer t... When set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer the frequency it calculates and does a re-layout of components. This is useful for heavy containers or containers with a large quantity of sub-components for which frequent layout calls would be expensive.	Container
	buttonAlign : String The alignment of any buttons added to this panel. Valid values are 'right,' 'left' and 'center' (defaults to 'right').	Panel
	buttons : Array An array of Ext.Buttons or Ext.Button configs used to add buttons to the footer of this panel.	Panel
	clearCls : String The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). This config is only used when this Co... The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager.	Component
	closable : Boolean True to display the 'close' tool button and allow the user to close the window, false to hide the button and disallow... True to display the 'close' tool button and allow the user to close the window, false to hide the button and disallow closing the window (default to true). By default, when close is requested by either clicking the close button in the header or pressing ESC when the Window has focus, the close method will be called. This will destroy the Window and its content meaning that it may not be reused. To make closing a Window hide the Window so that it may be reused, set closeAction to 'hide'.	Window
	closeAction : String The action to take when the close button is clicked. The default action is 'close' which will actually remove the win... The action to take when the close button is clicked. The default action is 'close' which will actually remove the window from the DOM and destroy it. The other valid option is 'hide' which will simply hide the window by setting visibility to hidden and applying negative offsets, keeping the window available to be redisplayed via the show method.	Window
	cls : String An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for a... An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.	Component
	collapseFirst : Boolean True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the pane... True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the panel's title bar, false to render it last (defaults to true).	Panel
	collapsed : Boolean True to render the window collapsed, false to render it expanded (defaults to false). Note that if expandOnShow is tr... True to render the window collapsed, false to render it expanded (defaults to false). Note that if expandOnShow is true (the default) it will override the `collapsed` config and the window will always be expanded when shown.	Window
	collapsedCls : String A CSS class to add to the panel's element after it has been collapsed (defaults to 'x-panel-collapsed').	Panel
	collapsible : Boolean True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header ... 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).	Panel
	constrain : Boolean True to constrain the window to the viewport, false to allow it to fall outside of the viewport (defaults to false). ... True to constrain the window to the viewport, false to allow it to fall outside of the viewport (defaults to false). Optionally the header only can be constrained using constrainHeader.	Window
	constrainHeader : Boolean True to constrain the window header to the viewport, allowing the window body to fall outside of the viewport, false ... True to constrain the window header to the viewport, allowing the window body to fall outside of the viewport, false to allow the header to fall outside the viewport (defaults to false). Optionally the entire window can be constrained using constrain.	Window
	contentEl : String The id of an existing HTML node to use as the panel's body content (defaults to ''). The specified Element is appende... 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 after any configured HTML has been inserted, and so the document will not contain this HTML at the time the render event is fired.	Panel
	ctCls : String An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for... An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.	Component
	defaultButton : String/Number/Button The id / index of a button or a button instance to focus when this window received the focus.	Window
	defaultType : String The default xtype of child Components to create in this Container when a child item is specified as a raw configurati... The default xtype of child Components to create in this Container when a child item is specified as a raw configuration object, rather than as an instantiated Component. Defaults to 'panel'.	Container
	defaults : Object A config object that will be applied to all components added to this container either via the items config or via the... A config object that will be applied to all components added to this container either via the items config or via the add or insert methods. The defaults config can contain any number of name/value property pairs to be added to each item, and should be valid for the types of items being added to the container. For example, to automatically apply padding to the body of each of a set of contained Ext.Panel items, you could pass: defaults: {bodyStyle:'padding:15px'}.	Container
	disabled : Boolean Render this component disabled (default is false).	Component
	disabledClass : String CSS class added to the component when it is disabled (defaults to "x-item-disabled").	Component
	draggable : Boolean True to allow the window to be dragged by the header bar, false to disable dragging (defaults to true). Note that by ... True to allow the window to be dragged by the header bar, false to disable dragging (defaults to true). Note that by default the window will be centered in the viewport, so if dragging is disabled the window may need to be positioned programmatically after render (e.g., myWindow.setPosition(100, 100);).	Window
	elements : String A comma-delimited list of panel elements to initialize when the window is rendered. Normally, this list will be gener... A comma-delimited list of panel elements to initialize when the window is rendered. Normally, this list will be generated automatically based on the items added to the window at config time, but sometimes it might be useful to make sure a structural element is rendered even if not specified at config time (for example, you may want to add a button or toolbar dynamically after the window has been rendered). Adding those elements to this list will allocate the required placeholders in the window when it is rendered. Valid values are header (required) tbar (top bar) body (required) bbar (bottom bar) footer Defaults to 'header,body'.	Window
	expandOnShow : Boolean True to always expand the window when it is displayed, false to keep it in its current state (which may be collapsed)... True to always expand the window when it is displayed, false to keep it in its current state (which may be collapsed) when displayed (defaults to true).	Window
	fieldLabel : String The label text to display next to this Component (defaults to '') This config is only used when this Component is ren... The label text to display next to this Component (defaults to '') This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: `new Ext.FormPanel({ height: 100, renderTo: Ext.getBody(), items: [{ xtype: 'textfield', fieldLabel: 'Name' }] });`	Component
	footer : Boolean True to create the footer element explicitly, false to skip creating it. By default, when footer is not specified, if... 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.	Panel
	header : Boolean True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if... True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if a 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.	Panel
	headerAsText : Boolean True to display the panel title in the header, false to hide it (defaults to true).	Panel
	height : Number The height of this component in pixels (defaults to auto).	BoxComponent
	hidden : Boolean Render this component hidden (default is false).	Component
	hideBorders : Boolean True to hide the borders of each contained component, false to defer to the component's existing border settings (def... True to hide the borders of each contained component, false to defer to the component's existing border settings (defaults to false).	Container
	hideCollapseTool : Boolean True to hide the expand/collapse toggle button when collapsible = true, false to display it (defaults to false).	Panel
	hideLabel : Boolean True to completely hide the label element (defaults to false). By default, even if you do not specify a fieldLabel th... True to completely hide the label element (defaults to false). By default, even if you do not specify a fieldLabel the space will still be reserved so that the field will line up with other fields that do have labels. Setting this to true will cause the field to not reserve that space. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: `new Ext.FormPanel({ height: 100, renderTo: Ext.getBody(), items: [{ xtype: 'textfield' hideLabel: true }] });`	Component
	hideMode : String How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset p... How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display". For Containers which may be hidden and shown as part of a card layout Container such as a TabPanel, it is recommended that hideMode is configured as "offsets". This ensures that hidden Components still have height and width so that layout managers can perform measurements when calculating layouts.	Component
	hideParent : Boolean True to hide and show the component's container when hide/show is called on the component, false to hide and show the... True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container.	Component
	html : String/Object An HTML fragment, or a DomHelper specification to use as the panel's body content (defaults to ''). The HTML content ... An HTML fragment, or a 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 before any configured contentEl is appended.	Panel
	iconCls : String A CSS class that will provide a background image to be used as the header icon (defaults to ''). An example custom ic... 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;}	Panel
	id : String The unique id of this component (defaults to an auto-assigned id). You should assign an id if you need to be able to ... The unique id of this component (defaults to an auto-assigned id). You should assign an id if you need to be able to access the component later and you do not have an object reference available (e.g., using Ext.ComponentMgr.getCmp). Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent.	Component
	itemCls : String An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCl... An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCls value if set, or ''). Since it is applied to the item wrapper, it allows you to write standard CSS rules that can apply to the field, the label (if specified) or any other element within the markup for the field. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: `// Apply a style to the field's label: <style> .required .x-form-item-label {font-weight:bold;color:red;} </style> new Ext.FormPanel({ height: 100, renderTo: Ext.getBody(), items: [{ xtype: 'textfield', fieldLabel: 'Name', itemCls: 'required' //this label will be styled },{ xtype: 'textfield', fieldLabel: 'Favorite Color' }] });`	Component
	items : Mixed A single item, or an array of child Components to be added to this container. Each item can be any type of object bas... A single item, or an array of child Components to be added to this container. Each item can be any type of object based on Ext.Component. Component config objects may also be specified in order to avoid the overhead of constructing a real Component object if lazy rendering might mean that the added Component will not be rendered immediately. To take advantage of this "lazy instantiation", set the Ext.Component.xtype config property to the registered type of the Component wanted. For a list of all available xtypes, see Ext.Component. If a single item is being passed, it should be passed directly as an object reference (e.g., items: {...}). Multiple items should be passed as an array of objects (e.g., items: [{...}, {...}]).	Container
	keys : Object/Array A KeyMap config object (in the format expected by Ext.KeyMap.addBinding used to assign custom key handling to this pa... A KeyMap config object (in the format expected by Ext.KeyMap.addBinding used to assign custom key handling to this panel (defaults to null).	Panel
	labelSeparator : String The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.l... The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.labelSeparator, which is a colon ':' by default). To display no separator for this field's label specify empty string ''. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: `new Ext.FormPanel({ height: 100, renderTo: Ext.getBody(), items: [{ xtype: 'textfield', fieldLabel: 'Name', labelSeparator: '...' }] });`	Component
	labelStyle : String A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if se... A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or '').. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: `new Ext.FormPanel({ height: 100, renderTo: Ext.getBody(), items: [{ xtype: 'textfield', fieldLabel: 'Name', labelStyle: 'font-weight:bold;' }] });`	Component
	layout : String The layout type to be used in this container. If not specified, a default Ext.layout.ContainerLayout will be created ... The layout type to be used in this container. If not specified, a default Ext.layout.ContainerLayout will be created and used. Specific config values for the chosen layout type can be specified using layoutConfig. Valid values are: absolute accordion anchor border card column fit form table	Container
	layoutConfig : Object This is a config object containing properties specific to the chosen layout (to be used in conjunction with the layou... This is a config object containing properties specific to the chosen layout (to be used in conjunction with the layout config value). For complete details regarding the valid config options for each layout type, see the layout class corresponding to the type specified: Ext.layout.Absolute Ext.layout.Accordion Ext.layout.AnchorLayout Ext.layout.BorderLayout Ext.layout.CardLayout Ext.layout.ColumnLayout Ext.layout.FitLayout Ext.layout.FormLayout Ext.layout.TableLayout	Container
	listeners : Object (optional) A config object containing one or more event handlers to be added to this object during initialization. Th... (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.	Observable
	manager : Ext.WindowGroup A reference to the WindowGroup that should manage this window (defaults to Ext.WindowMgr).	Window
	maskDisabled : Boolean True to mask the panel when it is disabled, false to not mask it (defaults to true). Either way, the panel will alway... True to mask the panel when it is disabled, false to not mask it (defaults to true). Either way, the panel will always tell its contained elements to disable themselves when it is disabled, but masking the panel can provide an additional visual cue that the panel is disabled.	Panel
	maximizable : Boolean True to display the 'maximize' tool button and allow the user to maximize the window, false to hide the button and di... True to display the 'maximize' tool button and allow the user to maximize the window, false to hide the button and disallow maximizing the window (defaults to false). Note that when a window is maximized, the tool button will automatically change to a 'restore' button with the appropriate behavior already built-in that will restore the window to its previous size.	Window
	maximized : Boolean True to initially display the window in a maximized state. (Defaults to false).	Window
	minButtonWidth : Number Minimum width in pixels of all buttons in this panel (defaults to 75)	Panel
	minHeight : Number The minimum height in pixels allowed for this window (defaults to 100). Only applies when resizable = true.	Window
	minWidth : Number The minimum width in pixels allowed for this window (defaults to 200). Only applies when resizable = true.	Window
	minimizable : Boolean True to display the 'minimize' tool button and allow the user to minimize the window, false to hide the button and di... True to display the 'minimize' tool button and allow the user to minimize the window, false to hide the button and disallow minimizing the window (defaults to false). Note that this button provides no implementation -- the behavior of minimizing a window is implementation-specific, so the minimize event must be handled and a custom minimize behavior implemented for this option to be useful.	Window
	modal : Boolean True to make the window modal and mask everything behind it when displayed, false to display it without restricting a... True to make the window modal and mask everything behind it when displayed, false to display it without restricting access to other UI elements (defaults to false).	Window
	onEsc : Function Allows override of the built-in processing for the escape key. Default action is to close the Window (performing what... Allows override of the built-in processing for the escape key. Default action is to close the Window (performing whatever action is specified in closeAction. To prevent the Window closing when the escape key is pressed, specify this as Ext.emptyFn (See Ext.emptyFn).	Window
	overCls : String An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and... An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and removed when the mouse moves out. (defaults to ''). This can be useful for adding customized "active" or "hover" styles to the component or any of its children using standard CSS rules.	Component
	pageX : Number The page level x coordinate for this component if contained within a positioning container.	BoxComponent
	pageY : Number The page level y coordinate for this component if contained within a positioning container.	BoxComponent
	plain : Boolean True to render the window body with a transparent background so that it will blend into the framing elements, false t... True to render the window body with a transparent background so that it will blend into the framing elements, false to add a lighter background color to visually highlight the body element and separate it more distinctly from the surrounding frame (defaults to false).	Window
	plugins : Object/Array An object or array of objects that will provide custom functionality for this component. The only requirement for a v... An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.	Component
	renderTo : Mixed The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using... The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.	Component
	resizable : Boolean True to allow user resizing at each edge and corner of the window, false to disable resizing (defaults to true).	Window
	resizeHandles : String A valid Ext.Resizable handles config string (defaults to 'all'). Only applies when resizable = true.	Window
	shadow : Boolean/String True (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the panel, false to display no shadow (... True (or a valid Ext.Shadow 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.	Panel
	shadowOffset : Number The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies when float... The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies when floating = true.	Panel
	shim : Boolean False to disable the iframe shim in browsers which need one (defaults to true). Note that this option only applies wh... False to disable the iframe shim in browsers which need one (defaults to true). Note that this option only applies when floating = true.	Panel
	stateEvents : Array An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be... An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events supported by this component, including browser or custom events (e.g., ['click', 'customerchange']). See stateful for an explanation of saving and restoring Component state.	Component
	stateId : String The unique id for this component to use for state management purposes (defaults to the component id if one was set, o... The unique id for this component to use for state management purposes (defaults to the component id if one was set, otherwise null if the component is using a generated id). See stateful for an explanation of saving and restoring Component state.	Component
	stateful : Boolean A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startu... A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startup. The component must have either a stateId or id assigned for state to be managed. Auto-generated ids are not guaranteed to be stable across page loads and cannot be relied upon to save and restore the same state for a component. For state saving to work, the state manager's provider must have been set to an implementation of Ext.state.Provider which overrides the set and get methods to save and recall name/value pairs. A built-in implementation, Ext.state.CookieProvider is available. To set the state provider for the current page: `Ext.state.Manager.setProvider(new Ext.state.CookieProvider());` Components attempt to save state when one of the events listed in the stateEvents configuration fires. You can perform extra processing on state save and restore by attaching handlers to the beforestaterestore, staterestore, beforestatesave and statesave events	Component
	style : String A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.app... A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.applyStyles.	Component
	tabTip : String Adds a tooltip when mousing over the tab of a Ext.Panel which is an item of a Ext.TabPanel. Ext.QuickTips.init() must... 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.	Panel
	tbar : Object/Array The top toolbar of the panel. This can be either an Ext.Toolbar object or an array of buttons/button configs to be ad... The top toolbar of the panel. This can be either an 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 getTopToolbar.	Panel
	title : String The title text to display in the panel header (defaults to ''). When a title is specified the header element will aut... 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 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.	Panel
	titleCollapse : Boolean True to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar, fa... True to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar, false to allow it only by clicking to tool button (defaults to false).	Panel
	tools : Array An array of tool button configs to be added to the header tool area. When rendered, each tool is stored as an Element... An array of tool button configs to be added to the header tool area. When rendered, each tool is stored as an Element referenced by a public property called `tools.<tool-type>` Each tool config may contain the following properties: id : String Required. The type of tool to create. Values may be `toggle` (Created by default when collapsible is `true`) `close` `minimize` `maximize` `restore` `gear` `pin` `unpin` `right` `left` `up` `down` `refresh` `minus` `plus` `help` `search` `save` `print` handler : Function Required. The function to call when clicked. Arguments passed are: event : Ext.EventObject The click event. toolEl : Ext.Element The tool Element. Panel : Ext.Panel The host Panel scope : Object The scope in which to call the handler. qtip : String/Object A tip string, or a config argument to Ext.QuickTip.register hidden : Boolean True to initially render hidden. on : Object A listener config object specifiying event listeners in the format of an argument to addListener Example usage: `tools:[{ id:'refresh', qtip: 'Refresh form Data', // hidden:true, handler: function(event, toolEl, panel){ // refresh logic } }]` 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.	Panel
	width : Number The width of this component in pixels (defaults to auto).	BoxComponent
	x : Number The X position of the left edge of the Window on initial showing. Defaults to centering the Window within the width o... The X position of the left edge of the Window on initial showing. Defaults to centering the Window within the width of the Window's container {@link Ext.Element Element) (The Element that the Window is rendered to).	Window
	xtype : String The registered xtype to create. This config option is not used when passing a config object into a constructor. This ... The registered xtype to create. This config option is not used when passing a config object into a constructor. This config option is used only when lazy instantiation is being used, and a child item of a Container is being specified not as a fully instantiated Component, but as a Component config object. The xtype will be looked up at render time up to determine what type of child Component to create. The predefined xtypes are listed here. If you subclass Components to create your own Components, you may register them using Ext.ComponentMgr.registerType in order to be able to take advantage of lazy instantiation and rendering.	Component
	y : Number The Y position of the top edge of the Window on initial showing. Defaults to centering the Window within the height o... The Y position of the top edge of the Window on initial showing. Defaults to centering the Window within the height of the Window's container {@link Ext.Element Element) (The Element that the Window is rendered to).	Window

Public Properties

Property		Defined By
	body : Ext.Element The Panel's body Element which may be used to contain HTML content. The content may be specified in the html config,... The Panel's body Element which may be used to contain HTML content. The content may be specified in the html config, or it may be loaded using the autoLoad config, or through the Panel's Updater. Read-only. 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. If this Panel is intended to be used as the host of a Layout (See layout then the body Element must not be loaded or changed - it is under the control of the Panel's Layout.	Panel
	buttons : Array This Panel's Array of buttons as created from the `buttons` config property. Read only.	Panel
	dd : Ext.dd.DD If this Window is configured draggable, this property will contain an instance of Ext.dd.DD which handles dragging th... If this Window is configured draggable, this property will contain an instance of Ext.dd.DD which handles dragging the Window's DOM Element.	Window
	disabled : Boolean True if this component is disabled. Read-only.	Component
	footer : Ext.Element The Panel's footer Element. Read-only. This Element is used to house the Panel's buttons.	Panel
	header : Ext.Element The Panel's header Element. Read-only. This Element is used to house the title and tools	Panel
	hidden : Boolean True if this component is hidden. Read-only.	Component
	initialConfig : Object This Component's initial configuration specification. Read-only.	Component
	items : MixedCollection The collection of components in this container as a Ext.util.MixedCollection	Container
	ownerCt : Ext.Container The component's owner Ext.Container (defaults to undefined, and is set automatically when the component is added to a... The component's owner Ext.Container (defaults to undefined, and is set automatically when the component is added to a container). Read-only.	Component
	rendered : Boolean True if this component has been rendered. Read-only.	Component

Public Methods

Method		Defined By
	Window( `Object config` ) Parameters: `config` : Object The config object Returns:	Window
	add( `Ext.Component/Object component` ) : Ext.Component Adds a Component to this Container. Fires the beforeadd event before adding, then fires the add event after the compo... Adds a Component to this Container. Fires the beforeadd event before adding, then fires the add event after the component has been added. You will never call the render method of a child Component when using a Container. Child Components are rendered by this Container's layout manager when this Container is first rendered. Certain layout managers allow dynamic addition of child components. Those that do include Ext.layout.CardLayout, Ext.layout.AnchorLayout, Ext.layout.FormLayout, Ext.layout.TableLayout. If the Container is already rendered when add is called, you may need to call doLayout to refresh the view which causes any unrendered child Components to be rendered. This is required so that you can add multiple child components if needed while only refreshing the layout once. When creating complex UIs, it is important to remember that sizing and positioning of child items is the responsibility of the Container's layout manager. If you expect child items to be sized in response to user interactions, you must specify a layout manager which creates and manages the type of layout you have in mind. Omitting the layout config means that a basic layout manager is used which does nothnig but render child components sequentially into the Container. No sizing or positioning will be performed in this situation. Parameters: `component` : Ext.Component/Object The Component to add. Ext uses lazy rendering, and will only render the added Component should it become necessary, that is: when the Container is layed out either on first render or in response to a doLayout call. A Component config object may be passed instead of an instantiated Component object. The type of Component created from a config object is determined by the xtype config property. If no xtype is configured, the Container's defaultType is used. For a list of all available xtypes, see Ext.Component. Returns: `Ext.Component` component The Component (or config object) that was added with the Container's default config values applied. example: `var myNewGrid = new Ext.grid.GridPanel({ store: myStore, colModel: myColModel }); myTabPanel.add(myNewGrid); myTabPanel.setActiveTab(myNewGrid);`	Container
	addButton( `String/Object config`, `Function handler`, `Object scope` ) : Ext.Button Adds a button to this panel. Note that this method must be called prior to rendering. The preferred approach is to ... Adds a button to this panel. Note that this method must be called prior to rendering. The preferred approach is to add buttons via the buttons config. Parameters: `config` : String/Object A valid Ext.Button config. A string will become the text for a default button config, an object will be treated as a button config object. `handler` : Function The function to be called on button Ext.Button.click `scope` : Object The scope to use for the button handler function Returns: `Ext.Button` The button that was added	Panel
	addClass( `string cls` ) : void Adds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. Parameters: `cls` : string The CSS class name to add Returns: `void`	Component
	addEvents( `Object object` ) : void Used to define events on this Observable Used to define events on this Observable Parameters: `object` : Object The object with the events defined Returns: `void`	Observable
	addListener( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this component Appends an event handler to this component Parameters: `eventName` : String The type of event to listen for `handler` : Function The method the event invokes `scope` : Object (optional) The scope in which to execute the handler function. The handler function's "this" context. `options` : Object (optional) An object containing handler configuration properties. This may contain any of the following properties: scope : Object The scope in which to execute the handler function. The handler function's "this" context. delay : Number The number of milliseconds to delay the invocation of the handler after the event fires. single : Boolean True to add a handler to handle just the next firing of the event, and then remove itself. buffer : Number Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place. Combining Options Using the options argument, it is possible to combine different types of listeners: A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId) `el.on('click', this.onClick, this, { single: true, delay: 100, forumId: 4 });` Attaching multiple handlers in 1 call The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers. `foo.on({ 'click' : { fn: this.onClick, scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver, scope: this }, 'mouseout' : { fn: this.onMouseOut, scope: this } });` Or a shorthand syntax: `foo.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut, scope: this });` Returns: `void`	Observable
	alignTo( `Mixed element`, `String position`, [`Array offsets`] ) : Ext.Window Aligns the window to the specified element Aligns the window to the specified element Parameters: `element` : Mixed The element to align to. `position` : String The position to align to (see Ext.Element.alignTo for more details). `offsets` : Array (optional) Offset the positioning by [x, y] Returns: `Ext.Window` this	Window
	anchorTo( `Mixed element`, `String position`, [`Array offsets`], [`Boolean/Number monitorScroll`] ) : Ext.Window Anchors this window to another element and realigns it when the window is resized or scrolled. Anchors this window to another element and realigns it when the window is resized or scrolled. Parameters: `element` : Mixed The element to align to. `position` : String The position to align to (see Ext.Element.alignTo for more details) `offsets` : Array (optional) Offset the positioning by [x, y] `monitorScroll` : Boolean/Number (optional) true to monitor body scroll and reposition. If this parameter is a number, it is used as the buffer delay (defaults to 50ms). Returns: `Ext.Window` this	Window
	applyToMarkup( `String/HTMLElement el` ) : void Apply this component to existing markup that is valid. With this function, no call to render() is required. Apply this component to existing markup that is valid. With this function, no call to render() is required. Parameters: `el` : String/HTMLElement Returns: `void`	Component
	bubble( `Function fn`, [`Object scope`], [`Array args`] ) : void Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of... Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of function call will be the scope provided or the current component. The arguments to the function will be the args provided or the current component. If the function returns false at any point, the bubble is stopped. Parameters: `fn` : Function The function to call `scope` : Object (optional) The scope of the function (defaults to current node) `args` : Array (optional) The args to call the function with (default to passing the current component) Returns: `void`	Container
	cascade( `Function fn`, [`Object scope`], [`Array args`] ) : void Cascades down the component/container heirarchy from this component (called first), calling the specified function wi... Cascades down the component/container heirarchy from this component (called first), calling the specified function with each component. The scope (this) of function call will be the scope provided or the current component. The arguments to the function will be the args provided or the current component. If the function returns false at any point, the cascade is stopped on that branch. Parameters: `fn` : Function The function to call `scope` : Object (optional) The scope of the function (defaults to current component) `args` : Array (optional) The args to call the function with (defaults to passing the current component) Returns: `void`	Container
	center() : Ext.Window Centers this window in the viewport Centers this window in the viewport Parameters: None. Returns: `Ext.Window` this	Window
	cloneConfig( `Object overrides` ) : Ext.Component Clone the current component using the original config values passed into this instance by default. Clone the current component using the original config values passed into this instance by default. Parameters: `overrides` : Object A new config containing any properties to override in the cloned version. An id property can be passed on this object, otherwise one will be generated to avoid duplicates. Returns: `Ext.Component` clone The cloned copy of this component	Component
	close() : void Closes the window, removes it from the DOM and destroys the window object. The beforeclose event is fired before the... Closes the window, removes it from the DOM and destroys the window object. The beforeclose event is fired before the close happens and will cancel the close action if it returns false. Parameters: None. Returns: `void`	Window
	collapse( `Boolean animate` ) : Ext.Panel Collapses the panel body so that it becomes hidden. Fires the beforecollapse event which will cancel the collapse ac... Collapses the panel body so that it becomes hidden. Fires the beforecollapse event which will cancel the collapse action if it returns false. Parameters: `animate` : Boolean True to animate the transition, else false (defaults to the value of the animCollapse panel config) Returns: `Ext.Panel` this	Panel
	destroy() : void Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the c... Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the component from its Ext.Container (if applicable) and unregistering it from Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method should usually not need to be called directly. Parameters: None. Returns: `void`	Component
	disable() : Ext.Component Disable this component. Disable this component. Parameters: None. Returns: `Ext.Component` this	Component
	doLayout( [`Boolean shallow`] ) : void Force this container's layout to be recalculated. A call to this function is required after adding a new component to... Force this container's layout to be recalculated. A call to this function is required after adding a new component to an already rendered container, or possibly after changing sizing/position properties of child components. Parameters: `shallow` : Boolean (optional) True to only calc the layout of this component, and let child components auto calc layouts as required (defaults to false, which calls doLayout recursively for each subcontainer) Returns: `void`	Container
	enable() : Ext.Component Enable this component. Enable this component. Parameters: None. Returns: `Ext.Component` this	Component
	expand( `Boolean animate` ) : Ext.Panel Expands the panel body so that it becomes visible. Fires the beforeexpand event which will cancel the expand action ... Expands the panel body so that it becomes visible. Fires the beforeexpand event which will cancel the expand action if it returns false. Parameters: `animate` : Boolean True to animate the transition, else false (defaults to the value of the animCollapse panel config) Returns: `Ext.Panel` this	Panel
	find( `String prop`, `String value` ) : Array Find a component under this container at any level by property Find a component under this container at any level by property Parameters: `prop` : String `value` : String Returns: `Array` Array of Ext.Components	Container
	findBy( `Function fcn`, [`Object scope`] ) : Array Find a component under this container at any level by a custom function. If the passed function returns true, the com... Find a component under this container at any level by a custom function. If the passed function returns true, the component will be included in the results. The passed function is called with the arguments (component, this container). Parameters: `fcn` : Function `scope` : Object (optional) Returns: `Array` Array of Ext.Components	Container
	findById( `String id` ) : Ext.Component Find a component under this container at any level by id Find a component under this container at any level by id Parameters: `id` : String Returns: `Ext.Component`	Container
	findByType( `String/Class xtype`, [`Boolean shallow`] ) : Array Find a component under this container at any level by xtype or class Find a component under this container at any level by xtype or class Parameters: `xtype` : String/Class The xtype string for a component, or the class of the component directly `shallow` : Boolean (optional) False to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype. Returns: `Array` Array of Ext.Components	Container
	findParentBy( `Function fcn`, [`Object scope`] ) : Ext.Container Find a container above this component at any level by a custom function. If the passed function returns true, the con... Find a container above this component at any level by a custom function. If the passed function returns true, the container will be returned. The passed function is called with the arguments (container, this component). Parameters: `fcn` : Function `scope` : Object (optional) Returns: `Ext.Container` The first Container for which the custom function returns true	Component
	findParentByType( `String/Class xtype` ) : Ext.Container Find a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class Parameters: `xtype` : String/Class The xtype string for a component, or the class of the component directly Returns: `Ext.Container` The first Container which matches the given xtype or class	Component
	fireEvent( `String eventName`, `Object... args` ) : Boolean Fires the specified event with the passed parameters (minus the event name). Fires the specified event with the passed parameters (minus the event name). Parameters: `eventName` : String `args` : Object... Variable number of parameters are passed to handlers Returns: `Boolean` returns false if any of the handlers return false otherwise it returns true	Observable
	focus() : void Focuses the window. If a defaultButton is set, it will receive focus, otherwise the window itself will receive focus. Focuses the window. If a defaultButton is set, it will receive focus, otherwise the window itself will receive focus. Parameters: None. Returns: `void`	Window
	getBottomToolbar() : Ext.Toolbar Returns the toolbar from the bottom (bbar) section of the panel. Returns the toolbar from the bottom (bbar) section of the panel. Parameters: None. Returns: `Ext.Toolbar` The toolbar	Panel
	getBox( [`Boolean local`] ) : Object Gets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. Parameters: `local` : Boolean (optional) If true the element's left and top are returned instead of page XY (defaults to false) Returns: `Object` box An object in the format {x, y, width, height}	BoxComponent
	getComponent( `String/Number id` ) : Ext.Component Gets a direct child Component by id, or by index. Gets a direct child Component by id, or by index. Parameters: `id` : String/Number or index of child Component to return. Returns: `Ext.Component`	Container
	getEl() : Ext.Element Returns the underlying Ext.Element. Returns the underlying Ext.Element. Parameters: None. Returns: `Ext.Element` The element	Component
	getFrameHeight() : Number Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and header and ... Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and header and footer elements, but not including the body height). To retrieve the body height see getInnerHeight. Parameters: None. Returns: `Number` The frame height	Panel
	getFrameWidth() : Number Returns the width in pixels of the framing elements of this panel (not including the body width). To retrieve the bo... Returns the width in pixels of the framing elements of this panel (not including the body width). To retrieve the body width see getInnerWidth. Parameters: None. Returns: `Number` The frame width	Panel
	getId() : String Returns the id of this component. Returns the id of this component. Parameters: None. Returns: `String`	Component
	getInnerHeight() : Number Returns the height in pixels of the body element (not including the height of any framing elements). For the frame he... Returns the height in pixels of the body element (not including the height of any framing elements). For the frame height see getFrameHeight. Parameters: None. Returns: `Number` The body height	Panel
	getInnerWidth() : Number Returns the width in pixels of the body element (not including the width of any framing elements). For the frame widt... Returns the width in pixels of the body element (not including the width of any framing elements). For the frame width see getFrameWidth. Parameters: None. Returns: `Number` The body width	Panel
	getItemId() : String Returns the item id of this component. Returns the item id of this component. Parameters: None. Returns: `String`	Component
	getLayout() : ContainerLayout Returns the layout currently in use by the container. If the container does not currently have a layout set, a defau... Returns the layout currently in use by the container. If the container does not currently have a layout set, a default Ext.layout.ContainerLayout will be created and set as the container's layout. Parameters: None. Returns: `ContainerLayout` layout The container's layout	Container
	getLayoutTarget() : Ext.Element Returns the Element to be used to contain the child Components of this Container. An implementation is provided which... Returns the Element to be used to contain the child Components of this Container. An implementation is provided which returns the Container's Element, but if there is a more complex structure to a Container, this may be overridden to return the element into which the layout renders child Components. Parameters: None. Returns: `Ext.Element` The Element to render child Components into.	Container
	getPosition( [`Boolean local`] ) : Array Gets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. Parameters: `local` : Boolean (optional) If true the element's left and top are returned instead of page XY (defaults to false) Returns: `Array` The XY position of the element (e.g., [100, 200])	BoxComponent
	getSize() : Object Gets the current size of the component's underlying element. Gets the current size of the component's underlying element. Parameters: None. Returns: `Object` An object containing the element's size {width: (element width), height: (element height)}	BoxComponent
	getTool( `String id` ) : Object Retrieve a tool by id. Retrieve a tool by id. Parameters: `id` : String Returns: `Object` tool	Panel
	getTopToolbar() : Ext.Toolbar Returns the toolbar from the top (tbar) section of the panel. Returns the toolbar from the top (tbar) section of the panel. Parameters: None. Returns: `Ext.Toolbar` The toolbar	Panel
	getUpdater() : Ext.Updater Get the Ext.Updater for this panel. Enables you to perform Ajax updates of this panel's body. Get the Ext.Updater for this panel. Enables you to perform Ajax updates of this panel's body. Parameters: None. Returns: `Ext.Updater` The Updater	Panel
	getXType() : String Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all available xtypes, see the Ex... Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all available xtypes, see the Ext.Component header. Example usage: `var t = new Ext.form.TextField(); alert(t.getXType()); // alerts 'textfield'` Parameters: None. Returns: `String` The xtype	Component
	getXTypes() : String Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext... Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext.Component header. If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes. Example usage: `var t = new Ext.form.TextField(); alert(t.getXTypes()); // alerts 'component/box/field/textfield'` Parameters: None. Returns: `String` The xtype hierarchy string	Component
	hasListener( `String eventName` ) : Boolean Checks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters: `eventName` : String The name of the event to check for Returns: `Boolean` True if the event is being listened for, else false	Observable
	hide( [`String/Element animateTarget`], [`Function callback`], [`Object scope`] ) : void Hides the window, setting it to invisible and applying negative offsets. Hides the window, setting it to invisible and applying negative offsets. Parameters: `animateTarget` : String/Element (optional) The target element or id to which the window should animate while hiding (defaults to null with no animation) `callback` : Function (optional) A callback function to call after the window is hidden `scope` : Object (optional) The scope in which to execute the callback Returns: `void`	Window
	insert( `Number index`, `Ext.Component component` ) : Ext.Component Inserts a Component into this Container at a specified index. Fires the beforeadd event before inserting, then fires ... Inserts a Component into this Container at a specified index. Fires the beforeadd event before inserting, then fires the add event after the Component has been inserted. Parameters: `index` : Number The index at which the Component will be inserted into the Container's items collection `component` : Ext.Component The child Component to insert. Ext uses lazy rendering, and will only render the inserted Component should it become necessary. A Component config object may be passed in order to avoid the overhead of constructing a real Component object if lazy rendering might mean that the inserted Component will not be rendered immediately. To take advantage of this "lazy instantiation", set the Ext.Component.xtype config property to the registered type of the Component wanted. For a list of all available xtypes, see Ext.Component. Returns: `Ext.Component` component The Component (or config object) that was inserted with the Container's default config values applied.	Container
	isVisible() : void Returns true if this component is visible. Returns true if this component is visible. Parameters: None. Returns: `void`	Component
	isXType( `String xtype`, [`Boolean shallow`] ) : void Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from th... Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from the xtype (default) or whether it is directly of the xtype specified (shallow = true). If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes. For a list of all available xtypes, see the Ext.Component header. Example usage: `var t = new Ext.form.TextField(); var isText = t.isXType('textfield'); // true var isBoxSubclass = t.isXType('box'); // true, descended from BoxComponent var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance` Parameters: `xtype` : String The xtype to check for this Component `shallow` : Boolean (optional) False to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype. Returns: `void`	Component
	load( `Object/String/Function config` ) : Ext.Panel Loads this content panel immediately with content returned from an XHR call. Loads this content panel immediately with content returned from an XHR call. Parameters: `config` : Object/String/Function A config object containing any of the following options: `panel.load({ url: "your-url.php", params: {param1: "foo", param2: "bar"}, // or a URL encoded string callback: yourFunction, scope: yourObject, // optional scope for the callback discardUrl: false, nocache: false, text: "Loading...", timeout: 30, scripts: false });` The only required property is url. The optional properties nocache, text and scripts are shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this panel Updater instance. Returns: `Ext.Panel` this	Panel
	maximize() : void Fits the window within its current container and automatically replaces the 'maximize' tool button with the 'restore'... Fits the window within its current container and automatically replaces the 'maximize' tool button with the 'restore' tool button. Parameters: None. Returns: `void`	Window
	minimize() : void Placeholder method for minimizing the window. By default, this method simply fires the minimize event since the beha... Placeholder method for minimizing the window. By default, this method simply fires the minimize event since the behavior of minimizing a window is application-specific. To implement custom minimize behavior, either the minimize event can be handled or this method can be overridden. Parameters: None. Returns: `void`	Window
	on( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this element (shorthand for addListener) Appends an event handler to this element (shorthand for addListener) Parameters: `eventName` : String The type of event to listen for `handler` : Function The method the event invokes `scope` : Object (optional) The scope in which to execute the handler function. The handler function's "this" context. `options` : Object (optional) Returns: `void`	Observable
	purgeListeners() : void Removes all listeners for this object Removes all listeners for this object Parameters: None. Returns: `void`	Observable
	relayEvents( `Object o`, `Array events` ) : void Relays selected events from the specified Observable as if the events were fired by `this`. Relays selected events from the specified Observable as if the events were fired by `this`. Parameters: `o` : Object The Observable whose events this object is to relay. `events` : Array Array of event names to relay. Returns: `void`	Observable
	remove( `Component/String component`, [`Boolean autoDestroy`] ) : Ext.Component Removes a component from this container. Fires the beforeremove event before removing, then fires the remove event a... Removes a component from this container. Fires the beforeremove event before removing, then fires the remove event after the component has been removed. Parameters: `component` : Component/String The component reference or id to remove. `autoDestroy` : Boolean (optional) True to automatically invoke the removed Component's Ext.Component.destroy function. Defaults to the value of this Container's autoDestroy config. Returns: `Ext.Component` component The Component that was removed.	Container
	removeAll( [`Boolean autoDestroy`] ) : Array Removes all components from this container. Removes all components from this container. Parameters: `autoDestroy` : Boolean (optional) True to automatically invoke the removed Component's Ext.Component.destroy function. Defaults to the value of this Container's autoDestroy config. Returns: `Array` Array of the destroyed components	Container
	removeClass( `string cls` ) : void Removes a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. Parameters: `cls` : string The CSS class name to remove Returns: `void`	Component
	removeListener( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes a listener Removes a listener Parameters: `eventName` : String The type of event to listen for `handler` : Function The handler to remove `scope` : Object (optional) The scope (this object) for the handler Returns: `void`	Observable
	render( [`Element/HTMLElement/String container`], [`String/Number position`] ) : void Render this Component into the passed HTML element. If you are using a Container object to house this Component, then... Render this Component into the passed HTML element. If you are using a Container object to house this Component, then do not use the render method. A Container's child Components are rendered by that Container's layout manager when the Container is first rendered. Certain layout managers allow dynamic addition of child components. Those that do include Ext.layout.CardLayout, Ext.layout.AnchorLayout, Ext.layout.FormLayout, Ext.layout.TableLayout. If the Container is already rendered when a new child Component is added, you may need to call the Container's doLayout to refresh the view which causes any unrendered child Components to be rendered. This is required so that you can add multiple child components if needed while only refreshing the layout once. When creating complex UIs, it is important to remember that sizing and positioning of child items is the responsibility of the Container's layout manager. If you expect child items to be sized in response to user interactions, you must configure the Container with a layout manager which creates and manages the type of layout you have in mind. Omitting the Container's layout config means that a basic layout manager is used which does nothing but render child components sequentially into the Container. No sizing or positioning will be performed in this situation. Parameters: `container` : Element/HTMLElement/String (optional) The element this Component should be rendered into. If it is being created from existing markup, this should be omitted. `position` : String/Number (optional) The element ID or DOM node index within the container before which this component will be inserted (defaults to appending to the end of the container) Returns: `void`	Component
	restore() : void Restores a maximized window back to its original size and position prior to being maximized and also replaces the 're... Restores a maximized window back to its original size and position prior to being maximized and also replaces the 'restore' tool button with the 'maximize' tool button. Parameters: None. Returns: `void`	Window
	resumeEvents() : void Resume firing events. (see suspendEvents) Resume firing events. (see suspendEvents) Parameters: None. Returns: `void`	Observable
	setActive( `Boolean active` ) : void Makes this the active window by showing its shadow, or deactivates it by hiding its shadow. This method also fires t... Makes this the active window by showing its shadow, or deactivates it by hiding its shadow. This method also fires the activate or deactivate event depending on which action occurred. Parameters: `active` : Boolean True to activate the window, false to deactivate it (defaults to false) Returns: `void`	Window
	setAnimateTarget( `String/Element el` ) : void Sets the target element from which the window should animate while opening. Sets the target element from which the window should animate while opening. Parameters: `el` : String/Element The target element or id Returns: `void`	Window
	setDisabled( `Boolean disabled` ) : void Convenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters: `disabled` : Boolean Returns: `void`	Component
	setHeight( `Number height` ) : Ext.BoxComponent Sets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters: `height` : Number The new height to set Returns: `Ext.BoxComponent` this	BoxComponent
	setIconClass( `String cls` ) : void Sets the CSS class that provides the icon image for this panel. This method will replace any existing icon class if ... Sets the CSS class that provides the icon image for this panel. This method will replace any existing icon class if one has already been set. Parameters: `cls` : String The new CSS class name Returns: `void`	Panel
	setPagePosition( `Number x`, `Number y` ) : Ext.BoxComponent Sets the page XY position of the component. To set the left and top instead, use setPosition. This method fires the ... Sets the page XY position of the component. To set the left and top instead, use setPosition. This method fires the move event. Parameters: `x` : Number The new x position `y` : Number The new y position Returns: `Ext.BoxComponent` this	BoxComponent
	setPosition( `Number left`, `Number top` ) : Ext.BoxComponent Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This method fires ... Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This method fires the move event. Parameters: `left` : Number The new left `top` : Number The new top Returns: `Ext.BoxComponent` this	BoxComponent
	setSize( `Number/Object width`, `Number height` ) : Ext.BoxComponent Sets the width and height of the component. This method fires the resize event. This method can accept either width... Sets the width and height of the component. This method fires the resize event. This method can accept either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}. Parameters: `width` : Number/Object The new width to set, or a size object in the format {width, height} `height` : Number The new height to set (not required if a size object is passed as the first arg) Returns: `Ext.BoxComponent` this	BoxComponent
	setTitle( `String title`, [`String iconCls`] ) : void Sets the title text for the panel and optionally the icon class. In order to be able to set the title, a header eleme... Sets the title text for the panel and optionally the icon class. In order to be able to set the title, a header element must have been created for the Panel. This is triggered either by configuring the Panel with a non-blank title, or configuring it with `header: true`. Parameters: `title` : String The title text to set `iconCls` : String (optional) iconCls A user-defined CSS class that provides the icon image for this panel Returns: `void`	Panel
	setVisible( `Boolean visible` ) : Ext.Component Convenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters: `visible` : Boolean True to show, false to hide Returns: `Ext.Component` this	Component
	setWidth( `Number width` ) : Ext.BoxComponent Sets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters: `width` : Number The new width to set Returns: `Ext.BoxComponent` this	BoxComponent
	show( [`String/Element animateTarget`], [`Function callback`], [`Object scope`] ) : void Shows the window, rendering it first if necessary, or activates it and brings it to front if hidden. Shows the window, rendering it first if necessary, or activates it and brings it to front if hidden. Parameters: `animateTarget` : String/Element (optional) The target element or id from which the window should animate while opening (defaults to undefined with no animation) `callback` : Function (optional) A callback function to call after the window is displayed `scope` : Object (optional) The scope in which to execute the callback Returns: `void`	Window
	suspendEvents() : void Suspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters: None. Returns: `void`	Observable
	syncSize() : Ext.BoxComponent Force the component's size to recalculate based on the underlying element's current height and width. Force the component's size to recalculate based on the underlying element's current height and width. Parameters: None. Returns: `Ext.BoxComponent` this	BoxComponent
	toBack() : Ext.Window Sends this window to the back of (lower z-index than) any other visible windows Sends this window to the back of (lower z-index than) any other visible windows Parameters: None. Returns: `Ext.Window` this	Window
	toFront() : Ext.Window Brings this window to the front of any other visible windows Brings this window to the front of any other visible windows Parameters: None. Returns: `Ext.Window` this	Window
	toggleCollapse( `Boolean animate` ) : Ext.Panel Shortcut for performing an expand or collapse based on the current state of the panel. Shortcut for performing an expand or collapse based on the current state of the panel. Parameters: `animate` : Boolean True to animate the transition, else false (defaults to the value of the animCollapse panel config) Returns: `Ext.Panel` this	Panel
	toggleMaximize() : void A shortcut method for toggling between maximize and restore based on the current maximized state of the window. A shortcut method for toggling between maximize and restore based on the current maximized state of the window. Parameters: None. Returns: `void`	Window
	un( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes a listener (shorthand for removeListener) Removes a listener (shorthand for removeListener) Parameters: `eventName` : String The type of event to listen for `handler` : Function The handler to remove `scope` : Object (optional) The scope (this object) for the handler Returns: `void`	Observable
	updateBox( `Object box` ) : Ext.BoxComponent Sets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. Parameters: `box` : Object An object in the format {x, y, width, height} Returns: `Ext.BoxComponent` this	BoxComponent

Public Events

Event		Defined By
	activate : ( `Ext.Window this` ) Fires after the window has been visually activated via setActive. Fires after the window has been visually activated via setActive. Listeners will be called with the following arguments: `this` : Ext.Window	Window
	add : ( `Ext.Container this`, `Ext.Component component`, `Number index` ) Fires after any Ext.Component is added or inserted into the container. Fires after any Ext.Component is added or inserted into the container. Listeners will be called with the following arguments: `this` : Ext.Container `component` : Ext.Component The component that was added `index` : Number The index at which the component was added to the container's items collection	Container
	afterlayout : ( `Ext.Container this`, `ContainerLayout layout` ) Fires when the components in this container are arranged by the associated layout manager. Fires when the components in this container are arranged by the associated layout manager. Listeners will be called with the following arguments: `this` : Ext.Container `layout` : ContainerLayout The ContainerLayout implementation for this container	Container
	beforeadd : ( `Ext.Container this`, `Ext.Component component`, `Number index` ) Fires before any Ext.Component is added or inserted into the container. A handler can return false to cancel the add. Fires before any Ext.Component is added or inserted into the container. A handler can return false to cancel the add. Listeners will be called with the following arguments: `this` : Ext.Container `component` : Ext.Component The component being added `index` : Number The index at which the component will be added to the container's items collection	Container
	beforeclose : ( `Ext.Panel p` ) Fires before the Panel is closed. Note that Panels do not directly support being closed, but some Panel subclasses d... Fires before the Panel is closed. Note that Panels do not directly support being closed, but some Panel subclasses do (like Ext.Window). This event only applies to such subclasses. A handler can return false to cancel the close. Listeners will be called with the following arguments: `p` : Ext.Panel The Panel being closed.	Panel
	beforecollapse : ( `Ext.Panel p`, `Boolean animate` ) Fires before the Panel is collapsed. A handler can return false to cancel the collapse. Fires before the Panel is collapsed. A handler can return false to cancel the collapse. Listeners will be called with the following arguments: `p` : Ext.Panel the Panel being collapsed. `animate` : Boolean True if the collapse is animated, else false.	Panel
	beforedestroy : ( `Ext.Component this` ) Fires before the component is destroyed. Return false to stop the destroy. Fires before the component is destroyed. Return false to stop the destroy. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	beforeexpand : ( `Ext.Panel p`, `Boolean animate` ) Fires before the Panel is expanded. A handler can return false to cancel the expand. Fires before the Panel is expanded. A handler can return false to cancel the expand. Listeners will be called with the following arguments: `p` : Ext.Panel The Panel being expanded. `animate` : Boolean True if the expand is animated, else false.	Panel
	beforehide : ( `Ext.Component this` ) Fires before the component is hidden. Return false to stop the hide. Fires before the component is hidden. Return false to stop the hide. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	beforeremove : ( `Ext.Container this`, `Ext.Component component` ) Fires before any Ext.Component is removed from the container. A handler can return false to cancel the remove. Fires before any Ext.Component is removed from the container. A handler can return false to cancel the remove. Listeners will be called with the following arguments: `this` : Ext.Container `component` : Ext.Component The component being removed	Container
	beforerender : ( `Ext.Component this` ) Fires before the component is rendered. Return false to stop the render. Fires before the component is rendered. Return false to stop the render. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	beforeshow : ( `Ext.Component this` ) Fires before the component is shown. Return false to stop the show. Fires before the component is shown. Return false to stop the show. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	beforestaterestore : ( `Ext.Component this`, `Object state` ) Fires before the state of the component is restored. Return false to stop the restore. Fires before the state of the component is restored. Return false to stop the restore. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values	Component
	beforestatesave : ( `Ext.Component this`, `Object state` ) Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values	Component
	bodyresize : ( `Ext.Panel p`, `Number width`, `Number height` ) Fires after the Panel has been resized. Fires after the Panel has been resized. Listeners will be called with the following arguments: `p` : Ext.Panel the Panel which has been resized. `width` : Number The Panel's new width. `height` : Number The Panel's new height.	Panel
	close : ( `Ext.Panel p` ) Fires after the Panel is closed. Note that Panels do not directly support being closed, but some Panel subclasses do... Fires after the Panel is closed. Note that Panels do not directly support being closed, but some Panel subclasses do (like Ext.Window). Listeners will be called with the following arguments: `p` : Ext.Panel The Panel that has been closed.	Panel
	collapse : ( `Ext.Panel p` ) Fires after the Panel has been collapsed. Fires after the Panel has been collapsed. Listeners will be called with the following arguments: `p` : Ext.Panel the Panel that has been collapsed.	Panel
	deactivate : ( `Ext.Window this` ) Fires after the window has been visually deactivated via setActive. Fires after the window has been visually deactivated via setActive. Listeners will be called with the following arguments: `this` : Ext.Window	Window
	destroy : ( `Ext.Component this` ) Fires after the component is destroyed. Fires after the component is destroyed. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	disable : ( `Ext.Component this` ) Fires after the component is disabled. Fires after the component is disabled. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	enable : ( `Ext.Component this` ) Fires after the component is enabled. Fires after the component is enabled. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	expand : ( `Ext.Panel p` ) Fires after the Panel has been expanded. Fires after the Panel has been expanded. Listeners will be called with the following arguments: `p` : Ext.Panel The Panel that has been expanded.	Panel
	hide : ( `Ext.Component this` ) Fires after the component is hidden. Fires after the component is hidden. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	iconchange : ( `Ext.Panel p`, `String The`, `String The` ) Fires after the Panel icon class has been set or changed. Fires after the Panel icon class has been set or changed. Listeners will be called with the following arguments: `p` : Ext.Panel the Panel which has had its icon class changed. `The` : String new icon class. `The` : String old icon class.	Panel
	maximize : ( `Ext.Window this` ) Fires after the window has been maximized. Fires after the window has been maximized. Listeners will be called with the following arguments: `this` : Ext.Window	Window
	minimize : ( `Ext.Window this` ) Fires after the window has been minimized. Fires after the window has been minimized. Listeners will be called with the following arguments: `this` : Ext.Window	Window
	move : ( `Ext.Component this`, `Number x`, `Number y` ) Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments: `this` : Ext.Component `x` : Number The new x position `y` : Number The new y position	BoxComponent
	remove : ( `Ext.Container this`, `Ext.Component component` ) Fires after any Ext.Component is removed from the container. Fires after any Ext.Component is removed from the container. Listeners will be called with the following arguments: `this` : Ext.Container `component` : Ext.Component The component that was removed	Container
	render : ( `Ext.Component this` ) Fires after the component is rendered. Fires after the component is rendered. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	resize : ( `Ext.Window this`, `Number width`, `Number height` ) Fires after the window has been resized. Fires after the window has been resized. Listeners will be called with the following arguments: `this` : Ext.Window `width` : Number The window's new width `height` : Number The window's new height	Window
	restore : ( `Ext.Window this` ) Fires after the window has been restored to its original size after being maximized. Fires after the window has been restored to its original size after being maximized. Listeners will be called with the following arguments: `this` : Ext.Window	Window
	show : ( `Ext.Component this` ) Fires after the component is shown. Fires after the component is shown. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	staterestore : ( `Ext.Component this`, `Object state` ) Fires after the state of the component is restored. Fires after the state of the component is restored. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values	Component
	statesave : ( `Ext.Component this`, `Object state` ) Fires after the state of the component is saved to the configured state provider. Fires after the state of the component is saved to the configured state provider. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values	Component
	titlechange : ( `Ext.Panel p`, `String The` ) Fires after the Panel title has been set or changed. Fires after the Panel title has been set or changed. Listeners will be called with the following arguments: `p` : Ext.Panel the Panel which has had its title changed. `The` : String new title.	Panel