Ext.chart.Chart

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

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

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

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

Available since: 2.3.0

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

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

The above is the same as:

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

Don't use it together with loader config.

Available since: 4.1.1

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

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

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

Defaults to: false

Available since: 4.0.0

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

Defaults to: false

Available since: 4.0.0

true to automatically show the component upon creation. This config option may only be used for floating components or components that use autoRender.

Defaults to: false

Available since: 2.3.0

Turn on autoSize support which will set the bounding div's size to the natural size of the contents.

Defaults to: false

Available since: 4.0.0

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

Defaults to: Ext.baseCSSPrefix + 'surface'

Available since: 4.0.0

Overrides: Ext.AbstractComponent.baseCls

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

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

border: 5,
style: {
    borderColor: 'red',
    borderStyle: 'solid'
}

To turn off the border, use border: false.

Available since: 4.0.0

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

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

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

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

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

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

Available since: 4.0.5

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

Defaults to: ''

Available since: 1.1.0

Defines the column width inside column layout.

Can be specified as a number or as a percentage.

Available since: 4.1.1

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

Available since: 4.0.0

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

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

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

Defaults to: 'draw'

Available since: 4.0.0

Overrides: Ext.AbstractComponent.componentLayout

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

Available since: 4.1.2

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

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

Notes:

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

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

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

Available since: 3.4.0

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

Available since: 3.4.0

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

Defaults to: "tl-bl?"

Available since: Ext JS 4.1.3

true to disable the component.

Defaults to: false

Available since: 2.3.0

CSS class to add when the Component is disabled.

Defaults to: 'x-item-disabled'

Available since: 4.0.0

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

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

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

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

Defaults to: false

Available since: 4.0.0

Overrides: Ext.AbstractComponent.draggable

Defines the priority order for which Surface implementation to use. The first one supported by the current environment will be used.

Defaults to: ['Svg', 'Vml']

Available since: 4.0.0

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

Components such as Windows and Menus are floating by default.

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

Floating Components as child items of a Container

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

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

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

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

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

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

Defaults to: false

Available since: 4.0.0

Overrides: Ext.AbstractComponent.floating

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

Defaults to: true

Available since: 4.0.0

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

Defaults to: false

Available since: 4.1.1

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

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

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

Available since: 4.0.0

The height of this component in pixels.

Available since: 4.0.0

true to hide the component.

Defaults to: false

Available since: 2.3.0

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

• '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. This is useful when a hidden Component must maintain measurable dimensions. Hiding using display results in a Component having zero dimensions.

Defaults to: 'display'

Available since: 1.1.0

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

Defaults to: ''

Available since: 3.4.0

The unique id of this component instance.

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

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

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

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

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

Defaults to an auto-assigned id.

Available since: 1.1.0

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

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

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

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

Available since: 3.4.0

Array of sprites or sprite config objects to add initially to the surface.

Available since: 4.1.1

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

DOM events from Ext JS Components

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

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

Available since: 1.1.0

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

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

Available since: 4.0.0

Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10' (top, right, bottom, left).

Available since: 4.0.0

Enables selecting a region on chart. True to enable any selection, 'horizontal' or 'vertical' to restrict the selection to X or Y axis.

The mask in itself will do nothing but fire 'select' event. See Ext.chart.Mask for example.

Available since: 4.1.0

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

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

Available since: 4.0.0

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

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

Available since: 4.0.0

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

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

Available since: 4.0.0

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

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

Available since: 4.0.0

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

Defaults to: ''

Available since: 2.3.0

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

Available since: 4.1.0

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

Available since: 4.1.0

Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10' (top, right, bottom, left).

Available since: 4.0.0

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

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

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

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

By using config object with ptype:

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

Or with just a ptype:

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

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

Available since: 2.3.0

Defines the region inside border layout.

Possible values:

• 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. There must be a component with region: "center" in every border layout.

Available since: 4.1.1

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

• id
• ui
• uiCls
• baseCls
• componentCls
• frame

See renderSelectors and childEls for usage examples.

Available since: 4.0.7

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

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

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

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

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

Available since: 4.0.0

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

Notes:

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

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

See also: render.

Available since: 2.3.0

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

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

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

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

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

Available since: 4.0.0

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

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

Available since: 4.0.0

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

Defaults to: 'all'

Available since: 4.0.0

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

Defaults to: 100

Available since: 4.0.6

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

Defaults to: 'sides'

Available since: 4.0.0

Number of pixels to offset the shadow.

Available since: 4.1.0

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

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

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

Defaults to: 3

Available since: 4.1.0

Overrides: Ext.AbstractComponent.shrinkWrap

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

See stateful for an explanation of saving and restoring object state.

Available since: 4.0.0

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

See stateful for an explanation of saving and restoring state.

Available since: 4.0.0

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

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

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

To set the state provider for the current page:

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

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

}));

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

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

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

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

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

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

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

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

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

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

Defaults to: false

Available since: 4.0.0

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

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

Available since: 1.1.0

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

Defaults to: 'x-html'

Available since: 4.0.0

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

Defaults to: false

Available since: 4.0.0

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

Defaults to: true

Available since: 4.0.0

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

Available since: 3.4.0

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

Defaults to: 'overwrite'

Available since: 3.4.0

A UI style for a component.

Defaults to: 'default'

Available since: 4.0.0

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

Defaults to: []

Available since: 4.0.0

The width of this component in pixels.

Available since: 4.0.0

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

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

But by using xtype, the above becomes:

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

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

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

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

 var text1 = Ext.create('Ext.form.field.Text', {
     fieldLabel: 'Foo'
 });

 // or alternatively:

 var text1 = Ext.widget({
     xtype: 'textfield',
     fieldLabel: 'Foo'
 });

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

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

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

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

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

See Ext.enums.Widget for list of all available xtypes.

Available since: 2.3.0

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

Defaults to: false

Available since: 4.1.0

Defaults to: true

Available since: 4.0.0

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

Defaults to: false

Available since: 4.1.0

Defaults to: []

Available since: 4.0.0

Defaults to: []

Available since: 4.1.0

The number of component layout calls made on this object.

Defaults to: 0

Available since: 4.0.3

Defaults to: {}

Available since: 4.1.1

Defaults to: 'autocomponent'

Available since: 4.1.2

Defaults to: false

Available since: 4.1.0

Indicates whether or not the component can be dragged.

Defaults to: false

Available since: 4.0.0

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

Defaults to: 0

Available since: 4.1.1

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

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

These differences are abstracted away by the up method.

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

See floating and zIndexManager

Available since: 4.0.0

Defaults to: Ext.baseCSSPrefix + 'frame'

Available since: 4.1.0

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

Available since: 4.1.0

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

Available since: 4.1.0

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

Available since: 4.1.0

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

Available since: 4.1.0

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

Defaults to: {}

Available since: 4.1.0

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

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

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

Available since: 4.0.0

• top : Number (optional)

  The width of the top framing element in pixels.

  Defaults to: 0

• right : Number (optional)

  The width of the right framing element in pixels.

  Defaults to: 0

• bottom : Number (optional)

  The width of the bottom framing element in pixels.

  Defaults to: 0

• left : Number (optional)

  The width of the left framing element in pixels.

  Defaults to: 0

• width : Number (optional)

  The total width of the left and right framing elements in pixels.

  Defaults to: 0

• height : Number (optional)

  The total height of the top and right bottom elements in pixels.

  Defaults to: 0

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

Available since: 4.1.0

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>" style="background-position: {tl}; padding-left: {frameWidth}px" 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>" style="background-position: {tr}; padding-right: {frameWidth}px" role="presentation"></tpl>', '<div id="{fgid}TC" class="{frameCls}-tc {baseCls}-tc {baseCls}-{ui}-tc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tc</tpl>" style="background-position: {tc}; height: {frameWidth}px" 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>" style="background-position: {ml}; padding-left: {frameWidth}px" 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>" style="background-position: {mr}; padding-right: {frameWidth}px" role="presentation"></tpl>', '<div id="{fgid}MC" class="{frameCls}-mc {baseCls}-mc {baseCls}-{ui}-mc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mc</tpl>" 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>" style="background-position: {bl}; padding-left: {frameWidth}px" 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>" style="background-position: {br}; padding-right: {frameWidth}px" role="presentation"></tpl>', '<div id="{fgid}BC" class="{frameCls}-bc {baseCls}-bc {baseCls}-{ui}-bc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bc</tpl>" style="background-position: {bc}; height: {frameWidth}px" role="presentation"></div>', '<tpl if="right"></div></tpl>', '<tpl if="left"></div></tpl>', '</tpl>', '{%this.renderDockedItems(out,values,1);%}']

Available since: 4.1.0

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

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

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

Available since: 4.1.0

Defaults to: []

Available since: 4.1.1

Defaults to: {}

Available since: 4.1.1

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

Defaults to: true

Available since: 4.0.0

Defaults to: true

Available since: 4.1.1

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

Defaults to: true

Available since: 4.0.0

Defaults to: 0

Available since: 4.1.0

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

Defaults to: true

Available since: 4.0.0

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

Available since: 4.1.2

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

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

These differences are abstracted away by the up method.

Note: to access items within the Container see itemId.

Available since: 2.3.0

Indicates whether or not the component has been rendered.

Defaults to: false

Available since: 1.1.0

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

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); // dependent on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Available since: 4.0.0

The Surface instance managed by this component.

Available since: 4.1.1

Defaults to: 0

Available since: 4.0.0

Only present for floating Components after they have been rendered.

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

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

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

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

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

See floating and zIndexParent

Available since: 4.0.0

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

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

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

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

See floating and zIndexManager

Available since: 4.1.0

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

Available since: 4.1.0

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

Available since: 2.3.0

Parameters

• cls : String/String[]

  The CSS class name to add.

Returns

• Ext.Component

  Returns the Component to allow method chaining.

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

Available since: 4.0.0

Parameters

• cls : String/String[]

  The CSS class name to add.

Returns

• Ext.Component

  Returns the Component to allow method chaining.

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

Available since: 4.0.0

Parameters

• classes : String/String[]

  A string or an array of strings to add to the uiCls.

• skip : Object

  (Boolean) skip true to skip adding it to the class and do it later (via the return).

Adds the specified events to the list of events which this Observable may fire.

Available since: 1.1.0

Parameters

• eventNames : Object/String...

  Either an object with event names as properties with a value of true. For example:

  this.addEvents({
      storeloaded: true,
      storecleared: true
  });
  

  Or any number of event names as separate parameters. For example:

  this.addEvents('storeloaded', 'storecleared');
  

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

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

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

Available since: 4.1.0

Appends an event handler to this object. For example:

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

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

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

One can also specify options for each event handler separately:

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

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

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

Available since: 1.1.0

Parameters

• eventName : String/Object

  The name of the event to listen for. May also be an object who's property names are event names.

• fn : Function (optional)

  The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to fireEvent plus the options parameter described below.

• scope : Object (optional)

  The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

• options : Object (optional)

  An object containing handler configuration.

  Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

  This object may contain any of the following properties:

  • scope : Object

    The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

  • delay : Number

    The number of milliseconds to delay the invocation of the handler after the event fires.

  • single : Boolean

    True to add a handler to handle just the next firing of the event, and then remove itself.

  • buffer : Number

    Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

  • target : Ext.util.Observable

    Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

  • element : String

    This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

    This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

      new Ext.panel.Panel({
          title: 'The title',
          listeners: {
              click: this.handlePanelClick,
              element: 'body'
          }
      });
    

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

    Combining Options

    Using the options argument, it is possible to combine different types of listeners:

    A delayed, one-time listener.

    myPanel.on('hide', this.handleClick, this, {
        single: true,
        delay: 100
    });
    

    Defaults to: false

Returns

• Object

  Only when the destroyable option is specified.

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

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

  And when those listeners need to be removed:

  Ext.destroy(this.btnListeners);
  

  or

  this.btnListeners.destroy();
  

Overrides: Ext.AbstractComponent.addListener

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

Available since: 4.0.0

Parameters

• item : Ext.util.Observable/Ext.Element

  The item to which to add a listener/listeners.

• ename : Object/String

  The event name, or an object containing event name properties.

• fn : Function (optional)

  If the ename parameter was an event name, this is the handler function.

• scope : Object (optional)

  If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

• options : Object (optional)

  If the ename parameter was an event name, this is the addListener options.

Returns

• Object

  Only when the destroyable option is specified.

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

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

  And when those listeners need to be removed:

  Ext.destroy(this.btnListeners);
  

  or

  this.btnListeners.destroy();
  

Available since: 4.0.0

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

Available since: 4.1.0

Parameters

• state : Object

  The state object.

• propName : String

  The name of the property on this object to save.

• value : String (optional)

  The value of the state property (defaults to this[propName]).

Returns

• Boolean

  The state object or a new object if state was null and the property was saved.

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

Available since: 4.0.0

Parameters

• events : String/String[]

  The event name or an array of event names.

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

Available since: 4.0.0

Parameters

• ui : String

  The UI to remove from the element.

Method which adds a specified UI to the components element.

Available since: 4.0.0

Available since: 4.0.0

Parameters

• x : Object
• y : Object

Available since: 4.1.0

Parameters

• width : Object
• height : Object

Invoked after the Component has been hidden.

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

Available since: 4.0.0

Parameters

• callback : Function (optional)
• scope : Object (optional)

Template method called after a Component has been positioned.

Available since: 4.0.0

Parameters

• x : Number
• y : Number

Overrides: Ext.AbstractComponent.afterSetPosition

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

Gets passed the same parameters as show.

Available since: 4.0.0

Parameters

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

Aligns this floating Component to the specified element

Available since: 4.0.0

Parameters

• element : Ext.Component/Ext.Element/HTMLElement/String

  The element or Ext.Component to align to. If passing a component, it must be a component instance. If a string id is passed, it will be used as an element id.

• position : String (optional)

  The position to align to (see Ext.Element.alignTo for more details).

  Defaults to: "tl-bl?"

• offsets : Number[] (optional)

  Offset the positioning by [x, y]

Returns

• Ext.Component

  this

• process the passed fx configuration.

Available since: 4.0.0

Parameters

• config : Object

Performs custom animation on this object.

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

Animating a Component

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

• x - The Component's page X position in pixels.

• y - The Component's page Y position in pixels

• left - The Component's left value in pixels.

• top - The Component's top value in pixels.

• width - The Component's width value in pixels.

• width - The Component's width value in pixels.

• dynamic - Specify as true to update the Component's layout (if it is a Container) at every frame of the animation. Use sparingly as laying out on every intermediate size change is an expensive operation.

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

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

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

Available since: 4.0.0

Parameters

• config : Object

  Configuration for Ext.fx.Anim. Note that the to config is required.

Returns

• Object

  this

Overrides: Ext.util.Animate.animate

Sets references to elements inside the component.

Available since: 4.1.0

Parameters

• el : Object
• id : Object

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

Available since: 4.1.0

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

Available since: 4.0.0

Parameters

• state : Object

  The state

Available since: 4.0.0

Template method to do any pre-blur processing.

Available since: 4.1.0

Parameters

• e : Ext.EventObject

  The event object

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

Available since: 4.0.0

Parameters

• adjWidth : Number

  The box-adjusted width that was set.

• adjHeight : Number

  The box-adjusted height that was set.

Invoked before the Component is destroyed.

Available since: 4.0.0

Template method to do any pre-focus processing.

Available since: 4.1.2

Parameters

• e : Ext.EventObject

  The event object

Available since: 4.1.0

Overrides: Ext.util.Renderable.beforeRender

Template method called before a Component is positioned.

Available since: 4.1.0

Parameters

• x : Object
• y : Object
• animate : Object

Overrides: Ext.AbstractComponent.beforeSetPosition

Invoked before the Component is shown.

Available since: 4.0.0

Binds listeners for this component to the store. By default it will add anything bound by the getStoreListeners method, however it can be overridden in a subclass to provide any more complicated handling.

Available since: 4.1.0

Parameters

• store : Ext.data.AbstractStore

  The store to bind to

Available since: 4.0.0

Returns

• Ext.Component

  this

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

Available since: 3.4.0

Parameters

• fn : Function

  The function to call

• scope : Object (optional)

  The scope of the function. Defaults to current node.

• args : Array (optional)

  The args to call the function with. Defaults to passing the current component.

Returns

• Ext.Component

  this

Available since: 4.1.0

Parameters

• left : Object
• top : Object

Call the original method that was previously overridden with override

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callOverridden();

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Available since: 4.0.0

Parameters

• args : Array/Arguments

  The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

• Object

  Returns the result of calling the overridden method

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

 Ext.define('My.Base', {
     constructor: function (x) {
         this.x = x;
     },

     statics: {
         method: function (x) {
             return x;
         }
     }
 });

 Ext.define('My.Derived', {
     extend: 'My.Base',

     constructor: function () {
         this.callParent([21]);
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

 Ext.define('My.DerivedOverride', {
     override: 'My.Derived',

     constructor: function (x) {
         this.callParent([x*2]); // calls original My.Derived constructor
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // now alerts 42

This also works with static methods.

 Ext.define('My.Derived2', {
     extend: 'My.Base',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Base.method
         }
     }
 });

 alert(My.Base.method(10);     // alerts 10
 alert(My.Derived2.method(10); // alerts 20

Lastly, it also works with overridden static methods.

 Ext.define('My.Derived2Override', {
     override: 'My.Derived2',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Derived2.method
         }
     }
 });

 alert(My.Derived2.method(10); // now alerts 40

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

Available since: 4.0.0

Parameters

• args : Array/Arguments

  The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

• Object

  Returns the result of calling the parent method

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

Consider:

 Ext.define('Ext.some.Class', {
     method: function () {
         console.log('Good');
     }
 });

 Ext.define('Ext.some.DerivedClass', {
     method: function () {
         console.log('Bad');

         // ... logic but with a bug ...

         this.callParent();
     }
 });

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

 Ext.define('App.paches.DerivedClass', {
     override: 'Ext.some.DerivedClass',

     method: function () {
         console.log('Fixed');

         // ... logic but with bug fixed ...

         this.callSuper();
     }
 });

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

Available since: Ext JS 4.1.3

Parameters

• args : Array/Arguments

  The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

• Object

  Returns the result of calling the superclass method

Cancel any deferred focus on this component

Available since: 4.1.0

Center this Component in its container.

Available since: 4.0.0

Returns

• Ext.Component

  this

Removes all listeners for this object including the managed listeners

Available since: 4.0.0

Removes all managed listeners for this object.

Available since: 4.0.0

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

Available since: 2.3.0

Parameters

• overrides : Object

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

Returns

• Ext.Component

  clone The cloned copy of this component

Available since: 4.1.1

Available since: 4.0.0

Parameters

• plugin : Object

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

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

Available since: 4.0.5

Continue to fire event.

Available since: 4.0.7

Parameters

• eventName : String
• args : Array
• bubbles : Boolean

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

Available since: 4.1.0

Parameters

• pos : Object
• withUnits : Object

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

Available since: 4.0.0

Parameters

• newName : Object
• beginEnd : Array (optional)

  The caller can specify on which indices to slice

Returns

• Function

Create the Surface instance. Resolves the correct Surface implementation to instantiate based on the 'enginePriority' config. Once the Surface instance is created you can use the handle to that instance to add sprites. For example:

drawComponent.surface.add(sprite);

Available since: 4.0.0

Available since: 4.0.0

Disable the component.

Available since: 1.1.0

Parameters

• silent : Boolean (optional)

  Passing true will suppress the disable event from being fired.

  Defaults to: false

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

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

Available since: 4.1.0

Parameters

• out : Object
• values : Object

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

Available since: 4.1.0

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

Available since: 4.0.0

Returns

• Ext.container.Container

  this

Moves this floating Component into a constrain region.

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

An alternative constraint may be passed.

Available since: 4.0.0

Parameters

• constrainTo : String/HTMLElement/Ext.Element/Ext.util.Region (optional)

  The Element or Region into which this Component is to be constrained. Defaults to the element into which this floating Component was rendered.

Available since: 4.1.0

Parameters

• out : Object
• renderData : Object

Available since: 4.1.0

Parameters

• out : Object
• renderData : Object
• after : Object

Enable the component

Available since: 1.1.0

Parameters

• silent : Boolean (optional)

  Passing true will suppress the enable event from being fired.

  Defaults to: false

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

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

Example:

Ext.define('Ext.overrides.form.field.Base', {
    override: 'Ext.form.field.Base',

    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent: function () {
        this.callParent();
        this.enableBubble('change');
    }
});

var myForm = Ext.create('Ext.form.Panel', {
    title: 'User Details',
    items: [{
        ...
    }],
    listeners: {
        change: function() {
            // Title goes red if form has been modified.
            myForm.header.setStyle('color', 'red');
        }
    }
});

Available since: 3.4.0

Parameters

• eventNames : String/String[]

  The event name to bubble, or an Array of event names.

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

Available since: 4.1.0

Parameters

• runLayout : Boolean (optional)

  True to run the component's layout.

  Defaults to: false

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

See also the up method.

Available since: 2.3.0

Parameters

• fn : Function

  The custom function to call with the arguments (container, this component).

Returns

• Ext.container.Container

  The first Container for which the custom function returns true

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

See also the up method.

Available since: 2.3.0

Parameters

• xtype : String/Ext.Class

  The xtype string for a component, or the class of the component directly

Returns

• Ext.container.Container

  The first Container which matches the given xtype or class

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

Available since: 4.1.0

Parameters

• containerIdx : Number

  The index into the Container items of this Component.

Available since: 4.1.0

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

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

Available since: 1.1.0

Parameters

• eventName : String

  The name of the event to fire.

• args : Object...

  Variable number of parameters are passed to handlers.

Returns

• Boolean

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

Available since: 4.0.0

Try to focus this component.

Available since: 1.1.0

Parameters

• selectText : Boolean (optional)

  If applicable, true to also select the text in this component

• delay : Boolean/Number (optional)

  Delay the focus this number of milliseconds (true for 10 milliseconds).

Returns

• Ext.Component

  The focused Component. Usually this Component. Some Containers may delegate focus to a descendant Component (Windows can do this through their defaultFocus config option.

Forces this component to redo its componentLayout.

Available since: 4.0.2

Deprecate 5.0

Available since: 4.0.0

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

Available since: 4.0.0

Returns

• Ext.fx.Anim/Boolean

  Anim if element has active effects, else false

Available since: 4.1.2

Parameters

• target : Object

Available since: 4.0.0

Gets the current box measurements of the component's underlying element.

Available since: 4.0.0

Parameters

• local : Boolean (optional)

  If true the element's left and top are returned instead of page XY.

  Defaults to: false

Returns

• Object

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

Gets the bubbling parent for an Observable

Available since: 4.0.7

Returns

• Ext.util.Observable

  The bubble parent. null is returned if no bubble target exists

The up() method uses this to find the immediate owner.

Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.

Available since: 3.4.0

Returns

• Ext.container.Container

  the Container which owns this Component.

Overrides: Ext.AbstractComponent.getBubbleTarget

Available since: 4.1.0

Available since: 4.1.0

Parameters

• cls : Object

Available since: 4.0.0

Available since: 4.1.0

Parameters

• name : Object

Gets the x/y offsets to constrain this float

Available since: 4.0.1

Parameters

• constrainTo : String/HTMLElement/Ext.Element/Ext.util.Region (optional)

  The Element or Region into which this Component is to be constrained.

Returns

• Number[]

  The x/y constraints

Available since: 4.0.0

Available since: 4.0.0

Retrieves the top level element representing this component.

Available since: 1.1.0

Returns

• Ext.dom.Element

Overrides: Ext.AbstractComponent.getEl

Available since: 4.1.0

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

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

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

Available since: 4.1.0

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

Available since: 4.1.0

Available since: 4.1.0

Parameters

• frameInfo : Object

Available since: 4.1.0

Parameters

• table : Object

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

Available since: 4.0.0

Returns

• Number

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

Available since: 1.1.0

Returns

• String

Overrides: Ext.AbstractComponent.getId

Returns the initial configuration passed to constructor when instantiating this class.

Available since: 4.1.0

Parameters

• name : String (optional)

  Name of the config option to return.

Returns

• Object/Mixed

  The full config object or a single config value when name parameter specified.

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

Available since: 4.1.0

Parameters

• position : String/Number/Ext.dom.Element/HTMLElement

  Index, element id or element you want to put this component before.

Returns

• HTMLElement

  DOM element that you can use in the insertBefore

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

Available since: 4.0.0

Returns

• String

Gets the Ext.ComponentLoader for this Component.

Available since: 4.0.0

Returns

• Ext.ComponentLoader

  The loader instance, null if it doesn't exist.

Available since: 4.1.0

Include margins

Available since: 4.0.0

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

Available since: 4.1.0

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

Available since: 4.0.0

Parameters

• pluginId : String

Returns

• Ext.AbstractPlugin

  plugin instance.

Gets the current XY position of the component's underlying element.

Available since: 4.0.0

Parameters

• local : Boolean (optional)

  If true the element's left and top are returned instead of page XY.

  Defaults to: false

Returns

• Number[]

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

Deprecate 5.0

Available since: 4.0.0

Available since: 4.0.0

Available since: 4.1.0

Deprecate 5.0

Available since: 4.0.0

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

Available since: 4.0.0

Returns

• Object

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

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

Available since: 4.1.0

Parameters

• ownerCtSizeModel : Object

Returns

• Object

  The size model for this component.

  • width : Ext.layout.SizeModel

    The size model for the width.

  • height : Ext.layout.SizeModel

    The size model for the height.

The supplied default state gathering method for the AbstractComponent class.

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

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

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

Available since: 4.0.0

Returns

• Object

Overrides: Ext.state.Stateful.getState

Gets the state id for this object.

Available since: 4.0.0

Returns

• String

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

Gets the current store instance.

Available since: 4.1.0

Returns

• Ext.data.AbstractStore

  The store, null if one does not exist.

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

Available since: 4.1.0

Parameters

• cls : Object

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

Available since: 4.0.0

Available since: 4.0.0

Parameters

• name : Object

Deprecate 5.0

Available since: 4.0.0

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

Available since: 4.0.0

Returns

• Number

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

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

Available since: 2.3.0

Returns

• String

  The xtype

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

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

Example usage:

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

Available since: 2.3.0

Returns

• String

  The xtype hierarchy string

Available since: 4.1.2

Parameters

• e : Object

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

Available since: 4.0.0

Returns

• Ext.fx.Anim/Boolean

  Anim if element has active effects, else false

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

Available since: 4.1.0

Parameters

• className : String

  The CSS class to check for.

Returns

• Boolean

  true if the class exists, else false.

Available since: 4.1.0

Parameters

• config : Object

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

Available since: 1.1.0

Parameters

• eventName : String

  The name of the event to check for

Returns

• Boolean

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

Checks if there is currently a specified uiCls.

Available since: 4.0.0

Parameters

• cls : String

  The cls to check.

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

Available since: 1.1.0

Parameters

• animateTarget : String/Ext.Element/Ext.Component (optional)

  only valid for floating Components such as Windows or ToolTips, or regular Components which have been configured with floating: true.. The target to which the Component should animate while hiding.

  Defaults to: null

• callback : Function (optional)

  A callback function to call after the Component is hidden.

• scope : Object (optional)

  The scope (this reference) in which the callback is executed. Defaults to this Component.

Returns

• Ext.Component

  this

Initialize configuration for this class. a typical example:

Ext.define('My.awesome.Class', {
    // The default config
    config: {
        name: 'Awesome',
        isAwesome: true
    },

    constructor: function(config) {
        this.initConfig(config);
    }
});

var awesome = new My.awesome.Class({
    name: 'Super Awesome'
});

alert(awesome.getName()); // 'Super Awesome'

Available since: 4.0.0

Parameters

• config : Object

Returns

• Ext.Base

  this

Available since: 4.1.0

Parameters

• container : Object

Available since: 4.0.0

Initialize any events on this component

Available since: 4.0.0

Available since: 4.1.0

Poke in a reference to applyRenderTpl(frameInfo, out)

Available since: 4.1.0

Parameters

• table : Object

Available since: 4.0.0

Parameters

• plugin : Object

Initialized the renderData to be used when rendering the renderTpl.

Available since: 4.1.0

Returns

• Object

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

Initializes the renderTpl.

Available since: 4.1.0

Returns

• Ext.XTemplate

  The renderTpl XTemplate instance.

Available since: 4.0.0

Parameters

• resizable : Object

Initializes the state of the object upon construction.

Available since: 4.0.0

Converts style definitions to String.

Available since: 4.0.0

Parameters

• targetEl : Object

Returns

• String

  A CSS style string with style, padding, margin and border.

Tests whether this Component matches the selector string.

Available since: 4.0.0

Parameters

• selector : String

  The selector string to test against.

Returns

• Boolean

  true if this Component matches the selector.

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

Available since: 4.1.0

Available since: 4.1.0

Parameters

• ancestor : Object

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

Available since: 4.0.0

Parameters

• container : Ext.Container

Returns

• Boolean

  true if the component is the descendant of a particular container, otherwise false.

Method to determine whether this Component is currently disabled.

Available since: 4.0.0

Returns

• Boolean

  the disabled state of this Component.

Method to determine whether this Component is draggable.

Available since: 4.0.0

Returns

• Boolean

  the draggable state of this component.

Method to determine whether this Component is droppable.

Available since: 4.0.0

Returns

• Boolean

  the droppable state of this component.

Method to determine whether this Component is floating.

Available since: 4.0.0

Returns

• Boolean

  the floating state of this component.

Available since: 4.1.0

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

Available since: 4.0.0

Returns

• Boolean

  the hidden state of this Component.

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

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

Available since: 4.1.0

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

Available since: 4.1.0

Returns

• Boolean

  true layout of this component is suspended.

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 determine whether this Component is truly visible to the user.

  Generally, to determine whether a Component is hidden, the no argument form is needed. For example when creating dynamically laid out UIs in a hidden Container before showing them.

  Defaults to: false

Returns

• Boolean

  true if this component is visible, false otherwise.

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

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

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

Example usage:

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

Available since: 2.3.0

Parameters

• xtype : String

  The xtype to check for this Component

• shallow : Boolean (optional)

  true to check whether this Component is directly of the specified xtype, false to check whether this Component is descended from the xtype.

  Defaults to: false

Returns

• Boolean

  true if this component descends from the specified xtype, false otherwise.

Available since: 4.0.0

Parameters

• dom : Object

Available since: 4.1.0

Shorthand for addManagedListener.

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

Available since: 4.0.2

Parameters

• item : Ext.util.Observable/Ext.Element

  The item to which to add a listener/listeners.

• ename : Object/String

  The event name, or an object containing event name properties.

• fn : Function (optional)

  If the ename parameter was an event name, this is the handler function.

• scope : Object (optional)

  If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

• options : Object (optional)

  If the ename parameter was an event name, this is the addListener options.

Returns

• Object

  Only when the destroyable option is specified.

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

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

  And when those listeners need to be removed:

  Ext.destroy(this.btnListeners);
  

  or

  this.btnListeners.destroy();
  

Shorthand for removeManagedListener.

Removes listeners that were added by the mon method.

Available since: 4.0.2

Parameters

• item : Ext.util.Observable/Ext.Element

  The item from which to remove a listener/listeners.

• ename : Object/String

  The event name, or an object containing event name properties.

• fn : Function (optional)

  If the ename parameter was an event name, this is the handler function.

• scope : Object (optional)

  If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

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

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

Available since: 4.0.0

Parameters

• selector : String (optional)

  A ComponentQuery selector to filter the following nodes.

Returns

• Ext.Component

  The next node (or the next node which matches the selector). Returns null if there is no matching node.

Returns the next sibling of this Component.

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

May also be referred to as next()

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

Available since: 4.0.0

Parameters

• selector : String (optional)

  A ComponentQuery selector to filter the following items.

Returns

• Ext.Component

  The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling.

Shorthand for addListener.

Appends an event handler to this object. For example:

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

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

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

One can also specify options for each event handler separately:

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

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

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

Available since: 1.1.0

Parameters

• eventName : String/Object

  The name of the event to listen for. May also be an object who's property names are event names.

• fn : Function (optional)

  The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to fireEvent plus the options parameter described below.

• scope : Object (optional)

  The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

• options : Object (optional)

  An object containing handler configuration.

  Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

  This object may contain any of the following properties:

  • scope : Object

    The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

  • delay : Number

    The number of milliseconds to delay the invocation of the handler after the event fires.

  • single : Boolean

    True to add a handler to handle just the next firing of the event, and then remove itself.

  • buffer : Number

    Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

  • target : Ext.util.Observable

    Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

  • element : String

    This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

    This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

      new Ext.panel.Panel({
          title: 'The title',
          listeners: {
              click: this.handlePanelClick,
              element: 'body'
          }
      });
    

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

    Combining Options

    Using the options argument, it is possible to combine different types of listeners:

    A delayed, one-time listener.

    myPanel.on('hide', this.handleClick, this, {
        single: true,
        delay: 100
    });
    

    Defaults to: false

Returns

• Object

  Only when the destroyable option is specified.

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

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

  And when those listeners need to be removed:

  Ext.destroy(this.btnListeners);
  

  or

  this.btnListeners.destroy();
  

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