X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/d41dc04ad17d1d9125fb2cf72db2b4782dbe3a8c..refs/heads/old:/docs/output/Ext.Container.html?ds=sidebyside diff --git a/docs/output/Ext.Container.html b/docs/output/Ext.Container.html index fb4029bc..43e286a3 100644 --- a/docs/output/Ext.Container.html +++ b/docs/output/Ext.Container.html @@ -1,46 +1,30 @@ -
Observable - Component - BoxComponent - Container
Package: | Ext |
Defined In: | Container.js |
Class: | Container |
Subclasses: | Panel, Viewport |
Extends: | BoxComponent |
Base class for any Ext.BoxComponent that can contain other components. The most commonly -used Container classes are Ext.Panel, Ext.Window and Ext.TabPanel, but you can -create a lightweight Container to encapsulate an HTML element that is created to your -specifications at render time by using the autoEl config option -which takes the form of a DomHelper specification. If you do not need -the capabilities offered by the above mentioned classes, for instance embedded -column layouts inside FormPanels, then this is a useful technique.
-The code below illustrates both how to explicitly create a Container, and how to implicitly -create one using the 'container' xtype:
var embeddedColumns = new Ext.Container({
- autoEl: {},
+Observable
+ Component
+ BoxComponent
+ Container
Class Ext.Container
Package: Ext Defined In: Container.js Class: Container Subclasses: Panel,
Toolbar,
Viewport,
Menu Extends: BoxComponent
Base class for any Ext.BoxComponent that may contain other Components. Containers handle the
+basic behavior of containing items, namely adding, inserting and removing items.
+The most commonly used Container classes are Ext.Panel, Ext.Window and Ext.TabPanel.
+If you do not need the capabilities offered by the aforementioned classes you can create a lightweight
+Container to be encapsulated by an HTML element to your specifications by using the
+autoEl
config option. This is a useful technique when creating
+embedded column layouts inside FormPanels
+for example.
+The code below illustrates both how to explicitly create a Container, and how to implicitly
+create one using the 'container'
xtype:
// explicitly create a Container
+var embeddedColumns = new Ext.Container({
+ autoEl: 'div', // This is the default
layout: 'column',
defaults: {
+ // implicitly create Container by specifying xtype
xtype: 'container',
- autoEl: {},
+ autoEl: 'div', // This is the default.
layout: 'form',
columnWidth: 0.5,
style: {
padding: '10px'
}
},
+// The two items below will be Ext.Containers, each encapsulated by a <DIV> element.
items: [{
items: {
xtype: 'datefield',
@@ -55,341 +39,397 @@ create one using the 'container' xtype:var embeddedCo
}
}]
});
-Containers handle the basic behavior of containing items, namely adding, inserting and removing them.
-The specific layout logic required to visually render contained items is delegated to any one of the different
-layout classes available.
-When either specifying child items of a Container, or dynamically adding components to a Container,
-remember to consider how you wish the Container to arrange those child elements, and whether those child elements
-need to be sized using one of Ext's built-in layout schemes.
-By default, Containers use the ContainerLayout scheme. This simply renders
-child components, appending them one after the other inside the Container, and does not apply any sizing at all.
-This is a common source of confusion when widgets like GridPanels or TreePanels are added to Containers for
-which no layout has been specified. If a Container is left to use the ContainerLayout scheme, none of its child
-components will be resized, or changed in any way when the Container is resized.
-A very common example of this is where a developer will attempt to add a GridPanel to a TabPanel by wrapping
-the GridPanel inside a wrapping Panel and add that wrapping Panel to the TabPanel. This misses the point that
-Ext's inheritance means that a GridPanel is a Component which can be added unadorned into a Container. If
-that wrapping Panel has no layout configuration, then the GridPanel will not be sized as expected.
-
Below is an example of adding a newly created GridPanel to a TabPanel. A TabPanel uses Ext.layout.CardLayout
-as its layout manager which means all its child items are sized to fit exactly into its client area. The following
-code requires prior knowledge of how to create GridPanels. See Ext.grid.GridPanel, Ext.data.Store
-and Ext.data.JsonReader as well as the grid examples in the Ext installation's examples/grid
-directory.
// Create the GridPanel.
-myGrid = new Ext.grid.GridPanel({
+Layout
+Container classes delegate the rendering of child Components to a layout
+manager class which must be configured into the Container using the
+layout
configuration property.
+When either specifying child items
of a Container,
+or dynamically adding Components to a Container, remember to
+consider how you wish the Container to arrange those child elements, and
+whether those child elements need to be sized using one of Ext's built-in
+layout
schemes. By default, Containers use the
+ContainerLayout scheme which only
+renders child components, appending them one after the other inside the
+Container, and does not apply any sizing at all.
+A common mistake is when a developer neglects to specify a
+layout
(e.g. widgets like GridPanels or
+TreePanels are added to Containers for which no layout
+has been specified). If a Container is left to use the default
+ContainerLayout scheme, none of its
+child components will be resized, or changed in any way when the Container
+is resized.
+Certain layout managers allow dynamic addition of child components.
+Those that do include Ext.layout.CardLayout,
+Ext.layout.AnchorLayout, Ext.layout.FormLayout, and
+Ext.layout.TableLayout. For example:
// Create the GridPanel.
+var myNewGrid = new Ext.grid.GridPanel({
store: myStore,
columns: myColumnModel,
- title: 'Results',
+ title: 'Results', // the title becomes the title of the tab
});
-myTabPanel.add(myGrid);
-myTabPanel.setActiveTab(myGrid);
-
-
-
- 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
-
-
-
-
-
- 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
-
-
-
-
-
- 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
-
-
-
-
-
- autoWidth : Boolean
- True to use width:'auto', false to use fixed width (defaults to false). Note: Although many components inherit this c...
-
- True to use width:'auto', false to use fixed width (defaults to false). Note: Although many components inherit this config option, not all will function as expected with a width of 'auto'. Setting autoWidth:true means that the browser will manage width based on the element's contents, and that Ext will not manage it at all.
-
-
- BoxComponent
-
-
-
-
-
- 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
-
-
-
-
-
- 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
-
-
-
-
-
- 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
-
-
-
-
-
- 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
-
-
-
-
-
- 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
-
-
-
-
-
- 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({
+myTabPanel.add(myNewGrid); // Ext.TabPanel implicitly uses CardLayout
+myTabPanel.setActiveTab(myNewGrid);
+The example above adds a newly created GridPanel to a TabPanel. Note that
+a TabPanel uses Ext.layout.CardLayout as its layout manager which
+means all its child items are sized to fit
+exactly into its client area.
+
Overnesting is a common problem.
+An example of overnesting occurs when a GridPanel is added to a TabPanel
+by wrapping the GridPanel inside a wrapping Panel (that has no
+layout
specified) and then add that wrapping Panel
+to the TabPanel. The point to realize is that a GridPanel is a
+Component which can be added directly to a Container. If the wrapping Panel
+has no layout
configuration, then the overnested
+GridPanel will not be sized as expected.
+
Adding via remote configuration
+A server side script can be used to add Components which are generated dynamically on the server.
+An example of adding a GridPanel to a TabPanel where the GridPanel is generated by the server
+based on certain parameters:
+
// execute an Ajax request to invoke server side script:
+Ext.Ajax.request({
+ url: 'gen-invoice-grid.php',
+ // send additional parameters to instruct server script
+ params: {
+ startDate: Ext.getCmp('start-date').getValue(),
+ endDate: Ext.getCmp('end-date').getValue()
+ },
+ // process the response object to add it to the TabPanel:
+ success: function(xhr) {
+ var newComponent = eval(xhr.responseText); // see discussion below
+ myTabPanel.add(newComponent); // add the component to the TabPanel
+ myTabPanel.setActiveTab(newComponent);
+ },
+ failure: function() {
+ Ext.Msg.alert("Grid create failed", "Server communication failure");
+ }
+});
+The server script needs to return an executable Javascript statement which, when processed
+using eval()
, will return either a config object with an xtype,
+or an instantiated Component. The server might return this for example:
(function() {
+ function formatDate(value){
+ return value ? value.dateFormat('M d, Y') : '';
+ };
+
+ var store = new Ext.data.Store({
+ url: 'get-invoice-data.php',
+ baseParams: {
+ startDate: '01/01/2008',
+ endDate: '01/31/2008'
+ },
+ reader: new Ext.data.JsonReader({
+ record: 'transaction',
+ idProperty: 'id',
+ totalRecords: 'total'
+ }, [
+ 'customer',
+ 'invNo',
+ {name: 'date', type: 'date', dateFormat: 'm/d/Y'},
+ {name: 'value', type: 'float'}
+ ])
+ });
+
+ var grid = new Ext.grid.GridPanel({
+ title: 'Invoice Report',
+ bbar: new Ext.PagingToolbar(store),
+ store: store,
+ columns: [
+ {header: "Customer", width: 250, dataIndex: 'customer', sortable: true},
+ {header: "Invoice Number", width: 120, dataIndex: 'invNo', sortable: true},
+ {header: "Invoice Date", width: 100, dataIndex: 'date', renderer: formatDate, sortable: true},
+ {header: "Value", width: 120, dataIndex: 'value', renderer: 'usMoney', sortable: true}
+ ],
+ });
+ store.load();
+ return grid; // return instantiated component
+})();
+When the above code fragment is passed through the eval
function in the success handler
+of the Ajax request, the code is executed by the Javascript processor, and the anonymous function
+runs, and returns the instantiated grid component.
+Note: since the code above is generated by a server script, the baseParams
for
+the Store, the metadata to allow generation of the Record layout, and the ColumnModel
+can all be generated into the code since these are all known on the server.
Config Options
Config Options Defined By activeItem : String/NumberA 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.AccordionLayout, Ext.layout.CardLayout and
+Ext.layout.FitLayout). Related to Ext.layout.ContainerLayout.activeItem. Container allowDomMove : BooleanWhether the component can move the Dom node when rendering (defaults to true). Component anchor : StringNote: this config is only used when this Component is rendered
+by a Container which has been configured to use an Anc...Note: this config is only used when this Component is rendered
+by a Container which has been configured to use an AnchorLayout (or subclass thereof).
+based layout manager, for example:
+- Ext.form.FormPanel
+- specifying
layout: 'anchor' // or 'form', or 'absolute'
+
+See Ext.layout.AnchorLayout.anchor also.
BoxComponent applyTo : MixedSpecify the id of the element, a DOM element or an existing Element corresponding to a DIV
+that is already present in...Specify the id of the element, a DOM element or an existing Element corresponding to a DIV
+that is already present in the document that specifies some structural markup for this
+component.
+- Description :
+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.
+
+- Notes :
+When 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 : BooleanIf 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 : MixedA tag name or DomHelper spec used to create the Element which will
+encapsulate this Component.
+You do not normally ne...A tag name or DomHelper spec used to create the Element which will
+encapsulate this Component.
+You do not normally need to specify this. For the base classes Ext.Component, Ext.BoxComponent,
+and Ext.Container, this defaults to 'div'. The more complex Ext classes use a more complex
+DOM structure created by their own onRender methods.
+This is intended to allow the developer to create application-specific utility Components encapsulated by
+different DOM elements. Example usage:
{
+ xtype: 'box',
+ autoEl: {
+ tag: 'img',
+ src: 'http://www.example.com/example.jpg'
+ }
+}, {
+ xtype: 'box',
+ autoEl: {
+ tag: 'blockquote',
+ html: 'autoEl is cool!'
+ }
+}, {
+ xtype: 'container',
+ autoEl: 'ul',
+ cls: 'ux-unordered-list',
+ items: {
+ xtype: 'box',
+ autoEl: 'li',
+ html: 'First list item'
+ }
+}
Component autoHeight : BooleanTrue to use height:'auto', false to use fixed height (or allow it to be managed by its parent
+Container's layout mana...True to use height:'auto', false to use fixed height (or allow it to be managed by its parent
+Container's layout manager. 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.
+If the browser is managing the height, be aware that resizes performed by the browser in response
+to changes within the structure of the Component cannot be detected. Therefore changes to the height might
+result in elements needing to be synchronized with the new height. Example:
var w = new Ext.Window({
+ title: 'Window',
+ width: 600,
+ autoHeight: true,
+ items: {
+ title: 'Collapse Me',
+ height: 400,
+ collapsible: true,
+ border: false,
+ listeners: {
+ beforecollapse: function() {
+ w.el.shadow.hide();
+ },
+ beforeexpand: function() {
+ w.el.shadow.hide();
+ },
+ collapse: function() {
+ w.syncShadow();
+ },
+ expand: function() {
+ w.syncShadow();
+ }
+ }
+ }
+}).show();
BoxComponent autoScroll : Booleantrue to use overflow:'auto' on the components layout element and show scroll bars automatically when
+necessary, false...true
to use overflow:'auto' on the components layout element and show scroll bars automatically when
+necessary, false
to clip any overflowing content (defaults to false
). BoxComponent autoShow : BooleanTrue 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 autoWidth : BooleanTrue to use width:'auto', false to use fixed width (or allow it to be managed by its parent
+Container's layout manage...True to use width:'auto', false to use fixed width (or allow it to be managed by its parent
+Container's layout manager. Defaults to false.
+Note: Although many components inherit this config option, not all will
+function as expected with a width of 'auto'. Setting autoWidth:true means that the
+browser will manage width based on the element's contents, and that Ext will not manage it at all.
+If the browser is managing the width, be aware that resizes performed by the browser in response
+to changes within the structure of the Component cannot be detected. Therefore changes to the width might
+result in elements needing to be synchronized with the new width. For example, where the target element is:
<div id='grid-container' style='margin-left:25%;width:50%'></div>
+A Panel rendered into that target element must listen for browser window resize in order to relay its
+child items when the browser changes its width:var myPanel = new Ext.Panel({
+ renderTo: 'grid-container',
+ monitorResize: true, // relay on browser resize
+ title: 'Panel',
+ height: 400,
+ autoWidth: true,
+ layout: 'hbox',
+ layoutConfig: {
+ align: 'stretch'
+ },
+ defaults: {
+ flex: 1
+ },
+ items: [{
+ title: 'Box 1',
+ }, {
+ title: 'Box 2'
+ }, {
+ title: 'Box 3'
+ }],
+});
BoxComponent boxMaxHeight : NumberThe maximum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana...The maximum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size management applied by layout managers.
BoxComponent boxMaxWidth : NumberThe maximum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag...The maximum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size management applied by layout managers.
BoxComponent boxMinHeight : NumberThe minimum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana...The minimum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size management applied by layout managers.
BoxComponent boxMinWidth : NumberThe minimum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag...The minimum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size management applied by layout managers.
BoxComponent bubbleEvents : ArrayAn array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble....An array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.
+Defaults to ['add', 'remove']
.
Container bufferResize : Boolean/NumberWhen set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
+th...When set to true (50 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. Defaults to 50
. Container clearCls : StringThe CSS class used to to apply to the special clearing div rendered
+directly after each form field wrapper to provide...The CSS class used to to apply to the special clearing div rendered
+directly after each form field wrapper to provide field clearing (defaults to
+'x-form-clear-left').
+
Note: this config is only used when this Component is rendered by a Container
+which has been configured to use the FormLayout layout
+manager (e.g. Ext.form.FormPanel or specifying layout:'form') and either a
+fieldLabel is specified or isFormField=true is specified.
+See Ext.layout.FormLayout.fieldTpl also.
Component cls : StringAn optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
+useful for ...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 contentEl : StringOptional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
+for this comp...Optional. Specify an existing HTML element, or the id
of an existing HTML element to use as the content
+for this component.
+
+- Description :
+This config option is used to take an existing HTML element and place it in the layout element
+of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.
+- Notes :
+The specified HTML element is appended to the layout element of the component after any configured
+HTML has been inserted, and so the document will not contain this element at the time the render event is fired.
+The specified HTML element used will not participate in any
layout
+scheme that the Component may use. It is just HTML. Layouts operate on child items
.
+Add either the x-hidden
or the x-hide-display
CSS class to
+prevent a brief flicker of the content before it is rendered to the panel.
+
Component ctCls : StringAn optional extra CSS class that will be added to this component's container. This can be useful for
+adding customize...An optional extra CSS class that will be added to this component's container. This can be useful for
+adding customized styles to the container or any of its children using standard CSS rules. See
+Ext.layout.ContainerLayout.extraCls also.
+Note: ctCls defaults to '' except for the following class
+which assigns a value by default:
+
+- Box Layout : 'x-box-layout-ct'
+
+To configure the above Class with an extra CSS class append to the default. For example,
+for BoxLayout (Hbox and Vbox):ctCls: 'x-box-layout-ct custom-class'
+ Component data : MixedThe initial set of data to apply to the tpl
to
+update the content area of the Component. Component defaultType : StringThe 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'
, except Ext.menu.Menu which defaults to 'menuitem'
,
+and Ext.Toolbar and Ext.ButtonGroup which default to 'button'
.
Container defaults : Object|FunctionThis option is a means of applying default settings to all added items whether added through the items
+config or via ...This option is a means of applying default settings to all added items whether added through the items
+config or via the add or insert methods.
+If an added item is a config object, and not an instantiated Component, then the default properties are
+unconditionally applied. If the added item is an instantiated Component, then the default properties are
+applied conditionally so as not to override existing properties in the item.
+If the defaults option is specified as a function, then the function will be called using this Container as the
+scope (this
reference) and passing the added item as the first parameter. Any resulting object
+from that call is then applied to the item as default properties.
+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'}
.
+Usage:
defaults: { // defaults are applied to items, not the container
+ autoScroll:true
+},
+items: [
+ {
+ xtype: 'panel', // defaults do not have precedence over
+ id: 'panel1', // options in config objects, so the defaults
+ autoScroll: false // will not be applied here, panel1 will be autoScroll:false
+ },
+ new Ext.Panel({ // defaults do have precedence over options
+ id: 'panel2', // options in components, so the defaults
+ autoScroll: false // will be applied here, panel2 will be autoScroll:true.
+ })
+]
Container disabled : BooleanRender this component disabled (default is false). Component disabledClass : StringCSS class added to the component when it is disabled (defaults to 'x-item-disabled'). Component fieldLabel : StringThe label text to display next to this Component (defaults to '').
+Note: this config is only used when this Component...The label text to display next to this Component (defaults to '').
+
Note: this config is only used when this Component is rendered by a Container which
+has been configured to use the FormLayout layout manager (e.g.
+Ext.form.FormPanel or specifying layout:'form').
+Also see hideLabel and
+Ext.layout.FormLayout.fieldTpl.
+Example use:new Ext.FormPanel({
height: 100,
renderTo: Ext.getBody(),
items: [{
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
-
-
- Component
-
-
-
-
-
- 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
-
-
-
-
-
- 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({
+});
Component flex : NumberNote: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxL...Note: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxLayout.
+Each child Component with a flex
property will be flexed either vertically (by a VBoxLayout)
+or horizontally (by an HBoxLayout) according to the item's relative flex
value
+compared to the sum of all Components with flex value specified. Any child items that have
+either a flex = 0
or flex = undefined
will not be 'flexed' (the initial size will not be changed).
BoxComponent forceLayout : BooleanIf true the container will force a layout initially even if hidden or collapsed. This option
+is useful for forcing fo...If true the container will force a layout initially even if hidden or collapsed. This option
+is useful for forcing forms to render in collapsed or hidden containers. (defaults to false). Container height : NumberThe height of this component in pixels (defaults to auto).
+Note to express this dimension as a percentage or offset s...The height of this component in pixels (defaults to auto).
+Note to express this dimension as a percentage or offset see Ext.Component.anchor. BoxComponent hidden : BooleanRender this component hidden (default is false). If true, the
+hide method will be called internally. Component hideBorders : BooleanTrue 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 hideLabel : Booleantrue to completely hide the label element
+(label and separator). Defaults to false.
+By default, even if you do not sp...true to completely hide the label element
+(label and separator). 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.
+
Note: see the note for clearCls.
+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
-
-
-
-
-
- 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:
+});
Component hideMode : StringHow 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).
+
Note: the default of 'display' is generally preferred
+since items are automatically laid out when they are first shown (no sizing
+is done while hidden).
Component hideParent : BooleanTrue 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/ObjectAn HTML fragment, or a DomHelper specification to use as the layout element
+content (defaults to ''). The HTML conten...An HTML fragment, or a DomHelper specification to use as the layout element
+content (defaults to ''). The HTML content is added after the component is rendered,
+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. Component id : StringThe 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.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.
+Note: to avoid complications imposed by a unique id also see
+itemId
and ref
.
+Note: to access the container of an item see ownerCt
.
Component itemCls : StringNote: this config is only used when this Component is rendered by a Container which
+has been configured to use the Fo...Note: this config is only used when this Component is rendered by a Container which
+has been configured to use the FormLayout layout manager (e.g.
+Ext.form.FormPanel or specifying layout:'form').
+An additional CSS class to apply to the div wrapping the form item
+element of this field. If supplied, itemCls at the field level will override
+the default itemCls supplied at the container level. The value specified for
+itemCls will be added to the default class ('x-form-item').
+Since it is applied to the item wrapper (see
+Ext.layout.FormLayout.fieldTpl), 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.
+
Note: see the note for fieldLabel.
+Example use:// Apply a style to the field's label:
<style>
- .required .x-form-item-label {font-weight:bold;color:red;}
+ .required .x-form-item-label {font-weight:bold;color:red;}
</style>
new Ext.FormPanel({
@@ -398,56 +438,110 @@ myTabPanel.setActiveTab(myGrid);
items: [{
xtype: 'textfield',
fieldLabel: 'Name',
- itemCls: 'required' //this label will be styled
+ 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
-
-
-
-
-
- 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({
+});
Component itemId : StringAn itemId can be used as an alternative way to get a reference to a component
+when no object reference is available. ...An itemId can be used as an alternative way to get a reference to a component
+when no object reference is available. Instead of using an id
with
+Ext.getCmp, use itemId
with
+Ext.Container.getComponent which will retrieve
+itemId
's or id's. Since itemId
's are an index to the
+container's internal MixedCollection, the itemId
is scoped locally to the container --
+avoiding potential conflicts with Ext.ComponentMgr which requires a unique
+id
.
+var c = new Ext.Panel({ //
+ height: 300,
+ renderTo: document.body,
+ layout: 'auto',
+ items: [
+ {
+ itemId: 'p1',
+ title: 'Panel 1',
+ height: 150
+ },
+ {
+ itemId: 'p2',
+ title: 'Panel 2',
+ height: 150
+ }
+ ]
+})
+p1 = c.getComponent('p1'); // not the same as Ext.getCmp()
+p2 = p1.ownerCt.getComponent('p2'); // reference via a sibling
+
+Note: to access the container of an item see ownerCt.
Component items : Object/Array** IMPORTANT: be sure to specify a layout if needed ! **
+A single item, or an array of child Components to be added t...** IMPORTANT: be sure to specify a layout
if needed ! **
+A single item, or an array of child Components to be added to this container,
+for example:
+// specifying a single item
+items: {...},
+layout: 'fit', // specify a layout!
+
+// specifying multiple items
+items: [{...}, {...}],
+layout: 'anchor', // specify a layout!
+Each item may be:
+
+- any type of object based on Ext.Component
+- a fully instanciated object or
+- an object literal that:
+
+- has a specified
xtype
+- the Ext.Component.xtype specified is associated with the Component
+desired and should be chosen from one of the available xtypes as listed
+in Ext.Component.
+- If an
xtype
is not explicitly
+specified, the defaultType for that Container is used.
+- will be "lazily instanciated", avoiding the overhead of constructing a fully
+instanciated Component object
+
+Notes:
+ Container labelSeparator : StringThe separator to display after the text of each
+fieldLabel. This property may be configured at various levels.
+The o...The separator to display after the text of each
+fieldLabel. This property may be configured at various levels.
+The order of precedence is:
+
+- field / component level
+- container level
+- layout level (defaults to colon ':')
+
+To display no separator for this field's label specify empty string ''.
+
Note: see the note for clearCls.
+Also see hideLabel and
+Ext.layout.FormLayout.fieldTpl.
+Example use:new Ext.FormPanel({
height: 100,
renderTo: Ext.getBody(),
+ layoutConfig: {
+ labelSeparator: '~' // layout config has lowest priority (defaults to ':')
+ },
+ labelSeparator: '>>', // config at container level
items: [{
xtype: 'textfield',
- fieldLabel: 'Name',
- labelSeparator: '...'
+ fieldLabel: 'Field 1',
+ labelSeparator: '...' // field/component level config supersedes others
+ },{
+ xtype: 'textfield',
+ fieldLabel: 'Field 2' // labelSeparator will be '='
}]
-});
-
-
- 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({
+});
Component labelStyle : StringA CSS style specification string to apply directly to this field's
+label. Defaults to the container's labelStyle val...A CSS style specification string to apply directly to this field's
+label. Defaults to the container's labelStyle value if set (e.g.,
+Ext.layout.FormLayout.labelStyle , or '').
+
Note: see the note for clearCls
.
+Also see hideLabel
and
+Ext.layout.FormLayout.fieldTpl.
+Example use:new Ext.FormPanel({
height: 100,
renderTo: Ext.getBody(),
items: [{
@@ -455,1932 +549,846 @@ myTabPanel.setActiveTab(myGrid);
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:
-
-
- 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
-
-
-
-
-
- monitorResize : Boolean
- True to automatically monitor window resize events to handle anything that is sensitive to the current size of the vi...
-
- True to automatically monitor window resize events to handle anything that is sensitive to the current size of the viewport. This value is typically managed by the chosen layout and should not need to be set manually.
-
-
- Container
-
-
-
-
-
- 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
-
-
-
-
-
- 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
-
-
-
-
-
- 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
-
-
-
-
-
- width : Number
- The width of this component in pixels (defaults to auto).
-
- BoxComponent
-
-
-
-
-
- x : Number
- The local x (left) coordinate for this component if contained within a positioning container.
-
- BoxComponent
-
-
-
-
-
- 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 local y (top) coordinate for this component if contained within a positioning container.
-
- BoxComponent
-
-
-
- Public Properties
-
-
- Property
- Defined By
-
-
-
-
-
- disabled : Boolean
- True if this component is disabled. Read-only.
-
- Component
-
-
-
-
-
-
-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
-
-
-
- Public Methods
-
-
- Method
- Defined By
-
-
-
-
-
- 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/ObjectThe 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
-
-
-
-
-
- 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
: stringThe 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
: ObjectThe 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
: StringThe type of event to listen forhandler
: FunctionThe method the event invokesscope
: 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
+});
Component layout : String/Object*Important: In order for child items to be correctly sized and
+positioned, typically a layout manager must be specifi...*Important: In order for child items to be correctly sized and
+positioned, typically a layout manager must be specified through
+the layout
configuration option.
+
The sizing and positioning of child items is the responsibility of
+the Container's layout manager which creates and manages the type of layout
+you have in mind. For example:
new Ext.Window({
+ width:300, height: 300,
+ layout: 'fit', // explicitly set layout manager: override the default (layout:'auto')
+ items: [{
+ title: 'Panel inside a Window'
+ }]
+}).show();
+If the layout configuration is not explicitly specified for
+a general purpose container (e.g. Container or Panel) the
+default layout manager will be used
+which does nothing but render child components sequentially into the
+Container (no sizing or positioning will be performed in this situation).
+Some container classes implicitly specify a default layout
+(e.g. FormPanel specifies layout:'form'
). Other specific
+purpose classes internally specify/manage their internal layout (e.g.
+GridPanel, TabPanel, TreePanel, Toolbar, Menu, etc.).
+
layout
may be specified as either as an Object or
+as a String:
+- Specify as an Object
+
+- Example usage:
+
layout: {
+ type: 'vbox',
+ padding: '5',
+ align: 'left'
+}
+type
+
The layout type to be used for this container. If not specified,
+a default Ext.layout.ContainerLayout will be created and used.
+
Valid layout type
values are:
+
+- Layout specific configuration properties
+
Additional layout specific configuration properties may also be
+specified. For complete details regarding the valid config options for
+each layout type, see the layout class corresponding to the type
+specified.
+
+- Specify as a String
+
+- Example usage:
+
layout: 'vbox',
+layoutConfig: {
+ padding: '5',
+ align: 'left'
+}
+layout
+
The layout type
to be used for this container (see list
+of valid layout type values above).
+layoutConfig
+
Additional layout specific configuration properties. For complete
+details regarding the valid config options for each layout type, see the
+layout class corresponding to the layout
specified.
+
Container layoutConfig : Object Container listeners : ObjectA config object containing one or more event handlers to be added to this
+object during initialization. This should ...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.
+
DOM events from ExtJs Components
+
While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
+is usually only done when extra value can be added. For example the DataView's
+click
event passing the node clicked on. To access DOM
+events directly from a Component's HTMLElement, listeners must be added to the Element after the Component
+has been rendered. A plugin can simplify this step:
// Plugin is configured with a listeners config object.
+// The Component is appended to the argument list of all handler functions.
+Ext.DomObserver = Ext.extend(Object, {
+ constructor: function(config) {
+ this.listeners = config.listeners ? config.listeners : config;
+ },
+
+ // Component passes itself into plugin's init method
+ init: function(c) {
+ var p, l = this.listeners;
+ for (p in l) {
+ if (Ext.isFunction(l[p])) {
+ l[p] = this.createHandler(l[p], c);
+ } else {
+ l[p].fn = this.createHandler(l[p].fn, c);
+ }
+ }
+
+ // Add the listeners to the Element immediately following the render call
+ c.render = c.render.createSequence(function() {
+ var e = c.getEl();
+ if (e) {
+ e.on(l);
+ }
+ });
+ },
+
+ createHandler: function(fn, c) {
+ return function(e) {
+ fn.call(this, e, c);
+ };
+ }
+});
+
+var combo = new Ext.form.ComboBox({
+
+ // Collapse combo when its element is clicked on
+ plugins: [ new Ext.DomObserver({
+ click: function(evt, comp) {
+ comp.collapse();
+ }
+ })],
+ store: myStore,
+ typeAhead: true,
+ mode: 'local',
+ triggerAction: 'all'
+});
Observable margins : ObjectNote: this config is only used when this BoxComponent is rendered
+by a Container which has been configured to use the...Note: this config is only used when this BoxComponent is rendered
+by a Container which has been configured to use the BorderLayout
+or one of the two BoxLayout subclasses.
+An object containing margins to apply to this BoxComponent in the
+format:
{
+ top: (top margin),
+ right: (right margin),
+ bottom: (bottom margin),
+ left: (left margin)
+}
+May also be a string containing space-separated, numeric margin values. The order of the
+sides associated with each value matches the way CSS processes margin values:
+
+- If there is only one value, it applies to all sides.
+- If there are two values, the top and bottom borders are set to the first value and the
+right and left are set to the second.
+- If there are three values, the top is set to the first value, the left and right are set
+to the second, and the bottom is set to the third.
+- If there are four values, they apply to the top, right, bottom, and left, respectively.
+
+Defaults to:
{top:0, right:0, bottom:0, left:0}
BoxComponent monitorResize : BooleanTrue to automatically monitor window resize events to handle anything that is sensitive to the current size
+of the vi...True to automatically monitor window resize events to handle anything that is sensitive to the current size
+of the viewport. This value is typically managed by the chosen layout
and should not need
+to be set manually. Container overCls : StringAn 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 : NumberThe page level x coordinate for this component if contained within a positioning container. BoxComponent pageY : NumberThe page level y coordinate for this component if contained within a positioning container. BoxComponent plugins : Object/ArrayAn object or array of objects that will provide custom functionality for this component. The only
+requirement for a ...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 ptype : StringThe registered ptype to create. This config option is not used when passing
+a config object into a constructor. This ...The registered ptype 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 Plugin is being
+specified not as a fully instantiated Component, but as a Component config
+object. The ptype will be looked up at render time up to determine what
+type of Plugin to create.
+If you create your own Plugins, you may register them using
+Ext.ComponentMgr.registerPlugin in order to be able to
+take advantage of lazy instantiation and rendering. Component ref : StringA path specification, relative to the Component's ownerCt
+specifying into which ancestor Container to place a named r...A path specification, relative to the Component's ownerCt
+specifying into which ancestor Container to place a named reference to this Component.
+The ancestor axis can be traversed by using '/' characters in the path.
+For example, to put a reference to a Toolbar Button into the Panel which owns the Toolbar:
var myGrid = new Ext.grid.EditorGridPanel({
+ title: 'My EditorGridPanel',
+ store: myStore,
+ colModel: myColModel,
+ tbar: [{
+ text: 'Save',
+ handler: saveChanges,
+ disabled: true,
+ ref: '../saveButton'
+ }],
+ listeners: {
+ afteredit: function() {
+// The button reference is in the GridPanel
+ myGrid.saveButton.enable();
+ }
+ }
+});
+In the code above, if the ref
had been 'saveButton'
+the reference would have been placed into the Toolbar. Each '/' in the ref
+moves up one level from the Component's ownerCt
.
+ Component region : StringNote: this config is only used when this BoxComponent is rendered
+by a Container which has been configured to use the...Note: this config is only used when this BoxComponent is rendered
+by a Container which has been configured to use the BorderLayout
+layout manager (e.g. specifying layout:'border').
+See Ext.layout.BorderLayout also.
BoxComponent renderTo : MixedSpecify the id of the element, a DOM element or an existing Element that this component
+will be rendered into.
+Notes ...Specify the id of the element, a DOM element or an existing Element that this component
+will be rendered into.
+- Notes :
+Do not use this option if the Component is to be a child item of
+a Container. It is the responsibility of the
+Container's layout manager
+to render and manage its child items.
+When using this config, a call to render() is not required.
+
+
+See render also.
Component resizeEvent : StringThe event to listen to for resizing in layouts. Defaults to 'resize'
. Container stateEvents : ArrayAn array of events that, when fired, should trigger this component to
+save its state (defaults to none). stateEvents ...An array of events that, when fired, should trigger this component to
+save its state (defaults to none). stateEvents
may be any type
+of event 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 : StringThe 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 : BooleanA 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({
+ expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now
+}));
+A stateful Component attempts to save state when one of the events
+listed in the stateEvents
configuration fires.
+To save state, a stateful Component first serializes its state by
+calling getState
. By default, this function does
+nothing. The developer must provide an implementation which returns an
+object hash which represents the Component's restorable state.
+The value yielded by getState is passed to Ext.state.Manager.set
+which uses the configured Ext.state.Provider to save the object
+keyed by the Component's stateId
, or, if that is not
+specified, its id
.
+During construction, a stateful Component attempts to restore
+its state by calling Ext.state.Manager.get passing the
+stateId
, or, if that is not specified, the
+id
.
+The resulting object is passed to applyState
.
+The default implementation of applyState
simply copies
+properties into the object, but a developer may override this to support
+more behaviour.
+You can perform extra processing on state save and restore by attaching
+handlers to the beforestaterestore, staterestore,
+beforestatesave and statesave events.
Component style : StringA custom style specification to be applied to this component's Element. Should be a valid argument to
+Ext.Element.ap...A custom style specification to be applied to this component's Element. Should be a valid argument to
+Ext.Element.applyStyles.
+new Ext.Panel({
+ title: 'Some Title',
+ renderTo: Ext.getBody(),
+ width: 400, height: 300,
+ layout: 'form',
+ items: [{
+ xtype: 'textarea',
+ style: {
+ width: '95%',
+ marginBottom: '10px'
+ }
+ },
+ new Ext.Button({
+ text: 'Send',
+ minWidth: '100',
+ style: {
+ marginBottom: '10px'
+ }
+ })
+ ]
+});
Component tabTip : StringNote: this config is only used when this BoxComponent is a child item of a TabPanel.
+A string to be used as innerHTML...Note: this config is only used when this BoxComponent is a child item of a TabPanel.
+A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over
+the associated tab selector element. Ext.QuickTips.init()
+must be called in order for the tips to render. BoxComponent tpl : MixedAn Ext.Template, Ext.XTemplate
+or an array of strings to form an Ext.XTemplate.
+Used in conjunction with the data and...An Ext.Template , Ext.XTemplate
+or an array of strings to form an Ext.XTemplate.
+Used in conjunction with the data
and
+tplWriteMode
configurations. Component tplWriteMode : StringThe Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.X...The Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.XTemplate.overwrite
). Component width : NumberThe width of this component in pixels (defaults to auto).
+Note to express this dimension as a percentage or offset se...The width of this component in pixels (defaults to auto).
+Note to express this dimension as a percentage or offset see Ext.Component.anchor. BoxComponent x : NumberThe local x (left) coordinate for this component if contained within a positioning container. BoxComponent xtype : StringThe 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 : NumberThe local y (top) coordinate for this component if contained within a positioning container. BoxComponent
Public Properties
Property Defined By disabled : BooleanTrue if this component is disabled. Read-only. Component el : Ext.ElementThe Ext.Element which encapsulates this Component. Read-only.
+This will usually be a <DIV> element created by the ...The Ext.Element which encapsulates this Component. Read-only.
+This will usually be a <DIV> element created by the class's onRender method, but
+that may be overridden using the autoEl
config.
+
Note: this element will not be available until this Component has been rendered.
+To add listeners for DOM events to this Component (as opposed to listeners
+for this Component's own Observable events), see the listeners
+config for a suggestion, or use a render listener directly:
new Ext.Panel({
+ title: 'The Clickable Panel',
+ listeners: {
+ render: function(p) {
+ // Append the Panel to the click handler's argument list.
+ p.getEl().on('click', handlePanelClick.createDelegate(null, [p], true));
+ },
+ single: true // Remove the listener after first invocation
+ }
+});
+See also getEl
Component hidden : BooleanTrue if this component is hidden. Read-only. Component initialConfig : ObjectThis Component's initial configuration specification. Read-only. Component items : MixedCollectionThe collection of components in this container as a Ext.util.MixedCollection Container ownerCt : Ext.ContainerThis Component's owner Container (defaults to undefined, and is set automatically when
+this Component is added to a C... Component refOwner : Ext.ContainerThe ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has...The ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has been configured with a ref
. Component rendered : BooleanTrue if this component has been rendered. Read-only. Component
Public Methods
Method Defined By add( ...Object/Array component
)
+ :
+ Ext.Component/ArrayAdds Component(s) to this Container.
+Description :
+<ul class="mdetail-params">
+Fires the beforeadd event before addin...Adds Component(s) to this Container.
+
Description :
+
+- Fires the beforeadd event before adding
+- The Container's default config values will be applied
+accordingly (see
defaults
for details).
+- Fires the add event after the component has been added.
+
+
Notes :
+
+- 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. For example:var tb = new Ext.Toolbar();
+tb.render(document.body); // toolbar is rendered
+tb.add({text:'Button 1'}); // add multiple items (defaultType for Toolbar is 'button')
+tb.add({text:'Button 2'});
+tb.doLayout(); // refresh the layout
+- Warning: Containers directly managed by the BorderLayout layout manager
+may not be removed or added. See the Notes for BorderLayout
+for more details.
+
Parameters:component
: ...Object/ArrayEither one or more Components to add or an Array of Components to add. See
+items
for additional information.
Returns:Ext.Component/Array
The Components that were added.
Container addClass( string cls
)
+ :
+ Ext.ComponentAdds a CSS class to the component's underlying element.Adds a CSS class to the component's underlying element.Parameters:cls
: stringThe CSS class name to add
Returns:Ext.Component
this
Component addEvents( Object|String o
, string Optional.
)
+ :
+ voidAdds the specified events to the list of events which this Observable may fire.Adds the specified events to the list of events which this Observable may fire.Parameters:o
: Object|StringEither an object with event names as properties with a value of true
+or the first event name string if multiple event names are being passed as separate parameters.Optional.
: stringEvent name if multiple event names are being passed as separate parameters.
+Usage:this.addEvents('storeloaded', 'storecleared');
Returns:- void
Observable addListener( String eventName
, Function handler
, [Object scope
], [Object options
] )
+ :
+ voidAppends an event handler to this object.Appends an event handler to this object.Parameters:eventName
: StringThe name of the event to listen for.handler
: FunctionThe method the event invokes.scope
: Object(optional) The scope (this
reference) in which the handler function is executed.
+If omitted, defaults to the object which fired the event.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
+
- scope : ObjectThe scope (
this
reference) in which the handler function is executed.
+If omitted, defaults to the object which fired the event.
+- delay : NumberThe number of milliseconds to delay the invocation of the handler after the event fires.
+- single : BooleanTrue to add a handler to handle just the next firing of the event, and then remove itself.
+- buffer : NumberCauses 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.
+handler is not invoked, but the new handler is scheduled in its place.
+- target : ObservableOnly call the handler if the event was fired on the target Observable, not
+if the event was bubbled up from a child Observable.
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
+A delayed, one-time listener.
+myDataView.on('click', this.onClick, this, {
+single: true,
+delay: 100
});
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
- }
+myGridPanel.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
-
-
-
-
-
- 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
+myGridPanel.on({
+'click' : this.onClick,
+'mouseover' : this.onMouseOver,
+'mouseout' : this.onMouseOut,
+ scope: this
+});
Returns:- void
Observable applyToMarkup( String/HTMLElement el
)
+ :
+ voidApply 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
] )
+ :
+ Ext.ComponentBubbles 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
: FunctionThe function to callscope
: 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
+the bubble is stopped.Parameters:fn
: FunctionThe function to callscope
: 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:Ext.Component
this
Component cascade( Function fn
, [Object scope
], [Array args
] )
+ :
+ Ext.ContainerCascades 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
: FunctionThe function to callscope
: 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
-
-
-
-
-
- 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
: ObjectA 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
-
-
-
-
-
- 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
-
-
-
-
-
- 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
: Stringvalue
: 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
: Functionscope
: 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/ClassThe xtype string for a component, or the class of the component directlyshallow
: 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
: Functionscope
: 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/ClassThe 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
: Stringargs
: 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( [Boolean selectText
], [Boolean/Number delay
] ) : Ext.Component
- Try to focus this component.
-
- Try to focus this component.
- Parameters:
- selectText
: Boolean(optional) If applicable, true to also select the text in this componentdelay
: Boolean/Number(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)
- Returns:
-
- Ext.Component
this
-
-
-
-
-
- Component
-
-
-
-
-
- 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/Numberor 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
-
-
-
-
-
- getId() : String
- Returns the id of this component.
-
- Returns the id of this component.
- Parameters:
- - None.
- Returns:
-
- String
-
-
-
-
-
- Component
-
-
-
-
-
- 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
+the cascade is stopped on that branch.
Parameters:fn
: FunctionThe function to callscope
: 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:Ext.Container
this
Container cloneConfig( Object overrides
)
+ :
+ Ext.ComponentClone 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
: ObjectA 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 destroy()
+ :
+ voidDestroys 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.ComponentDisable this component and fire the 'disable' event.Disable this component and fire the 'disable' event.Parameters:- None.
Returns:Ext.Component
this
Component doLayout( [Boolean shallow
], [Boolean force
] )
+ :
+ Ext.ContainerForce 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)force
: Boolean(optional) True to force a layout to occur, even if the item is hidden.
Returns:Ext.Container
this
Container enable()
+ :
+ Ext.ComponentEnable this component and fire the 'enable' event.Enable this component and fire the 'enable' event.Parameters:- None.
Returns:Ext.Component
this
Component enableBubble( String/Array events
)
+ :
+ voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present....Enables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget()
if present. There is no implementation in the Observable base class.
+This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.
+Example:
Ext.override(Ext.form.Field, {
+ // Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+ // We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget : function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
+ }
+ }
+});
Parameters:events
: String/ArrayThe event name to bubble, or an Array of event names.
Returns:- void
Observable find( String prop
, String value
)
+ :
+ ArrayFind a component under this container at any level by propertyFind a component under this container at any level by propertyParameters:prop
: Stringvalue
: String
Returns:Array
Array of Ext.Components
Container findBy( Function fn
, [Object scope
] )
+ :
+ ArrayFind 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:fn
: FunctionThe function to callscope
: Object(optional)
Returns:Array
Array of Ext.Components
Container findById( String id
)
+ :
+ Ext.ComponentFind a component under this container at any level by idFind a component under this container at any level by idParameters:id
: String
Returns:Ext.Component
Container findByType( String/Class xtype
, [Boolean shallow
] )
+ :
+ ArrayFind a component under this container at any level by xtype or classFind a component under this container at any level by xtype or classParameters:xtype
: String/ClassThe xtype string for a component, or the class of the component directlyshallow
: 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 fn
)
+ :
+ Ext.ContainerFind 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.Parameters:fn
: FunctionThe custom function to call with the arguments (container, this component).
Returns:Ext.Container
The first Container for which the custom function returns true
Component findParentByType( String/Ext.Component/Class xtype
, [Boolean shallow
] )
+ :
+ Ext.ContainerFind a container above this component at any level by xtype or classFind a container above this component at any level by xtype or classParameters:xtype
: String/Ext.Component/ClassThe xtype to check for this Component. Note that the the component can either be an instance
+or a component class: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:Ext.Container
The first Container which matches the given xtype or class
Component fireEvent( String eventName
, Object... args
)
+ :
+ BooleanFires the specified event with the passed parameters (minus the event name).
+An event may be set to bubble up an Obse...Fires the specified event with the passed parameters (minus the event name).
+An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)
+by calling enableBubble.
Parameters:eventName
: StringThe name of the event to fire.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( [Boolean selectText
], [Boolean/Number delay
] )
+ :
+ Ext.ComponentTry to focus this component.Try to focus this component.Parameters:selectText
: Boolean(optional) If applicable, true to also select the text in this componentdelay
: Boolean/Number(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)
Returns:Ext.Component
this
Component get( String/Number key
)
+ :
+ Ext.ComponentGet a component contained by this container (alias for items.get(key))Get a component contained by this container (alias for items.get(key))Parameters:key
: String/NumberThe index or id of the component
Returns:Ext.Component
Ext.Component
Container getBox( [Boolean local
] )
+ :
+ ObjectGets 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 getBubbleTarget()
+ :
+ Ext.ContainerProvides the link for Observable's fireEvent method to bubble up the ownership hierarchy.Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.Parameters:- None.
Returns:Ext.Container
the Container which owns this Component.
Component getComponent( String/Number comp
)
+ :
+ Ext.ComponentExamines this container's items property
+and gets a direct child component of this container.Examines this container's items
property
+and gets a direct child component of this container.Parameters:comp
: String/NumberThis parameter may be any of the following:
+
+For additional information see Ext.util.MixedCollection.get.
Returns:Ext.Component
The component (if found).
Container getEl()
+ :
+ Ext.ElementReturns the Ext.Element which encapsulates this Component.
+This will usually be a <DIV> element created by the cla...Returns the Ext.Element which encapsulates this Component.
+This will usually be a <DIV> element created by the class's onRender method, but
+that may be overridden using the autoEl config.
+
Note: this element will not be available until this Component has been rendered.
+To add listeners for DOM events to this Component (as opposed to listeners
+for this Component's own Observable events), see the listeners config for a suggestion,
+or use a render listener directly:
new Ext.Panel({
+ title: 'The Clickable Panel',
+ listeners: {
+ render: function(p) {
+ // Append the Panel to the click handler's argument list.
+ p.getEl().on('click', handlePanelClick.createDelegate(null, [p], true));
+ },
+ single: true // Remove the listener after first invocation
+ }
+});
Parameters:- None.
Returns:Ext.Element
The Element which encapsulates this Component.
Component getHeight()
+ :
+ NumberGets the current height of the component's underlying element.Gets the current height of the component's underlying element.Parameters:- None.
Returns:Number
BoxComponent getId()
+ :
+ StringReturns the id of this component or automatically generates and
+returns an id if an id is not defined yet:'ext-comp-'...Returns the id
of this component or automatically generates and
+returns an id
if an id
is not defined yet:'ext-comp-' + (++Ext.Component.AUTO_ID)
Parameters:- None.
Returns:String
id
Component getItemId()
+ :
+ String Component getLayout()
+ :
+ ContainerLayoutReturns 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.ElementReturns 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
-
-
-
-
-
- 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.
+the element into which the layout renders child Components.Parameters:- None.
Returns:Ext.Element
The Element to render child Components into.
Container getOuterSize()
+ :
+ ObjectGets the current size of the component's underlying element, including space taken by its margins.Gets the current size of the component's underlying element, including space taken by its margins.Parameters:- None.
Returns:Object
An object containing the element's size {width: (element width + left/right margins), height: (element height + top/bottom margins)}
BoxComponent getPosition( [Boolean local
] )
+ :
+ ArrayGets 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 getResizeEl()
+ :
+ Ext.ElementReturns the outermost Element of this Component which defines the Components overall size.
+Usually this will return t...Returns the outermost Element of this Component which defines the Components overall size.
+Usually this will return the same Element as getEl
,
+but in some cases, a Component may have some more wrapping Elements around its main
+active Element.
+An example is a ComboBox. It is encased in a wrapping Element which
+contains both the <input>
Element (which is what would be returned
+by its getEl
method, and the trigger button Element.
+This Element is returned as the resizeEl
.
Parameters:- None.
Returns:Ext.Element
The Element which is to be resized by size managing layouts.
BoxComponent getSize()
+ :
+ ObjectGets 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 getWidth()
+ :
+ NumberGets the current width of the component's underlying element.Gets the current width of the component's underlying element.Parameters:- None.
Returns:Number
BoxComponent getXType()
+ :
+ StringGets 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()
+ :
+ StringReturns 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
: StringThe name of the event to check for
- Returns:
-
- Boolean
True if the event is being listened for, else false
-
-
-
-
-
- Observable
-
-
-
-
-
- hide() : Ext.Component
- Hide this component.
-
- Hide this component.
- Parameters:
- - None.
- Returns:
-
- Ext.Component
this
-
-
-
-
-
- Component
-
-
-
-
-
- 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
: NumberThe index at which the Component will be inserted
+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
)
+ :
+ BooleanChecks to see if this object has any listeners for a specified eventChecks to see if this object has any listeners for a specified eventParameters:eventName
: StringThe name of the event to check for
Returns:Boolean
True if the event is being listened for, else false
Observable hide()
+ :
+ Ext.ComponentHide this component. Listen to the 'beforehide' event and return
+false to cancel hiding the component. Fires the 'h...Hide this component. Listen to the 'beforehide' event and return
+false to cancel hiding the component. Fires the 'hide'
+event after hiding the component. Note this method is called internally if
+the component is configured to be hidden
.Parameters:- None.
Returns:Ext.Component
this
Component insert( Number index
, Ext.Component component
)
+ :
+ Ext.ComponentInserts 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
: NumberThe index at which the Component will be inserted
into the Container's items collectioncomponent
: Ext.ComponentThe 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
+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
+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()
+ :
+ BooleanReturns true if this component is visible.Returns true if this component is visible.Parameters:- None.
Returns:Boolean
True if this component is visible, false otherwise.
Component isXType( String/Ext.Component/Class xtype
, [Boolean shallow
] )
+ :
+ BooleanTests 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.
+For a list of all available xtypes, see the Ext.Component header.
Example usage:
-var t = new Ext.form.TextField();
+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
: StringThe xtype to check for this Componentshallow
: 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
-
-
-
-
-
- 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
: StringThe type of event to listen forhandler
: FunctionThe method the event invokesscope
: 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
: ObjectThe Observable whose events this object is to relay.events
: ArrayArray 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/StringThe 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
: stringThe CSS class name to remove
- Returns:
-
- void
-
-
-
-
-
- Component
-
-
-
-
-
- removeListener( String eventName
, Function handler
, [Object scope
] ) : void
- Removes a listener
-
- Removes a listener
- Parameters:
- eventName
: StringThe type of event to listen forhandler
: FunctionThe handler to removescope
: 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
+var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instanceParameters:xtype
: String/Ext.Component/ClassThe xtype to check for this Component. Note that the the component can either be an instance
+or a component class:
+var c = new Ext.Component();
+console.log(c.isXType(c));
+console.log(c.isXType(Ext.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:Boolean
True if this component descends from the specified xtype, false otherwise.
Component mon( Observable|Element item
, Object|String ename
, Function fn
, Object scope
, Object opt
)
+ :
+ voidAdds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroye...Adds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroyed. Usage:
+myGridPanel.mon(myGridPanel.getSelectionModel(), 'selectionchange', handleSelectionChange, null, {buffer: 50});
+
+or:
+myGridPanel.mon(myGridPanel.getSelectionModel(), {
+ selectionchange: handleSelectionChange,
+ buffer: 50
+});
+
Parameters:item
: Observable|ElementThe item to which to add a listener/listeners.ename
: Object|StringThe event name, or an object containing event name properties.fn
: FunctionOptional. If the ename
parameter was an event name, this
+is the handler function.scope
: ObjectOptional. If the ename
parameter was an event name, this
+is the scope (this
reference) in which the handler function is executed.opt
: ObjectOptional. If the ename
parameter was an event name, this
+is the addListener options.
Returns:- void
Component mun( Observable|Element item
, Object|String ename
, Function fn
, Object scope
)
+ :
+ voidRemoves listeners that were added by the mon method.Removes listeners that were added by the mon method.Parameters:item
: Observable|ElementThe item from which to remove a listener/listeners.ename
: Object|StringThe event name, or an object containing event name properties.fn
: FunctionOptional. If the ename
parameter was an event name, this
+is the handler function.scope
: ObjectOptional. If the ename
parameter was an event name, this
+is the scope (this
reference) in which the handler function is executed.
Returns:- void
Component nextSibling()
+ :
+ Ext.ComponentReturns the next component in the owning containerReturns the next component in the owning containerParameters:- None.
Returns:Ext.Component
Component on( String eventName
, Function handler
, [Object scope
], [Object options
] )
+ :
+ voidAppends an event handler to this object (shorthand for addListener.)Appends an event handler to this object (shorthand for addListener.)Parameters:eventName
: StringThe type of event to listen forhandler
: FunctionThe method the event invokesscope
: Object(optional) The scope (this
reference) in which the handler function is executed.
+If omitted, defaults to the object which fired the event.options
: Object(optional) An object containing handler configuration.
Returns:- void
Observable previousSibling()
+ :
+ Ext.ComponentReturns the previous component in the owning containerReturns the previous component in the owning containerParameters:- None.
Returns:Ext.Component
Component purgeListeners()
+ :
+ voidRemoves all listeners for this objectRemoves all listeners for this objectParameters:- None.
Returns:- void
Observable relayEvents( Object o
, Array events
)
+ :
+ voidRelays 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
: ObjectThe Observable whose events this object is to relay.events
: ArrayArray of event names to relay.
Returns:- void
Observable remove( Component/String component
, [Boolean autoDestroy
] )
+ :
+ Ext.ComponentRemoves 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/StringThe 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
] )
+ :
+ ArrayRemoves 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
)
+ :
+ Ext.ComponentRemoves a CSS class from the component's underlying element.Removes a CSS class from the component's underlying element.Parameters:cls
: stringThe CSS class name to remove
Returns:Ext.Component
this
Component removeListener( String eventName
, Function handler
, [Object scope
] )
+ :
+ voidRemoves an event handler.Removes an event handler.Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
Observable render( [Element/HTMLElement/String container
], [String/Number position
] )
+ :
+ voidRender 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.
+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.
+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
+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.
+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
+
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
+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
-
-
-
-
-
- resumeEvents() : void
- Resume firing events. (see suspendEvents)
-
- Resume firing events. (see suspendEvents)
- Parameters:
- - None.
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- 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
-
- BoxComponent
-
-
-
-
-
- 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
: NumberThe new x positiony
: NumberThe 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
: NumberThe new lefttop
: NumberThe 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/ObjectThe new width to set, or a size object in the format {width, height}height
: NumberThe new height to set (not required if a size object is passed as the first arg)
- Returns:
-
- Ext.BoxComponent
this
-
-
-
-
-
- BoxComponent
-
-
-
-
-
- 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
: BooleanTrue to show, false to hide
- Returns:
-
- Ext.Component
this
-
-
-
-
-
- Component
-
-
-
-
-
- setWidth( Number width
) : Ext.BoxComponent
-
- BoxComponent
-
-
-
-
-
- show() : Ext.Component
- Show this component.
-
- Show this component.
- Parameters:
- - None.
- Returns:
-
- Ext.Component
this
-
-
-
-
-
- Component
-
-
-
-
-
- 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
-
-
-
-
-
- un( String eventName
, Function handler
, [Object scope
] ) : void
- Removes a listener (shorthand for removeListener)
-
- Removes a listener (shorthand for removeListener)
- Parameters:
- eventName
: StringThe type of event to listen forhandler
: FunctionThe handler to removescope
: 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
: ObjectAn object in the format {x, y, width, height}
- Returns:
-
- Ext.BoxComponent
this
-
-
-
-
-
- BoxComponent
-
-
-
- Public Events
-
-
- Event
- Defined By
-
-
-
-
-
- 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.Containercomponent
: Ext.ComponentThe component that was addedindex
: NumberThe 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.Containerlayout
: ContainerLayoutThe 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.Containercomponent
: Ext.ComponentThe component being addedindex
: NumberThe index at which the component will be added to the container's items collection
-
-
-
-
- Container
-
-
-
-
-
- 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
-
-
-
-
-
- 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.Containercomponent
: Ext.ComponentThe 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.Componentstate
: ObjectThe 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.Componentstate
: ObjectThe hash of state values
-
-
-
-
- Component
-
-
-
-
-
- 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
-
-
-
-
-
- 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
-
-
-
-
-
- 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.Componentx
: NumberThe new x positiony
: NumberThe 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.Containercomponent
: Ext.ComponentThe 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.Component this
, Number adjWidth
, Number adjHeight
, Number rawWidth
, Number rawHeight
)
- Fires after the component is resized.
-
- Fires after the component is resized.
- Listeners will be called with the following arguments:
- this
: Ext.ComponentadjWidth
: NumberThe box-adjusted width that was setadjHeight
: NumberThe box-adjusted height that was setrawWidth
: NumberThe width that was originally specifiedrawHeight
: NumberThe height that was originally specified
-
-
-
-
- BoxComponent
-
-
-
-
-
- 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.Componentstate
: ObjectThe 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.Componentstate
: ObjectThe hash of state values
-
-
-
-
- Component
-
-
-
-
\ No newline at end of file
+which this component will be inserted (defaults to appending to the end of the container)Returns:- void
Component resumeEvents()
+ :
+ voidResume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
+event...Resume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
+events fired during event suspension will be sent to any listeners now.Parameters:- None.
Returns:- void
Observable setAutoScroll( Boolean scroll
)
+ :
+ Ext.BoxComponentSets the overflow on the content element of the component.Sets the overflow on the content element of the component.Parameters:scroll
: BooleanTrue to allow the Component to auto scroll.
Returns:Ext.BoxComponent
this
BoxComponent setDisabled( Boolean disabled
)
+ :
+ Ext.ComponentConvenience function for setting disabled/enabled by boolean.Convenience function for setting disabled/enabled by boolean.Parameters:disabled
: Boolean
Returns:Ext.Component
this
Component setHeight( Mixed height
)
+ :
+ Ext.BoxComponentSets 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
: MixedThe new height to set. This may be one of:
+- A Number specifying the new height in the Element's defaultUnits (by default, pixels).
+- A String used to set the CSS height style.
+- undefined to leave the height unchanged.
+
Returns:Ext.BoxComponent
this
BoxComponent setPagePosition( Number x
, Number y
)
+ :
+ Ext.BoxComponentSets 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
: NumberThe new x positiony
: NumberThe new y position
Returns:Ext.BoxComponent
this
BoxComponent setPosition( Number left
, Number top
)
+ :
+ Ext.BoxComponentSets 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
: NumberThe new lefttop
: NumberThe new top
Returns:Ext.BoxComponent
this
BoxComponent setSize( Mixed width
, Mixed height
)
+ :
+ Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
+either wid...Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
+either width and height as separate arguments, or you can pass a size object like {width:10, height:20}
.Parameters:width
: MixedThe new width to set. This may be one of:
+- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
+- A String used to set the CSS width style.
+- A size object in the format
{width: widthValue, height: heightValue}
.
+undefined
to leave the width unchanged.
+
height
: MixedThe new height to set (not required if a size object is passed as the first arg).
+This may be one of:
+- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
+- A String used to set the CSS height style. Animation may not be used.
+undefined
to leave the height unchanged.
+
Returns:Ext.BoxComponent
this
BoxComponent setVisible( Boolean visible
)
+ :
+ Ext.ComponentConvenience function to hide or show this component by boolean.Convenience function to hide or show this component by boolean.Parameters:visible
: BooleanTrue to show, false to hide
Returns:Ext.Component
this
Component setWidth( Mixed width
)
+ :
+ Ext.BoxComponentSets 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
: MixedThe new width to set. This may be one of:
+- A Number specifying the new width in the Element's defaultUnits (by default, pixels).
+- A String used to set the CSS width style.
+
Returns:Ext.BoxComponent
this
BoxComponent show()
+ :
+ Ext.ComponentShow this component. Listen to the 'beforeshow' event and return
+false to cancel showing the component. Fires the '...Show this component. Listen to the 'beforeshow' event and return
+false to cancel showing the component. Fires the 'show'
+event after showing the component.Parameters:- None.
Returns:Ext.Component
this
Component suspendEvents( Boolean queueSuspended
)
+ :
+ voidSuspend the firing of all events. (see resumeEvents)Suspend the firing of all events. (see resumeEvents)Parameters:queueSuspended
: BooleanPass as true to queue up suspended events to be fired
+after the resumeEvents call instead of discarding all suspended events;
Returns:- void
Observable syncSize()
+ :
+ Ext.BoxComponentForce 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 un( String eventName
, Function handler
, [Object scope
] )
+ :
+ voidRemoves an event handler (shorthand for removeListener.)Removes an event handler (shorthand for removeListener.)Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
Observable update( Mixed htmlOrData
, [Boolean loadScripts
], [Function callback
] )
+ :
+ voidUpdate the content area of a component.Update the content area of a component.Parameters:htmlOrData
: MixedIf this component has been configured with a template via the tpl config
+then it will use this argument as data to populate the template.
+If this component was not configured with a template, the components
+content area will be updated via Ext.Element updateloadScripts
: Boolean(optional) Only legitimate when using the html configuration. Defaults to falsecallback
: Function(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading
Returns:- void
Component updateBox( Object box
)
+ :
+ Ext.BoxComponentSets the current box measurements of the component's underlying element.Sets the current box measurements of the component's underlying element.Parameters:box
: ObjectAn object in the format {x, y, width, height}
Returns:Ext.BoxComponent
this
BoxComponent
Public Events
Event Defined By add :
+ ( Ext.Container this
, Ext.Component component
, Number index
)
+ Listeners will be called with the following arguments:this
: Ext.Containercomponent
: Ext.ComponentThe component that was addedindex
: NumberThe index at which the component was added to the container's items collection
Container added :
+ ( Ext.Component this
, Ext.Container ownerCt
, number index
)
+ Fires when a component is added to an Ext.ContainerFires when a component is added to an Ext.ContainerListeners will be called with the following arguments:this
: Ext.ComponentownerCt
: Ext.ContainerContainer which holds the componentindex
: numberPosition at which the component was added
Component 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.Containerlayout
: ContainerLayoutThe ContainerLayout implementation for this container
Container afterrender :
+ ( Ext.Component this
)
+ Fires after the component rendering is finished.
+The afterrender event is fired after this Component has been rendere...Fires after the component rendering is finished.
+The afterrender event is fired after this Component has been rendered, been postprocesed
+by any afterRender method defined for the Component, and, if stateful, after state
+has been restored.
Listeners will be called with the following arguments:this
: Ext.Component
Component 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.Containercomponent
: Ext.ComponentThe component being addedindex
: NumberThe index at which the component will be added to the container's items collection
Container beforedestroy :
+ ( Ext.Component this
)
+ Component beforehide :
+ ( Ext.Component this
)
+ Fires before the component is hidden by calling the hide method.
+Return false from an event handler to stop the hide.Fires before the component is hidden by calling the hide method.
+Return false from an event handler 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.Containercomponent
: Ext.ComponentThe component being removed
Container beforerender :
+ ( Ext.Component this
)
+ Component beforeshow :
+ ( Ext.Component this
)
+ Fires before the component is shown by calling the show method.
+Return false from an event handler to stop the show.Fires before the component is shown by calling the show method.
+Return false from an event handler 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 from an event handler to stop the restore.Fires before the state of the component is restored. Return false from an event handler to stop the restore.Listeners will be called with the following arguments:this
: Ext.Componentstate
: ObjectThe hash of state values returned from the StateProvider. If this
+event is not vetoed, then the state object is passed to applyState. By default,
+that simply copies property values into this Component. The method maybe overriden to
+provide custom state restoration.
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.Componentstate
: ObjectThe hash of state values. This is determined by calling
+getState() on the Component. This method must be provided by the
+developer to return whetever representation of state is required, by default, Ext.Component
+has a null implementation.
Component 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 hide :
+ ( Ext.Component this
)
+ Fires after the component is hidden.
+Fires after the component is hidden when calling the hide method.Fires after the component is hidden.
+Fires after the component is hidden when calling the hide method.Listeners will be called with the following arguments:this
: Ext.Component
Component 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.Componentx
: NumberThe new x positiony
: NumberThe new y position
BoxComponent remove :
+ ( Ext.Container this
, Ext.Component component
)
+ Listeners will be called with the following arguments:this
: Ext.Containercomponent
: Ext.ComponentThe component that was removed
Container removed :
+ ( Ext.Component this
, Ext.Container ownerCt
)
+ Fires when a component is removed from an Ext.ContainerFires when a component is removed from an Ext.ContainerListeners will be called with the following arguments:this
: Ext.ComponentownerCt
: Ext.ContainerContainer which holds the component
Component render :
+ ( Ext.Component this
)
+ Fires after the component markup is rendered.Fires after the component markup is rendered.Listeners will be called with the following arguments:this
: Ext.Component
Component resize :
+ ( Ext.Component this
, Number adjWidth
, Number adjHeight
, Number rawWidth
, Number rawHeight
)
+ Fires after the component is resized.Fires after the component is resized.Listeners will be called with the following arguments:this
: Ext.ComponentadjWidth
: NumberThe box-adjusted width that was setadjHeight
: NumberThe box-adjusted height that was setrawWidth
: NumberThe width that was originally specifiedrawHeight
: NumberThe height that was originally specified
BoxComponent show :
+ ( Ext.Component this
)
+ Fires after the component is shown when calling the show method.Fires after the component is shown when calling the show method.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.Componentstate
: ObjectThe hash of state values returned from the StateProvider. This is passed
+to applyState. By default, that simply copies property values into this
+Component. The method maybe overriden to provide custom state restoration.
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.Componentstate
: ObjectThe hash of state values. This is determined by calling
+getState() on the Component. This method must be provided by the
+developer to return whetever representation of state is required, by default, Ext.Component
+has a null implementation.
Component
\ No newline at end of file