Package: | Ext |
Defined In: | Window.js |
Class: | Window |
Extends: | Panel |
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 | |
autoHeight : Boolean True to use height:'auto', false to use fixed height. Note: although many components inherit this config option, not ...
True to use height:'auto', false to use fixed height. Note: although many components inherit this config option, not all will function as expected with a height of 'auto'. (defaults to false).
|
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 a Ext.Toolbar object, a toolbar config, or an array of buttons/button co...
The bottom toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, 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 | |
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 | |
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 panel collapsed, false to render it expanded (defaults to false).
|
Panel | |
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 '').
|
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. This usually defaults to 'panel', but for Ext.form.FormPanel and Ext.form.FieldSet, the defaultType is 'textfield'. |
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
|
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 | |
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 | |
Render this component hidden (default is false).
|
hidden : Boolean 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 | |
hideMode : String How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset posi...
How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display".
|
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 '').
|
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).
|
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 | |
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. Valid values are: absolute, accordion, anchor, border, card, column, fit, form and table. Specific config values for the chosen layout type can be specified using layoutConfig.
|
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:
|
Container | |
listeners : Object A config object containing one or more event handlers to be added to this object during initialization. This should b...
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 | |
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). See stateful fo...
The unique id for this component to use for state management purposes (defaults to the component 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.
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: 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 a Ext.Toolbar object, a toolbar config, or an array of buttons/button confi...
The top toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, 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:
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 |
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 | Window | |
disabled : Boolean
True if this component is disabled. Read-only.
|
Component | |
footer : Ext.Element | Panel | |
header : Ext.Element | Panel | |
True if this component is hidden. Read-only.
|
hidden : Boolean 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 |
Method | Defined By | |
---|---|---|
Window( Object config )
Parameters:
|
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:
|
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:
|
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:
|
Component | |
addEvents( Object object ) : void Used to define events on this Observable
Used to define events on this Observable
Parameters:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
Container | |
center() : Ext.Window Centers this window in the viewport
Centers this window in the viewport
Parameters:
|
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:
|
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:
|
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:
|
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:
|
Component | |
disable() : Ext.Component Disable this component.
Disable this component.
Parameters:
|
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:
|
Container | |
enable() : Ext.Component Enable this component.
Enable this component.
Parameters:
|
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:
|
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:
|
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:
|
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:
|
Container | |
findByType( String/Class xtype ) : 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:
|
Container | |
findParentBy( Function fcn , [Object scope ] ) : Array 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:
|
Component | |
findParentByType( String/Class xtype ) : 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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
Container | |
getEl() : Ext.Element Returns the underlying Ext.Element.
Returns the underlying Ext.Element.
Parameters:
|
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:
|
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:
|
Panel | |
getId() : String Returns the id of this component.
Returns the id of this component.
Parameters:
|
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:
|
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:
|
Panel | |
getItemId() : String Returns the item id of this component.
Returns the item id of this component.
Parameters:
|
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:
|
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:
|
BoxComponent | |
getSize() : Object Gets the current size of the component's underlying element.
Gets the current size of the component's underlying element.
Parameters:
|
BoxComponent | |
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:
|
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:
|
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:
Parameters:
|
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:
Parameters:
|
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:
|
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:
|
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:
|
Container | |
isVisible() : void Returns true if this component is visible.
Returns true if this component is visible.
Parameters:
|
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:
Parameters:
|
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:
|
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:
|
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:
|
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:
|
Observable | |
purgeListeners() : void Removes all listeners for this object
Removes all listeners for this object
Parameters:
|
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:
|
Observable | |
remove( Component/String component , [Boolean autoDestroy ] ) : void 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:
|
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:
|
Component | |
removeListener( String eventName , Function handler , [Object scope ] ) : void Removes a listener
Removes a listener
Parameters:
|
Observable | |
render( [Element/HTMLElement/String container ], [String/Number position ] ) : void Render this Components into the passed HTML element.
If you are using a Container object to house this Component, the...
Render this Components 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 nothnig but render child components sequentially into the Container. No sizing or positioning will be performed in this situation.
Parameters:
|
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:
|
Window | |
resumeEvents() : void Resume firing events. (see suspendEvents)
Resume firing events. (see suspendEvents)
Parameters:
|
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:
|
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:
|
Window | |
setDisabled( Boolean disabled ) : void Convenience function for setting disabled/enabled by boolean.
Convenience function for setting disabled/enabled by boolean.
Parameters:
|
Component | |
setHeight( Number height ) : Ext.BoxComponent
|
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:
|
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:
|
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:
|
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:
|
BoxComponent | |
setTitle( String title , [String iconCls ] ) : void Sets the title text for the panel and optionally the icon class.
Sets the title text for the panel and optionally the icon class.
Parameters:
|
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:
|
Component | |
setWidth( Number width ) : Ext.BoxComponent
|
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:
|
Window | |
suspendEvents() : void Suspend the firing of all events. (see resumeEvents)
Suspend the firing of all events. (see resumeEvents)
Parameters:
|
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:
|
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:
|
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:
|
Window | |
toggleCollapse( Boolean animate ) : Ext.Panel
Shortcut for performing an expand or collapse based on the current state of the panel.
Parameters:
|
Panel | |
toggleMaximize() : void | Window | |
un( String eventName , Function handler , [Object scope ] ) : void Removes a listener (shorthand for removeListener)
Removes a listener (shorthand for removeListener)
Parameters:
|
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:
|
BoxComponent |
Event | Defined By | |
---|---|---|
activate : ( Ext.Window this )
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
Panel | |
deactivate : ( Ext.Window this )
|
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:
|
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:
|
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:
|
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:
|
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:
|
Component | |
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
Panel |