Notes:

Ext.container.Container
view source

activeItem : String/Number

A string component id or the numeric index of the component that should be\ninitially activated within the container's...

A string component id or the numeric index of the component that should be\ninitially activated within the container's layout on render. For example,\nactiveItem: 'item-1' or activeItem: 0 (index 0 = the first item in the\ncontainer's collection). activeItem only applies to layout styles that can\ndisplay items one at a time (like Ext.layout.container.Card and\nExt.layout.container.Fit).

Ext.container.Viewport
view source

allowDomMove : Booleanprivate

anchorSize : Number/Object

Defines the anchoring size of container. ...

Defines the anchoring size of container.\nEither a number to define the width of the container or an object with width and height fields.

Ext.container.Viewport
view source

applyTo : String/HTMLElement/Ext.Elementprivate

autoDestroy : Boolean

If true the container will automatically destroy any contained component that is removed\nfrom it, else destruction mu...

If true the container will automatically destroy any contained component that is removed\nfrom it, else destruction must be handled manually.

Defaults to: true

autoEl : String/Object

A tag name or DomHelper spec used to create the Element which will\nencapsulate this Component. ...

A tag name or DomHelper spec used to create the Element which will\nencapsulate this Component.

\n\n

You do not normally need to specify this. For the base classes Ext.Component and\nExt.container.Container, this defaults to 'div'. The more complex Sencha classes use a more\ncomplex DOM structure specified by their own renderTpls.

\n\n

This is intended to allow the developer to create application-specific utility Components encapsulated by\ndifferent DOM elements. Example usage:

\n\n

{\n    xtype: 'component',\n    autoEl: {\n        tag: 'img',\n        src: 'http://www.example.com/example.jpg'\n    }\n}, {\n    xtype: 'component',\n    autoEl: {\n        tag: 'blockquote',\n        html: 'autoEl is cool!'\n    }\n}, {\n    xtype: 'container',\n    autoEl: 'ul',\n    cls: 'ux-unordered-list',\n    items: {\n        xtype: 'component',\n        autoEl: 'li',\n        html: 'First list item'\n    }\n}\n

autoLoad : Ext.ComponentLoader/Object/String/Booleandeprecated

An alias for loader config which also allows to specify just a string which will be\nused as the url that's automatica...

An alias for loader config which also allows to specify just a string which will be\nused as the url that's automatically loaded:

\n\n

Ext.create('Ext.Component', {\n    autoLoad: 'content.html',\n    renderTo: Ext.getBody()\n});\n

\n\n

The above is the same as:

\n\n

Ext.create('Ext.Component', {\n    loader: {\n        url: 'content.html',\n        autoLoad: true\n    },\n    renderTo: Ext.getBody()\n});\n

\n\n

Don't use it together with loader config.

This cfg has been deprecated since 4.1.1

Use loader config instead.

\n\n

autoRender : Boolean/String/HTMLElement/Ext.Element

This config is intended mainly for non-floating Components which may or may not be shown. ...

This config is intended mainly for non-floating Components which may or may not be shown. Instead of using\nrenderTo in the configuration, and rendering upon construction, this allows a Component to render itself\nupon first show. If floating is true, the value of this config is omited as if it is true.

\n\n

Specify as true to have this Component render to the document body upon first show.

\n\n

Specify as an element, or the ID of an element to have this Component render to a specific element upon first\nshow.

Defaults to: false

autoScroll : Boolean

true to use overflow:'auto' on the components layout element and show scroll bars automatically when necessary,\nfalse...

true to use overflow:'auto' on the components layout element and show scroll bars automatically when necessary,\nfalse to clip any overflowing content.\nThis should not be combined with overflowX or overflowY.

Defaults to: false

autoShow : Boolean

True to automatically show the component upon creation. ...

True to automatically show the component upon creation. This config option may only be used for\nfloating components or components that use autoRender. Defaults to false.

Defaults to: false

baseCls : String

The base CSS class to apply to this components's element. ...

The base CSS class to apply to this components's element. This will also be prepended to elements within this\ncomponent like Panel's body will get a class x-panel-body. This means that if you create a subclass of Panel, and\nyou want it to get all the Panels styling for the element and the body, you leave the baseCls x-panel and use\ncomponentCls to add specific styling for this component.

Defaults to: "x-component"

border : Number/String/Boolean

Specifies the border size for this component. ...

Specifies the border size for this component. The border can be a single numeric value to apply to all sides or it can\nbe a CSS style specification for each style, for example: '10 5 3 10'.

\n\n

For components that have no border by default, setting this won't make the border appear by itself.\nYou also need to specify border color and style:

\n\n

border: 5,\nstyle: {\n    borderColor: 'red',\n    borderStyle: 'solid'\n}\n

\n\n

To turn off the border, use border: false.

bubbleEvents : String[]

An array of events that, when fired, should be bubbled to any parent container. ...

An array of events that, when fired, should be bubbled to any parent container.\nSee Ext.util.Observable.enableBubble.

Defaults to: ["add", "remove"]

childEls : Object[]

An array describing the child elements of the Component. ...

An array describing the child elements of the Component. Each member of the array\nis an object with these properties:

\n\n

name - The property name on the Component for the child element.
itemId - The id to combine with the Component's id that is the id of the child element.
id - The id of the child element.

\n\n\n

If the array member is a string, it is equivalent to { name: m, itemId: m }.

\n\n

For example, a Component which renders a title and body text:

\n\n

Ext.create('Ext.Component', {\n    renderTo: Ext.getBody(),\n    renderTpl: [\n        '<h1 id=\"{id}-title\">{title}</h1>',\n        '<p>{msg}</p>',\n    ],\n    renderData: {\n        title: \"Error\",\n        msg: \"Something went wrong\"\n    },\n    childEls: [\"title\"],\n    listeners: {\n        afterrender: function(cmp){\n            // After rendering the component will have a title property\n            cmp.title.setStyle({color: \"red\"});\n        }\n    }\n});\n

\n\n

A more flexible, but somewhat slower, approach is renderSelectors.

cls : String

An optional extra CSS class that will be added to this component's Element. ...

An optional extra CSS class that will be added to this component's Element. This can be useful\nfor adding customized styles to the component or any of its children using standard CSS rules.

Defaults to: ""

columnWidth : Number/String

Defines the column width inside column layout. ...

Defines the column width inside column layout.

\n\n

Can be specified as a number or as a percentage.

componentCls : String

CSS Class to be added to a components root level element to give distinction to it via styling.

componentLayout : String/Object

The sizing and positioning of a Component's internal Elements is the responsibility of the Component's layout\nmanager...

The sizing and positioning of a Component's internal Elements is the responsibility of the Component's layout\nmanager which sizes a Component's internal structure in response to the Component being sized.

\n\n

Generally, developers will not use this configuration as all provided Components which need their internal\nelements sizing (Such as input fields) come with their own componentLayout managers.

\n\n

The default layout manager will be used on instances of the base Ext.Component\nclass which simply sizes the Component's encapsulating element to the height and width specified in the\nsetSize method.

contentEl : String

Specify an existing HTML element, or the id of an existing HTML element to use as the content for this component. ...

Specify an existing HTML element, or the id of an existing HTML element to use as the content for this component.

\n\n

This config option is used to take an existing HTML element and place it in the layout element of a new component\n(it simply moves the specified DOM element after the Component is rendered to use as the content.

\n\n

Notes:

\n\n

The specified HTML element is appended to the layout element of the component after any configured\nHTML has been inserted, and so the document will not contain this element at the time\nthe render event is fired.

\n\n

The specified HTML element used will not participate in any layout\nscheme that the Component may use. It is just HTML. Layouts operate on child\nitems.

\n\n

Add either the x-hidden or the x-hide-display CSS class to prevent a brief flicker of the content before it\nis rendered to the panel.

data : Object

The initial set of data to apply to the tpl to update the content area of the Component.

defaultType : String

The default xtype of child Components to create in this Container when\na child item is specified as a raw configurati...

The default xtype of child Components to create in this Container when\na child item is specified as a raw configuration object, rather than as an instantiated Component.

Defaults to: "panel"

defaults : Object/Function

This option is a means of applying default settings to all added items whether added\nthrough the items config or via ...

This option is a means of applying default settings to all added items whether added\nthrough the items config or via the add or insert methods.

\n\n

Defaults are applied to both config objects and instantiated components conditionally\nso as not to override existing properties in the item (see Ext.applyIf).

\n\n

If the defaults option is specified as a function, then the function will be called\nusing this Container as the scope (this reference) and passing the added item as\nthe first parameter. Any resulting object from that call is then applied to the item\nas default properties.

\n\n

For example, to automatically apply padding to the body of each of a set of\ncontained Ext.panel.Panel items, you could pass:\ndefaults: {bodyStyle:'padding:15px'}.

\n\n

Usage:

\n\n

defaults: { // defaults are applied to items, not the container\n    autoScroll: true\n},\nitems: [\n    // default will not be applied here, panel1 will be autoScroll: false\n    {\n        xtype: 'panel',\n        id: 'panel1',\n        autoScroll: false\n    },\n    // this component will have autoScroll: true\n    new Ext.panel.Panel({\n        id: 'panel2'\n    })\n]\n

detachOnRemove : Boolean

True to move any component to the detachedBody when the component is\nremoved from this container. ...

True to move any component to the detachedBody when the component is\nremoved from this container. This option is only applicable when the component is not destroyed while\nbeing removed, see autoDestroy and remove. If this option is set to false, the DOM\nof the component will remain in the current place until it is explicitly moved.

Defaults to: true

disabled : Boolean

True to disable the component. ...

True to disable the component.

Defaults to: false

disabledCls : String

CSS class to add when the Component is disabled. ...

CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.

Defaults to: "x-item-disabled"

draggable : Boolean/Object

Specify as true to make a floating Component draggable using the Component's encapsulating element as\nthe drag handle. ...

Specify as true to make a floating Component draggable using the Component's encapsulating element as\nthe drag handle.

\n\n

This may also be specified as a config object for the ComponentDragger which is\ninstantiated to perform dragging.

\n\n

For example to create a Component which may only be dragged around using a certain internal element as the drag\nhandle, use the delegate option:

\n\n

new Ext.Component({\n    constrain: true,\n    floating: true,\n    style: {\n        backgroundColor: '#fff',\n        border: '1px solid black'\n    },\n    html: '<h1 style=\"cursor:move\">The title</h1><p>The content</p>',\n    draggable: {\n        delegate: 'h1'\n    }\n}).show();\n

Defaults to: false

Overrides: Ext.AbstractComponent.draggable

floating : Boolean

Specify as true to float the Component outside of the document flow using CSS absolute positioning. ...

Specify as true to float the Component outside of the document flow using CSS absolute positioning.

\n\n

Components such as Windows and Menus are floating by default.

\n\n

Floating Components that are programatically rendered will register\nthemselves with the global ZIndexManager

\n\n

Floating Components as child items of a Container

\n\n

A floating Component may be used as a child item of a Container. This just allows the floating Component to seek\na ZIndexManager by examining the ownerCt chain.

\n\n

When configured as floating, Components acquire, at render time, a ZIndexManager which\nmanages a stack of related floating Components. The ZIndexManager brings a single floating Component to the top\nof its stack when the Component's toFront method is called.

\n\n

The ZIndexManager is found by traversing up the ownerCt chain to find an ancestor which itself is\nfloating. This is so that descendant floating Components of floating Containers (Such as a ComboBox dropdown\nwithin a Window) can have its zIndex managed relative to any siblings, but always above that floating\nancestor Container.

\n\n

If no floating ancestor is found, a floating Component registers itself with the default ZIndexManager.

\n\n

Floating components do not participate in the Container's layout. Because of this, they are not rendered until\nyou explicitly show them.

\n\n

After rendering, the ownerCt reference is deleted, and the floatParent property is set to the found\nfloating ancestor Container. If no floating ancestor Container was found the floatParent property will\nnot be set.

Defaults to: false

Overrides: Ext.AbstractComponent.floating

focusOnToFront : Boolean

Specifies whether the floated component should be automatically focused when\nit is brought to the front. ...

Specifies whether the floated component should be automatically focused when\nit is brought to the front.

Defaults to: true

formBind : Boolean

When inside FormPanel, any component configured with formBind: true will\nbe enabled/disabled depending on the validit...

When inside FormPanel, any component configured with formBind: true will\nbe enabled/disabled depending on the validity state of the form.\nSee Ext.form.Panel for more information and example.

Defaults to: false

frame : Boolean

Specify as true to have the Component inject framing elements within the Component at render time to provide a\ngraphi...

Specify as true to have the Component inject framing elements within the Component at render time to provide a\ngraphical rounded frame around the Component content.

\n\n

This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet\nExplorer prior to version 9 which do not support rounded corners natively.

\n\n

The extra space taken up by this framing is available from the read only property frameSize.

Ext.container.Viewport
view source

height : Numberprivate

Sets itself to viewport width.

Overrides: Ext.AbstractComponent.height

hidden : Boolean

True to hide the component. ...

True to hide the component.

Defaults to: false

hideMode : String

A String which specifies how this Component's encapsulating DOM element will be hidden. ...

A String which specifies how this Component's encapsulating DOM element will be hidden. Values may be:

\n\n

'display' : The Component will be hidden using the display: none style.
'visibility' : The Component will be hidden using the visibility: hidden style.
'offsets' : The Component will be hidden by absolutely positioning it out of the visible area of the document.\nThis is useful when a hidden Component must maintain measurable dimensions. Hiding using display results in a\nComponent having zero dimensions.

\n\n

Defaults to: "display"

html : String/Object

An HTML fragment, or a DomHelper specification to use as the layout element content. ...

An HTML fragment, or a DomHelper specification to use as the layout element content.\nThe HTML content is added after the component is rendered, so the document will not contain this HTML at the time\nthe render event is fired. This content is inserted into the body before any configured contentEl\nis appended.

Defaults to: ""

id : String

The unique id of this component instance. ...

The unique id of this component instance.

\n\n

It should not be necessary to use this configuration except for singleton objects in your application. Components\ncreated with an id may be accessed globally using Ext.getCmp.

\n\n

Instead of using assigned ids, use the itemId config, and ComponentQuery\nwhich provides selector-based searching for Sencha Components analogous to DOM querying. The Container class contains shortcut methods to query\nits descendant Components by selector.

\n\n

Note that this id will also be used as the element id for the containing HTML element that is rendered to the\npage for this component. This allows you to write id-based CSS rules to style the specific instance of this\ncomponent uniquely, and also to select sub-elements using this component's id as the parent.

\n\n

Note: to avoid complications imposed by a unique id also see itemId.

\n\n

Note: to access the container of a Component see ownerCt.

\n\n

Defaults to an auto-assigned id.

itemId : String

An itemId can be used as an alternative way to get a reference to a component when no object reference is\navailable. ...

An itemId can be used as an alternative way to get a reference to a component when no object reference is\navailable. Instead of using an id with Ext.getCmp, use itemId with\nExt.container.Container.getComponent which will retrieve\nitemId's or id's. Since itemId's are an index to the container's internal MixedCollection, the\nitemId is scoped locally to the container -- avoiding potential conflicts with Ext.ComponentManager\nwhich requires a unique id.

\n\n

var c = new Ext.panel.Panel({ //\n    height: 300,\n    renderTo: document.body,\n    layout: 'auto',\n    items: [\n        {\n            itemId: 'p1',\n            title: 'Panel 1',\n            height: 150\n        },\n        {\n            itemId: 'p2',\n            title: 'Panel 2',\n            height: 150\n        }\n    ]\n})\np1 = c.getComponent('p1'); // not the same as Ext.getCmp()\np2 = p1.ownerCt.getComponent('p2'); // reference via a sibling\n

\n\n

Also see id, Ext.container.Container.query, Ext.container.Container.down and\nExt.container.Container.child.

\n\n

Note: to access the container of an item see ownerCt.

items : Object/Object[]

A single item, or an array of child Components to be added to this container\n\nUnless configured with a layout, a Cont...

A single item, or an array of child Components to be added to this container

\n\n

Unless configured with a layout, a Container simply renders child\nComponents serially into its encapsulating element and performs no sizing or\npositioning upon them.

\n\n

Example:

\n\n

// specifying a single item\nitems: {...},\nlayout: 'fit',    // The single items is sized to fit\n\n// specifying multiple items\nitems: [{...}, {...}],\nlayout: 'hbox', // The items are arranged horizontally\n

\n\n

Each item may be:

\n\n

A Component
A Component configuration object

\n\n\n

If a configuration object is specified, the actual type of Component to be\ninstantiated my be indicated by using the xtype option.

\n\n

Every Component class has its own xtype.

\n\n

If an xtype is not explicitly specified, the\ndefaultType for the Container is used, which by default is usually panel.

\n\n

Notes:

\n\n

Ext uses lazy rendering. Child Components will only be rendered\nshould it become necessary. Items are automatically laid out when they are first\nshown (no sizing is done while hidden), or in response to a doLayout call.

\n\n

Do not specify contentEl or\nhtml with items.

layout : String/Object

Important: In order for child items to be correctly sized and\npositioned, typically a layout manager must be specifie...

Important: In order for child items to be correctly sized and\npositioned, typically a layout manager must be specified through\nthe layout configuration option.

\n\n

The sizing and positioning of child items is the responsibility of\nthe Container's layout manager which creates and manages the type of layout\nyou have in mind. For example:

\n\n

If the layout configuration is not explicitly specified for\na general purpose container (e.g. Container or Panel) the\ndefault layout manager will be used\nwhich does nothing but render child components sequentially into the\nContainer (no sizing or positioning will be performed in this situation).

\n\n

layout may be specified as either as an Object or as a String:

\n\n

Specify as an Object

\n\n

Example usage:

\n\n

layout: {\n    type: 'vbox',\n    align: 'left'\n}\n

\n\n

type
\n\n
The layout type to be used for this container. If not specified,\na default Ext.layout.container.Auto will be created and used.
\n\n
Valid layout type values are:
\n\n
- Auto - Default
- card
- fit
- hbox
- vbox
- anchor
- table
\n
Layout specific configuration properties
\n\n
Additional layout specific configuration properties may also be\nspecified. For complete details regarding the valid config options for\neach layout type, see the layout class corresponding to the type\nspecified.

\n\n\n

Specify as a String

\n\n

Example usage:

\n\n

layout: 'vbox'\n

\n\n

layout
\n\n
The layout type to be used for this container (see list\nof valid layout type values above).
\n\n
Additional layout specific configuration properties. For complete\ndetails regarding the valid config options for each layout type, see the\nlayout class corresponding to the layout specified.

\n\n\n

Configuring the default layout type

\n\n

If a certain Container class has a default layout (For example a Toolbar\nwith a default `Box` layout), then to simply configure the default layout,\nuse an object, but without the `type` property:\n\n\nxtype: 'toolbar',\nlayout: {\n    pack: 'center'\n}\n

listeners : Object

A config object containing one or more event handlers to be added to this object during initialization. ...

A config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.

\n\n

DOM events from Ext JS Components

\n\n

While some Ext JS Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the element option to identify the Component property to add a\nDOM listener to:

\n\n

new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n

loader : Ext.ComponentLoader/Object

A configuration object or an instance of a Ext.ComponentLoader to load remote content\nfor this Component. ...

A configuration object or an instance of a Ext.ComponentLoader to load remote content\nfor this Component.

\n\n

Ext.create('Ext.Component', {\n    loader: {\n        url: 'content.html',\n        autoLoad: true\n    },\n    renderTo: Ext.getBody()\n});\n

margin : Number/String

Specifies the margin for this component. ...

Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can\nbe a CSS style specification for each style, for example: '10 5 3 10'.

maxHeight : Number

The maximum value in pixels which this Component will set its height to. ...

The maximum value in pixels which this Component will set its height to.

\n\n

Warning: This will override any size management applied by layout managers.

maxWidth : Number

The maximum value in pixels which this Component will set its width to. ...

The maximum value in pixels which this Component will set its width to.

\n\n

Warning: This will override any size management applied by layout managers.

minHeight : Number

The minimum value in pixels which this Component will set its height to. ...

The minimum value in pixels which this Component will set its height to.

\n\n

Warning: This will override any size management applied by layout managers.

minWidth : Number

The minimum value in pixels which this Component will set its width to. ...

The minimum value in pixels which this Component will set its width to.

\n\n

Warning: This will override any size management applied by layout managers.

overCls : String

An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element,\nand...

An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element,\nand removed when the mouse moves out. This can be useful for adding customized 'active' or 'hover' styles to the\ncomponent or any of its children using standard CSS rules.

Defaults to: ""

overflowX : String

Possible values are:\n * 'auto' to enable automatic horizontal scrollbar (overflow-x: 'auto'). ...

Possible values are:\n * 'auto' to enable automatic horizontal scrollbar (overflow-x: 'auto').\n * 'scroll' to always enable horizontal scrollbar (overflow-x: 'scroll').\nThe default is overflow-x: 'hidden'. This should not be combined with autoScroll.

overflowY : String

Possible values are:\n * 'auto' to enable automatic vertical scrollbar (overflow-y: 'auto'). ...

Possible values are:\n * 'auto' to enable automatic vertical scrollbar (overflow-y: 'auto').\n * 'scroll' to always enable vertical scrollbar (overflow-y: 'scroll').\nThe default is overflow-y: 'hidden'. This should not be combined with autoScroll.

padding : Number/String

Specifies the padding for this component. ...

Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it\ncan be a CSS style specification for each style, for example: '10 5 3 10'.

plugins : Object/Object[]

An object or array of objects that will provide custom functionality for this component. ...

An object or array of objects that will provide custom functionality for this component. The only requirement for\na valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component\nis created, if any plugins are available, the component will call the init method on each plugin, passing a\nreference to itself. Each plugin can then call methods or respond to events on the component as needed to provide\nits functionality.

region : String

Defines the region inside border layout. ...

Defines the region inside border layout.

\n\n

Possible values:

\n\n

center
north
south
east
west

\n\n

renderData : Object

The data used by renderTpl in addition to the following property values of the component:\n\n\nid\nui\nuiCls\nbaseCls\ncompo...

The data used by renderTpl in addition to the following property values of the component:

\n\n

id
ui
uiCls
baseCls
componentCls
frame

\n\n\n

See renderSelectors and childEls for usage examples.

renderSelectors : Object

An object containing properties specifying DomQuery selectors which identify child elements\ncreated by the render pro...

An object containing properties specifying DomQuery selectors which identify child elements\ncreated by the render process.

\n\n

After the Component's internal structure is rendered according to the renderTpl, this object is iterated through,\nand the found Elements are added as properties to the Component using the renderSelector property name.

\n\n

For example, a Component which renderes a title and description into its element:

\n\n

Ext.create('Ext.Component', {\n    renderTo: Ext.getBody(),\n    renderTpl: [\n        '<h1 class=\"title\">{title}</h1>',\n        '<p>{desc}</p>'\n    ],\n    renderData: {\n        title: \"Error\",\n        desc: \"Something went wrong\"\n    },\n    renderSelectors: {\n        titleEl: 'h1.title',\n        descEl: 'p'\n    },\n    listeners: {\n        afterrender: function(cmp){\n            // After rendering the component will have a titleEl and descEl properties\n            cmp.titleEl.setStyle({color: \"red\"});\n        }\n    }\n});\n

\n\n

For a faster, but less flexible, alternative that achieves the same end result (properties for child elements on the\nComponent after render), see childEls and addChildEls.

Ext.container.Viewport
view source

renderTo : String/HTMLElement/Ext.Elementprivate

Always renders to document body.

Overrides: Ext.AbstractComponent.renderTo

renderTpl : Ext.XTemplate/String/String[]protected

An XTemplate used to create the internal structure inside this Component's encapsulating\nElement. ...

An XTemplate used to create the internal structure inside this Component's encapsulating\nElement.

\n\n

You do not normally need to specify this. For the base classes Ext.Component and\nExt.container.Container, this defaults to null which means that they will be initially rendered\nwith no internal structure; they render their Element empty. The more specialized ExtJS and Touch\nclasses which use a more complex DOM structure, provide their own template definitions.

\n\n

This is intended to allow the developer to create application-specific utility Components with customized\ninternal structure.

\n\n

Upon rendering, any created child elements may be automatically imported into object properties using the\nrenderSelectors and childEls options.

Defaults to: "{%this.renderContent(out,values)%}"

resizable : Boolean/Object

Specify as true to apply a Resizer to this Component after rendering. ...

Specify as true to apply a Resizer to this Component after rendering.

\n\n

May also be specified as a config object to be passed to the constructor of Resizer\nto override any defaults. By default the Component passes its minimum and maximum size, and uses\nExt.resizer.Resizer.dynamic: false

resizeHandles : String

A valid Ext.resizer.Resizer handles config string. ...

A valid Ext.resizer.Resizer handles config string. Only applies when resizable = true.

Defaults to: "all"

saveDelay : Number

A buffer to be applied if many state events are fired within a short period. ...

A buffer to be applied if many state events are fired within a short period.

Defaults to: 100

shadow : String/Boolean

Specifies whether the floating component should be given a shadow. ...

Specifies whether the floating component should be given a shadow. Set to true to automatically create an\nExt.Shadow, or a string indicating the shadow's display Ext.Shadow.mode. Set to false to\ndisable the shadow.

Defaults to: "sides"

shadowOffset : String/Boolean

Number of pixels to offset the shadow.

shrinkWrap : Boolean/Number

If this property is a number, it is interpreted as follows:\n\n\n0: Neither width nor height depend on content. ...

If this property is a number, it is interpreted as follows:

\n\n

0: Neither width nor height depend on content. This is equivalent to false.
1: Width depends on content (shrink wraps), but height does not.
2: Height depends on content (shrink wraps), but width does not. The default.
3: Both width and height depend on content (shrink wrap). This is equivalent to true.

\n\n\n

In CSS terms, shrink-wrap width is analogous to an inline-block element as opposed\nto a block-level element. Some container layouts always shrink-wrap their children,\neffectively ignoring this property (e.g., Ext.layout.container.HBox,\nExt.layout.container.VBox, Ext.layout.component.Dock).

Defaults to: 2

stateEvents : String[]

An array of events that, when fired, should trigger this object to\nsave its state. ...

An array of events that, when fired, should trigger this object to\nsave its state. Defaults to none. stateEvents may be any type\nof event supported by this object, including browser or custom events\n(e.g., ['click', 'customerchange']).

\n\n\n

See stateful for an explanation of saving and\nrestoring object state.

\n\n

stateId : String

The unique id for this object to use for state management purposes. ...

The unique id for this object to use for state management purposes.

\n\n

See stateful for an explanation of saving and restoring state.

\n\n

stateful : Boolean

A flag which causes the object to attempt to restore the state of\ninternal properties from a saved state on startup. ...

A flag which causes the object to attempt to restore the state of\ninternal properties from a saved state on startup. The object must have\na stateId for state to be managed.

\n\n

Auto-generated ids are not guaranteed to be stable across page loads and\ncannot be relied upon to save and restore the same state for a object.

\n\n

For state saving to work, the state manager's provider must have been\nset to an implementation of Ext.state.Provider which overrides the\nset and get\nmethods to save and recall name/value pairs. A built-in implementation,\nExt.state.CookieProvider is available.

\n\n

To set the state provider for the current page:

\n\n

Ext.state.Manager.setProvider(new Ext.state.CookieProvider({

\n\n

   expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now\n

\n\n

}));

\n\n

A stateful object attempts to save state when one of the events\nlisted in the stateEvents configuration fires.

\n\n

To save state, a stateful object first serializes its state by\ncalling getState.

\n\n

The Component base class implements getState to save its width and height within the state\nonly if they were initially configured, and have changed from the configured value.

\n\n

The Panel class saves its collapsed state in addition to that.

\n\n

The Grid class saves its column state in addition to its superclass state.

\n\n

If there is more application state to be save, the developer must provide an implementation which\nfirst calls the superclass method to inherit the above behaviour, and then injects new properties\ninto the returned object.

\n\n

The value yielded by getState is passed to Ext.state.Manager.set\nwhich uses the configured Ext.state.Provider to save the object\nkeyed by the stateId.

\n\n

During construction, a stateful object attempts to restore its state by calling\nExt.state.Manager.get passing the stateId

\n\n

The resulting object is passed to applyState*. The default implementation of\napplyState simply copies properties into the object, but a developer may\noverride this to support restoration of more complex application state.

\n\n

You can perform extra processing on state save and restore by attaching\nhandlers to the beforestaterestore, staterestore,\nbeforestatesave and statesave events.

Defaults to: false

style : String/Object

A custom style specification to be applied to this component's Element. ...

A custom style specification to be applied to this component's Element. Should be a valid argument to\nExt.Element.applyStyles.

\n\n

new Ext.panel.Panel({\n    title: 'Some Title',\n    renderTo: Ext.getBody(),\n    width: 400, height: 300,\n    layout: 'form',\n    items: [{\n        xtype: 'textarea',\n        style: {\n            width: '95%',\n            marginBottom: '10px'\n        }\n    },\n    new Ext.button.Button({\n        text: 'Send',\n        minWidth: '100',\n        style: {\n            marginBottom: '10px'\n        }\n    })\n    ]\n});\n

styleHtmlCls : String

The class that is added to the content target when you set styleHtmlContent to true. ...

The class that is added to the content target when you set styleHtmlContent to true.

Defaults to: "x-html"

styleHtmlContent : Boolean

True to automatically style the html inside the content target of this component (body for panels). ...

True to automatically style the html inside the content target of this component (body for panels).

Defaults to: false

suspendLayout : Boolean

If true, suspend calls to doLayout. ...

If true, suspend calls to doLayout. Useful when batching multiple adds to a container\nand not passing them as multiple arguments or an array.

Defaults to: false

toFrontOnShow : Boolean

True to automatically call toFront when the show method is called on an already visible,\nfloating component. ...

True to automatically call toFront when the show method is called on an already visible,\nfloating component.

Defaults to: true

tpl : Ext.XTemplate/Ext.Template/String/String[]

An Ext.Template, Ext.XTemplate or an array of strings to form an Ext.XTemplate. ...

An Ext.Template, Ext.XTemplate or an array of strings to form an Ext.XTemplate. Used in\nconjunction with the data and tplWriteMode configurations.

tplWriteMode : String

The Ext.(X)Template method to use when updating the content area of the Component. ...

The Ext.(X)Template method to use when updating the content area of the Component.\nSee Ext.XTemplate.overwrite for information on default mode.

Defaults to: "overwrite"

ui : String

A UI style for a component. ...

A UI style for a component.

Defaults to: "default"

uiCls : String[]private

An array of of classNames which are currently applied to this component ...

An array of of classNames which are currently applied to this component

Defaults to: []

Ext.container.Viewport
view source

width : Numberprivate

Sets itself to viewport height.

Overrides: Ext.AbstractComponent.width

xtype : String

This property provides a shorter alternative to creating objects than using a full\nclass name. ...

This property provides a shorter alternative to creating objects than using a full\nclass name. Using xtype is the most common way to define component instances,\nespecially in a container. For example, the items in a form containing text fields\ncould be created explicitly like so:

\n\n

 items: [\n     Ext.create('Ext.form.field.Text', {\n         fieldLabel: 'Foo'\n     }),\n     Ext.create('Ext.form.field.Text', {\n         fieldLabel: 'Bar'\n     }),\n     Ext.create('Ext.form.field.Number', {\n         fieldLabel: 'Num'\n     })\n ]\n

\n\n

But by using xtype, the above becomes:

\n\n

 items: [\n     {\n         xtype: 'textfield',\n         fieldLabel: 'Foo'\n     },\n     {\n         xtype: 'textfield',\n         fieldLabel: 'Bar'\n     },\n     {\n         xtype: 'numberfield',\n         fieldLabel: 'Num'\n     }\n ]\n

\n\n

When the xtype is common to many items, Ext.container.AbstractContainer.defaultType\nis another way to specify the xtype for all items that don't have an explicit xtype:

\n\n

 defaultType: 'textfield',\n items: [\n     { fieldLabel: 'Foo' },\n     { fieldLabel: 'Bar' },\n     { fieldLabel: 'Num', xtype: 'numberfield' }\n ]\n

\n\n

Each member of the items array is now just a \"configuration object\". These objects\nare used to create and configure component instances. A configuration object can be\nmanually used to instantiate a component using Ext.widget:

\n\n

 var text1 = Ext.create('Ext.form.field.Text', {\n     fieldLabel: 'Foo'\n });\n\n // or alternatively:\n\n var text1 = Ext.widget({\n     xtype: 'textfield',\n     fieldLabel: 'Foo'\n });\n

\n\n

This conversion of configuration objects into instantiated components is done when\na container is created as part of its {Ext.container.AbstractContainer.initComponent}\nprocess. As part of the same process, the items array is converted from its raw\narray form into a Ext.util.MixedCollection instance.

\n\n

You can define your own xtype on a custom component by specifying\nthe xtype property in Ext.define. For example:

\n\n

Ext.define('MyApp.PressMeButton', {\n    extend: 'Ext.button.Button',\n    xtype: 'pressmebutton',\n    text: 'Press Me'\n});\n

\n\n

Care should be taken when naming an xtype in a custom component because there is\na single, shared scope for all xtypes. Third part components should consider using\na prefix to avoid collisions.

\n\n

Ext.define('Foo.form.CoolButton', {\n    extend: 'Ext.button.Button',\n    xtype: 'ux-coolbutton',\n    text: 'Cool!'\n});\n

Properties

Defined By

Instance Properties

$className : Stringprivate

...

Defaults to: "Ext.Base"

_isLayoutRoot : Booleanprotected

Setting this property to true causes the isLayoutRoot method to return\ntrue and stop the search for the top-most comp...

Setting this property to true causes the isLayoutRoot method to return\ntrue and stop the search for the top-most component for a layout.

Defaults to: false

autoGenId : Booleanprivate

true indicates an id was auto-generated rather than provided by configuration. ...

true indicates an id was auto-generated rather than provided by configuration.

Defaults to: false

componentLayoutCounter : Numberprivate

The number of component layout calls made on this object. ...

The number of component layout calls made on this object.

Defaults to: 0

configMap : Objectprivate

...

Defaults to: {}

draggable : Booleanreadonly

Indicates whether or not the component can be dragged. ...

Indicates whether or not the component can be dragged.

Defaults to: false

eventsSuspended : Numberprivate

Initial suspended call count. ...

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

Defaults to: 0

floatParent : Ext.Containerreadonly

Only present for floating Components which were inserted as child items of Containers. ...

Only present for floating Components which were inserted as child items of Containers.

\n\n

Floating Components that are programatically rendered will not have a floatParent\nproperty.

\n\n

For floating Components which are child items of a Container, the floatParent will be the owning Container.

\n\n

For example, the dropdown BoundList of a ComboBox which is in a Window will have the\nWindow as its floatParent

\n\n

See floating and zIndexManager

frameSize : Objectreadonly

Indicates the width of any framing elements which were added within the encapsulating element\nto provide graphical, r...

Indicates the width of any framing elements which were added within the encapsulating element\nto provide graphical, rounded borders. See the frame config.

\n\n

This is an object containing the frame width in pixels for all four sides of the Component containing the\nfollowing properties:

Defaults to: {left: 0, top: 0, right: 0, bottom: 0, width: 0, height: 0}

top : Number (optional)
The width of the top framing element in pixels.
\n
Defaults to: 0
right : Number (optional)
The width of the right framing element in pixels.
\n
Defaults to: 0
bottom : Number (optional)
The width of the bottom framing element in pixels.
\n
Defaults to: 0
left : Number (optional)
The width of the left framing element in pixels.
\n
Defaults to: 0
width : Number (optional)
The total width of the left and right framing elements in pixels.
\n
Defaults to: 0
height : Number (optional)
The total height of the top and right bottom elements in pixels.
\n
Defaults to: 0

hasListeners : Objectreadonly

This object holds a key for any event that has a listener. ...

This object holds a key for any event that has a listener. The listener may be set\ndirectly on the instance, or on its class or a super class (via observe) or\non the MVC EventBus. The values of this object are truthy\n(a non-zero number) and falsy (0 or undefined). They do not represent an exact count\nof listeners. The value for an event is truthy if the event must be fired and is\nfalsy if there is no need to fire the event.

\n\n

The intended use of this property is to avoid the expense of fireEvent calls when\nthere are no listeners. This can be particularly helpful when one would otherwise\nhave to call fireEvent hundreds or thousands of times. It is used like this:

\n\n

 if (this.hasListeners.foo) {\n     this.fireEvent('foo', this, arg1);\n }\n

initConfigList : Arrayprivate

...

Defaults to: []

initConfigMap : Objectprivate

...

Defaults to: {}

isComponent : Boolean

true in this class to identify an object as an instantiated Component, or subclass thereof. ...

true in this class to identify an object as an instantiated Component, or subclass thereof.

Defaults to: true

isInstance : Booleanprivate

...

Defaults to: true

isObservable : Boolean

true in this class to identify an object as an instantiated Observable, or subclass thereof. ...

true in this class to identify an object as an instantiated Observable, or subclass thereof.

Defaults to: true

Ext.container.Viewport
view source

isViewport : Boolean

true in this class to identify an object as an instantiated Viewport, or subclass thereof. ...

true in this class to identify an object as an instantiated Viewport, or subclass thereof.

Defaults to: true

items : Ext.util.AbstractMixedCollection

The MixedCollection containing all the child items of this container.

layoutCounter : Numberprivate

The number of container layout calls made on this object. ...

The number of container layout calls made on this object.

Defaults to: 0

maskOnDisable : Boolean

This is an internal flag that you use when creating custom components. ...

This is an internal flag that you use when creating custom components. By default this is set to true which means\nthat every component gets a mask when it's disabled. Components like FieldContainer, FieldSet, Field, Button, Tab\noverride this property to false since they want to implement custom disable logic.

Defaults to: true

ownerCt : Ext.Containerreadonly

This Component's owner Container (is set automatically\nwhen this Component is added to a Container). ...

This Component's owner Container (is set automatically\nwhen this Component is added to a Container).

\n\n

Note: to access items within the Container see itemId.

rendered : Booleanreadonly

Indicates whether or not the component has been rendered. ...

Indicates whether or not the component has been rendered.

Defaults to: false

self : Ext.Classprotected

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n

Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); // dependent on 'this'\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n

zIndexManager : Ext.ZIndexManagerreadonly

Only present for floating Components after they have been rendered. ...

Only present for floating Components after they have been rendered.

\n\n

A reference to the ZIndexManager which is managing this Component's z-index.

\n\n

The ZIndexManager maintains a stack of floating Component z-indices, and also provides\na single modal mask which is insert just beneath the topmost visible modal floating Component.

\n\n

Floating Components may be brought to the front or sent to the back of the\nz-index stack.

\n\n

This defaults to the global ZIndexManager for floating Components that are\nprogramatically rendered.

\n\n

For floating Components which are added to a Container, the ZIndexManager is acquired from the first\nancestor Container found which is floating. If no floating ancestor is found, the global ZIndexManager is\nused.

\n\n

See floating and zIndexParent

zIndexParent : Ext.Containerreadonly

Only present for floating Components which were inserted as child items of Containers, and which have a floating\nCont...

Only present for floating Components which were inserted as child items of Containers, and which have a floating\nContainer in their containment ancestry.

\n\n

For floating Components which are child items of a Container, the zIndexParent will be a floating\nancestor Container which is responsible for the base z-index value of all its floating descendants. It provides\na ZIndexManager which provides z-indexing services for all its descendant floating\nComponents.

\n\n

Floating Components that are programatically rendered will not have a zIndexParent\nproperty.

\n\n

For example, the dropdown BoundList of a ComboBox which is in a Window will have the\nWindow as its zIndexParent, and will always show above that Window, wherever the Window is placed in the z-index stack.

\n\n

See floating and zIndexManager

Defined By

Static Properties

$onExtended : Arrayprivatestatic

...

Defaults to: []

Methods

Defined By

Instance Methods

newExt.container.Viewport( Ext.Element/String/Object config ) : Object

Creates new Component. ...

Creates new Component.

Parameters

config : Ext.Element/String/Object
The configuration options may be specified as either:
\n\n
- an element : it is set as the internal element and its id used as the component id
- a string : it is assumed to be the id of an existing element and is used as the component id
- anything else : it is assumed to be a standard config object and is applied to the component
\n\n

Returns

Object
\n

Overrides: Ext.AbstractComponent.constructor

Ext.util.ElementContainer
view source

add( Ext.Component[]/Ext.Component... component ) : Ext.Component[]/Ext.Component

Adds Component(s) to this Container. ...

Adds Component(s) to this Container.

\n\n

Description:

\n\n

Fires the beforeadd event before adding.
The Container's default config values will be applied\naccordingly (see defaults for details).
Fires the add event after the component has been added.

\n\n\n

Notes:

\n\n

If the Container is already rendered when add\nis called, it will render the newly added Component into its content area.

\n\n

If the Container was configured with a size-managing layout manager,\nthe Container will recalculate its internal layout at this time too.

\n\n

Note that the default layout manager simply renders child Components sequentially\ninto the content area and thereafter performs no sizing.

\n\n

If adding multiple new child Components, pass them as an array to the add method,\nso that only one layout recalculation is performed.

\n\n

tb = new Ext.toolbar.Toolbar({\n    renderTo: document.body\n});  // toolbar is rendered\n// add multiple items.\n// (defaultType for Toolbar is 'button')\ntb.add([{text:'Button 1'}, {text:'Button 2'}]);\n

\n\n

To inject components between existing ones, use the insert method.

\n\n

Warning:

\n\n

Components directly managed by the BorderLayout layout manager may not be removed\nor added. See the Notes for BorderLayout for\nmore details.

Parameters

component : Ext.Component[]/Ext.Component...
Either one or more Components to add or an Array of Components to add.\nSee items for additional information.
\n

Returns

Ext.Component[]/Ext.Component
The Components that were added.
\n

addChildEls( )

Adds each argument passed to this method to the childEls array. ...

Adds each argument passed to this method to the childEls array.

addClass( String/String[] cls ) : Ext.Componentdeprecated

Adds a CSS class to the top level element representing this component. ...

Adds a CSS class to the top level element representing this component.

This method has been deprecated since 4.1

Use addCls instead.

\n\n

Parameters

cls : String/String[]
The CSS class name to add
\n\n

Returns

Ext.Component
Returns the Component to allow method chaining.
\n\n

addCls( String/String[] cls ) : Ext.Component

Adds a CSS class to the top level element representing this component. ...

Adds a CSS class to the top level element representing this component.

Parameters

cls : String/String[]
The CSS class name to add
\n\n

Returns

Ext.Component
Returns the Component to allow method chaining.
\n\n

addClsWithUI( String/String[] classes, Object skip )

Adds a cls to the uiCls array, which will also call addUIClsToElement and adds to all elements of this\ncomponent. ...

Adds a cls to the uiCls array, which will also call addUIClsToElement and adds to all elements of this\ncomponent.

Parameters

classes : String/String[]
A string or an array of strings to add to the uiCls
\n
skip : Object
(Boolean) skip True to skip adding it to the class and do it later (via the return)
\n

addEvents( Object/String... eventNames )

Adds 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

eventNames : Object/String...
Either an object with event names as properties with\na value of true. For example:
\n\n
```
this.addEvents({\n    storeloaded: true,\n    storecleared: true\n});\n
```
\n\n
Or any number of event names as separate parameters. For example:
\n\n
```
this.addEvents('storeloaded', 'storecleared');\n
```
\n

addFocusListener( )private

Sets up the focus listener on this Component's focusEl if it has one. ...

Sets up the focus listener on this Component's focusEl if it has one.

\n\n\n

Form Components which must implicitly participate in tabbing order usually have a naturally focusable\nelement as their focusEl, and it is the DOM event of that recieving focus which drives\nthe Component's onFocus handling, and the DOM event of it being blurred which drives the onBlur handling.

\n\n\n

If the focusEl is not naturally focusable, then the listeners are only added\nif the FocusManager is enabled.

\n\n

addListener( String/Object eventName, [Function fn], [Object scope], [Object options] )

Appends an event handler to this object. ...

Appends an event handler to this object. For example:

\n\n

myGridPanel.on(\"mouseover\", this.onMouseOver, this);\n

\n\n

The method also allows for a single argument to be passed which is a config object\ncontaining properties which specify multiple events. For example:

\n\n

myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n

\n\n

One can also specify options for each event handler separately:

\n\n

myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n

\n\n

Names of methods in a specified scope may also be used. Note that\nscope MUST be specified to use this option:

\n\n

myGridPanel.on({\n    cellClick: {fn: 'onCellClick', scope: this, single: true},\n    mouseover: {fn: 'onMouseOver', scope: panel}\n});\n

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

addManagedListener( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope], [Object opt] )

Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestr...

Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.

Parameters

item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n
opt : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n

addPropertyToState( Object state, String propName, [String value] ) : Booleanprotected

Save a property to the given state object if it is not its default or configured\nvalue. ...

Save a property to the given state object if it is not its default or configured\nvalue.

Parameters

state : Object
The state object
\n
propName : String
The name of the property on this object to save.
\n
value : String (optional)
The value of the state property (defaults to this[propName]).
\n

Returns

Boolean
The state object or a new object if state was null and the property\nwas saved.
\n

addStateEvents( String/String[] events )

Add events that will trigger the state to be saved. ...

Add events that will trigger the state to be saved. If the first argument is an\narray, each element of that array is the name of a state event. Otherwise, each\nargument passed to this method is the name of a state event.

Parameters

events : String/String[]
The event name or an array of event names.
\n

addUIClsToElement( String ui )

Method which adds a specified UI + uiCls to the components element. ...

Method which adds a specified UI + uiCls to the components element. Can be overridden to remove the UI from more\nthan just the components element.

Parameters

ui : String
The UI to remove from the element
\n

addUIToElement( )private

Method which adds a specified UI to the components element. ...

Method which adds a specified UI to the components element.

afterComponentLayout( Number width, Number height, Number oldWidth, Number oldHeight )protectedtemplate

Called by the layout system after the Component has been layed out. ...

Called by the layout system after the Component has been layed out.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

width : Number
The width that was set
\n
height : Number
The height that was set
\n
oldWidth : Number
The old width. undefined if this was the initial layout.
\n
oldHeight : Number
The old height. undefined if this was the initial layout.
\n

afterHide( [Function callback], [Object scope] )protectedtemplate

Invoked after the Component has been hidden. ...

Invoked after the Component has been hidden.

\n\n

Gets passed the same callback and scope parameters that onHide received.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

callback : Function (optional)
\n
scope : Object (optional)
\n

afterLayout( Ext.layout.container.Container layout )protectedtemplate

Invoked after the Container has laid out (and rendered if necessary)\nits child Components. ...

Invoked after the Container has laid out (and rendered if necessary)\nits child Components.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

layout : Ext.layout.container.Container
\n

afterRender( )protectedtemplate

Allows addition of behavior after rendering is complete. ...

Allows addition of behavior after rendering is complete. At this stage the Component’s Element\nwill have been styled according to the configuration, will have had any configured CSS class\nnames added, and will be in the configured visibility and the configured enable state.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

afterSetPosition( Number x, Number y )protectedtemplate

Template method called after a Component has been positioned. ...

Template method called after a Component has been positioned.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

x : Number
\n
y : Number
\n

afterShow( [String/Ext.Element animateTarget], [Function callback], [Object scope] )protectedtemplate

Invoked after the Component is shown (after onShow is called). ...

Invoked after the Component is shown (after onShow is called).

\n\n

Gets passed the same parameters as show.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

animateTarget : String/Ext.Element (optional)
\n
callback : Function (optional)
\n
scope : Object (optional)
\n

alignTo( Ext.Component/Ext.Element/HTMLElement/String element, [String position], [Number[] offsets] ) : Ext.Component

Aligns this floating Component to the specified element ...

Aligns this floating Component to the specified element

Parameters

element : Ext.Component/Ext.Element/HTMLElement/String
The element or Ext.Component to align to. If passing a component, it must be a\ncomponent instance. If a string id is passed, it will be used as an element id.
\n
position : String (optional)
The position to align to\n(see Ext.Element.alignTo for more details).
\n
Defaults to: "tl-bl?"
offsets : Number[] (optional)
Offset the positioning by [x, y]
\n

Returns

Ext.Component
this
\n

Ext.util.ElementContainer
view source

animate( Object config ) : Object

Performs custom animation on this object. ...

Performs custom animation on this object.

\n\n

This method is applicable to both the Component class and the Sprite\nclass. It performs animated transitions of certain properties of this object over a specified timeline.

\n\n

Animating a Component

\n\n

When animating a Component, the following properties may be specified in from, to, and keyframe objects:

\n\n

x - The Component's page X position in pixels.
y - The Component's page Y position in pixels
left - The Component's left value in pixels.
top - The Component's top value in pixels.
width - The Component's width value in pixels.
width - The Component's width value in pixels.
dynamic - Specify as true to update the Component's layout (if it is a Container) at every frame of the animation.\nUse sparingly as laying out on every intermediate size change is an expensive operation.

\n\n\n

For example, to animate a Window to a new size, ensuring that its internal layout and any shadow is correct:

\n\n

myWindow = Ext.create('Ext.window.Window', {\n    title: 'Test Component animation',\n    width: 500,\n    height: 300,\n    layout: {\n        type: 'hbox',\n        align: 'stretch'\n    },\n    items: [{\n        title: 'Left: 33%',\n        margins: '5 0 5 5',\n        flex: 1\n    }, {\n        title: 'Left: 66%',\n        margins: '5 5 5 5',\n        flex: 2\n    }]\n});\nmyWindow.show();\nmyWindow.header.el.on('click', function() {\n    myWindow.animate({\n        to: {\n            width: (myWindow.getWidth() == 500) ? 700 : 500,\n            height: (myWindow.getHeight() == 300) ? 400 : 300\n        }\n    });\n});\n

\n\n

For performance reasons, by default, the internal layout is only updated when the Window reaches its final \"to\"\nsize. If dynamic updating of the Window's child Components is required, then configure the animation with\ndynamic: true and the two child items will maintain their proportions during the animation.

Parameters

config : Object
Configuration for Ext.fx.Anim.\nNote that the to config is required.
\n

Returns

Object
this
\n

applyChildEls( Object el, Object id )private

Sets references to elements inside the component. ...

Sets references to elements inside the component.

Parameters

el : Object
\n
id : Object
\n

applyRenderSelectors( )private

Sets references to elements inside the component. ...

Sets references to elements inside the component. This applies renderSelectors\nas well as childEls.

applyState( Object state )

Applies the state to the object. ...

Applies the state to the object. This should be overridden in subclasses to do\nmore complex state operations. By default it applies the state properties onto\nthe current object.

Parameters

state : Object
The state
\n

beforeComponentLayout( Number adjWidth, Number adjHeight )protectedtemplate

Occurs before componentLayout is run. ...

Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout from\nbeing executed.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

adjWidth : Number
The box-adjusted width that was set
\n
adjHeight : Number
The box-adjusted height that was set
\n

beforeDestroy( )protectedtemplate

Invoked before the Component is destroyed. ...

Invoked before the Component is destroyed.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

beforeLayout( )protectedtemplate

Occurs before componentLayout is run. ...

Occurs before componentLayout is run. Returning false from this method\nwill prevent the containerLayout from being executed.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

beforeSetPosition( Object x, Object y, Object animate )private

Template method called before a Component is positioned. ...

Template method called before a Component is positioned.

Parameters

x : Object
\n
y : Object
\n
animate : Object
\n

beforeShow( )protectedtemplate

Invoked before the Component is shown. ...

Invoked before the Component is shown.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

bubble( Function fn, [Object scope], [Array args] ) : Ext.Component

Bubbles up the component/container heirarchy, calling the specified function with each component. ...

Bubbles up the component/container heirarchy, calling the specified function with each component. The scope\n(this) of function call will be the scope provided or the current component. The arguments to the function will\nbe the args provided or the current component. If the function returns false at any point, the bubble is stopped.

Parameters

fn : Function
The function to call
\n
scope : Object (optional)
The scope of the function. Defaults to current node.
\n
args : Array (optional)
The args to call the function with. Defaults to passing the current component.
\n

Returns

Ext.Component
this
\n

callOverridden( Array/Arguments args ) : Objectdeprecatedprotected

Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

This method has been deprecated

as of 4.1. Use callParent instead.

\n\n

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callOverridden(arguments)
\n

Returns

Object
Returns the result of calling the overridden method
\n

callParent( Array/Arguments args ) : Objectprotected

Call the \"parent\" method of the current method. ...

Call the \"parent\" method of the current method. That is the method previously\noverridden by derivation or by an override (see Ext.define).

\n\n

 Ext.define('My.Base', {\n     constructor: function (x) {\n         this.x = x;\n     },\n\n     statics: {\n         method: function (x) {\n             return x;\n         }\n     }\n });\n\n Ext.define('My.Derived', {\n     extend: 'My.Base',\n\n     constructor: function () {\n         this.callParent([21]);\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // alerts 21\n

\n\n

This can be used with an override as follows:

\n\n

 Ext.define('My.DerivedOverride', {\n     override: 'My.Derived',\n\n     constructor: function (x) {\n         this.callParent([x*2]); // calls original My.Derived constructor\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // now alerts 42\n

\n\n

This also works with static methods.

\n\n

 Ext.define('My.Derived2', {\n     extend: 'My.Base',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Base.method\n         }\n     }\n });\n\n alert(My.Base.method(10);     // alerts 10\n alert(My.Derived2.method(10); // alerts 20\n

\n\n

Lastly, it also works with overridden static methods.

\n\n

 Ext.define('My.Derived2Override', {\n     override: 'My.Derived2',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Derived2.method\n         }\n     }\n });\n\n alert(My.Derived2.method(10); // now alerts 40\n

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)
\n

Returns

Object
Returns the result of calling the parent method
\n

cancelFocus( )protected

Cancel any deferred focus on this component ...

Cancel any deferred focus on this component

cancelLayout( Ext.Component comp )

Cancels layout of a component. ...

Cancels layout of a component.

Parameters

comp : Ext.Component
\n

cascade( Function fn, [Object scope], [Array args] ) : Ext.Container

Cascades down the component/container heirarchy from this component (passed in\nthe first call), calling the specified...

Cascades down the component/container heirarchy from this component (passed in\nthe first call), calling the specified function with each component. The scope\n(this reference) of the function call will be the scope provided or the current\ncomponent. The arguments to the function will be the args provided or the current\ncomponent. If the function returns false at any point, the cascade is stopped on\nthat branch.

Parameters

fn : Function
The function to call
\n
scope : Object (optional)
The scope of the function (defaults to current component)
\n
args : Array (optional)
The args to call the function with. The current component\nalways passed as the last argument.
\n

Returns

Ext.Container
this
\n

center( ) : Ext.Component

Center this Component in its container. ...

Center this Component in its container.

Returns

Ext.Component
this
\n

child( [String selector] )

Retrieves the first direct child of this container which matches the passed selector. ...

Retrieves the first direct child of this container which matches the passed selector.\nThe passed in selector must comply with an Ext.ComponentQuery selector.

Parameters

selector : String (optional)
An Ext.ComponentQuery selector. If no selector is\nspecified, the first child will be returned.
\n

clearListeners( )

Removes all listeners for this object including the managed listeners ...

Removes all listeners for this object including the managed listeners

clearManagedListeners( )

Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

cloneConfig( Object overrides ) : Ext.Component

Clone the current component using the original config values passed into this instance by default. ...

Clone the current component using the original config values passed into this instance by default.

Parameters

overrides : Object
A new config containing any properties to override in the cloned version.\nAn id property can be passed on this object, otherwise one will be generated to avoid duplicates.
\n

Returns

Ext.Component
clone The cloned copy of this component
\n

configClass( )private

...

constructPlugins( )private

Returns an array of fully constructed plugin instances. ...

Returns an array of fully constructed plugin instances. This converts any configs into their\nappropriate instances.

\n\n

It does not mutate the plugins array. It creates a new array.

\n\n

This is borrowed by Lockable which clones and distributes Plugins\nto both child grids of a locking grid, so must keep to that contract.

continueFireEvent( String eventName, Array args, Boolean bubbles )private

Continue to fire event. ...

Continue to fire event.

Parameters

eventName : String
\n
args : Array
\n
bubbles : Boolean
\n

convertPosition( Object pos, Object withUnits )private

This method converts an \"{x: x, y: y}\" object to a \"{left: x+'px', top: y+'px'}\" object. ...

This method converts an \"{x: x, y: y}\" object to a \"{left: x+'px', top: y+'px'}\" object.\nThe returned object contains the styles to set to effect the position. This is\noverridden in RTL mode to be \"{right: x, top: y}\".

Parameters

pos : Object
\n
withUnits : Object
\n

createRelayer( Object newName, [Array beginEnd] ) : Functionprivate

Creates an event handling function which refires the event from this object as the passed event name. ...

Creates an event handling function which refires the event from this object as the passed event name.

Parameters

newName : Object
\n
beginEnd : Array (optional)
The caller can specify on which indices to slice
\n

Returns

Function
\n

destroy( )private

...

Overrides: Ext.AbstractComponent.destroy, Ext.AbstractPlugin.destroy, Ext.layout.Layout.destroy

disable( [Boolean silent] )

Disable the component. ...

Disable the component.

Parameters

silent : Boolean (optional)
Passing true will supress the 'disable' event from being fired.
\n
Defaults to: false

doApplyRenderTpl( Object out, Object values )private

Called from the selected frame generation template to insert this Component's inner structure inside the framing stru...

Called from the selected frame generation template to insert this Component's inner structure inside the framing structure.

\n\n

When framing is used, a selected frame generation template is used as the primary template of the #getElConfig instead\nof the configured renderTpl. The renderTpl is invoked by this method which is injected into the framing template.

Parameters

out : Object
\n
values : Object
\n

doAutoRender( )

Handles autoRender. ...

Handles autoRender.\nFloating Components may have an ownerCt. If they are asking to be constrained, constrain them within that\nownerCt, and have their z-index managed locally. Floating Components are always rendered to document.body

doComponentLayout( ) : Ext.container.Container

This method needs to be called whenever you change something on this component that requires the Component's\nlayout t...

This method needs to be called whenever you change something on this component that requires the Component's\nlayout to be recalculated.

Returns

Ext.container.Container
this
\n

doConstrain( [String/HTMLElement/Ext.Element/Ext.util.Region constrainTo] )

Moves this floating Component into a constrain region. ...

Moves this floating Component into a constrain region.

\n\n

By default, this Component is constrained to be within the container it was added to, or the element it was\nrendered to.

\n\n

An alternative constraint may be passed.

Parameters

constrainTo : String/HTMLElement/Ext.Element/Ext.util.Region (optional)
The Element or Region\ninto which this Component is to be constrained. Defaults to the element into which this floating Component\nwas rendered.
\n

doLayout( ) : Ext.container.Container

Manually force this container's layout to be recalculated. ...

Manually force this container's layout to be recalculated. The framework uses this internally to refresh layouts\nform most cases.

Returns

Ext.container.Container
this
\n

down( [String selector] )

Retrieves the first descendant of this container which matches the passed selector. ...

Retrieves the first descendant of this container which matches the passed selector.\nThe passed in selector must comply with an Ext.ComponentQuery selector.

Parameters

selector : String (optional)
An Ext.ComponentQuery selector. If no selector is\nspecified, the first child will be returned.
\n

enable( [Boolean silent] )

Enable the component ...

Enable the component

Parameters

silent : Boolean (optional)
Passing true will supress the 'enable' event from being fired.
\n
Defaults to: false

enableBubble( String/String[] eventNames )

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. There is no implementation in the Observable base class.

\n\n

This is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.

\n\n

Example:

\n\n

Ext.override(Ext.form.field.Base, {\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n        this.enableBubble('change');\n    }),\n\n    //  We know that we want Field's events to bubble directly to the FormPanel.\n    getBubbleTarget : function() {\n        if (!this.formPanel) {\n            this.formPanel = this.findParentByType('form');\n        }\n        return this.formPanel;\n    }\n});\n\nvar myForm = new Ext.formPanel({\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\n        change: function() {\n            // Title goes red if form has been modified.\n            myForm.header.setStyle('color', 'red');\n        }\n    }\n});\n

Parameters

eventNames : String/String[]
The event name to bubble, or an Array of event names.
\n

ensureAttachedToBody( [Boolean runLayout] )

Ensures that this component is attached to document.body. ...

Ensures that this component is attached to document.body. If the component was\nrendered to Ext.getDetachedBody, then it will be appended to document.body.\nAny configured position is also restored.

Parameters

runLayout : Boolean (optional)
True to run the component's layout.
\n
Defaults to: false

findParentBy( Function fn ) : Ext.container.Container

Find a container above this component at any level by a custom function. ...

Find a container above this component at any level by a custom function. If the passed function returns true, the\ncontainer will be returned.

\n\n

Parameters

fn : Function
The custom function to call with the arguments (container, this component).
\n

Returns

Ext.container.Container
The first Container for which the custom function returns true
\n

findParentByType( String/Ext.Class xtype ) : Ext.container.Container

Find a container above this component at any level by xtype or class\n\nSee also the up method. ...

Find a container above this component at any level by xtype or class

\n\n

Parameters

xtype : String/Ext.Class
The xtype string for a component, or the class of the component directly
\n

Returns

Ext.container.Container
The first Container which matches the given xtype or class
\n

finishRender( Number containerIdx )private

This method visits the rendered component tree in a \"top-down\" order. ...

This method visits the rendered component tree in a \"top-down\" order. That is, this\ncode runs on a parent component before running on a child. This method calls the\nonRender method of each component.

Parameters

containerIdx : Number
The index into the Container items of this Component.
\n

fireEvent( String eventName, Object... args ) : Boolean

Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...

Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addListener).

\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.

Parameters

eventName : String
The name of the event to fire.
\n
args : Object...
Variable number of parameters are passed to handlers.
\n

Returns

Boolean
returns false if any of the handlers return false otherwise it returns true.
\n

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 component
\n
delay : Boolean/Number (optional)
Delay the focus this number of milliseconds (true for 10 milliseconds).
\n

Returns

Ext.Component
The focused Component. Usually this Component. Some Containers may\ndelegate focus to a descendant Component (Windows can do this through their\ndefaultFocus config option.
\n

forceComponentLayout( )deprecated

Forces this component to redo its componentLayout. ...

Forces this component to redo its componentLayout.

This method has been deprecated since 4.1.0

Use updateLayout instead.

\n\n

getActiveAnimation( ) : Ext.fx.Anim/Boolean

Returns the current animation if this object has any effects actively running or queued, else returns false. ...

Returns the current animation if this object has any effects actively running or queued, else returns false.

Returns

Ext.fx.Anim/Boolean
Anim if element has active effects, else false
\n\n

getAutoId( )private

...

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.
\n
Defaults to: false

Returns

Object
box An object in the format {x, y, width, height}
\n

getBubbleParent( ) : Ext.util.Observableprivate

Gets the bubbling parent for an Observable ...

Gets the bubbling parent for an Observable

Returns

Ext.util.Observable
The bubble parent. null is returned if no bubble target exists
\n

Ext.container.Container
view source

getBubbleTarget( ) : Ext.container.Container

Provides 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.

Returns

Ext.container.Container
the Container which owns this Component.
\n

getChildByElement( Ext.Element/HTMLElement/String el, Boolean deep ) : Ext.Component

Return the immediate child Component in which the passed element is located. ...

Return the immediate child Component in which the passed element is located.

Parameters

el : Ext.Element/HTMLElement/String
The element to test (or ID of element).
\n
deep : Boolean
If true, returns the deepest descendant Component which contains the passed element.
\n

Returns

Ext.Component
The child item which contains the passed element.
\n

getChildItemsToDisable( ) : Ext.Component[]private

Gets a list of child components to enable/disable when the container is\nenabled/disabled ...

Gets a list of child components to enable/disable when the container is\nenabled/disabled

Returns

Ext.Component[]
Items to be enabled/disabled
\n

getComponent( String/Number comp ) : Ext.Component

Examines this container's items property and gets a direct child\ncomponent of this container. ...

Examines this container's items property and gets a direct child\ncomponent of this container.

Parameters

comp : String/Number
This parameter may be any of the following:
\n\n
- a String : representing the itemId\nor id of the child component.
- a Number : representing the position of the child component\nwithin the items property
\n\n\n
For additional information see Ext.util.MixedCollection.get.
\n

Returns

Ext.Component
The component (if found).
\n

getConfig( Object name )private

...

Parameters

name : Object
\n

getConstrainVector( [String/HTMLElement/Ext.Element/Ext.util.Region constrainTo] ) : Number[]private

Gets the x/y offsets to constrain this float ...

Gets the x/y offsets to constrain this float

Parameters

constrainTo : String/HTMLElement/Ext.Element/Ext.util.Region (optional)
The Element or Region\ninto which this Component is to be constrained.
\n

Returns

Number[]
The x/y constraints
\n

getEl( ) : Ext.dom.Element

Retrieves the top level element representing this component. ...

Retrieves the top level element representing this component.

Returns

Ext.dom.Element
\n

getFocusEl( ) : Ext.Elementprivate

Returns the focus holder element associated with this Container. ...

Returns the focus holder element associated with this Container. By default, this is the Container's target\nelement. Subclasses which use embedded focusable elements (such as Window and Button) should override this for use\nby the focus method.

Returns

Ext.Element
the focus holding element.
\n

Overrides: Ext.AbstractComponent.getFocusEl

getFrameInfo( )private

On render, reads an encoded style attribute, \"background-position\" from the style of this Component's element. ...

On render, reads an encoded style attribute, \"background-position\" from the style of this Component's element.\nThis information is memoized based upon the CSS class name of this Component's element.\nBecause child Components are rendered as textual HTML as part of the topmost Container, a dummy div is inserted\ninto the document to receive the document element's CSS class name, and therefore style attributes.

getFrameTpl( Object table )private

...

Parameters

table : Object
\n

getHeight( ) : Number

Gets the current height of the component's underlying element. ...

Gets the current height of the component's underlying element.

Returns

Number
\n

getId( ) : String

Retrieves the id of this component. ...

Retrieves the id of this component. Will autogenerate an id if one has not already been set.

Returns

String
\n

getInitialConfig( [String name] ) : Object/Mixed

Returns the initial configuration passed to constructor when instantiating\nthis class. ...

Returns the initial configuration passed to constructor when instantiating\nthis class.

Parameters

name : String (optional)
Name of the config option to return.
\n

Returns

Object/Mixed
The full config object or a single config value\nwhen name parameter specified.
\n

getInsertPosition( String/Number/Ext.dom.Element/HTMLElement position ) : HTMLElement

This function takes the position argument passed to onRender and returns a\nDOM element that you can use in the insert...

This function takes the position argument passed to onRender and returns a\nDOM element that you can use in the insertBefore.

Parameters

position : String/Number/Ext.dom.Element/HTMLElement
Index, element id or element you want\nto put this component before.
\n

Returns

HTMLElement
DOM element that you can use in the insertBefore
\n

getItemId( ) : String

Returns the value of itemId assigned to this component, or when that\nis not set, returns the value of id. ...

Returns the value of itemId assigned to this component, or when that\nis not set, returns the value of id.

Returns

String
\n

getLayout( ) : Ext.layout.container.Container

Returns the layout instance currently associated with this Container. ...

Returns the layout instance currently associated with this Container.\nIf a layout has not been instantiated yet, that is done first

Returns

Ext.layout.container.Container
The layout
\n

getLoader( ) : Ext.ComponentLoader

Gets the Ext.ComponentLoader for this Component. ...

Gets the Ext.ComponentLoader for this Component.

Returns

Ext.ComponentLoader
The loader instance, null if it doesn't exist.
\n

getOverflowStyle( )private

Returns the CSS style object which will set the Component's scroll styles. ...

Returns the CSS style object which will set the Component's scroll styles. This must be applied\nto the target element.

getPlugin( String pluginId ) : Ext.AbstractPlugin

Retrieves a plugin by its pluginId which has been bound to this component. ...

Retrieves a plugin by its pluginId which has been bound to this component.

Parameters

pluginId : String
\n

Returns

Ext.AbstractPlugin
plugin instance.
\n

getPosition( [Boolean local] ) : Number[]

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.
\n
Defaults to: false

Returns

Number[]
The XY position of the element (e.g., [100, 200])
\n

getSize( ) : Object

Gets the current size of the component's underlying element. ...

Gets the current size of the component's underlying element.

Returns

Object
An object containing the element's size {width: (element width), height: (element height)}
\n

getSizeModel( Object ownerCtSizeModel ) : Object

Returns an object that describes how this component's width and height are managed. ...

Returns an object that describes how this component's width and height are managed.\nAll of these objects are shared and should not be modified.

Parameters

ownerCtSizeModel : Object
\n

Returns

Object
The size model for this component.
\n
- width : Ext.layout.SizeModel
  The size model\nfor the width.
  \n
- height : Ext.layout.SizeModel
  The size model\nfor the height.
  \n

getState( ) : Object

The supplied default state gathering method for the AbstractComponent class. ...

The supplied default state gathering method for the AbstractComponent class.

\n\n

This method returns dimension settings such as flex, anchor, width and height along with collapsed\nstate.

\n\n

Subclasses which implement more complex state should call the superclass's implementation, and apply their state\nto the result if this basic state is to be saved.

\n\n

Note that Component state will only be saved if the Component has a stateId and there as a StateProvider\nconfigured for the document.

Returns

Object
\n

Overrides: Ext.state.Stateful.getState

getStateId( ) : Stringprivate

Gets the state id for this object. ...

Gets the state id for this object.

Returns

String
The 'stateId' or the implicit 'id' specified by component configuration.
\n

getStyleProxy( Object cls )private

Returns an offscreen div with the same class name as the element this is being rendered. ...

Returns an offscreen div with the same class name as the element this is being rendered.\nThis is because child item rendering takes place in a detached div which, being not part of the document, has no styling.

Parameters

cls : Object
\n

getTargetEl( )private

This is used to determine where to insert the 'html', 'contentEl' and 'items' in this component. ...

This is used to determine where to insert the 'html', 'contentEl' and 'items' in this component.

getTpl( Object name )private

...

Parameters

name : Object
\n

getWidth( ) : Number

Gets the current width of the component's underlying element. ...

Gets the current width of the component's underlying element.

Returns

Number
\n

getXType( ) : String

Gets the xtype for this component as registered with Ext.ComponentManager. ...

Gets the xtype for this component as registered with Ext.ComponentManager. For a list of all available\nxtypes, see the Ext.Component header. Example usage:

\n\n

var t = new Ext.form.field.Text();\nalert(t.getXType());  // alerts 'textfield'\n

Returns

String
The xtype
\n

getXTypes( ) : String

Returns this Component's xtype hierarchy as a slash-delimited string. ...

Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the\nExt.Component header.

\n\n

If using your own subclasses, be aware that a Component must register its own xtype to participate in\ndetermination of inherited xtypes.

\n\n

Example usage:

\n\n

var t = new Ext.form.field.Text();\nalert(t.getXTypes());  // alerts 'component/field/textfield'\n

Returns

String
The xtype hierarchy string
\n

hasActiveFx( ) : Ext.fx.Anim/Booleandeprecated

Returns the current animation if this object has any effects actively running or queued, else returns false. ...

Returns the current animation if this object has any effects actively running or queued, else returns false.

This method has been deprecated since 4.0

Replaced by getActiveAnimation

\n\n

Returns

Ext.fx.Anim/Boolean
Anim if element has active effects, else false
\n\n

hasCls( String className ) : Boolean

Checks if the specified CSS class exists on this element's DOM node. ...

Checks if the specified CSS class exists on this element's DOM node.

Parameters

className : String
The CSS class to check for
\n

Returns

Boolean
True if the class exists, else false
\n

hasConfig( Object config )private

...

Parameters

config : Object
\n

hasListener( String eventName ) : Boolean

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer\nindicates whether the event needs firing or not.

Parameters

eventName : String
The name of the event to check for
\n

Returns

Boolean
true if the event is being listened for or bubbles, else false
\n

hasUICls( String cls )

Checks if there is currently a specified uiCls ...

Checks if there is currently a specified uiCls

Parameters

cls : String
The cls to check
\n

hide( [String/Ext.Element/Ext.Component animateTarget], [Function callback], [Object scope] ) : Ext.Component

Hides this Component, setting it to invisible using the configured hideMode. ...

Hides this Component, setting it to invisible using the configured hideMode.

Parameters

animateTarget : String/Ext.Element/Ext.Component (optional)
only valid for floating Components\nsuch as Windows or ToolTips, or regular Components which have\nbeen configured with floating: true.. The target to which the Component should animate while hiding.
\n
Defaults to: null
callback : Function (optional)
A callback function to call after the Component is hidden.
\n
scope : Object (optional)
The scope (this reference) in which the callback is executed.\nDefaults to this Component.
\n

Returns

Ext.Component
this
\n

initComponent( )protectedtemplate

The initComponent template method is an important initialization step for a Component. ...

The initComponent template method is an important initialization step for a Component. It is intended to be\nimplemented by each subclass of Ext.Component to provide any needed constructor logic. The\ninitComponent method of the class being created is called first, with each initComponent method\nup the hierarchy to Ext.Component being called thereafter. This makes it easy to implement and,\nif needed, override the constructor logic of the Component at any step in the hierarchy.

\n\n

The initComponent method must contain a call to callParent in order\nto ensure that the parent class' initComponent method is also called.

\n\n

All config options passed to the constructor are applied to this before initComponent is called,\nso you can simply access them with this.someOption.

\n\n

The following example demonstrates using a dynamic string for the text of a button at the time of\ninstantiation of the class.

\n\n

Ext.define('DynamicButtonText', {\n    extend: 'Ext.button.Button',\n\n    initComponent: function() {\n        this.text = new Date();\n        this.renderTo = Ext.getBody();\n        this.callParent();\n    }\n});\n\nExt.onReady(function() {\n    Ext.create('DynamicButtonText');\n});\n

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

initConfig( Object config ) : Ext.Baseprotected

Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n

Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n

Parameters

config : Object
\n

Returns

Ext.Base
this
\n

initFrame( )private

...

initRenderData( ) : Objectprivate

Initialized the renderData to be used when rendering the renderTpl. ...

Initialized the renderData to be used when rendering the renderTpl.

Returns

Object
Object with keys and values that are going to be applied to the renderTpl
\n

initRenderTpl( ) : Ext.XTemplateprivate

Initializes the renderTpl. ...

Initializes the renderTpl.

Returns

Ext.XTemplate
The renderTpl XTemplate instance.
\n

initState( )private

Initializes the state of the object upon construction. ...

Initializes the state of the object upon construction.

initStyles( Object targetEl ) : Stringprivate

Converts style definitions to String. ...

Converts style definitions to String.

Parameters

targetEl : Object
\n

Returns

String
A CSS style string with style, padding, margin and border.
\n

insert( Number index, Ext.Component component ) : Ext.Component

Inserts a Component into this Container at a specified index. ...

Inserts a Component into this Container at a specified index. Fires the\nbeforeadd event before inserting, then fires the add\nevent after the Component has been inserted.

Parameters

index : Number
The index at which the Component will be inserted\ninto the Container's items collection
\n
component : Ext.Component
The child Component to insert.
\n\n
Ext uses lazy rendering, and will only render the inserted Component should\nit become necessary.
\n\n
A Component config object may be passed in order to avoid the overhead of\nconstructing a real Component object if lazy rendering might mean that the\ninserted Component will not be rendered immediately. To take advantage of\nthis 'lazy instantiation', set the Ext.Component.xtype config\nproperty to the registered type of the Component wanted.
\n\n
For a list of all available xtypes, see Ext.Component.
\n

Returns

Ext.Component
component The Component (or config object) that was\ninserted with the Container's default config values applied.
\n

is( String selector ) : Boolean

Tests whether this Component matches the selector string. ...

Tests whether this Component matches the selector string.

Parameters

selector : String
The selector string to test against.
\n

Returns

Boolean
True if this Component matches the selector.
\n

isAncestor( Ext.Component possibleDescendant )

Determines whether this Container is an ancestor of the passed Component. ...

Determines whether this Container is an ancestor of the passed Component.\nThis will return true if the passed Component is anywhere within the subtree\nbeneath this Container.

Parameters

possibleDescendant : Ext.Component
The Component to test for presence\nwithin this Container's subtree.
\n

isDescendantOf( Ext.Container container ) : Boolean

Determines whether this component is the descendant of a particular container. ...

Determines whether this component is the descendant of a particular container.

Parameters

container : Ext.Container
\n

Returns

Boolean
True if it is.
\n

isDisabled( ) : Boolean

Method to determine whether this Component is currently disabled. ...

Method to determine whether this Component is currently disabled.

Returns

Boolean
the disabled state of this Component.
\n

isDraggable( ) : Boolean

Method to determine whether this Component is draggable. ...

Method to determine whether this Component is draggable.

Returns

Boolean
the draggable state of this component.
\n

isDroppable( ) : Boolean

Method to determine whether this Component is droppable. ...

Method to determine whether this Component is droppable.

Returns

Boolean
the droppable state of this component.
\n

isFloating( ) : Boolean

Method to determine whether this Component is floating. ...

Method to determine whether this Component is floating.

Returns

Boolean
the floating state of this component.
\n

isHidden( ) : Boolean

Method to determine whether this Component is currently set to hidden. ...

Method to determine whether this Component is currently set to hidden.

Returns

Boolean
the hidden state of this Component.
\n

isLayoutRoot( )protected

Determines whether this Component is the root of a layout. ...

Determines whether this Component is the root of a layout. This returns true if\nthis component can run its layout without assistance from or impact on its owner.\nIf this component cannot run its layout given these restrictions, false is returned\nand its owner will be considered as the next candidate for the layout root.

\n\n

Setting the _isLayoutRoot property to true causes this method to always\nreturn true. This may be useful when updating a layout of a Container which shrink\nwraps content, and you know that it will not change size, and so can safely be the\ntopmost participant in the layout run.

isLayoutSuspended( ) : Boolean

Returns true if layout is suspended for this component. ...

Returns true if layout is suspended for this component. This can come from direct\nsuspension of this component's layout activity (Ext.Container.suspendLayout) or if one\nof this component's containers is suspended.

Returns

Boolean
True layout of this component is suspended.
\n

isVisible( [Boolean deep] ) : Boolean

Returns true if this component is visible. ...

Returns true if this component is visible.

Parameters

deep : Boolean (optional)
Pass true to interrogate the visibility status of all parent Containers to\ndetermine whether this Component is truly visible to the user.
\n\n
Generally, to determine whether a Component is hidden, the no argument form is needed. For example when creating\ndynamically laid out UIs in a hidden Container before showing them.
\n
Defaults to: false

Returns

Boolean
True if this component is visible, false otherwise.
\n

isXType( String xtype, [Boolean shallow] ) : Boolean

Tests whether or not this Component is of a specific xtype. ...

Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended\nfrom the xtype (default) or whether it is directly of the xtype specified (shallow = true).

\n\n

If using your own subclasses, be aware that a Component must register its own xtype to participate in\ndetermination of inherited xtypes.

\n\n

For a list of all available xtypes, see the Ext.Component header.

\n\n

Example usage:

\n\n

var t = new Ext.form.field.Text();\nvar isText = t.isXType('textfield');        // true\nvar isBoxSubclass = t.isXType('field');       // true, descended from Ext.form.field.Base\nvar isBoxInstance = t.isXType('field', true); // false, not a direct Ext.form.field.Base instance\n

Parameters

xtype : String
The xtype to check for this Component
\n
shallow : Boolean (optional)
True to check whether this Component is directly of the specified xtype, false to\ncheck whether this Component is descended from the xtype.
\n
Defaults to: false

Returns

Boolean
True if this component descends from the specified xtype, false otherwise.
\n

mon( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope], [Object opt] )

Shorthand for addManagedListener. ...

Shorthand for addManagedListener.

\n\n

Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.

Parameters

item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n
opt : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n

move( Number fromIdx, Number toIdx ) : Ext.Component

Moves a Component within the Container ...

Moves a Component within the Container

Parameters

fromIdx : Number
The index the Component you wish to move is currently at.
\n
toIdx : Number
The new index for the Component.
\n

Returns

Ext.Component
component The Component (or config object) that was moved.
\n

mun( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope] )

Shorthand for removeManagedListener. ...

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

Parameters

item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n

nextNode( [String selector] ) : Ext.Component

Returns the next node in the Component tree in tree traversal order. ...

Returns the next node in the Component tree in tree traversal order.

\n\n

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the\ntree to attempt to find a match. Contrast with nextSibling.

Parameters

selector : String (optional)
A ComponentQuery selector to filter the following nodes.
\n

Returns

Ext.Component
The next node (or the next node which matches the selector).\nReturns null if there is no matching node.
\n

nextSibling( [String selector] ) : Ext.Component

Returns the next sibling of this Component. ...

Returns the next sibling of this Component.

\n\n

Optionally selects the next sibling which matches the passed ComponentQuery selector.

\n\n

May also be refered to as next()

\n\n

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with\nnextNode

Parameters

selector : String (optional)
A ComponentQuery selector to filter the following items.
\n

Returns

Ext.Component
The next sibling (or the next sibling which matches the selector).\nReturns null if there is no matching sibling.
\n

on( String/Object eventName, [Function fn], [Object scope], [Object options] )

Shorthand for addListener. ...

Shorthand for addListener.

\n\n

Appends an event handler to this object. For example:

\n\n

myGridPanel.on(\"mouseover\", this.onMouseOver, this);\n

\n\n

The method also allows for a single argument to be passed which is a config object\ncontaining properties which specify multiple events. For example:

\n\n

myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n

\n\n

One can also specify options for each event handler separately:

\n\n

myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n

\n\n

Names of methods in a specified scope may also be used. Note that\nscope MUST be specified to use this option:

\n\n

myGridPanel.on({\n    cellClick: {fn: 'onCellClick', scope: this, single: true},\n    mouseover: {fn: 'onMouseOver', scope: panel}\n});\n

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

onAdd( Ext.Component component, Number position )protectedtemplate

This method is invoked after a new Component has been added. ...

This method is invoked after a new Component has been added. It\nis passed the Component which has been added. This method may\nbe used to update any internal structure which may depend upon\nthe state of the child items.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

component : Ext.Component
\n
position : Number
\n

onAdded( Ext.container.Container container, Number pos )protectedtemplate

Method to manage awareness of when components are added to their\nrespective Container, firing an added event. ...

Method to manage awareness of when components are added to their\nrespective Container, firing an added event. References are\nestablished at add time rather than at render time.

\n\n

Allows addition of behavior when a Component is added to a\nContainer. At this stage, the Component is in the parent\nContainer's collection of child items. After calling the\nsuperclass's onAdded, the ownerCt reference will be present,\nand if configured with a ref, the refOwner will be set.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

container : Ext.container.Container
Container which holds the component
\n
pos : Number
Position at which the component was added
\n

onBeforeAdd( Ext.Component item )protectedtemplate

This method is invoked before adding a new child Component. ...

This method is invoked before adding a new child Component. It\nis passed the new Component, and may be used to modify the\nComponent, or prepare the Container in some way. Returning\nfalse aborts the add operation.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

item : Ext.Component
\n

onConfigUpdate( Object names, Object callback, Object scope )private

...

Parameters

names : Object
\n
callback : Object
\n
scope : Object
\n

onDestroy( )protectedtemplate

Allows addition of behavior to the destroy operation. ...

Allows addition of behavior to the destroy operation.\nAfter calling the superclass’s onDestroy, the Component will be destroyed.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

onDisable( )protectedtemplate

Allows addition of behavior to the disable operation. ...

Allows addition of behavior to the disable operation.\nAfter calling the superclass’s onDisable, the Component will be disabled.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

onEnable( )protectedtemplate

Allows addition of behavior to the enable operation. ...

Allows addition of behavior to the enable operation.\nAfter calling the superclass’s onEnable, the Component will be enabled.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

onHide( [String/Ext.Element/Ext.Component animateTarget], [Function callback], [Object scope] )protectedtemplate

Possibly animates down to a target element. ...

Possibly animates down to a target element.

\n\n

Allows addition of behavior to the hide operation. After\ncalling the superclass’s onHide, the Component will be hidden.

\n\n

Gets passed the same parameters as hide.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

animateTarget : String/Ext.Element/Ext.Component (optional)
\n
callback : Function (optional)
\n
scope : Object (optional)
\n

onPosition( Number x, Number y )protectedtemplate

Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that need...

Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

x : Number
The new x position
\n
y : Number
The new y position
\n

onRemove( Ext.Component component, Boolean autoDestroy )protectedtemplate

This method is invoked after a new Component has been\nremoved. ...

This method is invoked after a new Component has been\nremoved. It is passed the Component which has been\nremoved. This method may be used to update any internal\nstructure which may depend upon the state of the child items.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

component : Ext.Component
\n
autoDestroy : Boolean
\n

onRemoved( Boolean destroying )protectedtemplate

Method to manage awareness of when components are removed from their\nrespective Container, firing a removed event. ...

Method to manage awareness of when components are removed from their\nrespective Container, firing a removed event. References are properly\ncleaned up after removing a component from its owning container.

\n\n

Allows addition of behavior when a Component is removed from\nits parent Container. At this stage, the Component has been\nremoved from its parent Container's collection of child items,\nbut has not been destroyed (It will be destroyed if the parent\nContainer's autoDestroy is true, or if the remove call was\npassed a truthy second parameter). After calling the\nsuperclass's onRemoved, the ownerCt and the refOwner will not\nbe present.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

destroying : Boolean
Will be passed as true if the Container performing the remove operation will delete this\nComponent upon remove.
\n

onRender( Ext.core.Element parentNode, Number containerIdx )protectedtemplate

Template method called when this Component's DOM structure is created. ...

Template method called when this Component's DOM structure is created.

\n\n

At this point, this Component's (and all descendants') DOM structure exists but it has not\nbeen layed out (positioned and sized).

\n\n

Subclasses which override this to gain access to the structure at render time should\ncall the parent class's method before attempting to access any child elements of the Component.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

parentNode : Ext.core.Element
The parent Element in which this Component's encapsulating element is contained.
\n
containerIdx : Number
The index within the parent Container's child collection of this Component.
\n

onResize( )protectedtemplate

Allows addition of behavior to the resize operation. ...

Allows addition of behavior to the resize operation.

\n\n

Called when Ext.resizer.Resizer#drag event is fired.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

onShow( [String/Ext.Element animateTarget], [Function callback], [Object scope] )protectedtemplate

Allows addition of behavior to the show operation. ...

Allows addition of behavior to the show operation. After\ncalling the superclass's onShow, the Component will be visible.

\n\n

Override in subclasses where more complex behaviour is needed.

\n\n

Gets passed the same parameters as show.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

animateTarget : String/Ext.Element (optional)
\n
callback : Function (optional)
\n
scope : Object (optional)
\n

onShowComplete( [Function callback], [Object scope] )protectedtemplate

Invoked after the afterShow method is complete. ...

Invoked after the afterShow method is complete.

\n\n

Gets passed the same callback and scope parameters that afterShow received.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

callback : Function (optional)
\n
scope : Object (optional)
\n

onStateChange( )private

This method is called when any of the stateEvents are fired. ...

This method is called when any of the stateEvents are fired.

prepareClass( Function T )private

Prepares a given class for observable instances. ...

Prepares a given class for observable instances. This method is called when a\nclass derives from this class or uses this class as a mixin.

Parameters

T : Function
The class constructor to prepare.
\n

previousNode( [String selector] ) : Ext.Component

Returns the previous node in the Component tree in tree traversal order. ...

Returns the previous node in the Component tree in tree traversal order.

\n\n

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the\ntree in reverse order to attempt to find a match. Contrast with previousSibling.

Parameters

selector : String (optional)
A ComponentQuery selector to filter the preceding nodes.
\n

Returns

Ext.Component
The previous node (or the previous node which matches the selector).\nReturns null if there is no matching node.
\n

previousSibling( [String selector] ) : Ext.Component

Returns the previous sibling of this Component. ...

Returns the previous sibling of this Component.

\n\n

Optionally selects the previous sibling which matches the passed ComponentQuery\nselector.

\n\n

May also be refered to as prev()

\n\n

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with\npreviousNode

Parameters

selector : String (optional)
A ComponentQuery selector to filter the preceding items.
\n

Returns

Ext.Component
The previous sibling (or the previous sibling which matches the selector).\nReturns null if there is no matching sibling.
\n

query( [String selector] ) : Ext.Component[]

Retrieves all descendant components which match the passed selector. ...

Retrieves all descendant components which match the passed selector.\nExecutes an Ext.ComponentQuery.query using this container as its root.

Parameters

selector : String (optional)
Selector complying to an Ext.ComponentQuery selector.\nIf no selector is specified all items will be returned.
\n

Returns

Ext.Component[]
Components which matched the selector
\n

queryBy( Function fn, [Object scope] ) : Ext.Component[]

Retrieves all descendant components which match the passed function. ...

Retrieves all descendant components which match the passed function.\nThe function should return false for components that are to be\nexcluded from the selection.

Parameters

fn : Function
The matcher function. It will be called with a single argument,\nthe component being tested.
\n
scope : Object (optional)
The scope in which to run the function. If not specified,\nit will default to the active component.
\n

Returns

Ext.Component[]
Components matched by the passed function
\n

queryById( String id ) : Ext.Component

Finds a component at any level under this container matching the id/itemId. ...

Finds a component at any level under this container matching the id/itemId.\nThis is a shorthand for calling ct.down('#' + id);

Parameters

id : String
The id to find
\n

Returns

Ext.Component
The matching id, null if not found
\n

registerFloatingItem( Object cmp )

Called by Component#doAutoRender\n\nRegister a Container configured floating: true with this Component's ZIndexManager. ...

Called by Component#doAutoRender

\n\n

Components added in ths way will not participate in any layout, but will be rendered\nupon first show in the way that Windows are.

Parameters

cmp : Object
\n

relayEvents( Object origin, String[] events, [String prefix] )

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.

\n\n

For example if you are extending Grid, you might decide to forward some events from store.\nSo you can do this inside your initComponent:

\n\n

this.relayEvents(this.getStore(), ['load']);\n

\n\n

The grid instance will then have an observable 'load' event which will be passed the\nparameters of the store's load event and any function fired with the grid's load event\nwould have access to the grid using the this keyword.

Parameters

origin : Object
The Observable whose events this object is to relay.
\n
events : String[]
Array of event names to relay.
\n
prefix : String (optional)
A common prefix to prepend to the event names. For example:
\n\n
```
this.relayEvents(this.getStore(), ['load', 'clear'], 'store');\n
```
\n\n
Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.
\n

remove( Ext.Component/String component, [Boolean autoDestroy] ) : Ext.Component

Removes a component from this container. ...

Removes a component from this container. Fires the beforeremove event\nbefore removing, then fires the remove event after the component has\nbeen removed.

Parameters

component : Ext.Component/String
The component reference or id to remove.
\n
autoDestroy : Boolean (optional)
True to automatically invoke the removed Component's\nExt.Component.destroy function.
\n\n
Defaults to the value of this Container's autoDestroy config.
\n

Returns

Ext.Component
component The Component that was removed.
\n

Ext.util.ElementContainer
view source

removeAll( [Boolean autoDestroy] ) : Ext.Component[]

Removes all components from this container. ...

Removes all components from this container.

Parameters

autoDestroy : Boolean (optional)
True to automatically invoke the removed\nComponent's Ext.Component.destroy function.\nDefaults to the value of this Container's autoDestroy config.
\n

Returns

Ext.Component[]
Array of the removed components
\n

removeChildEls( Function testFn )

Removes items in the childEls array based on the return value of a supplied test\nfunction. ...

Removes items in the childEls array based on the return value of a supplied test\nfunction. The function is called with a entry in childEls and if the test function\nreturn true, that entry is removed. If false, that entry is kept.

Parameters

testFn : Function
The test function.
\n

removeCls( String/String[] cls ) : Ext.Component

Removes a CSS class from the top level element representing this component. ...

Removes a CSS class from the top level element representing this component.

Parameters

cls : String/String[]
The CSS class name to remove
\n

Returns

Ext.Component
Returns the Component to allow method chaining.
\n

removeClsWithUI( String/String[] cls )

Removes a cls to the uiCls array, which will also call removeUIClsFromElement and removes it from all\nelements of thi...

Removes a cls to the uiCls array, which will also call removeUIClsFromElement and removes it from all\nelements of this component.

Parameters

cls : String/String[]
A string or an array of strings to remove to the uiCls
\n

removeListener( String eventName, Function fn, [Object scope] )

Removes an event handler. ...

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n\n
fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\n

removeManagedListener( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope] )

Removes listeners that were added by the mon method. ...

Removes listeners that were added by the mon method.

Parameters

item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n

removeManagedListenerItem( Boolean isClear, Object managedListener )private

Remove a single managed listener item ...

Remove a single managed listener item

Parameters

isClear : Boolean
True if this is being called during a clear
\n
managedListener : Object
The managed listener item\nSee removeManagedListener for other args
\n

removeUIClsFromElement( String ui )

Method which removes a specified UI + uiCls from the components element. ...

Method which removes a specified UI + uiCls from the components element. The cls which is added to the element\nwill be: this.baseCls + '-' + ui

Parameters

ui : String
The UI to add to the element
\n

removeUIFromElement( )private

Method which removes a specified UI from the components element. ...

Method which removes a specified UI from the components element.

render( [Ext.Element/HTMLElement/String container], [String/Number position] )

Renders the Component into the passed HTML element. ...

Renders the Component into the passed HTML element.

\n\n

If you are using a Container object to house this\nComponent, then do not use the render method.

\n\n

A Container's child Components are rendered by that Container's\nlayout manager when the Container is first rendered.

\n\n

If the Container is already rendered when a new child Component is added, you may need to call\nthe Container's doLayout to refresh the view which\ncauses any unrendered child Components to be rendered. This is required so that you can add\nmultiple child components if needed while only refreshing the layout once.

\n\n

When creating complex UIs, it is important to remember that sizing and positioning\nof child items is the responsibility of the Container's layout\nmanager. If you expect child items to be sized in response to user interactions, you must\nconfigure the Container with a layout manager which creates and manages the type of layout you\nhave in mind.

\n\n

Omitting the Container's layout config means that a basic\nlayout manager is used which does nothing but render child components sequentially into the\nContainer. No sizing or positioning will be performed in this situation.

Parameters

container : Ext.Element/HTMLElement/String (optional)
The element this Component should be\nrendered into. If it is being created from existing markup, this should be omitted.
\n
position : String/Number (optional)
The element ID or DOM node index within the container before\nwhich this component will be inserted (defaults to appending to the end of the container)
\n

resumeEvents( )

Resumes firing events (see suspendEvents). ...

Resumes firing events (see suspendEvents).

\n\n

If events were suspended using the queueSuspended parameter, then all events fired\nduring event suspension will be sent to any listeners now.

savePropToState( String propName, Object state, [String stateName] ) : Boolean

Conditionally saves a single property from this object to the given state object. ...

Conditionally saves a single property from this object to the given state object.\nThe idea is to only save state which has changed from the initial state so that\ncurrent software settings do not override future software settings. Only those\nvalues that are user-changed state should be saved.

Parameters

propName : String
The name of the property to save.
\n
state : Object
The state object in to which to save the property.
\n
stateName : String (optional)
The name to use for the property in state.
\n

Returns

Boolean
True if the property was saved, false if not.
\n

savePropsToState( String/String[] propNames, Object state ) : Object

Gathers additional named properties of the instance and adds their current values\nto the passed state object. ...

Gathers additional named properties of the instance and adds their current values\nto the passed state object.

Parameters

propNames : String/String[]
The name (or array of names) of the property to save.
\n
state : Object
The state object in to which to save the property values.
\n

Returns

Object
state
\n

saveState( )

Saves the state of the object to the persistence store. ...

Saves the state of the object to the persistence store.

scrollBy( Number/Number[]/Object deltaX, Number/Boolean/Object deltaY, Boolean/Object animate )

Scrolls this Component's target element by the passed delta values, optionally animating. ...

Scrolls this Component's target element by the passed delta values, optionally animating.

\n\n

All of the following are equivalent:

\n\n

 comp.scrollBy(10, 10, true);\n comp.scrollBy([10, 10], true);\n comp.scrollBy({ x: 10, y: 10 }, true);\n

Parameters

deltaX : Number/Number[]/Object
Either the x delta, an Array specifying x and y deltas or\nan object with \"x\" and \"y\" properties.
\n
deltaY : Number/Boolean/Object
Either the y delta, or an animate flag or config object.
\n
animate : Boolean/Object
Animate flag/config object if the delta values were passed separately.
\n

sequenceFx( ) : Object

Ensures that all effects queued after sequenceFx is called on this object are run in sequence. ...

Ensures that all effects queued after sequenceFx is called on this object are run in sequence. This is the\nopposite of syncFx.

Returns

Object
this
\n

setActive( [Boolean active], [Ext.Component newActive] )

This method is called internally by Ext.ZIndexManager to signal that a floating Component has either been\nmoved to th...

This method is called internally by Ext.ZIndexManager to signal that a floating Component has either been\nmoved to the top of its zIndex stack, or pushed from the top of its zIndex stack.

\n\n

If a Window is superceded by another Window, deactivating it hides its shadow.

\n\n

This method also fires the activate or\ndeactivate event depending on which action occurred.

Parameters

active : Boolean (optional)
True to activate the Component, false to deactivate it.
\n
Defaults to: false
newActive : Ext.Component (optional)
The newly active Component which is taking over topmost zIndex position.
\n

setAutoScroll( Boolean scroll ) : Ext.Component

Sets the overflow on the content element of the component. ...

Sets the overflow on the content element of the component.

Parameters

scroll : Boolean
True to allow the Component to auto scroll.
\n

Returns

Ext.Component
this
\n

setBorder( String/Number border )

...

Parameters

border : String/Number
The border, see border. If a falsey value is passed\nthe border will be removed.
\n

setConfig( Object config, Object applyIfNotSet )private

...

Parameters

config : Object
\n
applyIfNotSet : Object
\n

setDisabled( Boolean disabled )

Enable or disable the component. ...

Enable or disable the component.

Parameters

disabled : Boolean
True to disable.
\n

setDocked( Object dock, [Boolean layoutParent] ) : Ext.Component

Sets the dock position of this component in its parent panel. ...

Sets the dock position of this component in its parent panel. Note that this only has effect if this item is part\nof the dockedItems collection of a parent that has a DockLayout (note that any Panel has a DockLayout by default)

Parameters

dock : Object
The dock position.
\n
layoutParent : Boolean (optional)
True to re-layout parent.
\n
Defaults to: false

Returns

Ext.Component
this
\n

setHeight( Number height ) : Ext.Component

Sets the height of the component. ...

Sets the height of the component. This method fires the resize event.

Parameters

height : Number
The new height to set. This may be one of:
\n\n
- 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.
- undefined to leave the height unchanged.
\n\n

Returns

Ext.Component
this
\n

setLoading( Boolean/Object/String load, [Boolean targetEl] ) : Ext.LoadMask

This method allows you to show or hide a LoadMask on top of this component. ...

This method allows you to show or hide a LoadMask on top of this component.

Parameters

load : Boolean/Object/String
True to show the default LoadMask, a config object that will be passed to the\nLoadMask constructor, or a message String to show. False to hide the current LoadMask.
\n
targetEl : Boolean (optional)
True to mask the targetEl of this Component instead of the this.el. For example,\nsetting this to true on a Panel will cause only the body to be masked.
\n
Defaults to: false

Returns

Ext.LoadMask
The LoadMask instance that has just been shown.
\n

setOverflowXY( String overflowX, String overflowY ) : Ext.Component

Sets the overflow x/y on the content element of the component. ...

Sets the overflow x/y on the content element of the component. The x/y overflow\nvalues can be any valid CSS overflow (e.g., 'auto' or 'scroll'). By default, the\nvalue is 'hidden'. Passing null for one of the values will erase the inline style.\nPassing undefined will preserve the current value.

Parameters

overflowX : String
The overflow-x value.
\n
overflowY : String
The overflow-y value.
\n

Returns

Ext.Component
this
\n

setPagePosition( Number x, Number y, [Boolean/Object animate] ) : Ext.Component

Sets the page XY position of the component. ...

Sets the page XY position of the component. To set the left and top instead, use setPosition.\nThis method fires the move event.

Parameters

x : Number
The new x position
\n
y : Number
The new y position
\n
animate : Boolean/Object (optional)
True to animate the Component into its new position. You may also pass an\nanimation configuration.
\n

Returns

Ext.Component
this
\n

setPosition( Number left, Number top, [Boolean/Object animate] ) : Ext.Component

Sets the left and top of the component. ...

Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This\nmethod fires the move event.

Parameters

left : Number
The new left
\n
top : Number
The new top
\n
animate : Boolean/Object (optional)
If true, the Component is animated into its new position. You may also pass an\nanimation configuration.
\n

Returns

Ext.Component
this
\n

setSize( Number/String/Object width, Number/String height ) : Ext.Component

Sets the width and height of this Component. ...

Sets the width and height of this Component. This method fires the resize event. This method can accept\neither width and height as separate arguments, or you can pass a size object like {width:10, height:20}.

Parameters

width : Number/String/Object
The new width to set. This may be one of:
\n\n
- 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.
\n\n
height : Number/String
The new height to set (not required if a size object is passed as the first arg).\nThis may be one of:
\n\n
- 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.
\n\n

Returns

Ext.Component
this
\n

setUI( String ui )

Sets the UI for the component. ...

Sets the UI for the component. This will remove any existing UIs on the component. It will also loop through any\nuiCls set on the component and rename them so they include the new UI

Parameters

ui : String
The new UI for the component
\n

setVisible( Boolean visible ) : Ext.Component

Convenience function to hide or show this component by boolean. ...

Convenience function to hide or show this component by boolean.

Parameters

visible : Boolean
True to show, false to hide
\n

Returns

Ext.Component
this
\n

setWidth( Number width ) : Ext.Component

Sets the width of the component. ...

Sets the width of the component. This method fires the resize event.

Parameters

width : Number
The new width to setThis may be one of:
\n\n
- 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.
\n\n

Returns

Ext.Component
this
\n

setupFramingTpl( Object frameTpl )private

Inject a reference to the function which applies the render template into the framing template. ...

Inject a reference to the function which applies the render template into the framing template. The framing template\nwraps the content.

Parameters

frameTpl : Object
\n

show( [String/Ext.Element animateTarget], [Function callback], [Object scope] ) : Ext.Component

Shows this Component, rendering it first if autoRender or floating are true. ...

Shows this Component, rendering it first if autoRender or floating are true.

\n\n

After being shown, a floating Component (such as a Ext.window.Window), is activated it and\nbrought to the front of its z-index stack.

Parameters

animateTarget : String/Ext.Element (optional)
only valid for floating Components such as Windows or ToolTips, or regular Components which have been configured\nwith floating: true. The target from which the Component should animate from while opening.
\n
Defaults to: null
callback : Function (optional)
A callback function to call after the Component is displayed.\nOnly necessary if animation was specified.
\n
scope : Object (optional)
The scope (this reference) in which the callback is executed.\nDefaults to this Component.
\n

Returns

Ext.Component
this
\n

showAt( Number x, Number y, [Boolean/Object animate] )

Displays component at specific xy position. ...

Displays component at specific xy position.\nA floating component (like a menu) is positioned relative to its ownerCt if any.\nUseful for popping up a context menu:

\n\n

listeners: {\n    itemcontextmenu: function(view, record, item, index, event, options) {\n        Ext.create('Ext.menu.Menu', {\n            width: 100,\n            height: 100,\n            margin: '0 0 10 0',\n            items: [{\n                text: 'regular item 1'\n            },{\n                text: 'regular item 2'\n            },{\n                text: 'regular item 3'\n            }]\n        }).showAt(event.getXY());\n    }\n}\n

Parameters

x : Number
The new x position
\n
y : Number
The new y position
\n
animate : Boolean/Object (optional)
True to animate the Component into its new position. You may also pass an\nanimation configuration.
\n

statics( ) : Ext.Classprotected

Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n

Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n

Returns

Ext.Class
\n

stopAnimation( ) : Ext.Element

Stops any running effects and clears this object's internal effects queue if it contains any additional effects\nthat ...

Stops any running effects and clears this object's internal effects queue if it contains any additional effects\nthat haven't started yet.

Returns

Ext.Element
The Element
\n

stopFx( ) : Ext.Elementdeprecated

Stops any running effects and clears this object's internal effects queue if it contains any additional effects\nthat ...

Stops any running effects and clears this object's internal effects queue if it contains any additional effects\nthat haven't started yet.

This method has been deprecated since 4.0

Replaced by stopAnimation

\n\n

Returns

Ext.Element
The Element
\n

suspendEvents( Boolean queueSuspended )

Suspends the firing of all events. ...

Suspends the firing of all events. (see resumeEvents)

Parameters

queueSuspended : Boolean
Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\n

syncFx( ) : Object

Ensures that all effects queued after syncFx is called on this object are run concurrently. ...

Ensures that all effects queued after syncFx is called on this object are run concurrently. This is the opposite\nof sequenceFx.

Returns

Object
this
\n

toBack( ) : Ext.Component

Sends this Component to the back of (lower z-index than) any other visible windows ...

Sends this Component to the back of (lower z-index than) any other visible windows

Returns

Ext.Component
this
\n

toFront( [Boolean preventFocus] ) : Ext.Component

Brings this floating Component to the front of any other visible, floating Components managed by the same\nZIndexManag...

Brings this floating Component to the front of any other visible, floating Components managed by the same\nZIndexManager

\n\n

If this Component is modal, inserts the modal mask just below this Component in the z-index stack.

Parameters

preventFocus : Boolean (optional)
Specify true to prevent the Component from being focused.
\n
Defaults to: false

Returns

Ext.Component
this
\n

un( String eventName, Function fn, [Object scope] )

Shorthand for removeListener. ...

Shorthand for removeListener.

\n\n

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n\n
fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\n

up( [String selector] ) : Ext.container.Container

Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector. ...

Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector.

\n\n

Example:

\n\n

var owningTabPanel = grid.up('tabpanel');\n

Parameters

selector : String (optional)
The simple selector to test.
\n

Returns

Ext.container.Container
The matching ancestor Container (or undefined if no match was found).
\n

update( String/Object htmlOrData, [Boolean loadScripts], [Function callback] )

Update the content area of a component. ...

Update the content area of a component.

Parameters

htmlOrData : String/Object
If this component has been configured with a template via the tpl config then\nit will use this argument as data to populate the template. If this component was not configured with a template,\nthe components content area will be updated via Ext.Element update
\n
loadScripts : Boolean (optional)
Only legitimate when using the html configuration.
\n
Defaults to: false
callback : Function (optional)
Only legitimate when using the html configuration. Callback to execute when\nscripts have finished loading
\n

updateAria( )private

Injected as an override by Ext.Aria.initialize ...

Injected as an override by Ext.Aria.initialize

updateBox( Object box ) : Ext.Component

Sets the current box measurements of the component's underlying element. ...

Sets the current box measurements of the component's underlying element.

Parameters

box : Object
An object in the format {x, y, width, height}
\n

Returns

Ext.Component
this
\n

updateLayout( Object options )

Updates this component's layout. ...

Updates this component's layout. If this update effects this components ownerCt,\nthat component's updateLayout method will be called to perform the layout instead.\nOtherwise, just this component (and its child items) will layout.

Parameters

options : Object
An object with layout options.
\n
- defer : Boolean
  True if this layout should be deferred.
  \n
- isRoot : Boolean
  True if this layout should be the root of the layout.
  \n

Defined By

Static Methods

addConfig( Object config )privatestatic

...

Parameters

config : Object
\n

addInheritableStatics( Object members )privatestatic

...

Parameters

members : Object
\n

addMember( Object name, Object member )privatestatic

...

Parameters

name : Object
\n
member : Object
\n

addMembers( Object members )static

Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

\n\n

Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.addMembers({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n

Parameters

members : Object
\n

addStatics( Object members ) : Ext.Basestatic

Add / override static properties of this class. ...

Add / override static properties of this class.

\n\n

Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n

Parameters

members : Object
\n

Returns

Ext.Base
this
\n

addXtype( Object xtype )privatestatic

...

Parameters

xtype : Object
\n

borrow( Ext.Base fromClass, Array/String members ) : Ext.Baseprivatestatic

Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

\n\n

Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n

Parameters

fromClass : Ext.Base
The class to borrow members from
\n
members : Array/String
The names of the members to borrow
\n

Returns

Ext.Base
this
\n

create( ) : Objectstatic

Create a new instance of this Class. ...

Create a new instance of this Class.

\n\n

Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n

\n\n

All parameters are passed to the constructor of the class.

Returns

Object
the created instance.
\n

createAlias( String/Object alias, String/Object origin )static

Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

\n\n

Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n

Parameters

alias : String/Object
The new method name, or an object to set multiple aliases. See\nflexSetter
\n
origin : String/Object
The original method name
\n

extend( Object config )privatestatic

...

Parameters

config : Object
\n

getName( ) : Stringstatic

Get the current class' name in string format. ...

Get the current class' name in string format.

\n\n

Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n

Returns

String
className
\n

implement( )deprecatedstatic

Adds members to class. ...

Adds members to class.

This method has been deprecated since 4.1

Use addMembers instead.

\n\n

mixin( Object name, Object mixinClass )privatestatic

Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

name : Object
\n
mixinClass : Object
\n

onExtended( Object fn, Object scope )privatestatic

...

Parameters

fn : Object
\n
scope : Object
\n

override( Object members ) : Ext.Basedeprecatedstatic

Override members of this class. ...

Override members of this class. Overridden methods can be invoked via\ncallParent.

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

\n\n

As of 4.1, direct use of this method is deprecated. Use Ext.define\ninstead:

\n\n

Ext.define('My.CatOverride', {\n    override: 'My.Cat',\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n

\n\n

The above accomplishes the same result but can be managed by the Ext.Loader\nwhich can properly order the override and its target class and the build process\ncan determine whether the override is needed based on the required state of the\ntarget class (My.Cat).

This method has been deprecated since 4.1.0

Use Ext.define instead

\n\n

Parameters

members : Object
The properties to add to this class. This should be\nspecified as an object literal containing one or more properties.
\n

Returns

Ext.Base
this class
\n

triggerExtended( )privatestatic

...

Defined By

Events

activate( Ext.Component this, Object eOpts )

Fires after a Component has been visually activated. ...

Fires after a Component has been visually activated.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

add( Ext.container.Container this, Ext.Component component, Number index, Object eOpts )

Fires after any Ext.Component is added or inserted into the container. ...

Fires after any Ext.Component is added or inserted into the container.

\n\n

This event bubbles: 'add' will also be fired when Component is added to any of\nthe child containers or their childern or ...

Parameters

this : Ext.container.Container
\n
component : Ext.Component
The component that was added
\n
index : Number
The index at which the component was added to the container's items collection
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

added( Ext.Component this, Ext.container.Container container, Number pos, Object eOpts )

Fires after a Component had been added to a Container. ...

Fires after a Component had been added to a Container.

Parameters

this : Ext.Component
\n
container : Ext.container.Container
Parent Container
\n
pos : Number
position of Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

afterlayout( Ext.container.Container this, Ext.layout.container.Container layout, Object eOpts )

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.

Parameters

this : Ext.container.Container
\n
layout : Ext.layout.container.Container
The ContainerLayout implementation for this container
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

afterrender( Ext.Component this, Object eOpts )

Fires after the component rendering is finished. ...

Fires after the component rendering is finished.

\n\n

The afterrender event is fired after this Component has been rendered, been postprocesed by any\nafterRender method defined for the Component.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforeactivate( Ext.Component this, Object eOpts )

Fires before a Component has been visually activated. ...

Fires before a Component has been visually activated. Returning false from an event listener can prevent\nthe activate from occurring.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforeadd( Ext.container.Container this, Ext.Component component, Number index, Object eOpts )

Fires before any Ext.Component is added or inserted into the container. ...

Fires before any Ext.Component is added or inserted into the container.\nA handler can return false to cancel the add.

Parameters

this : Ext.container.Container
\n
component : Ext.Component
The component being added
\n
index : Number
The index at which the component will be added to the container's items collection
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforedeactivate( Ext.Component this, Object eOpts )

Fires before a Component has been visually deactivated. ...

Fires before a Component has been visually deactivated. Returning false from an event listener can\nprevent the deactivate from occurring.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforedestroy( Ext.Component this, Object eOpts )

Fires before the component is destroyed. ...

Fires before the component is destroyed. Return false from an event handler to stop the\ndestroy.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforehide( Ext.Component this, Object eOpts )

Fires before the component is hidden when calling the hide method. ...

Fires before the component is hidden when calling the hide method. Return false from an event\nhandler to stop the hide.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforeremove( Ext.container.Container this, Ext.Component component, Object eOpts )

Fires before any Ext.Component is removed from the container. ...

Fires before any Ext.Component is removed from the container. A handler can return\nfalse to cancel the remove.

Parameters

this : Ext.container.Container
\n
component : Ext.Component
The component being removed
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforerender( Ext.Component this, Object eOpts )

Fires before the component is rendered. ...

Fires before the component is rendered. Return false from an event handler to stop the\nrender.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforeshow( Ext.Component this, Object eOpts )

Fires before the component is shown when calling the show method. ...

Fires before the component is shown when calling the show method. Return false from an event\nhandler to stop the show.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforestaterestore( Ext.state.Stateful this, Object state, Object eOpts )

Fires before the state of the object is restored. ...

Fires before the state of the object is restored. Return false from an event handler to stop the restore.

Parameters

this : Ext.state.Stateful
\n
state : Object
The hash of state values returned from the StateProvider. If this\nevent is not vetoed, then the state object is passed to applyState. By default,\nthat simply copies property values into this object. The method maybe overriden to\nprovide custom state restoration.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforestatesave( Ext.state.Stateful this, Object state, Object eOpts )

Fires before the state of the object is saved to the configured state provider. ...

Fires before the state of the object is saved to the configured state provider. Return false to stop the save.

Parameters

this : Ext.state.Stateful
\n
state : Object
The hash of state values. This is determined by calling\ngetState() on the object. This method must be provided by the\ndeveloper to return whetever representation of state is required, by default, Ext.state.Stateful\nhas a null implementation.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

blur( Ext.Component this, Ext.EventObject The, Object eOpts )

Fires when this Component loses focus. ...

Fires when this Component loses focus.

Parameters

this : Ext.Component
\n
The : Ext.EventObject
blur event.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

boxready( Ext.Component this, Number width, Number height, Object eOpts )

Fires one time - after the component has been layed out for the first time at its initial size. ...

Fires one time - after the component has been layed out for the first time at its initial size.

Parameters

this : Ext.Component
\n
width : Number
The initial width
\n
height : Number
The initial height
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

deactivate( Ext.Component this, Object eOpts )

Fires after a Component has been visually deactivated. ...

Fires after a Component has been visually deactivated.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

destroy( Ext.Component this, Object eOpts )

Fires after the component is destroyed. ...

Fires after the component is destroyed.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

disable( Ext.Component this, Object eOpts )

Fires after the component is disabled. ...

Fires after the component is disabled.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

enable( Ext.Component this, Object eOpts )

Fires after the component is enabled. ...

Fires after the component is enabled.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

focus( Ext.Component this, Ext.EventObject The, Object eOpts )

Fires when this Component receives focus. ...

Fires when this Component receives focus.

Parameters

this : Ext.Component
\n
The : Ext.EventObject
focus event.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

hide( Ext.Component this, Object eOpts )

Fires after the component is hidden. ...

Fires after the component is hidden. Fires after the component is hidden when calling the hide\nmethod.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

move( Ext.Component this, Number x, Number y, Object eOpts )

Fires after the component is moved. ...

Fires after the component is moved.

Parameters

this : Ext.Component
\n
x : Number
The new x position
\n
y : Number
The new y position
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

remove( Ext.container.Container this, Ext.Component component, Object eOpts )

Fires after any Ext.Component is removed from the container. ...

Fires after any Ext.Component is removed from the container.

\n\n

This event bubbles: 'remove' will also be fired when Component is removed from any of\nthe child containers or their children or ...

Parameters

this : Ext.container.Container
\n
component : Ext.Component
The component that was removed
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

removed( Ext.Component this, Ext.container.Container ownerCt, Object eOpts )

Fires when a component is removed from an Ext.container.Container ...

Fires when a component is removed from an Ext.container.Container

Parameters

this : Ext.Component
\n
ownerCt : Ext.container.Container
Container which holds the component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

render( Ext.Component this, Object eOpts )

Fires after the component markup is rendered. ...

Fires after the component markup is rendered.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

resize( Ext.Component this, Number width, Number height, Number oldWidth, Number oldHeight, Object eOpts )

Fires after the component is resized. ...

Fires after the component is resized. Note that this does not fire when the component is first layed out at its initial\nsize. To hook that point in the lifecycle, use the boxready event.

Parameters

this : Ext.Component
\n
width : Number
The new width that was set
\n
height : Number
The new height that was set
\n
oldWidth : Number
The previous width
\n
oldHeight : Number
The previous height
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

show( Ext.Component this, Object eOpts )

Fires after the component is shown when calling the show method. ...

Fires after the component is shown when calling the show method.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

staterestore( Ext.state.Stateful this, Object state, Object eOpts )

Fires after the state of the object is restored. ...

Fires after the state of the object is restored.

Parameters

this : Ext.state.Stateful
\n
state : Object
The hash of state values returned from the StateProvider. This is passed\nto applyState. By default, that simply copies property values into this\nobject. The method maybe overriden to provide custom state restoration.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n