Ext.AbstractComponent

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

This defaults to true for the Window class.

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: Ext 2

The base CSS class to apply to this components'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: 'x-component'

Available since: 4.0.0

Specifies the border 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'.

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

Available since: 4.0.0

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: Ext 3

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

Available since: Ext 3

True to disable the component.

Defaults to: false

Available since: Ext 2

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

Defaults to: 'x-item-disabled'

Available since: 4.0.0

Allows the component to be dragged.

Defaults to: false

Available since: 4.0.0

Create the Component as a floating and use absolute positioning.

The z-index of floating Components is handled by a ZIndexManager. If you simply render a floating Component into the DOM, it will be managed by the global WindowManager.

If you include a floating Component as a child item of a Container, then upon render, ExtJS will seek an ancestor floating Component to house a new ZIndexManager instance to manage its descendant floaters. If no floating ancestor can be found, the global WindowManager will be used.

When a floating Component which has a ZindexManager managing descendant floaters is destroyed, those descendant floaters will also be destroyed.

Defaults to: false

Available since: 4.0.0

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: Ext 2

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: Ext 1

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: Ext 3

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: Ext 1

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: Ext 3

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

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

Available since: 4.0.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: Ext 2

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

Available since: 4.0.0

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

Available since: Ext 2

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: Ext JS 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 renderes 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 render also.

Available since: Ext 2

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 ExtJS and 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.

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: Ext 1

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

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: Ext 3

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: Ext 3

A set style for a component. Can be a string or an Array of multiple strings (UIs)

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

The xtype configuration option can be used to optimize Component creation and rendering. It serves as a shortcut to the full componet name. For example, the component Ext.button.Button has an xtype of button.

You can define your own xtype on a custom component by specifying the alias config option with a prefix of widget. For example:

Ext.define('PressMeButton', {
    extend: 'Ext.button.Button',
    alias: 'widget.pressmebutton',
    text: 'Press Me'
})

Any Component can be created implicitly as an object config with an xtype specified, allowing it to be declared and passed into the rendering pipeline without actually being instantiated as an object. Not only is rendering deferred, but the actual creation of the object itself is also deferred, saving memory and resources until they are actually needed. In complex, nested layouts containing many Components, this can make a noticeable improvement in performance.

// Explicit creation of contained Components:
var panel = new Ext.Panel({
   ...
   items: [
      Ext.create('Ext.button.Button', {
         text: 'OK'
      })
   ]
};

// Implicit creation using xtype:
var panel = new Ext.Panel({
   ...
   items: [{
      xtype: 'button',
      text: 'OK'
   }]
};

In the first example, the button will always be created immediately during the panel's initialization. With many added Components, this approach could potentially slow the rendering of the page. In the second example, the button will not be created or rendered until the panel is actually displayed in the browser. If the panel is never displayed (for example, if it is a tab that remains hidden) then the button will never be created and will never consume any resources whatsoever.

Available since: Ext 2

The number of component layout calls made on this object.

Defaults to: 0

Available since: 4.0.3

Read-only property indicating whether or not the component can be dragged

Defaults to: false

Available since: 4.0.0

Defaults to: Ext.baseCSSPrefix + 'frame'

Available since: 4.0.0

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

Available since: 4.0.2

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

Available since: 4.0.5

Read-only property indicating 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:

Available since: 4.0.0

• top : Number

  The width of the top framing element in pixels.

• right : Number

  The width of the right framing element in pixels.

• bottom : Number

  The width of the bottom framing element in pixels.

• left : Number

  The width of the left framing element in pixels.

Defaults to: ['<table><tbody>', '<tpl if="top">', '<tr>', '<tpl if="left"><td id="{fgid}TL" class="{frameCls}-tl {baseCls}-tl {baseCls}-{ui}-tl<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tl</tpl></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 if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tc</tpl></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 if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tr</tpl></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 if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-ml</tpl></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 if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mc</tpl></tpl>" style="background-position: 0 0;" role="presentation"></td>', '<tpl if="right"><td id="{fgid}MR" class="{frameCls}-mr {baseCls}-mr {baseCls}-{ui}-mr<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mr</tpl></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 if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bl</tpl></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 if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bc</tpl></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 if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-br</tpl></tpl>" style="background-position: {br}; padding-left: {frameWidth}px" role="presentation"></td></tpl>', '</tr>', '</tpl>', '</tbody></table>']

Available since: 4.0.0

Defaults to: ['<tpl if="top">', '<tpl if="left"><div id="{fgid}TL" class="{frameCls}-tl {baseCls}-tl {baseCls}-{ui}-tl<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tl</tpl></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 if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tr</tpl></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 if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tc</tpl></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 if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-ml</tpl></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 if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mr</tpl></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 if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mc</tpl></tpl>" role="presentation"></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 if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bl</tpl></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 if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-br</tpl></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 if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bc</tpl></tpl>" style="background-position: {bc}; height: {frameWidth}px" role="presentation"></div>', '<tpl if="right"></div></tpl>', '<tpl if="left"></div></tpl>', '</tpl>']

Available since: 4.0.0

End Definitions

Defaults to: true

Available since: 4.0.0

Flag set by the container layout to which this Component is added. If the layout manages this Component's height, it sets the value to 1. If it does NOT manage the height, it sets it to 2. If the layout MAY affect the height, but only if the owning Container has a fixed height, this is set to 0.

Available since: 4.0.2

Flag set by the container layout to which this Component is added. If the layout manages this Component's width, it sets the value to 1. If it does NOT manage the width, it sets it to 2. If the layout MAY affect the width, but only if the owning Container has a fixed width, this is set to 0.

Available since: 4.0.2

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 its 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: false

Available since: 4.0.0

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

Note: to access items within the Container see itemId.

Available since: Ext 2

Read-only property indicating whether or not the component has been rendered.

Defaults to: false

Available since: Ext 1

Defaults to: /\s+/

Available since: 4.0.0

Defaults to: /^\s+|\s+$/g

Available since: 4.0.0

Defaults to: 0

Available since: 4.0.0

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

Available since: 4.0.5

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

Available since: Ext 2

Parameters

• cls : 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

  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

• cls : 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)

Appends an event handler to this object.

Available since: 4.0.0

Parameters

• eventName : String

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

• fn : Function

  The method the event invokes. 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 : 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'
        }
    });
    

  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
  });
  

  Attaching multiple handlers in 1 call

  The method also allows for a single argument to be passed which is a config object containing properties which specify multiple 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}
  });
  

Overrides: Ext.util.Observable.addListener

Available since: 4.0.0

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

Parameters

• force : Object

Occurs after componentLayout is run.

Available since: 4.0.0

Parameters

• adjWidth : Number

  The box-adjusted width that was set

• adjHeight : Number

  The box-adjusted height that was set

• isSetSize : Boolean

  Whether or not the height/width are stored on the component permanently

• callingContainer : Ext.Component

  Container requesting the layout. Only used when isSetSize is false.

Available since: 4.0.0

Perform custom animation on this object.

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

The sole parameter is an object which specifies start property values, end property values, and properties which describe the timeline. Of the properties listed below, only to is mandatory.

Properties include

• from
  An object which specifies start values for the properties being animated. If not supplied, properties are animated from current settings. The actual properties which may be animated depend upon ths object being animated. See the sections below on Element and Component animation.
• to
  An object which specifies end values for the properties being animated.
• duration
  The duration in milliseconds for which the animation will run.
• easing
  A string value describing an easing type to modify the rate of change from the default linear to non-linear. Values may be one of:

  • ease
  • easeIn
  • easeOut
  • easeInOut
  • backIn
  • backOut
  • elasticIn
  • elasticOut
  • bounceIn
  • bounceOut
• keyframes
  This is an object which describes the state of animated properties at certain points along the timeline. it is an object containing properties who's names are the percentage along the timeline being described and who's values specify the animation state at that point.
• listeners
  This is a standard listeners configuration object which may be used to inject behaviour at either the beforeanimate event or the afteranimate event.

Animating an Element

• x
  The page X position in pixels.
• y
  The page Y position in pixels
• left
  The element's CSS left value. Units must be supplied.
• top
  The element's CSS top value. Units must be supplied.
• width
  The element's CSS width value. Units must be supplied.
• height
  The element's CSS height value. Units must be supplied.
• scrollLeft
  The element's scrollLeft value.
• scrollTop
  The element's scrollLeft value.
• opacity
  The element's opacity value. This must be a value between 0 and 1.

Be aware than animating an Element which is being used by an Ext Component without in some way informing the Component about the changed element state will result in incorrect Component behaviour. This is because the Component will be using the old state of the element. To avoid this problem, it is now possible to directly animate certain properties of Components.

Animating a Component

• 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

  An object containing properties which describe the animation's start and end states, and the timeline of the animation.

Returns

• Object

  this

Overrides: Ext.util.Animate.animate

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

Available since: 4.0.0

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

• isSetSize : Boolean

  Whether or not the height/width are stored on the component permanently

• callingContainer : Ext.Component

  Container requesting sent the layout. Only used when isSetSize is false.

Available since: 4.0.0

Remove any references to elements added via renderSelectors/childEls

Available since: 4.0.6

Available since: 4.0.0

Parameters

• plugin : Object

Ensures that the plugins array contains fully constructed plugin instances. This converts any configs into their appropriate instances.

Available since: 4.0.5

Destroys the Component.

Available since: Ext 1

Overrides: Ext.state.Stateful.destroy

Disable the component.

Available since: Ext 1

Parameters

• silent : Boolean (optional)

  Passing true will supress the 'disable' event from being fired.

  Defaults to: false

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

Parameters

• width : Object
• height : Object
• isSetSize : Object
• callingContainer : Object

Returns

• Ext.container.Container

  this

Enable the component

Available since: Ext 1

Parameters

• silent : Boolean (optional)

  Passing true will supress the 'enable' event from being fired.

  Defaults to: false

This method finds the topmost active layout who's processing will eventually determine the size and position of this Component.

This method is useful when dynamically adding Components into Containers, and some processing must take place after the final sizing and positioning of the Component has been performed.

Available since: 4.0.0

Returns

• Ext.Component

Forces this component to redo its componentLayout.

Available since: 4.0.2

Available since: 4.0.0

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

Available since: Ext 3

Returns

• Ext.container.Container

  the Container which owns this Component.

Available since: 4.0.0

Retrieves the top level element representing this component.

Available since: Ext 1

Returns

• Ext.core.Element

Available since: 4.0.0

Available since: 4.0.0

Available since: 4.0.0

Parameters

• frameInfo : Object

Available since: 4.0.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 autogenerate an id if one has not already been set.

Available since: 4.0.0

Returns

• String

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

Available since: 4.0.0

Parameters

• position : String/Number/Ext.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

Available since: 4.0.0

Gets the Ext.ComponentLoader for this Component.

Available since: 4.0.0

Returns

• Ext.ComponentLoader

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

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

Available since: 4.0.0

Parameters

• pluginId : Object

Returns

• Ext.AbstractPlugin

  plugin instance.

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)}

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

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

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

Available since: 4.0.0

Returns

• Number

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: Ext 2

Returns

• String

  The xtype hierarchy string

Checks if there is currently a specified uiCls

Available since: 4.0.0

Parameters

• cls : String

  The cls to check

Creates an array of class names from the configurations to add to this Component's el on render.

Private, but (possibly) used by ComponentQuery for selection by class name if Component is not rendered.

Available since: 4.0.0

Returns

• String[]

  An array of class names with which the Component's element will be rendered.

Available since: 4.0.0

Adds ctCls to container.

Available since: 4.0.0

Parameters

• container : Object

Returns

• Ext.Element

  The initialized container

Initializes this components contents. It checks for the properties html, contentEl and tpl/data.

Available since: 4.0.0

Available since: 4.0.0

Available since: 4.0.0

Available since: 4.0.0

Parameters

• plugin : Object

Initialized the renderData to be used when rendering the renderTpl.

Available since: 4.0.0

Returns

• Object

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

Initializes the renderTpl.

Available since: 4.0.0

Returns

• Ext.XTemplate

  The renderTpl XTemplate instance.

Converts style definitions to String.

Available since: 4.0.0

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.

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

Available since: 4.0.0

Parameters

• container : Ext.Container

Returns

• Boolean

  True if it is.

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.

Available since: 4.0.2

Available since: 4.0.2

Method to determine whether this Component is floating.

Available since: 4.0.0

Returns

• Boolean

  the floating state of this component.

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

Available since: 4.0.0

Returns

• Boolean

  the hidden state of this Component.

Returns true if this component is visible.

Available since: Ext 1

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: Ext 2

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.

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

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.

Available since: Ext 3

Parameters

• container : Ext.container.Container

  Container which holds the component

• pos : Number

  Position at which the component was added

Available since: 4.0.0

Available since: 4.0.0

Available since: 4.0.0

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

Available since: 4.0.0

Parameters

• x : Number

  The new x position

• y : Number

  The new y position

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

Available since: Ext 3

Available since: 4.0.0

Parameters

• container : Object
• position : Object

Available since: 4.0.0

Available since: 4.0.0

Returns the previous 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 in reverse order to attempt to find a match. Contrast with previousSibling.

Available since: 4.0.0

Parameters

• selector : String (optional)

  A ComponentQuery selector to filter the preceding nodes.

Returns

• Ext.Component

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

Returns the previous sibling of this Component.

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

May also be refered to as prev()

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

Available since: 4.0.0

Parameters

• selector : String (optional)

  A ComponentQuery selector to filter the preceding items.

Returns

• Ext.Component

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

Called by Component#doAutoRender

Register a Container configured floating: true with this Component's ZIndexManager.

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

Available since: 4.0.5

Parameters

• cmp : Object

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

Available since: 4.0.5

Parameters

• testFn : Function

  The test function.

Available since: Ext 2

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

Available since: 4.0.0

Parameters

• className : Object

Returns

• Ext.Component

  Returns the Component to allow method chaining.

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

Available since: 4.0.0

Parameters

• cls : String/String[]

  A string or an array of strings to remove to the uiCls

inherit docs

Remove a single managed listener item

Available since: 4.0.1

Parameters

• isClear : Boolean

  True if this is being called during a clear

• managedListener : Object

  The managed listener item See removeManagedListener for other args

Overrides: Ext.util.Observable.removeManagedListenerItem

Available since: 4.0.0

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

Available since: 4.0.0

Parameters

• ui : String

  The UI to add to the element

Method which removes a specified UI from the components element.

Available since: 4.0.0

Available since: 4.0.0

Parameters

• container : Object
• position : Object

Available since: 4.0.3

Available since: 4.0.0

Parameters

• width : Object
• height : Object
• callingContainer : Object

Available since: 4.0.0

Parameters

• layout : Object

Enable or disable the component.

Available since: 4.0.0

Parameters

• disabled : Boolean

  True to disable.

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

Available since: 4.0.0

Parameters

• dock : Object

  The dock position.

• layoutParent : Boolean (optional)

  True to re-layout parent.

  Defaults to: false

Returns

• Ext.Component

  this

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

Available since: 4.0.0

Parameters

• height : Number

  The new height to set. This may be one of:

  • A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
  • A String used to set the CSS height style.
  • undefined to leave the height unchanged.

Returns

• Ext.Component

  this

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

Available since: 4.0.0

Parameters

• load : Boolean/Object/String

  True to show the default LoadMask, a config object that will be passed to the LoadMask constructor, or a message String to show. False to hide the current LoadMask.

• targetEl : Boolean (optional)

  True to mask the targetEl of this Component instead of the this.el. For example, setting this to true on a Panel will cause only the body to be masked.

  Defaults to: false

Returns

• Ext.LoadMask

  The LoadMask instance that has just been shown.

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

Available since: 4.0.0

Parameters

• left : Number

  The new left

• top : Number

  The new top

Returns

• Ext.Component

  this

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

Available since: 4.0.0

Parameters

• width : Number/String/Object

  The new width to set. This may be one of:

  • A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
  • A String used to set the CSS width style.
  • A size object in the format {width: widthValue, height: heightValue}.
  • undefined to leave the width unchanged.
• height : Number/String

  The new height to set (not required if a size object is passed as the first arg). This may be one of:

  • A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
  • A String used to set the CSS height style. Animation may not be used.
  • undefined to leave the height unchanged.

Returns

• Ext.Component

  this

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

Available since: 4.0.0

Parameters

• ui : String

  The new UI for the component

Convenience function to hide or show this component by boolean.

Available since: Ext 1

Parameters

• visible : Boolean

  True to show, false to hide

Returns

• Ext.Component

  this

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

Available since: 4.0.0

Parameters

• width : Number

  The new width to setThis may be one of:

  • A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
  • A String used to set the CSS width style.

Returns

• Ext.Component

  this

Available since: 4.0.0

Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector.

Example:

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

Available since: 4.0.0

Parameters

• selector : String (optional)

  The simple selector to test.

Returns

• Ext.container.Container

  The matching ancestor Container (or undefined if no match was found).

Update the content area of a component.

Available since: Ext 3

Parameters

• htmlOrData : String/Object

  If this component has been configured with a template via the tpl config then it will use this argument as data to populate the template. If this component was not configured with a template, the components content area will be updated via Ext.Element update

• loadScripts : Boolean (optional)

  Only legitimate when using the html configuration.

  Defaults to: false

• callback : Function (optional)

  Only legitimate when using the html configuration. Callback to execute when scripts have finished loading

Available since: 4.0.0

Fires after a Component had been added to a Container.

Available since: Ext 3

Parameters

• this : Ext.Component
• container : Ext.container.Container

  Parent Container

• pos : Number

  position of Component

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires after the component rendering is finished.

The afterrender event is fired after this Component has been rendered, been postprocesed by any afterRender method defined for the Component.

Available since: Ext 3

Parameters

• this : Ext.Component
• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires before a Component has been visually activated. Returning false from an event listener can prevent the activate from occurring.

Available since: 4.0.0

Parameters

• this : Ext.Component
• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires before a Component has been visually deactivated. Returning false from an event listener can prevent the deactivate from occurring.

Available since: 4.0.0

Parameters

• this : Ext.Component
• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: Ext 1

Parameters

• this : Ext.Component
• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires before the component is hidden when calling the hide method. Return false from an event handler to stop the hide.

Available since: Ext 1

Parameters

• this : Ext.Component
• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: Ext 1

Parameters

• this : Ext.Component
• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires before the component is shown when calling the show method. Return false from an event handler to stop the show.

Available since: Ext 1

Parameters

• this : Ext.Component
• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires after a Component has been visually deactivated.

Available since: 4.0.0

Parameters

• this : Ext.Component
• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires after the component is destroyed.

Available since: Ext 1

Parameters

• this : Ext.Component
• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires after the component is disabled.

Available since: Ext 1

Parameters

• this : Ext.Component
• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires after the component is enabled.

Available since: Ext 1

Parameters

• this : Ext.Component
• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires after the component is hidden. Fires after the component is hidden when calling the hide method.

Available since: Ext 1

Parameters

• this : Ext.Component
• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires after the component is moved.

Available since: 4.0.0

Parameters

• this : Ext.Component
• x : Number

  The new x position

• y : Number

  The new y position

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: Ext 3

Parameters

• this : Ext.Component
• ownerCt : Ext.container.Container

  Container which holds the component

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires after the component markup is rendered.

Available since: Ext 1

Parameters

• this : Ext.Component
• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires after the component is resized.

Available since: 4.0.0

Parameters

• this : Ext.Component
• adjWidth : Number

  The box-adjusted width that was set

• adjHeight : Number

  The box-adjusted height that was set

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: Ext 1

Parameters

• this : Ext.Component
• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.