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

Available since: 2.3.0

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 omitted 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

Available since: 2.3.0

Ext.ProgressBar
view source

baseCls : String

The base CSS class to apply to the progress bar's wrapper element. ...

The base CSS class to apply to the progress bar's wrapper element.

Defaults to: 'x-progress'

Overrides: Ext.AbstractComponent.baseCls

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' (top, right, bottom, left).

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

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: ''

Available since: 1.1.0

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.

Ext.ProgressBar
view source

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.

Defaults to: 'progressbar'

Overrides: Ext.AbstractComponent.componentLayout

constrain : Boolean

True to constrain this Components within its containing element, false to allow it to fall outside of its containing\n...

True to constrain this Components within its containing element, false to allow it to fall outside of its containing\nelement. By default this Component will be rendered to document.body. To render and constrain this Component within\nanother element specify renderTo.

Defaults to: false

constrainTo : Ext.util.Region/Ext.Element

A Region (or an element from which a Region measurement will be read) which is used\nto constrain the component. ...

A Region (or an element from which a Region measurement will be read) which is used\nto constrain the component. Only applies when the component is floating.

constraintInsets : Object/String

An object or a string (in TRBL order) specifying insets from the configured constrain region\nwithin which this compon...

An object or a string (in TRBL order) specifying insets from the configured constrain region\nwithin which this component must be constrained when positioning or sizing.\nexample:

\n\n

constraintInsets: '10 10 10 10' // Constrain with 10px insets from parent

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.

Available since: 3.4.0

data : Object

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

Available since: 3.4.0

defaultAlign : String

The default Ext.Element#getAlignToXY anchor position value for this menu\nrelative to its element of origin. ...

The default Ext.Element#getAlignToXY anchor position value for this menu\nrelative to its element of origin. Used in conjunction with showBy.

Defaults to: "tl-bl?"

disabled : Boolean

true to disable the component. ...

true to disable the component.

Defaults to: false

Available since: 2.3.0

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'

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

fixed : Boolean

Configure as true to have this Component fixed at its X, Y coordinates in the browser viewport, immune\nto scrolling t...

Configure as true to have this Component fixed at its X, Y coordinates in the browser viewport, immune\nto scrolling the document.

\n\n

Only in browsers that support position:fixed

\n\n

IE6 and IE7, 8 and 9 quirks do not support position: fixed

Defaults to: false

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.

height : Number

The height of this component in pixels.

hidden : Boolean

true to hide the component. ...

true to hide the component.

Defaults to: false

Available since: 2.3.0

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'

Available since: 1.1.0

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: ''

Available since: 3.4.0

Ext.ProgressBar
view source

id : String

The progress bar element's id (defaults to an auto-generated id)

Overrides: Ext.AbstractComponent.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.

Available since: 3.4.0

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' (top, right, bottom, left).

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: ''

Available since: 2.3.0

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' (top, right, bottom, left).

plugins : Ext.AbstractPlugin[]/Ext.AbstractPlugin/Object[]/Object/Ext.enums.Plugin[]/Ext.enums.Plugin

An array of plugins to be added to this component. ...

An array of plugins to be added to this component. Can also be just a single plugin instead of array.

\n\n

Plugins provide custom functionality for a 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.

\n\n

Plugins can be added to component by either directly referencing the plugin instance:

\n\n

plugins: [Ext.create('Ext.grid.plugin.CellEditing', {clicksToEdit: 1})],\n

\n\n

By using config object with ptype:

\n\n

plugins: [{ptype: 'cellediting', clicksToEdit: 1}],\n

\n\n

Or with just a ptype:

\n\n

plugins: ['cellediting', 'gridviewdragdrop'],\n

\n\n

See Ext.enums.Plugin for list of all ptypes.

Available since: 2.3.0

region : \"north\"/\"south\"/\"east\"/\"west\"/\"center\"

Defines the region inside border layout. ...

Defines the region inside border layout.

\n\n

Possible values:

\n\n

north - Positions component at top.
south - Positions component at bottom.
east - Positions component at right.
west - Positions component at left.
center - Positions component at the remaining space.\nThere must be a component with region: \"center\" in every border layout.

\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 renders 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.

renderTo : String/HTMLElement/Ext.Element

Specify the id of the element, a DOM element or an existing Element that this component will be rendered into. ...

Specify the id of the element, a DOM element or an existing Element that this component will be rendered into.

\n\n

Notes:

\n\n

Do not use this option if the Component is to be a child item of a Container.\nIt is the responsibility of the Container's\nlayout manager to render and manage its child items.

\n\n

When using this config, a call to render() is not required.

\n\n

Properties

Defined By

Instance Properties

$className : Stringprivate

...

Defaults to: 'Ext.Base'

_alignRe : RegExpprivate

...

Defaults to: /^([a-z]+)-([a-z]+)(\\?)?$/

_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

_positionTopLeft : Arrayprivate

...

Defaults to: ['position', 'top', 'left']

allowDomMove : Booleanprivate

...

Defaults to: true

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

borderBoxCls : Stringprivate

private ...

private

Defaults to: Ext.baseCSSPrefix + 'border-box'

bubbleEvents : Arrayprivate

...

Defaults to: []

Ext.ProgressBar
view source

childEls : Arrayprivate

...

Defaults to: ['bar']

Overrides: Ext.util.ElementContainer.childEls

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: {}

contentPaddingProperty : String

The name of the padding property that is used by the layout to manage\npadding. ...

The name of the padding property that is used by the layout to manage\npadding. See managePadding

Defaults to: 'padding'

convertPositionSpec : Objectprivate

By default this method does nothing but return the position spec passed to it. ...

By default this method does nothing but return the position spec passed to it. In\nrtl mode it is overridden to convert \"l\" to \"r\" and vice versa when required.

defaultComponentLayoutType : Stringprivate

...

Defaults to: 'autocomponent'

deferLayouts : Booleanprivate

...

Defaults to: false

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

There are other similar relationships such as the button which activates a menu, or the\nmenu item which activated a submenu, or the\ncolumn header which activated the column menu.

\n\n

These differences are abstracted away by the up method.

\n\n

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

\n\n

See floating and zIndexManager

frameCls : Stringprivate

...

Defaults to: Ext.baseCSSPrefix + 'frame'

frameElNames : Arrayprivate

...

Defaults to: ['TL', 'TC', 'TR', 'ML', 'MC', 'MR', 'BL', 'BC', 'BR']

frameElementsArray : Arrayprivate

...

Defaults to: ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br']

frameIdRegex : RegExpprivate

...

Defaults to: /[\\-]frame\\d+[TMB][LCR]$/

frameInfoCache : Objectprivate

Cache the frame information object so as not to cause style recalculations ...

Cache the frame information object so as not to cause style recalculations

Defaults to: {}

frameSize : Objectreadonly

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

Indicates the width of any framing elements which were added within the encapsulating\nelement to provide graphical, rounded borders. See the frame config. This\nproperty is null if the component is not framed.

\n\n

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

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

frameTableTpl : Objectprivate

frameTpl : Arrayprivate

...

Defaults to: ['{%this.renderDockedItems(out,values,0);%}', '<tpl if="top">', '<tpl if="left"><div id="{fgid}TL" class="{frameCls}-tl {baseCls}-tl {baseCls}-{ui}-tl<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tl</tpl>{frameElCls}" role="presentation"></tpl>', '<tpl if="right"><div id="{fgid}TR" class="{frameCls}-tr {baseCls}-tr {baseCls}-{ui}-tr<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tr</tpl>{frameElCls}" role="presentation"></tpl>', '<div id="{fgid}TC" class="{frameCls}-tc {baseCls}-tc {baseCls}-{ui}-tc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tc</tpl>{frameElCls}" role="presentation"></div>', '<tpl if="right"></div></tpl>', '<tpl if="left"></div></tpl>', '</tpl>', '<tpl if="left"><div id="{fgid}ML" class="{frameCls}-ml {baseCls}-ml {baseCls}-{ui}-ml<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-ml</tpl>{frameElCls}" role="presentation"></tpl>', '<tpl if="right"><div id="{fgid}MR" class="{frameCls}-mr {baseCls}-mr {baseCls}-{ui}-mr<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mr</tpl>{frameElCls}" role="presentation"></tpl>', '<div id="{fgid}MC" class="{frameCls}-mc {baseCls}-mc {baseCls}-{ui}-mc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mc</tpl>{frameElCls}" role="presentation">', '{%this.applyRenderTpl(out, values)%}', '</div>', '<tpl if="right"></div></tpl>', '<tpl if="left"></div></tpl>', '<tpl if="bottom">', '<tpl if="left"><div id="{fgid}BL" class="{frameCls}-bl {baseCls}-bl {baseCls}-{ui}-bl<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bl</tpl>{frameElCls}" role="presentation"></tpl>', '<tpl if="right"><div id="{fgid}BR" class="{frameCls}-br {baseCls}-br {baseCls}-{ui}-br<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-br</tpl>{frameElCls}" role="presentation"></tpl>', '<div id="{fgid}BC" class="{frameCls}-bc {baseCls}-bc {baseCls}-{ui}-bc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bc</tpl>{frameElCls}" role="presentation"></div>', '<tpl if="right"></div></tpl>', '<tpl if="left"></div></tpl>', '</tpl>', '{%this.renderDockedItems(out,values,1);%}']

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

horizontalPosProp : Stringprivate

...

Defaults to: 'left'

initConfigList : Arrayprivate

...

Defaults to: []

initConfigMap : Objectprivate

...

Defaults to: {}

isAnimate : Booleanprivate

...

Defaults to: true

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

layoutSuspendCount : Numberprivate

...

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

offsetsCls : Stringprivate

...

Defaults to: Ext.baseCSSPrefix + 'hide-offsets'

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

Important. This is not a universal upwards navigation pointer. It indicates the Container which owns and manages\nthis Component if any. There are other similar relationships such as the button which activates a menu, or the\nmenu item which activated a submenu, or the\ncolumn header which activated the column menu.

\n\n

These differences are abstracted away by the up method.

\n\n

Note: to access items within the Container see itemId.

Available since: 2.3.0

rendered : Booleanreadonly

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

Indicates whether or not the component has been rendered.

Defaults to: false

Available since: 1.1.0

scrollFlags : Objectreadonly

An object property which provides unified information as to which dimensions are scrollable based upon\nthe autoScroll...

An object property which provides unified information as to which dimensions are scrollable based upon\nthe autoScroll, overflowX and overflowY settings (And for views of trees and grids, the owning panel's scroll setting).

\n\n

Note that if you set overflow styles using the style config or bodyStyle config, this object does not include that information;\nit is best to use autoScroll, overflowX and overflowY if you need to access these flags.

\n\n

This object has the following properties:

x : Boolean
true if this Component is scrollable horizontally - style setting may be 'auto' or 'scroll'.
\n
y : Boolean
true if this Component is scrollable vertically - style setting may be 'auto' or 'scroll'.
\n
both : Boolean
true if this Component is scrollable both horizontally and vertically.
\n
overflowX : String
The overflow-x style setting, 'auto' or 'scroll' or ''.
\n
overflowY : String
The overflow-y style setting, 'auto' or 'scroll' or ''.
\n

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

Ext.ProgressBar
view source

waitTimer : Objectprivate

private

weight : Numberprivate

...

Defaults to: 0

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.ProgressBar( config ) : Ext.Component

Creates new Component. ...

Creates new Component.

Parameters

config : Ext.Element/String/Object
The configuration options may be specified as either:
\n\n\n\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\n\n

Returns

Ext.Component
\n

Overrides: Ext.AbstractComponent.constructor

addChildEls( )

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

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

addClass( 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

Available since: 2.3.0

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( 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( classes, 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( 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

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 receiving focus which drives\nthe Component's onFocus handling, and the DOM event of it being blurred which drives the onBlur handling.

\n\n

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

addListener( eventName, [fn], [scope], [options] ) : Object

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
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 Ext.util.Observable.fireEvent plus the options parameter described below.
\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
options : Object (optional)
An object containing handler configuration.
\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
This object may contain any of the following properties:
\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
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \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
- 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
- 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
  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
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n
- destroyable : Boolean (optional)
  When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.
  \n
  Defaults to: false
- priority : Number (optional)
  An optional numeric priority that determines the order in which event handlers\n are run. Event handlers with no priority will be run as if they had a priority\n of 0. Handlers with a higher priority will be prioritized to run sooner than\n those with a lower priority. Negative numbers can be used to set a priority\n lower than the default. Internally, the framework uses a range of 1000 or\n greater, and -1000 or lesser for handers that are intended to run before or\n after all others, so it is recommended to stay within the range of -999 to 999\n when setting the priority of event handlers in application-level code.
  \n\n
  Combining Options
  \n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n
  A delayed, one-time listener.
  \n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n

Returns

Only when the destroyable option is specified.

\n\n

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

\n\n

this.btnListeners =  = myButton.on({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n

\n\n

And when those listeners need to be removed:

\n\n

Ext.destroy(this.btnListeners);\n

\n\n

this.btnListeners.destroy();\n

Overrides: Ext.util.Observable.addListener

addManagedListener( item, ename, [fn], [scope], [options] ) : Object

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
options : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n

Returns

Only when the destroyable option is specified.

\n\n\n\n\n

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

\n\n\n\n\n

this.btnListeners =  = myButton.mon({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

addOverCls( )private

...

addPlugin( plugin )private

Adds a plugin. ...

Adds a plugin. May be called at any time in the component's lifecycle.

Parameters

plugin : Object
\n

addPropertyToState( state, propName, [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( 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( 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.

adjustForConstraints( xy, parent )private

private ==> used outside of core\nTODO: currently only used by ToolTip. ...

private ==> used outside of core\nTODO: currently only used by ToolTip. does this method belong here?

Parameters

xy : Object
\n
parent : Object
\n

adjustPosition( x, y )private

...

Parameters

x : Object
\n
y : Object
\n

afterComponentLayout( width, height, oldWidth, oldHeight )protectedtemplate

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

Called by the layout system after the Component has been laid 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\n
height : Number
The height that was set
\n\n
oldWidth : Number/undefined
The old width, or undefined if this was the initial layout.
\n\n
oldHeight : Number/undefined
The old height, or undefined if this was the initial layout.
\n\n

Overrides: Ext.AbstractComponent.afterComponentLayout

afterFirstLayout( width, height )private

...

Parameters

width : Object
\n
height : Object
\n

afterHide( [callback], [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

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.

Overrides: Ext.util.Renderable.afterRender

afterSetPosition( x, 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

Overrides: Ext.AbstractComponent.afterSetPosition

afterShow( [animateTarget], [callback], [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( element, [position], [offsets], [animate] ) : Ext.util.Positionablechainable

Aligns the element with another element relative to the specified anchor points. ...

Aligns the element with another element relative to the specified anchor points. If\nthe other element is the document it aligns it to the viewport. The position\nparameter is optional, and can be specified in any one of the following formats:

\n\n

Blank: Defaults to aligning the element's top-left corner to the target's\nbottom-left corner (\"tl-bl\").
One anchor (deprecated): The passed anchor position is used as the target\nelement's anchor point. The element being aligned will position its top-left\ncorner (tl) to that point. This method has been deprecated in favor of the newer\ntwo anchor syntax below.
Two anchors: If two values from the table below are passed separated by a dash,\nthe first value is used as the element's anchor point, and the second value is\nused as the target's anchor point.

\n\n\n

In addition to the anchor points, the position parameter also supports the \"?\"\ncharacter. If \"?\" is passed at the end of the position string, the element will\nattempt to align as specified, but the position will be adjusted to constrain to\nthe viewport if necessary. Note that the element being aligned might be swapped to\nalign to a different position than that specified in order to enforce the viewport\nconstraints. Following are all of the supported anchor positions:

\n\n

Value  Description\n-----  -----------------------------\ntl     The top left corner (default)\nt      The center of the top edge\ntr     The top right corner\nl      The center of the left edge\nc      In the center of the element\nr      The center of the right edge\nbl     The bottom left corner\nb      The center of the bottom edge\nbr     The bottom right corner\n

\n\n\n

Example Usage:

\n\n

// align el to other-el using the default positioning\n// (\"tl-bl\", non-constrained)\nel.alignTo(\"other-el\");\n\n// align the top left corner of el with the top right corner of other-el\n// (constrained to viewport)\nel.alignTo(\"other-el\", \"tr?\");\n\n// align the bottom right corner of el with the center left edge of other-el\nel.alignTo(\"other-el\", \"br-l?\");\n\n// align the center of el with the bottom left corner of other-el and\n// adjust the x position by -6 pixels (and the y position by 0)\nel.alignTo(\"other-el\", \"c-bl\", [-6, 0]);\n

Parameters

element : Ext.util.Positionable/HTMLElement/String
The Positionable,\nHTMLElement, or id of the element to align to.
\n
position : String (optional)
The position to align to
\n
Defaults to: "tl-bl?"
offsets : Number[] (optional)
Offset the positioning by [x, y]
\n
animate : Boolean/Object (optional)
true for the default animation or a standard\nElement animation config object
\n

Returns

Ext.util.Positionable
this
\n

anchorTo( element, [position], [offsets], [animate], [monitorScroll], [callback] ) : Ext.util.Positionablechainable

Anchors an element to another element and realigns it when the window is resized. ...

Anchors an element to another element and realigns it when the window is resized.

Parameters

element : Ext.util.Positionable/HTMLElement/String
The Positionable,\nHTMLElement, or id of the element to align to.
\n
position : String (optional)
The position to align to
\n
Defaults to: "tl-bl?"
offsets : Number[] (optional)
Offset the positioning by [x, y]
\n
animate : Boolean/Object (optional)
true for the default animation or a standard\nElement animation config object
\n
monitorScroll : Boolean/Number (optional)
True to monitor body scroll and\nreposition. If this parameter is a number, it is used as the buffer delay in\nmilliseconds.
\n
Defaults to: 50
callback : Function (optional)
The function to call after the animation finishes
\n

Returns

Ext.util.Positionable
this
\n

anim( config )private

process the passed fx configuration. ...

process the passed fx configuration.

\n\n

Parameters

config : Object
\n

animate( 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.
height - The Component's height 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

Overrides: Ext.util.Animate.animate

applyChildEls( el, 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( 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

Ext.ProgressBar
view source

applyText( text )private

...

Parameters

text : Object
\n

beforeBlur( e )protected

Template method to do any pre-blur processing. ...

Template method to do any pre-blur processing.

Parameters

e : Ext.EventObject
The event object
\n

beforeComponentLayout( adjWidth, 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.

beforeFocus( e )protected

Template method to do any pre-focus processing. ...

Template method to do any pre-focus processing.

Parameters

e : Ext.EventObject
The event object
\n

beforeLayout( )protectedtemplate

Occurs before componentLayout is run. ...

Occurs before componentLayout is run. In previous releases, this method could\nreturn false to prevent its layout but that is not supported in Ext JS 4.1 or\nhigher. This method is simply a notification of the impending layout to give the\ncomponent a chance to adjust the DOM. Ideally, DOM reads should be avoided at this\ntime to reduce expensive document reflows.

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

Overrides: Ext.AbstractComponent.beforeLayout

beforeRender( )private

...

Overrides: Ext.util.Renderable.beforeRender

beforeSetPosition( x, y, animate )private

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

Template method called before a Component is positioned.

\n\n

Ensures that the position is adjusted so that the Component is constrained if so configured.

Parameters

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

Overrides: Ext.AbstractComponent.beforeSetPosition

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.

blur( ) : Ext.Componentchainableprivate

...

Returns

Ext.Component
this
\n

bubble( fn, [scope], [args] ) : Ext.Componentchainable

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

calculateAnchorXY( [anchor], [extraX], [extraY], [size] ) : Number[]private

Calculates x,y coordinates specified by the anchor position on the element, adding\nextraX and extraY values. ...

Calculates x,y coordinates specified by the anchor position on the element, adding\nextraX and extraY values.

Parameters

anchor : String (optional)
The specified anchor position.\nSee alignTo for details on supported anchor positions.
\n
Defaults to: 'tl'
extraX : Number (optional)
value to be added to the x coordinate
\n
extraY : Number (optional)
value to be added to the y coordinate
\n
size : Object (optional)
An object containing the size to use for calculating anchor\nposition {width: (target width), height: (target height)} (defaults to the\nelement's current size)
\n

Returns

Number[]
[x, y] An array containing the element's x and y coordinates
\n

calculateConstrainedPosition( [constrainTo], [proposedPosition], [local], [proposedSize] ) : Number[]

Calculates the new [x,y] position to move this Positionable into a constrain region. ...

Calculates the new [x,y] position to move this Positionable into a constrain region.

\n\n

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

\n\n

Priority is given to constraining the top and left within the constraint.

\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 Positionable\nwas rendered, or this Component's {@link Ext.Component.constrainTo.
\n
proposedPosition : Number[] (optional)
A proposed [X, Y] position to test for validity\nand to coerce into constraints instead of using this Positionable's current position.
\n
local : Boolean (optional)
The proposedPosition is local (relative to floatParent if a floating Component)
\n
proposedSize : Number[] (optional)
A proposed [width, height] size to use when calculating\nconstraints instead of using this Positionable's current size.
\n

Returns

Number[]
If the element needs to be translated, the new [X, Y] position within\nconstraints if possible, giving priority to keeping the top and left edge in the constrain region.\nOtherwise, false.
\n

callOverridden( 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( 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

\n\n

To override a method and replace it and also call the superclass method, use\ncallSuper. This is often done to patch a method to fix a bug.

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

callSuper( args ) : Objectprotected

This method is used by an override to call the superclass method but bypass any\noverridden method. ...

This method is used by an override to call the superclass method but bypass any\noverridden method. This is often done to \"patch\" a method that contains a bug\nbut for whatever reason cannot be fixed directly.

\n\n

Consider:

\n\n

 Ext.define('Ext.some.Class', {\n     method: function () {\n         console.log('Good');\n     }\n });\n\n Ext.define('Ext.some.DerivedClass', {\n     method: function () {\n         console.log('Bad');\n\n         // ... logic but with a bug ...\n\n         this.callParent();\n     }\n });\n

\n\n

To patch the bug in DerivedClass.method, the typical solution is to create an\noverride:

\n\n

 Ext.define('App.paches.DerivedClass', {\n     override: 'Ext.some.DerivedClass',\n\n     method: function () {\n         console.log('Fixed');\n\n         // ... logic but with bug fixed ...\n\n         this.callSuper();\n     }\n });\n

\n\n

The patch method cannot use callParent to call the superclass method since\nthat would call the overridden method containing the bug. In other words, the\nabove patch would only produce \"Fixed\" then \"Good\" in the console log, whereas,\nusing callParent would produce \"Fixed\" then \"Bad\" then \"Good\".

Parameters

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

Returns

Object
Returns the result of calling the superclass method
\n

cancelFocus( )protected

Cancel any deferred focus on this component ...

Cancel any deferred focus on this component

captureArgs( o, fn, scope )private

...

Parameters

o : Object
\n
fn : Object
\n
scope : Object
\n

center( ) : Ext.Component

Center this Component in its container. ...

Center this Component in its container.

Returns

Ext.Component
this
\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.

Ext.ProgressBar
view source

clearTimer( )private

private ...

private

cloneConfig( 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

...

constructPlugin( ptype )private

...

Parameters

ptype : String/Object
string or config object containing a ptype property.
\n\n
Constructs a plugin according to the passed config object/ptype string.
\n\n
Ensures that the constructed plugin always has a cmp reference back to this component.\nThe setting up of this is done in PluginManager. The PluginManager ensures that a reference to this\ncomponent is passed to the constructor. It also ensures that the plugin's setCmp method (if any) is called.
\n

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.

continueFireEvent( eventName, args, bubbles )private

Continue to fire event. ...

Continue to fire event.

Parameters

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

convertPositionSpec( posSpec )private

Defined in override Ext.rtl.AbstractComponent. ...

Defined in override Ext.rtl.AbstractComponent.

Parameters

posSpec : Object
\n

createRelayer( newName, [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 : String
The name under which to refire the passed parameters.
\n
beginEnd : Array (optional)
The caller can specify on which indices to slice.
\n

Returns

Function
\n

deleteMembers( )private

...

destroy( )private

...

Overrides: Ext.state.Stateful.destroy, Ext.util.ElementContainer.destroy, Ext.AbstractComponent.destroy, Ext.AbstractPlugin.destroy

disable( [silent] )

Disable the component. ...

Disable the component.

Available since: 1.1.0

Parameters

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

doApplyRenderTpl( out, 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.Containerchainable

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( [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

doRenderContent( out, renderData )private

...

Parameters

out : Object
\n
renderData : Object
\n

doRenderFramingDockedItems( out, renderData, after )private

...

Parameters

out : Object
\n
renderData : Object
\n
after : Object
\n

enable( [silent] )

Enable the component ...

Enable the component

Available since: 1.1.0

Parameters

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

enableBubble( 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.define('Ext.overrides.form.field.Base', {\n    override: 'Ext.form.field.Base',\n\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent: function () {\n        this.callParent();\n        this.enableBubble('change');\n    }\n});\n\nvar myForm = Ext.create('Ext.form.Panel', {\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( [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( 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( 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

findPlugin( ptype ) : Ext.AbstractPlugin

Retrieves plugin from this component's collection by its ptype. ...

Retrieves plugin from this component's collection by its ptype.

Parameters

ptype : String
The Plugin's ptype as specified by the class's alias configuration.
\n

Returns

Ext.AbstractPlugin
plugin instance.
\n

finishRender( 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

finishRenderChildren( )private

...

fireEvent( eventName, 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

fireEventArgs( eventName, args ) : Boolean

Fires the specified event with the passed parameter list. ...

Fires the specified event with the passed parameter list.

\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[]
An array of parameters which are passed to handlers.
\n

Returns

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

fireHierarchyEvent( ename )private

For more information on the hierarchy events, see the note for the\nhierarchyEventSource observer defined in the onCla...

For more information on the hierarchy events, see the note for the\nhierarchyEventSource observer defined in the onClassCreated callback.

\n\n

This functionality is contained in Component (as opposed to Container)\nbecause a Component can be the ownerCt for a floating component (loadmask),\nand the loadmask needs to know when its owner is shown/hidden via the\nhierarchyEventSource so that its hidden state can be synchronized.

\n\n

TODO: merge this functionality with Ext.globalEvents

Parameters

ename : Object
\n

fitContainer( animate )private

...

Parameters

animate : Object
\n

focus( [selectText], [delay], [callback], [scope] ) : 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
callback : Function (optional)
Only needed if the delay parameter is used. A function to call upon focus.
\n
scope : Function (optional)
Only needed if the delay parameter is used. The scope (this reference) in which to execute the callback.
\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

getActionEl( )private

Deprecate 5.0 ...

Deprecate 5.0

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

getAlignToXY( element, [position], [offsets] ) : Number[]

Gets the x,y coordinates to align this element with another element. ...

Gets the x,y coordinates to align this element with another element. See\nalignTo for more info on the supported position values.

Parameters

element : Ext.util.Positionable/HTMLElement/String
The Positionable,\nHTMLElement, or id of the element to align to.
\n
position : String (optional)
The position to align to
\n
Defaults to: "tl-bl?"
offsets : Number[] (optional)
Offset the positioning by [x, y]
\n

Returns

Number[]
[x, y]
\n

getAnchor( )private

private ...

private

getAnchorToXY( el, [anchor], [local], [size] ) : Number[]private

Begin Positionable methods\n\n\n\nOverridden in Ext.rtl.AbstractComponent. ...

\n\n

Begin Positionable methods

\n\n

Overridden in Ext.rtl.AbstractComponent.

\n\n

Gets the x,y coordinates of an element specified by the anchor position on the\nelement.

Parameters

el : Ext.dom.Element
The element
\n
anchor : String (optional)
The specified anchor position.\nSee alignTo for details on supported anchor positions.
\n
Defaults to: 'tl'
local : Boolean (optional)
True to get the local (element top/left-relative) anchor\nposition instead of page coordinates
\n
size : Object (optional)
An object containing the size to use for calculating anchor\nposition {width: (target width), height: (target height)} (defaults to the\nelement's current size)
\n

Returns

Number[]
[x, y] An array containing the element's x and y coordinates
\n

Overrides: Ext.util.Positionable.getAnchorToXY

getAnchorXY( [anchor], [local], [size] ) : Number[]

Gets the x,y coordinates specified by the anchor position on the element. ...

Gets the x,y coordinates specified by the anchor position on the element.

Parameters

anchor : String (optional)
The specified anchor position.\nSee alignTo for details on supported anchor positions.
\n
Defaults to: 'tl'
local : Boolean (optional)
True to get the local (element top/left-relative) anchor\nposition instead of page coordinates
\n
size : Object (optional)
An object containing the size to use for calculating anchor\nposition {width: (target width), height: (target height)} (defaults to the\nelement's current size)
\n

Returns

Number[]
[x, y] An array containing the element's x and y coordinates
\n

getAnimateTarget( target )private

...

Parameters

target : Object
\n

getAutoId( )private

...

getBorderPadding( ) : Objectprivate

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

\n\n

Returns the size of the element's borders and padding.

Returns

Object
an object with the following numeric properties\n- beforeX\n- afterX\n- beforeY\n- afterY
\n

Overrides: Ext.util.Positionable.getBorderPadding

getBox( [contentBox], [local] ) : Object

Return an object defining the area of this Element which can be passed to\nsetBox to set another Element's size/locati...

Return an object defining the area of this Element which can be passed to\nsetBox to set another Element's size/location to match this element.

Parameters

contentBox : Boolean (optional)
If true a box for the content of the element is\nreturned.
\n
local : Boolean (optional)
If true the element's left and top relative to its\noffsetParent are returned instead of page x/y.
\n

Returns

box An object in the format:

\n\n

{\n    x: <Element's X position>,\n    y: <Element's Y position>,\n    left: <Element's X position (an alias for x)>,\n    top: <Element's Y position (an alias for y)>,\n    width: <Element's width>,\n    height: <Element's height>,\n    bottom: <Element's lower bound>,\n    right: <Element's rightmost bound>\n}\n

\n\n

The returned object may also be addressed as an Array where index 0 contains the X\nposition and index 1 contains the Y position. The result may also be used for\nsetXY

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

getBubbleTarget( )protected

Implements an upward event bubbling policy. ...

Implements an upward event bubbling policy. By default a Component bubbles events up to its reference owner.

\n\n

Component subclasses may implement a different bubbling strategy by overriding this method.

Overrides: Ext.AbstractComponent.getBubbleTarget

getChildEls( )private

...

getClassChildEls( cls )private

...

Parameters

cls : Object
\n

getComponentLayout( )private

...

getConfig( name )private

...

Parameters

name : Object
\n

getConstrainVector( [constrainTo], [proposedPosition], [proposedSize] ) : Number[]/Boolean

Returns the [X, Y] vector by which this Positionable's element must be translated to make a best\nattempt to constrain...

Returns the [X, Y] vector by which this Positionable's element must be translated to make a best\nattempt to constrain within the passed constraint. Returns false if the element\ndoes not need to be moved.

\n\n

Priority is given to constraining the top and left within the constraint.

\n\n

The constraint may either be an existing element into which the element is to be\nconstrained, or a Region into which this element is to be\nconstrained.

\n\n

By default, any extra shadow around the element is not included in the constrain calculations - the edges\nof the element are used as the element bounds. To constrain the shadow within the constrain region, set the\nconstrainShadow property on this element to true.

Parameters

constrainTo : Ext.util.Positionable/HTMLElement/String/Ext.util.Region (optional)
The\nPositionable, HTMLElement, element id, or Region into which the element is to be\nconstrained.
\n
proposedPosition : Number[] (optional)
A proposed [X, Y] position to test for validity\nand to produce a vector for instead of using the element's current position
\n
proposedSize : Number[] (optional)
A proposed [width, height] size to constrain\ninstead of using the element's current size
\n

Returns

Number[]/Boolean
If the element needs to be translated, an [X, Y]\nvector by which this element must be translated. Otherwise, false.
\n

getContentTarget( )private

...

getDragEl( )private

...

getEl( ) : Ext.dom.Element

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

Retrieves the top level element representing this component.

Available since: 1.1.0

Returns

Ext.dom.Element
\n

Overrides: Ext.AbstractComponent.getEl

getElConfig( )private

...

getFocusEl( )private

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

Returns the focus holder element associated with this Component. At the Component base class level, this function returns undefined.

\n\n

Subclasses which use embedded focusable elements (such as Window, Field and Button) should override this\nfor use by the focus method.

\n\n

Containers which need to participate in the FocusManager's navigation and Container focusing scheme also\nneed to return a focusEl, although focus is only listened for in this case if the FocusManager is enabled.

getFrameInfo( )private

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

On render, reads an encoded style attribute, \"filter\" 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.

getFrameRenderData( )private

...

getFrameTpl( table )private

...

Parameters

table : Object
\n

getFramingInfoCls( )private

...

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

getHierarchyState( inner )private

A component's hierarchyState is used to keep track of aspects of a component's\nstate that affect its descendants hier...

A component's hierarchyState is used to keep track of aspects of a component's\nstate that affect its descendants hierarchically like \"collapsed\" and \"hidden\".\nFor example, if this.hierarchyState.hidden == true, it means that either this\ncomponent, or one of its ancestors is hidden.

\n\n

Hierarchical state management is implemented by chaining each component's\nhierarchyState property to its parent container's hierarchyState property via the\nprototype. The result is such that if a component's hierarchyState does not have\nit's own property, it inherits the property from the nearest ancestor that does.

\n\n

To set a hierarchical \"hidden\" value:

\n\n

this.getHierarchyState().hidden = true;\n

\n\n

It is important to remember when unsetting hierarchyState properties to delete\nthem instead of just setting them to a falsy value. This ensures that the\nhierarchyState returns to a state of inheriting the value instead of overriding it\nTo unset the hierarchical \"hidden\" value:

\n\n

delete this.getHierarchyState().hidden;\n

\n\n

IMPORTANT! ALWAYS access hierarchyState using this method, not by accessing\nthis.hierarchyState directly. The hierarchyState property does not exist until\nthe first time getHierarchyState() is called. At that point getHierarchyState()\nwalks up the component tree to establish the hierarchyState prototype chain.\nAdditionally the hierarchyState property should NOT be relied upon even after\nthe initial call to getHierarchyState() because it is possible for the\nhierarchyState to be invalidated. Invalidation typically happens when a component\nis moved to a new container. In such a case the hierarchy state remains invalid\nuntil the next time getHierarchyState() is called on the component or one of its\ndescendants.

Parameters

inner : Object
\n

getId( ) : String

Retrieves the id of this component. ...

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

Returns

String
\n

Overrides: Ext.AbstractComponent.getId

getInitialConfig( [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( 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

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

getLocalX( ) : Number

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

\n\n

Returns the x coordinate of this element reletive to its offsetParent.

Returns

Number
The local x coordinate
\n

Overrides: Ext.util.Positionable.getLocalX

getLocalXY( ) : Number[]

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

\n\n

Returns the x and y coordinates of this element relative to its offsetParent.

Returns

Number[]
The local XY position of the element
\n

Overrides: Ext.util.Positionable.getLocalXY

getLocalY( ) : Number

Returns the y coordinate of this element reletive to its offsetParent. ...

Returns the y coordinate of this element reletive to its offsetParent.

Returns

Number
The local y coordinate
\n

Overrides: Ext.util.Positionable.getLocalY

getMaskTarget( )private

...

getOffsetsTo( offsetsTo ) : Number[]

Returns the offsets of this element from the passed element. ...

Returns the offsets of this element from the passed element. The element must both\nbe part of the DOM tree and not have display:none to have page coordinates.

Parameters

offsetsTo : Ext.util.Positionable/HTMLElement/String
The Positionable,\nHTMLElement, or element id to get get the offsets from.
\n

Returns

Number[]
The XY page offsets (e.g. [100, -200])
\n

getOuterSize( )private

Include margins ...

Include margins

getOverflowEl( )private

Get an el for overflowing, defaults to the target el ...

Get an el for overflowing, defaults to the target el

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.

getOwningBorderContainer( ) : Ext.container.Containerprivate

Returns the owning container if that container uses border layout. ...

Returns the owning container if that container uses border layout. Otherwise\nthis method returns null.

\n\n

Defined in override Ext.layout.container.border.Region.

Returns

Ext.container.Container
The owning border container or null.
\n

getOwningBorderLayout( ) : Ext.layout.container.Borderprivate

Returns the owning border (Ext.layout.container.Border) instance if there is\none. ...

Returns the owning border (Ext.layout.container.Border) instance if there is\none. Otherwise this method returns null.

\n\n

Defined in override Ext.layout.container.border.Region.

Returns

Ext.layout.container.Border
The owning border layout or null.
\n

getPlugin( pluginId ) : Ext.AbstractPlugin

Retrieves a plugin from this component's collection by its pluginId. ...

Retrieves a plugin from this component's collection by its pluginId.

Parameters

pluginId : String
\n

Returns

Ext.AbstractPlugin
plugin instance.
\n

getPosition( [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

getPositionEl( )private

Deprecate 5.0 ...

Deprecate 5.0

getProxy( )private

...

getRefOwner( )privateprotected

Used by ComponentQuery, and the up method to find the\nowning Component in the linkage hierarchy. ...

Used by ComponentQuery, and the up method to find the\nowning Component in the linkage hierarchy.

\n\n

By default this returns the Container which contains this Component.

\n\n

This may be overriden by Component authors who implement ownership hierarchies which are not\nbased upon ownerCt, such as BoundLists being owned by Fields or Menus being owned by Buttons.

getRegion( ) : Ext.util.Region

Returns a region object that defines the area of this element. ...

Returns a region object that defines the area of this element.

Returns

Ext.util.Region
A Region containing \"top, left, bottom, right\" properties.
\n

getRenderTree( )private

...

getResizeEl( )private

Deprecate 5.0 ...

Deprecate 5.0

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( 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( 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\npart 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.

Ext.ProgressBar
view source

getText( )private

...

getTpl( name )private

...

Parameters

name : Object
\n

getViewRegion( ) : Ext.util.Region

Returns the content region of this element. ...

Returns the content region of this element. That is the region within the borders\nand padding.

Returns

Ext.util.Region
A Region containing \"top, left, bottom, right\" member data.
\n

getVisibilityEl( )private

Deprecate 5.0 ...

Deprecate 5.0

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

getX( ) : Number

Gets the current X position of the DOM element based on page coordinates. ...

Gets the current X position of the DOM element based on page coordinates.

Returns

Number
The X position of the element
\n

Overrides: Ext.util.Positionable.getX

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

Available since: 2.3.0

Returns

String
The xtype hierarchy string
\n

getXY( ) : Number[]

Gets the current position of the DOM element based on page coordinates. ...

Gets the current position of the DOM element based on page coordinates.

Returns

Number[]
The XY position of the element
\n

Overrides: Ext.util.Positionable.getXY

getY( ) : Number

Gets the current Y position of the DOM element based on page coordinates. ...

Gets the current Y position of the DOM element based on page coordinates.

Returns

Number
The Y position of the element
\n

Overrides: Ext.util.Positionable.getY

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( 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( config )private

...

Parameters

config : Object
\n

hasListener( 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( 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( [animateTarget], [callback], [scope] ) : Ext.Componentchainable

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

initBorderRegion( )private

This method is called by the Ext.layout.container.Border class when instances are\nadded as regions to the layout. ...

This method is called by the Ext.layout.container.Border class when instances are\nadded as regions to the layout. Since it is valid to add any component to a border\nlayout as a region, this method must be added to Ext.Component but is only ever\ncalled when that component is owned by a border layout.

\n\n

Defined in override Ext.layout.container.border.Region.

initCls( )private

...

Ext.ProgressBar
view source

initComponent( )protectedtemplate

private\n\nThe initComponent template method is an important initialization step for a Component. ...

private

\n\n

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

Available since: 1.1.0

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

Overrides: Ext.Component.initComponent

initConfig( config ) : Ext.Basechainableprotected

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

initContainer( container )private

...

Parameters

container : Object
\n

initDraggable( )private

...

initEvents( )protected

Initialize any events on this component ...

Initialize any events on this component

initFrame( )private

...

initFramingTpl( table )private

Poke in a reference to applyRenderTpl(frameInfo, out) ...

Poke in a reference to applyRenderTpl(frameInfo, out)

Parameters

table : Object
\n

initHierarchyEvents( )private

...

initHierarchyState( hierarchyState )private

Called by getHierarchyState to initialize the hierarchyState the first\ntime it is requested. ...

Called by getHierarchyState to initialize the hierarchyState the first\ntime it is requested.

\n\n

Overridden in Ext.rtl.AbstractComponent.

Parameters

hierarchyState : Object
\n

initPadding( targetEl )private

Initializes padding by applying it to the target element, or if the layout manages\npadding ensures that the padding o...

Initializes padding by applying it to the target element, or if the layout manages\npadding ensures that the padding on the target element is \"0\".

Parameters

targetEl : Object
\n

initPlugin( plugin )private

...

Parameters

plugin : Object
\n

Ext.ProgressBar
view source

initRenderData( ) : Objectprotected

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\n\n\n

Overrides: Ext.util.Renderable.initRenderData

initRenderTpl( ) : Ext.XTemplateprivate

Initializes the renderTpl. ...

Initializes the renderTpl.

Returns

Ext.XTemplate
The renderTpl XTemplate instance.
\n

initResizable( resizable )private

...

Parameters

resizable : Object
\n

initState( )private

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

Initializes the state of the object upon construction.

initStyles( targetEl )private

Applies padding, margin, border, top, left, height, and width configs to the\nappropriate elements. ...

Applies padding, margin, border, top, left, height, and width configs to the\nappropriate elements.

Parameters

targetEl : Object
\n

is( 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

isContainedFloater( )private

Utility method to determine if a Component is floating, and has an owning Container whose coordinate system\nit must b...

Utility method to determine if a Component is floating, and has an owning Container whose coordinate system\nit must be positioned in when using setPosition.

isDescendant( ancestor )private

...

Parameters

ancestor : Object
\n

isDescendantOf( 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 the component is the descendant of a particular container, otherwise false.
\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

isFocusable( )private

...

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

isHierarchicallyHidden( )private

...

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

isLocalRtl( ) : Booleanprivate

Returns true if this component's local coordinate system is rtl. ...

Returns true if this component's local coordinate system is rtl. For normal\ncomponents this equates to the value of isParentRtl(). Floaters are a bit different\nbecause a floater's element can be a childNode of something other than its\nparent component's element. For floaters we have to read the dom to see if the\ncomponent's element's parentNode has a css direction value of \"rtl\".

\n\n

Defined in override Ext.rtl.AbstractComponent.

Returns

Boolean
\n

isOppositeRootDirection( )private

Defined in override Ext.rtl.AbstractComponent. ...

Defined in override Ext.rtl.AbstractComponent.

isParentRtl( ) : Booleanprivate

Returns true if this component's parent container is rtl. ...

Returns true if this component's parent container is rtl. Used by rtl positioning\nmethods to determine if the component should be positioned using a right-to-left\ncoordinate system.

\n\n

Defined in override Ext.rtl.AbstractComponent.

Returns

Boolean
\n

isVisible( [deep] ) : Boolean

Returns true if this component is visible. ...

Returns true if this component is visible.

Available since: 1.1.0

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

Ext.ProgressBar
view source

isWaiting( ) : Boolean

Returns true if the progress bar is currently in a wait operation ...

Returns true if the progress bar is currently in a wait operation

Returns

Boolean
True if waiting, else false
\n

isXType( xtype, [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

Available since: 2.3.0

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

makeFloating( dom )private

...

Parameters

dom : Object
\n

mask( )private

...

mon( item, ename, [fn], [scope], [options] ) : Object

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
options : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n

Returns

Only when the destroyable option is specified.

\n\n\n\n\n

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

\n\n\n\n\n

this.btnListeners =  = myButton.mon({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

move( direction, distance, [animate] )

Move the element relative to its current position. ...

Move the element relative to its current position.

Parameters

direction : String
Possible values are:
\n\n
- \"l\" (or \"left\")
- \"r\" (or \"right\")
- \"t\" (or \"top\", or \"up\")
- \"b\" (or \"bottom\", or \"down\")
\n\n
distance : Number
How far to move the element in pixels
\n
animate : Boolean/Object (optional)
true for the default animation or a standard\nElement animation config object
\n

mun( item, ename, [fn], [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( [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( [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 referred 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( eventName, [fn], [scope], [options] ) : Object

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
- destroyable : Boolean (optional)
  When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.
  \n\n
  Defaults to: false
- priority : Number (optional)
  An optional numeric priority that determines the order in which event handlers\n are run. Event handlers with no priority will be run as if they had a priority\n of 0. Handlers with a higher priority will be prioritized to run sooner than\n those with a lower priority. Negative numbers can be used to set a priority\n lower than the default. Internally, the framework uses a range of 1000 or\n greater, and -1000 or lesser for handers that are intended to run before or\n after all others, so it is recommended to stay within the range of -999 to 999\n when setting the priority of event handlers in application-level code.
  \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

Returns

Only when the destroyable option is specified.

\n\n\n\n\n

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

\n\n\n\n\n

this.btnListeners =  = myButton.on({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

onAdded( container, 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.

Available since: 3.4.0

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

Overrides: Ext.AbstractComponent.onAdded

onAfterFloatLayout( )private

...

onBeforeFloatLayout( )private

...

onBlur( e )private

private ...

private

Parameters

e : Object
\n

onBoxReady( width, height )private

...

Parameters

width : Object
\n
height : Object
\n

onConfigUpdate( names, callback, scope )private

...

Parameters

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

Ext.ProgressBar
view source

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.

Overrides: Ext.Component.onDestroy

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.

onFloatShow( )private

...

onFocus( e )private

private ...

private

Parameters

e : Object
\n

onHide( [animateTarget], [callback], [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

Overrides: Ext.AbstractComponent.onHide

onKeyDown( e )private

Listen for TAB events and wrap round if tabbing of either end of the Floater ...

Listen for TAB events and wrap round if tabbing of either end of the Floater

Parameters

e : Object
\n

onMouseDown( e )private

Mousedown brings to front, and programatically grabs focus unless the mousedown was on a focusable element ...

Mousedown brings to front, and programatically grabs focus unless the mousedown was on a focusable element

Parameters

e : Object
\n

onPosition( x, 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

onRemoved( 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.

Available since: 3.4.0

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

Ext.ProgressBar
view source

onRender( parentNode, 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\n\n\n
containerIdx : Number
The index within the parent Container's child collection of this Component.
\n\n\n\n

Overrides: Ext.util.Renderable.onRender

onResize( width, height, oldWidth, oldHeight )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.

Parameters

width : Object
\n
height : Object
\n
oldWidth : Object
\n
oldHeight : Object
\n

onShow( [animateTarget], [callback], [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

Overrides: Ext.AbstractComponent.onShow

onShowComplete( [callback], [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

onShowVeto( )private

...

onStateChange( )private

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

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

parseBox( box )private

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Parameters

box : Object
\n

postBlur( e )protected

Template method to do any post-blur processing. ...

Template method to do any post-blur processing.

Parameters

e : Ext.EventObject
The event object
\n

prepareClass( 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( [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( [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 referred 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

prune( childEls, shared )private

...

Parameters

childEls : Object
\n
shared : Object
\n

registerFloatingItem( 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 this way will not participate in any layout, but will be rendered\nupon first show in the way that Windows are.

Parameters

cmp : Object
\n

registerWithOwnerCt( )private

...

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

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

Returns

Object
A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:
\n\n
```
this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');\n
```
\n\n
Can be undone by calling
\n\n
```
Ext.destroy(this.storeRelayers);\n
```
\n\n
or
\n\n
```
this.store.relayers.destroy();\n
```
\n

removeAnchor( ) : Ext.util.Positionablechainable

Remove any anchor to this element. ...

Remove any anchor to this element. See anchorTo.

Returns

Ext.util.Positionable
this
\n

removeChildEls( 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

removeClass( )private

...

Available since: 2.3.0

removeCls( 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( 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( eventName, fn, [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( item, ename, [fn], [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( isClear, managedListener )private

inherit docs\n\nRemove a single managed listener item ...

inherit docs

\n\n

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

Overrides: Ext.util.Observable.removeManagedListenerItem

removeOverCls( )private

...

removePlugin( plugin )private

...

Parameters

plugin : Object
\n

removeUIClsFromElement( 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( [container], [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

Ext.ProgressBar
view source

reset( [hide] ) : Ext.ProgressBarchainable

Resets the progress bar value to 0 and text to empty string. ...

Resets the progress bar value to 0 and text to empty string. If hide = true, the progress bar will also be hidden\n(using the hideMode property internally).

Parameters

hide : Boolean (optional)
True to hide the progress bar.
\n
Defaults to: false

Returns

Ext.ProgressBar
this
\n

resumeEvent( eventName )

Resumes firing of the named event(s). ...

Resumes firing of the named event(s).

\n\n

After calling this method to resume events, the events will fire when requested to fire.

\n\n

Note that if the suspendEvent method is called multiple times for a certain event,\nthis converse method will have to be called the same number of times for it to resume firing.

Parameters

eventName : String...
Multiple event names to resume.
\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.

resumeLayouts( flushOptions )private

...

Parameters

flushOptions : Object
\n

savePropToState( propName, state, [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( propNames, 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( deltaX, deltaY, 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( ) : Objectchainable

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( [active], [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( scroll ) : Ext.Componentchainable

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( border )

...

Parameters

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

setBorderRegion( region ) : String

This method changes the region config property for this border region. ...

This method changes the region config property for this border region. This is\nonly valid if this component is in a border layout (Ext.layout.container.Border).

\n\n

Defined in override Ext.layout.container.border.Region.

Parameters

region : String
The new region value (\"north\", \"south\", \"east\" or\n\"west\").
\n

Returns

String
The previous value of the region property.
\n

setBox( box, [animate] ) : Ext.util.Positionablechainable

Sets the element's box. ...

Sets the element's box. If animate is true then x, y, width, and height will be\nanimated concurrently.

Parameters

box : Object
The box to fill {x, y, width, height}
\n
animate : Boolean/Object (optional)
true for the default animation or a standard\nElement animation config object
\n

Returns

Ext.util.Positionable
this
\n

setComponentLayout( layout )private

...

Parameters

layout : Object
\n

setConfig( config, applyIfNotSet ) : Ext.Basechainableprivate

...

Parameters

config : Object
\n
applyIfNotSet : Object
\n

Returns

Ext.Base
this
\n

setDisabled( disabled )

Enable or disable the component. ...

Enable or disable the component.

Parameters

disabled : Boolean
true to disable.
\n

setDocked( dock, [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

setFloatParent( floatParent )private

...

Parameters

floatParent : Object
\n

setHeight( 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

setHiddenState( hidden )private

...

Parameters

hidden : Object
\n

setLoading( load, [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

setLocalX( x ) : Ext.util.Positionable

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

\n\n

Sets the local x coordinate of this element using CSS style. When used on an\nabsolute positioned element this method is symmetrical with getLocalX, but\nmay not be symmetrical when used on a relatively positioned element.

Parameters

x : Number
The x coordinate. A value of null sets the left style to 'auto'.
\n

Returns

Ext.util.Positionable
this
\n

Overrides: Ext.util.Positionable.setLocalX

setLocalXY( x, [y] ) : Ext.util.Positionable

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

\n\n

Sets the local x and y coordinates of this element using CSS style. When used on an\nabsolute positioned element this method is symmetrical with getLocalXY, but\nmay not be symmetrical when used on a relatively positioned element.

Parameters

x : Number/Array
The x coordinate or an array containing [x, y]. A value of\nnull sets the left style to 'auto'
\n
y : Number (optional)
The y coordinate, required if x is not an array. A value of\nnull sets the top style to 'auto'
\n

Returns

Ext.util.Positionable
this
\n

Overrides: Ext.util.Positionable.setLocalXY

setLocalY( y ) : Ext.util.Positionable

Sets the local y coordinate of this element using CSS style. ...

Sets the local y coordinate of this element using CSS style. When used on an\nabsolute positioned element this method is symmetrical with getLocalY, but\nmay not be symmetrical when used on a relatively positioned element.

Parameters

y : Number
The y coordinate. A value of null sets the top style to 'auto'.
\n

Returns

Ext.util.Positionable
this
\n

Overrides: Ext.util.Positionable.setLocalY

setMargin( margin )

Sets the margin on the target element. ...

Sets the margin on the target element.

Parameters

margin : Number/String
The margin to set. See the margin config.
\n

setOverflowXY( overflowX, overflowY ) : Ext.Componentchainable

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( x, [y], [animate] ) : Ext.Componentchainable

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/Number[]
The new x position or an array of [x,y].
\n
y : Number (optional)
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( x, [y], [animate] ) : Ext.Componentchainable

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

x : Number/Number[]/Object
The new left, an array of [x,y], or animation config object containing x and y properties.
\n
y : Number (optional)
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

setRegion( region, [animate] ) : Ext.util.Positionablechainable

Sets the element's position and size to the specified region. ...

Sets the element's position and size to the specified region. If animation is true\nthen width, height, x and y will be animated concurrently.

Parameters

region : Ext.util.Region
The region to fill
\n
animate : Boolean/Object (optional)
true for the default animation or a standard\nElement animation config object
\n

Returns

Ext.util.Positionable
this
\n

setRegionWeight( weight ) : Number

Sets the weight config property for this component. ...

Sets the weight config property for this component. This is only valid if this\ncomponent is in a border layout (Ext.layout.container.Border).

\n\n

Defined in override Ext.layout.container.border.Region.

Parameters

weight : Number
The new weight value.
\n

Returns

Number
The previous value of the weight property.
\n

setSize( width, 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( 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( visible ) : Ext.Component

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

Convenience function to hide or show this component by Boolean.

Available since: 1.1.0

Parameters

visible : Boolean
true to show, false to hide.
\n

Returns

Ext.Component
this
\n

setWidth( 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

setX( The, [animate] ) : Ext.util.Positionable

Sets the X position of the DOM element based on page coordinates. ...

Sets the X position of the DOM element based on page coordinates.

Parameters

The : Number
X position
\n
animate : Boolean/Object (optional)
True for the default animation, or a standard\nElement animation config object
\n

Returns

Ext.util.Positionable
this
\n

Overrides: Ext.util.Positionable.setX

setXY( pos, [animate] ) : Ext.util.Positionable

Sets the position of the DOM element in page coordinates. ...

Sets the position of the DOM element in page coordinates.

Parameters

pos : Number[]
Contains X & Y [x, y] values for new position (coordinates\nare page-based)
\n
animate : Boolean/Object (optional)
True for the default animation, or a standard\nElement animation config object
\n

Returns

Ext.util.Positionable
this
\n

Overrides: Ext.util.Positionable.setXY

setY( The, [animate] ) : Ext.util.Positionable

Sets the Y position of the DOM element based on page coordinates. ...

Sets the Y position of the DOM element based on page coordinates.

Parameters

The : Number
Y position
\n
animate : Boolean/Object (optional)
True for the default animation, or a standard\nElement animation config object
\n

Returns

Ext.util.Positionable
this
\n

Overrides: Ext.util.Positionable.setY

setZIndex( index )private

z-index is managed by the zIndexManager and may be overwritten at any time. ...

z-index is managed by the zIndexManager and may be overwritten at any time.\nReturns the next z-index to be used.\nIf this is a Container, then it will have rebased any managed floating Components,\nand so the next available z-index will be approximately 10000 above that.

Parameters

index : Object
\n

setupFramingTpl( 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

setupProtoEl( )private

...

setupRenderTpl( renderTpl )private

...

Parameters

renderTpl : Object
\n

show( [animateTarget], [callback], [scope] ) : Ext.Componentchainable

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

Overrides: Ext.AbstractComponent.show

showAt( x, [y], [animate] ) : Ext.Componentchainable

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/Number[]
The new x position or array of [x,y].
\n
y : Number (optional)
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

showBy( component, [position], [offsets] ) : Ext.Componentchainable

Shows this component by the specified Component or Element. ...

Shows this component by the specified Component or Element.\nUsed when this component is floating.

Parameters

component : Ext.Component/Ext.dom.Element
The Ext.Component or Ext.Element to show the component by.
\n
position : String (optional)
Alignment position as used by Ext.util.Positionable.getAlignToXY.\nDefaults to defaultAlign.
\n
offsets : Number[] (optional)
Alignment offsets as used by Ext.util.Positionable.getAlignToXY.
\n

Returns

Ext.Component
this
\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.Elementchainable

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

suspendEvent( eventName )

Suspends firing of the named event(s). ...

Suspends firing of the named event(s).

\n\n

After calling this method to suspend events, the events will no longer fire when requested to fire.

\n\n

Note that if this is called multiple times for a certain event, the converse method\nresumeEvent will have to be called the same number of times for it to resume firing.

Parameters

eventName : String...
Multiple event names to suspend.
\n

suspendEvents( 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

suspendLayouts( )private

...

syncFx( ) : Objectchainable

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

syncHidden( )private

synchronizes the hidden state of this component with the state of its hierarchy ...

synchronizes the hidden state of this component with the state of its hierarchy

syncShadow( )private

...

toBack( ) : Ext.Componentchainable

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( [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

translatePoints( x, [y] ) : Object

Translates the passed page coordinates into left/top css values for the element ...

Translates the passed page coordinates into left/top css values for the element

Parameters

x : Number/Array
The page x or an array containing [x, y]
\n
y : Number (optional)
The page y, required if x is not an array
\n

Returns

Object
An object with left and top properties. e.g.\n{left: (value), top: (value)}
\n

translateXY( x, [y] ) : Objectprivate

Translates the passed page coordinates into x and y css values for the element ...

Translates the passed page coordinates into x and y css values for the element

Parameters

x : Number/Array
The page x or an array containing [x, y]
\n
y : Number (optional)
The page y, required if x is not an array
\n

Returns

Object
An object with x and y properties. e.g.\n{x: (value), y: (value)}
\n

un( eventName, fn, [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

unitizeBox( box )private

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Parameters

box : Object
\n

unmask( )private

...

unregisterFloatingItem( cmp )private

...

Parameters

cmp : Object
\n

up( [selector], [limit] ) : Ext.container.Container

Navigates up the ownership hierarchy searching for an ancestor Container which matches any passed simple selector or ...

Navigates up the ownership hierarchy searching for an ancestor Container which matches any passed simple selector or component.

\n\n

Important. There is not a universal upwards navigation pointer. There are several upwards relationships\nsuch as the button which activates a menu, or the\nmenu item which activated a submenu, or the\ncolumn header which activated the column menu.

\n\n

These differences are abstracted away by this method.

\n\n

Example:

\n\n

var owningTabPanel = grid.up('tabpanel');\n

Parameters

selector : String/Ext.Component (optional)
The simple selector component or actual component to test. If not passed the immediate owner/activater is returned.
\n
limit : String/Number/Ext.Component (optional)
This may be a selector upon which to stop the upward scan, or a limit of teh number of steps, or Component reference to stop on.
\n

Returns

Ext.container.Container
The matching ancestor Container (or undefined if no match was found).
\n

update( htmlOrData, [loadScripts], [callback] )

Update the content area of a component. ...

Update the content area of a component.

Available since: 3.4.0

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( box ) : Ext.Componentchainable

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

updateFrame( )private

...

updateLayout( [options] )

Updates this component's layout. ...

Updates this component's layout. If this update affects 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 (optional)
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

Ext.ProgressBar
view source

updateProgress( [value], [text], [animate] ) : Ext.ProgressBarchainable

Updates the progress bar value, and optionally its text. ...

Updates the progress bar value, and optionally its text. If the text argument is not specified, any existing text\nvalue will be unchanged. To blank out existing text, pass ''. Note that even if the progress bar value exceeds 1,\nit will never automatically reset -- you are responsible for determining when the progress is complete and\ncalling reset to clear and/or hide the control.

Parameters

value : Number (optional)
A floating point value between 0 and 1 (e.g., .5)
\n
Defaults to: 0
text : String (optional)
The string to display in the progress text element
\n
Defaults to: ''
animate : Boolean (optional)
Whether to animate the transition of the progress bar. If this value is not\nspecified, the default for the class is used
\n
Defaults to: false

Returns

Ext.ProgressBar
this
\n

Ext.ProgressBar
view source

updateText( [text] ) : Ext.ProgressBarchainable

Updates the progress bar text. ...

Updates the progress bar text. If specified, textEl will be updated, otherwise the progress bar itself will\ndisplay the updated text.

Parameters

text : String (optional)
The string to display in the progress text element
\n
Defaults to: ''

Returns

Ext.ProgressBar
this
\n

Ext.ProgressBar
view source

wait( [config] ) : Ext.ProgressBarchainable

Initiates an auto-updating progress bar. ...

Initiates an auto-updating progress bar. A duration can be specified, in which case the progress bar will\nautomatically reset after a fixed amount of time and optionally call a callback function if specified. If no\nduration is passed in, then the progress bar will run indefinitely and must be manually cleared by calling\nreset.

\n\n

Example usage:

\n\n

var p = new Ext.ProgressBar({\n   renderTo: 'my-el'\n});\n\n//Wait for 5 seconds, then update the status el (progress bar will auto-reset)\nvar p = Ext.create('Ext.ProgressBar', {\n   renderTo: Ext.getBody(),\n   width: 300\n});\n\n//Wait for 5 seconds, then update the status el (progress bar will auto-reset)\np.wait({\n   interval: 500, //bar will move fast!\n   duration: 50000,\n   increment: 15,\n   text: 'Updating...',\n   scope: this,\n   fn: function(){\n      p.updateText('Done!');\n   }\n});\n\n//Or update indefinitely until some async action completes, then reset manually\np.wait();\nmyAction.on('complete', function(){\n    p.reset();\n    p.updateText('Done!');\n});\n

Parameters

config : Object (optional)
Configuration options
\n
- duration : Number
  The length of time in milliseconds that the progress bar should\nrun before resetting itself (defaults to undefined, in which case it will run indefinitely\nuntil reset is called)
  \n
- interval : Number
  The length of time in milliseconds between each progress update\n(defaults to 1000 ms)
  \n
- animate : Boolean
  Whether to animate the transition of the progress bar. If this\nvalue is not specified, the default for the class is used.
  \n
- increment : Number
  The number of progress update segments to display within the\nprogress bar (defaults to 10). If the bar reaches the end and is still updating, it will\nautomatically wrap back to the beginning.
  \n
- text : String
  Optional text to display in the progress bar element (defaults to '').
  \n
- fn : Function
  A callback function to execute after the progress bar finishes auto-\nupdating. The function will be called with no arguments. This function will be ignored if\nduration is not specified since in that case the progress bar can only be stopped programmatically,\nso any required function should be called by the same code after it resets the progress bar.
  \n
- scope : Object
  The scope that is passed to the callback function (only applies when\nduration and fn are both passed).
  \n

Returns

Ext.ProgressBar
this
\n

wrapPrimaryEl( dom )private

...

Parameters

dom : Object
\n

Overrides: Ext.util.Renderable.wrapPrimaryEl

Defined By

Static Methods

addConfig( config )privatestatic

...

Parameters

config : Object
\n

addInheritableStatics( members )chainableprivatestatic

...

Parameters

members : Object
\n

addMember( name, member )chainableprivatestatic

...

Parameters

name : Object
\n
member : Object
\n

addMembers( members )chainablestatic

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( members ) : Ext.Basechainablestatic

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( xtype )chainableprivatestatic

...

Parameters

xtype : Object
\n

borrow( fromClass, members ) : Ext.Basechainableprivatestatic

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( alias, 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( 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( name, mixinClass )privatestatic

Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

name : Object
\n
mixinClass : Object
\n

onExtended( fn, scope )chainableprivatestatic

...

Parameters

fn : Object
\n
scope : Object
\n

override( members ) : Ext.Basechainabledeprecatedstatic

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( this, 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

added( this, container, pos, eOpts )

Fires after a Component had been added to a Container. ...

Fires after a Component had been added to a Container.

Available since: 3.4.0

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

afterrender( this, 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 postprocessed by any\nafterRender method defined for the Component.

Available since: 3.4.0

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforeactivate( this, 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

beforedeactivate( this, 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( this, eOpts )

Fires before the component is destroyed. ...

Fires before the component is destroyed. Return false from an event handler to stop the\ndestroy.

Available since: 1.1.0

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforehide( this, 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.

Available since: 1.1.0

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforerender( this, eOpts )

Fires before the component is rendered. ...

Fires before the component is rendered. Return false from an event handler to stop the\nrender.

Available since: 1.1.0

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforeshow( this, 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.

Available since: 1.1.0

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforestaterestore( this, state, 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( this, state, 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( this, The, 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( this, width, height, eOpts )

Fires one time - after the component has been laid out for the first time at its initial size. ...

Fires one time - after the component has been laid 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( this, 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( this, eOpts )

Fires after the component is destroyed. ...

Fires after the component is destroyed.

Available since: 1.1.0

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

disable( this, eOpts )

Fires after the component is disabled. ...

Fires after the component is disabled.

Available since: 1.1.0

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

enable( this, eOpts )

Fires after the component is enabled. ...

Fires after the component is enabled.

Available since: 1.1.0

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

focus( this, The, 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( this, eOpts )

Fires after the component is hidden. ...

Fires after the component is hidden. Fires after the component is hidden when calling the hide\nmethod.

Available since: 1.1.0

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

move( this, x, y, 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

removed( this, ownerCt, eOpts )

Fires when a component is removed from an Ext.container.Container ...

Fires when a component is removed from an Ext.container.Container

Available since: 3.4.0

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( this, eOpts )

Fires after the component markup is rendered. ...

Fires after the component markup is rendered.

Available since: 1.1.0

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

resize( this, width, height, oldWidth, oldHeight, eOpts )

Fires after the component is resized. ...

Fires after the component is resized. Note that this does not fire when the component is first laid out at its initial\nsize. To hook that point in the life cycle, 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( this, eOpts )

Fires after the component is shown when calling the show method. ...

Fires after the component is shown when calling the show method.

Available since: 1.1.0

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

staterestore( this, state, 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