Ext JS 4.0.7 Sencha Docs

Ext.grid.column.Column

Alternate names

Ext.grid.Column

Hierarchy

Inherited mixins

Requires

Subclasses

Files

This class specifies the definition for a column inside a Ext.grid.Panel. It encompasses both the grid header configuration as well as displaying data within the grid itself. If the columns configuration is specified, this column will become a column group and can contain other columns inside. In general, this class will not be created directly, rather an array of column configurations will be passed to the grid:

Ext.create('Ext.data.Store', {
    storeId:'employeeStore',
    fields:['firstname', 'lastname', 'senority', 'dep', 'hired'],
    data:[
        {firstname:"Michael", lastname:"Scott", senority:7, dep:"Manangement", hired:"01/10/2004"},
        {firstname:"Dwight", lastname:"Schrute", senority:2, dep:"Sales", hired:"04/01/2004"},
        {firstname:"Jim", lastname:"Halpert", senority:3, dep:"Sales", hired:"02/22/2006"},
        {firstname:"Kevin", lastname:"Malone", senority:4, dep:"Accounting", hired:"06/10/2007"},
        {firstname:"Angela", lastname:"Martin", senority:5, dep:"Accounting", hired:"10/21/2008"}
    ]
});

Ext.create('Ext.grid.Panel', {
    title: 'Column Demo',
    store: Ext.data.StoreManager.lookup('employeeStore'),
    columns: [
        {text: 'First Name',  dataIndex:'firstname'},
        {text: 'Last Name',  dataIndex:'lastname'},
        {text: 'Hired Month',  dataIndex:'hired', xtype:'datecolumn', format:'M'},
        {text: 'Department (Yrs)', xtype:'templatecolumn', tpl:'{dep} ({senority})'}
    ],
    width: 400,
    renderTo: Ext.getBody()
});

Convenience Subclasses

There are several column subclasses that provide default rendering for various data types

Setting Sizes

The columns are laid out by a Ext.layout.container.HBox layout, so a column can either be given an explicit width value or a flex configuration. If no width is specified the grid will automatically the size the column to 100px. For column groups, the size is calculated by measuring the width of the child columns, so a width option should not be specified in that case.

Header Options

  • text: Sets the header text for the column
  • sortable: Specifies whether the column can be sorted by clicking the header or using the column menu
  • hideable: Specifies whether the column can be hidden using the column menu
  • menuDisabled: Disables the column header menu
  • draggable: Specifies whether the column header can be reordered by dragging
  • groupable: Specifies whether the grid can be grouped by the column dataIndex. See also Ext.grid.feature.Grouping

Data Options

  • dataIndex: The dataIndex is the field in the underlying Ext.data.Store to use as the value for the column.
  • renderer: Allows the underlying store value to be transformed before being displayed in the grid

Available since: 3.4.0

Defined By

Config options

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

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

Available since: Ext 2

Ext.grid.column.Column
view source
: String
Sets the alignment of the header and rendered columns. ...

Sets the alignment of the header and rendered columns. Defaults to 'left'.

Defaults to: 'left'

Available since: 3.4.0

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

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

Defaults to: true

Available since: Ext 2

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

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

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

This config is intended mainly for non-floating Components which may or may not be shown. Instead of using 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 use overflow:'auto' on the components layout element and show scroll bars automatically when necessary, false...

true to use overflow:'auto' on the components layout element and show scroll bars automatically when necessary, false to clip any overflowing content.

Defaults to: false

Available since: 4.0.0

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

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

Ext.grid.column.Column
view source
: String
The base CSS class to apply to this components's element. ...

The base CSS class to apply to this components's element. This will also be prepended to elements within this 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 + 'column-header ' + Ext.baseCSSPrefix + 'unselectable'

Available since: 4.0.0

Overrides: Ext.grid.header.Container.baseCls

Specifies the border for this component. ...

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

Defaults to: true

Available since: 4.0.0

Overrides: Ext.AbstractComponent.border

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

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

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

Available since: Ext 3

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

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

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

Ext.grid.column.Column
view source
: Object[]
An optional array of sub-column definitions. ...

An optional array of sub-column definitions. This column becomes a group, and houses the columns defined in the columns config.

Group columns may not be sortable. But they may be hideable and moveable. And you may move headers into and out of a group. Note that if all sub columns are dragged out of a group, the group is destroyed.

Available since: 4.0.0

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

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

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

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.

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

Available since: Ext 3

Ext.grid.column.Column
view source
: String
The name of the field in the grid's Ext.data.Store's Ext.data.Model definition from which to draw the column's value. ...

The name of the field in the grid's Ext.data.Store's Ext.data.Model definition from which to draw the column's value. Required.

Available since: 3.4.0

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

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

Defaults to: 'gridcolumn'

Available since: Ext 2

Overrides: Ext.container.AbstractContainer.defaultType

Width of the header if no width or flex is specified. ...

Width of the header if no width or flex is specified. Defaults to 100.

Defaults to: 100

Available since: 4.0.0

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

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

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

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

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

Usage:

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

Available since: Ext 2

True to disable the component. ...

True to disable the component.

Defaults to: false

Available since: Ext 2

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

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

Defaults to: 'x-item-disabled'

Available since: 4.0.0

Ext.grid.column.Column
view source
: Boolean
False to disable drag-drop reordering of this column. ...

False to disable drag-drop reordering of this column. Defaults to true.

Defaults to: true

Available since: 4.0.0

Overrides: Ext.Component.draggable

Ext.grid.column.Column
view source
: Object/String
An optional xtype or config object for a Field to use for editing. ...

An optional xtype or config object for a Field to use for editing. Only applicable if the grid is using an Editing plugin.

Available since: 3.4.0

Ext.grid.column.Column
view source
: Object/Stringdeprecated
Alias for editor. ...

Alias for editor.

Available since: 4.0.4

This cfg has been deprecated since 4.0.5

Use editor instead.

Ext.grid.column.Column
view source
: Booleandeprecated
...

Available since: 3.4.0

This cfg has been deprecated since .

True to prevent the column from being resizable.

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

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

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, Ext.Component.floating

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

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

Defaults to: true

Available since: 4.0.0

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

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

Ext.grid.column.Column
view source
: Boolean
If the grid uses a Ext.grid.feature.Grouping, this option may be used to disable the header menu item to group by the...

If the grid uses a Ext.grid.feature.Grouping, this option may be used to disable the header menu item to group by the column selected. By default, the header menu group option is enabled. Set to false to disable (but still show) the group option in the header menu for the column.

Available since: 3.4.0

The height of this component in pixels.

The height of this component in pixels.

Available since: 4.0.0

True to hide the component. ...

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

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

Ext.grid.column.Column
view source
: Boolean
False to prevent the user from hiding this column. ...

False to prevent the user from hiding this column. Defaults to true.

Defaults to: true

Available since: 3.4.0

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

An HTML fragment, or a DomHelper specification to use as the layout element content. 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. ...

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

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 single item, or an array of child Components to be added to this container Unless configured with a layout, a Con...

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

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

Example:

// specifying a single item
items: {...},
layout: 'fit',    // The single items is sized to fit

// specifying multiple items
items: [{...}, {...}],
layout: 'hbox', // The items are arranged horizontally
       

Each item may be:

  • A Component
  • A Component configuration object

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

Every Component class has its own xtype.

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

Notes:

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

Do not specify contentEl or html with items.

Available since: Ext 2

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

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

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

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

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

  • Specify as an Object
    • Example usage:
    • layout: {
          type: 'vbox',
          align: 'left'
      }
             
    • type

    • The layout type to be used for this container. If not specified, a default Ext.layout.container.Auto will be created and used.

      Valid layout type values are:

    • Layout specific configuration properties
    • Additional layout specific configuration properties may also be specified. For complete details regarding the valid config options for each layout type, see the layout class corresponding to the type specified.

  • Specify as a String
    • Example usage:
    • layout: 'vbox'
             
    • layout
    • The layout type to be used for this container (see list of valid layout type values above).

      Additional layout specific configuration properties. For complete details regarding the valid config options for each layout type, see the layout class corresponding to the layout specified.

Available since: Ext 2

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

A config object containing one or more event handlers to be added to this object during initialization. This 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.

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

Available since: 4.0.0

Only valid when a sibling element of a Splitter within a VBox or HBox layout. ...

Only valid when a sibling element of a Splitter within a VBox or HBox layout.

Specifies that if an immediate sibling Splitter is moved, the Component on the other side is resized, and this Component maintains its configured flex value.

Defaults to: false

Available since: 4.0.0

Specifies the margin for this component. ...

Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can 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. ...

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

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

Ext.grid.column.Column
view source
: Boolean
True to disable the column header menu containing sort/hide options. ...

True to disable the column header menu containing sort/hide options. Defaults to false.

Defaults to: false

Available since: 3.4.0

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

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

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

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

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

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

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

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

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

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

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.

Defaults to: '<div id="{id}-titleContainer" class="' + Ext.baseCSSPrefix + 'column-header-inner">' + '<span id="{id}-textEl" class="' + Ext.baseCSSPrefix + 'column-header-text">' + '{text}' + '</span>' + '<tpl if="!values.menuDisabled">' + '<div id="{id}-triggerEl" class="' + Ext.baseCSSPrefix + 'column-header-trigger"></div>' + '</tpl>' + '</div>'

Available since: 4.0.0

Overrides: Ext.AbstractComponent.renderTpl

Ext.grid.column.Column
view source
: Function
A renderer is an 'interceptor' method which can be used transform data (value, appearance, etc.) before it is rendered. ...

A renderer is an 'interceptor' method which can be used transform data (value, appearance, etc.) before it is rendered. Example:

{
    renderer: function(value){
        if (value === 1) {
            return '1 person';
        }
        return value + ' people';
    }
}

Defaults to: false

Available since: 3.4.0

Parameters

  • value : Object

    The data value for the current cell

  • metaData : Object

    A collection of metadata about the current cell; can be used or modified by the renderer. Recognized properties are: tdCls, tdAttr, and style.

  • record : Ext.data.Model

    The record for the current row

  • rowIndex : Number

    The index of the current row

  • colIndex : Number

    The index of the current column

  • store : Ext.data.Store

    The data store

  • view : Ext.view.View

    The current view

Returns

  • String

    The HTML string to be rendered.

Ext.grid.column.Column
view source
: Boolean
Set to false to prevent the column from being resizable. ...

Set to false to prevent the column from being resizable. Defaults to true

Available since: 3.4.0

Overrides: Ext.Component.resizable, Ext.grid.column.Column.resizable

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

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

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

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

Ext.grid.column.Column
view source
: Boolean
False to disable sorting of this column. ...

False to disable sorting of this column. Whether local/remote sorting is used is specified in Ext.data.Store.remoteSort. Defaults to true.

Defaults to: true

Available since: 3.4.0

Overrides: Ext.grid.header.Container.sortable, Ext.grid.column.Column.sortable

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

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

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

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. By default, this function does nothing. The developer must provide an implementation which returns an object hash which represents the restorable state of the 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 more behaviour.

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

Defaults to: true

Available since: 4.0.0

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

A custom style specification to be applied to this component's Element. Should be a valid argument to 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. ...

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

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

Defaults to: false

Available since: 4.0.0

If true, suspend calls to doLayout. ...

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

Defaults to: false

Available since: 4.0.0

Ext.grid.column.Column
view source
: String

A CSS class names to apply to the table cells for this column.

A CSS class names to apply to the table cells for this column.

Available since: 4.0.0

Ext.grid.column.Column
view source
: String
The header text to be used as innerHTML (html tags are accepted) to display in the Grid. ...

The header text to be used as innerHTML (html tags are accepted) to display in the Grid. Note: to have a clickable header with no text displayed you can use the default of &#160; aka &nbsp;.

Defaults to: '&#160;'

Available since: 4.0.0

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

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

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

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

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

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

Defaults to: []

Available since: 4.0.0

HeaderContainer overrides the default weight of 0 for all docked items to 100. ...

HeaderContainer overrides the default weight of 0 for all docked items to 100. This is so that it has more priority over things like toolbars.

Defaults to: 100

Available since: 4.0.0

The width of this component in pixels.

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

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

Defined By

Properties

...

Defaults to: 'el'

Available since: 4.0.0

...

Defaults to: true

Available since: 4.0.0

Available since: 4.0.0

...

Defaults to: 'presentation'

Available since: 4.0.0

...

Defaults to: /^((\w+-)|(ext-comp-))\d{4,}$/i

Available since: 4.0.0

...

Defaults to: []

Available since: 4.0.0

...

Defaults to: 'Columns'

Available since: 4.0.0

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

The number of component layout calls made on this object.

Defaults to: 0

Available since: 4.0.3

...

Defaults to: false

Available since: 4.0.0

...

Defaults to: 'top'

Available since: 4.0.0

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

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

Defaults to: false

Available since: 4.0.0

...

Defaults to: false

Available since: 4.0.0

...

Defaults to: /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate|element|vertical|horizontal|freezeEvent)$/

Available since: 4.0.0

...

Defaults to: Ext.baseCSSPrefix + 'column-header-first'

Available since: 4.0.0

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

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

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

For floating Components which are child items of a Container, the floatParent will be the 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.

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

See floating and zIndexManager

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

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

Ext.grid.column.Column
view source
: Numberprivate
...

Defaults to: 5

Available since: 4.0.0

...

Defaults to: Ext.baseCSSPrefix + 'column-header-open'

Available since: 4.0.0

Deprecate 5.0 ...

Deprecate 5.0

Defaults to: false

Available since: 4.0.0

Ext.grid.column.Column
view source
: Stringprivate
Not the standard, automatically applied overCls because we must filter out overs of child headers. ...

Not the standard, automatically applied overCls because we must filter out overs of child headers.

Defaults to: Ext.baseCSSPrefix + 'column-header-over'

Available since: 4.0.0

End Definitions ...

End Definitions

Defaults to: true

Available since: 4.0.0

...

Defaults to: true

Available since: 4.0.0

true if this HeaderContainer is in fact a group header which contains sub headers.

true if this HeaderContainer is in fact a group header which contains sub headers.

Available since: 4.0.0

Ext.grid.column.Column
view source
: Booleanprivate
Set in this class to identify, at runtime, instances which are not instances of the HeaderContainer base class, but a...

Set in this class to identify, at runtime, instances which are not instances of the HeaderContainer base class, but are in fact, the subclass: Header.

Defaults to: true

Available since: 4.0.0

...

Defaults to: true

Available since: 4.0.0

The MixedCollection containing all the child items of this container.

The MixedCollection containing all the child items of this container.

Available since: Ext 2

...

Defaults to: Ext.baseCSSPrefix + 'column-header-last'

Available since: 4.0.0

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

The number of container layout calls made on this object.

Defaults to: 0

Available since: 4.0.3

Flag set by the container layout to which this Component is added. ...

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

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

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: /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate)$/

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

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

Ext.grid.column.Column
view source
: Arrayprivate
...

Defaults to: ['ASC', 'DESC']

Available since: 4.0.0

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

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

Defaults to: false

Available since: Ext 1

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

Get the reference to the current class from which this object was instantiated. Unlike statics, 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'

        return 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

...

Defaults to: 'Sort Ascending'

Available since: 4.0.0

...

Defaults to: 'Clear Sort'

Available since: 4.0.0

...

Defaults to: 'Sort Descending'

Available since: 4.0.0

Ext.grid.column.Column
view source
: Objectprivate

Available since: 4.0.0

...

Defaults to: /\s+/

Available since: 4.0.0

Ext.grid.column.Column
view source
: Ext.Element

Element that contains the text in column header.

Element that contains the text in column header.

Available since: 4.0.0

private; will probably be removed by 4.0 ...

private; will probably be removed by 4.0

Defaults to: false

Available since: 4.0.0

Ext.grid.column.Column
view source
: Ext.Element

Element that acts as button for column header dropdown menu.

Element that acts as button for column header dropdown menu.

Available since: 4.0.0

...

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

Available since: 4.0.0

...

Defaults to: 0

Available since: 4.0.0

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

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, or if not found the global ZIndexManager is used.

See floating and floatParent

Available since: 4.0.0

Methods

Defined By

Instance methods

Creates new Component. ...

Creates new Component.

Available since: 1.1.0

Parameters

  • config : Ext.Element/String/Object

    The configuration options may be specified as either:

    • an element : it is set as the internal element and its id used as the component id
    • a string : it is assumed to be the id of an existing element and is used as the component id
    • anything else : it is assumed to be a standard config object and is applied to the component

Returns

Fires

    Overrides: Ext.util.Floating.constructor, Ext.Component.constructor

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

    Adds Component(s) to this Container.

    Description:

    Notes:

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

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

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

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

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

    Warning:

    Components directly managed by the BorderLayout layout manager may not be removed or added. See the Notes for BorderLayout for more details.

    Available since: Ext 2

    Parameters

    Returns

    Fires

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

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

    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

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

    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

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

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

      True to skip adding it to the class and do it later (via the return)

    Fires

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

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

      Available since: 1.1.0

      Parameters

      • o : Object/String

        Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. Usage:

        this.addEvents({
            storeloaded: true,
            storecleared: true
        });
        
      • more : String... (optional)

        Additional event names if multiple event names are being passed as separate parameters. Usage:

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

      Available since: 4.0.6

      Parameters

      Returns

      ( element, listeners, scope, options )
      Appends an event handler to this object. ...

      Appends an event handler to this object.

      Available since: 4.0.0

      Parameters

      Fires

        Overrides: Ext.util.Observable.addListener

        ( item, ename, [fn], [scope], [opt] )
        Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destr...

        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.

        • opt : Object (optional)

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

        Fires

          ...

          Available since: 4.0.0

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

          Add events that will trigger the state to be saved.

          Available since: 4.0.0

          Parameters

          • events : String/String[]

            The event name or an array of event names.

          Fires

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

            Method which adds a specified UI + uiCls to the components element. Can be overridden to remove the UI from more 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. ...

            Method which adds a specified UI to the components element.

            Available since: 4.0.0

            Parameters

            Fires

              private ...

              private

              Available since: 4.0.0

              Parameters

              Ext.grid.column.Column
              view source
              ( width, height )
              Occurs after componentLayout is run. ...

              Occurs after componentLayout is run.

              Available since: 4.0.0

              Parameters

              Fires

              Overrides: Ext.AbstractComponent.afterComponentLayout

              ...

              Available since: 4.0.0

              Parameters

              Fires

              Ext.grid.column.Column
              view source
              ( )private
              private ...

              private

              Available since: 4.0.0

              Fires

                Overrides: Ext.grid.header.Container.afterRender

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

                Template method called after a Component has been positioned.

                Available since: 4.0.0

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

                Parameters

                Fires

                ( animateTarget, cb, scope )private
                ...

                Available since: 4.0.0

                Parameters

                Fires

                ( element, [position], [offsets] ) : Ext.Componentchainable
                Aligns this floating Component to the specified element ...

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

                Fires

                • move
                process the passed fx configuration. ...
                • process the passed fx configuration.

                Available since: 4.0.0

                Parameters

                Fires

                  Perform custom animation on this object. ...

                  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

                  When animating an Element, the following properties may be specified in from, to, and keyframe objects:
                  • 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

                  When animating an Element, 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

                  Returns

                  Fires

                    Overrides: Ext.util.Animate.animate

                    Ext.grid.column.Column
                    view source
                    ( state )private
                    ...

                    Available since: 4.0.4

                    Parameters

                    Fires

                    ...

                    Available since: 4.0.4

                    Parameters

                    Fires

                    ...

                    Available since: 4.0.0

                    Parameters

                    Fires

                      Overrides: Ext.container.AbstractContainer.applyDefaults

                      Sets references to elements inside the component. ...

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

                      Available since: 4.0.0

                      Applies the state to the object. ...

                      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

                      ( adjWidth, adjHeight, isSetSize, callingContainer )
                      Occurs before componentLayout is run. ...

                      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.

                      Occurs before componentLayout is run. ...

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

                      Available since: 4.0.0

                      ...

                      Available since: 4.0.0

                      private ...

                      private

                      Available since: 4.0.0

                      Returns

                      Fires

                        ( fn, [scope], [args] ) : Ext.Componentchainable
                        Bubbles up the component/container heirarchy, calling the specified function with each component. ...

                        Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (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

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

                        Call the original method that was previously overridden with override

                        Ext.define('My.Cat', {
                            constructor: function() {
                                alert("I'm a cat!");
                        
                                return this;
                            }
                        });
                        
                        My.Cat.override({
                            constructor: function() {
                                alert("I'm going to be a cat!");
                        
                                var instance = this.callOverridden();
                        
                                alert("Meeeeoooowwww");
                        
                                return instance;
                            }
                        });
                        
                        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

                        Returns

                        • Object

                          Returns the result after calling the overridden method

                        Call the parent's overridden method. ...

                        Call the parent's overridden method. For example:

                        Ext.define('My.own.A', {
                            constructor: function(test) {
                                alert(test);
                            }
                        });
                        
                        Ext.define('My.own.B', {
                            extend: 'My.own.A',
                        
                            constructor: function(test) {
                                alert(test);
                        
                                this.callParent([test + 1]);
                            }
                        });
                        
                        Ext.define('My.own.C', {
                            extend: 'My.own.B',
                        
                            constructor: function() {
                                alert("Going to call parent's overriden constructor...");
                        
                                this.callParent(arguments);
                            }
                        });
                        
                        var a = new My.own.A(1); // alerts '1'
                        var b = new My.own.B(1); // alerts '1', then alerts '2'
                        var c = new My.own.C(2); // alerts "Going to call parent's overriden constructor..."
                                                 // alerts '2', then alerts '3'
                        

                        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 from the superclass' method

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

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

                        Available since: Ext 2

                        Parameters

                        • fn : Function

                          The function to call

                        • scope : Object (optional)

                          The scope of the function (defaults to current component)

                        • args : Array (optional)

                          The args to call the function with. The current component always passed as the last argument.

                        Returns

                        Center this Component in its container. ...

                        Center this Component in its container.

                        Available since: 4.0.0

                        Returns

                        Fires

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

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

                        Available since: 4.0.0

                        Parameters

                        • selector : String (optional)

                          An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned.

                        Returns

                        Fires

                          Remove any references to elements added via renderSelectors/childEls ...

                          Remove any references to elements added via renderSelectors/childEls

                          Available since: 4.0.6

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

                          Removes all listeners for this object including the managed listeners

                          Available since: 4.0.0

                          Fires

                            Removes all managed listeners for this object. ...

                            Removes all managed listeners for this object.

                            Available since: 4.0.0

                            Fires

                              invoked internally by a header when not using triStateSorting ...

                              invoked internally by a header when not using triStateSorting

                              Available since: 4.0.0

                              Parameters

                              Fires

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

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

                                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

                                ...

                                Available since: 4.0.0

                                Parameters

                                Ensures that the plugins array contains fully constructed plugin instances. ...

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

                                Available since: 4.0.5

                                Fires

                                  ( eventName, args, bubbles )private
                                  Continue to fire event. ...

                                  Continue to fire event.

                                  Available since: Ext JS 4.0.7

                                  Parameters

                                  Fires

                                    ...

                                    Available since: 4.0.0

                                    Parameters

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

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

                                    Available since: 4.0.0

                                    Parameters

                                    Returns

                                    ...

                                    Available since: 4.0.0

                                    Destroys the Component. ...

                                    Destroys the Component.

                                    Available since: Ext 1

                                    Fires

                                    Overrides: Ext.state.Stateful.destroy, Ext.AbstractComponent.destroy

                                    Disable the component. ...

                                    Disable the component.

                                    Available since: Ext 1

                                    Parameters

                                    • silent : Boolean (optional)

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

                                      Defaults to: false

                                    Fires

                                    Handles autoRender. ...

                                    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

                                    Fires

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

                                    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

                                    Fires

                                      Overrides: Ext.AbstractComponent.doComponentLayout

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

                                      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.

                                      Fires

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

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

                                      Available since: Ext 2

                                      Returns

                                      Fires

                                        ...

                                        Available since: 4.0.0

                                        Parameters

                                        Fires

                                          Ext.grid.column.Column
                                          view source
                                          ( state )private
                                          ...

                                          Available since: 4.0.0

                                          Parameters

                                          Fires

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

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

                                            Available since: 4.0.0

                                            Parameters

                                            • selector : String (optional)

                                              An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned.

                                            Returns

                                            Fires

                                              Enable the component ...

                                              Enable the component

                                              Available since: Ext 1

                                              Parameters

                                              • silent : Boolean (optional)

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

                                                Defaults to: false

                                              Fires

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

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

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

                                              Example:

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

                                              Available since: 3.4.0

                                              Parameters

                                              • events : String/String[]

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

                                              ...

                                              Available since: 4.0.0

                                              Parameters

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

                                              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

                                              Fires

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

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

                                                Available since: 2.3.0

                                                Parameters

                                                • fn : Function

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

                                                Returns

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

                                                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

                                                Fires

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

                                                  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.

                                                  Fires

                                                    private ...

                                                    private

                                                    Available since: 4.0.0

                                                    Fires

                                                      ( [selectText], [delay] ) : Ext.Componentchainable
                                                      Try to focus this component. ...

                                                      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

                                                      Fires

                                                        Forces this component to redo its componentLayout. ...

                                                        Forces this component to redo its componentLayout.

                                                        Available since: 4.0.2

                                                        Fires

                                                          Deprecate 5.0 ...

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

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

                                                          Available since: 4.0.0

                                                          Returns

                                                          ...

                                                          Available since: 4.0.0

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

                                                          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}

                                                          Fires

                                                            Gets the bubbling parent for an Observable ...

                                                            Gets the bubbling parent for an Observable

                                                            Available since: Ext JS 4.0.7

                                                            Returns

                                                            Fires

                                                              private ...

                                                              private

                                                              Available since: Ext 3

                                                              Returns

                                                              Overrides: Ext.AbstractComponent.getBubbleTarget

                                                              Ext.grid.column.Column
                                                              view source
                                                              ( )private
                                                              ...

                                                              Available since: 4.0.0

                                                              Fires

                                                                Ext.grid.column.Column
                                                                view source
                                                                ( )private
                                                                ...

                                                                Available since: 4.0.0

                                                                Fires

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

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

                                                                  Available since: 4.0.0

                                                                  Parameters

                                                                  Returns

                                                                  Returns the number of grid columns descended from this HeaderContainer. ...

                                                                  Returns the number of grid columns descended from this HeaderContainer. Group Columns are HeaderContainers. All grid columns are returned, including hidden ones.

                                                                  Available since: 4.0.0

                                                                  Fires

                                                                    Returns an array of menu CheckItems corresponding to all immediate children of the passed Container which have been c...

                                                                    Returns an array of menu CheckItems corresponding to all immediate children of the passed Container which have been configured as hideable.

                                                                    Available since: 4.0.0

                                                                    Parameters

                                                                    Fires

                                                                      Ext.grid.column.Column
                                                                      view source
                                                                      ( )private
                                                                      ...

                                                                      Available since: 4.0.4

                                                                      Fires

                                                                        Get the columns used for generating a template via TableChunker. ...

                                                                        Get the columns used for generating a template via TableChunker. Returns an array of all columns and their - dataIndex - align - width - id - columnId - used to create an identifying CSS class - cls The tdCls configuration from the Column object

                                                                        Available since: 4.0.0

                                                                        Parameters

                                                                        Fires

                                                                          ...

                                                                          Available since: 4.0.4

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

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

                                                                          Available since: Ext 2

                                                                          Parameters

                                                                          • comp : String/Number

                                                                            This parameter may be any of the following:

                                                                            • a String : representing the itemId or id of the child component
                                                                            • a Number : representing the position of the child component within the items property

                                                                            For additional information see Ext.util.MixedCollection.get.

                                                                          Returns

                                                                          used as the key lookup function for the items collection ...
                                                                          • used as the key lookup function for the items collection

                                                                          Available since: 4.0.0

                                                                          Parameters

                                                                          ...

                                                                          Available since: 4.0.0

                                                                          Fires

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

                                                                            Gets the x/y offsets to constrain this float

                                                                            Available since: 4.0.1

                                                                            Parameters

                                                                            Returns

                                                                            private ...

                                                                            private

                                                                            Available since: 4.0.0

                                                                            Ext.grid.column.Column
                                                                            view source
                                                                            ( )private
                                                                            ...

                                                                            Available since: 4.0.0

                                                                            ...

                                                                            Available since: 4.0.0

                                                                            Ext.grid.column.Column
                                                                            view source
                                                                            ( record, defaultField ) : Ext.form.field.Field
                                                                            Retrieves the editing field for editing associated with this header. ...

                                                                            Retrieves the editing field for editing associated with this header. Returns false if there is no field associated with the Header the method will return false. If the field has not been instantiated it will be created. Note: These methods only has an implementation if a Editing plugin has been enabled on the grid.

                                                                            Available since: 3.4.0

                                                                            Parameters

                                                                            • record : Object

                                                                              The Model instance being edited.

                                                                            • defaultField : Object

                                                                              An object representing a default field to be created

                                                                            Returns

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

                                                                            Retrieves the top level element representing this component.

                                                                            Available since: Ext 1

                                                                            Returns

                                                                            Overrides: Ext.AbstractComponent.getEl

                                                                            ...

                                                                            Available since: 4.0.0

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

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

                                                                            Available since: 4.0.0

                                                                            Returns

                                                                            ...

                                                                            Available since: 4.0.0

                                                                            ...

                                                                            Available since: 4.0.0

                                                                            Parameters

                                                                            ...

                                                                            Available since: 4.0.0

                                                                            Parameters

                                                                            Fires

                                                                              Gets the full width of all columns that are visible. ...

                                                                              Gets the full width of all columns that are visible.

                                                                              Available since: 4.0.0

                                                                              Parameters

                                                                              Fires

                                                                                Returns an array of all columns which map to Store fields. ...

                                                                                Returns an array of all columns which map to Store fields. This goes down to the lowest column header level, and does not return grouped headers which contain sub headers.

                                                                                Available since: 4.0.0

                                                                                Parameters

                                                                                • refreshCache : Boolean

                                                                                  If omitted, the cached set of columns will be returned. Pass true to refresh the cache.

                                                                                Returns

                                                                                Fires

                                                                                  Get a leaf level header by index regardless of what the nesting structure is. ...

                                                                                  Get a leaf level header by index regardless of what the nesting structure is.

                                                                                  Available since: 4.0.0

                                                                                  Parameters

                                                                                  Fires

                                                                                    Get the index of a leaf level header regardless of what the nesting structure is. ...

                                                                                    Get the index of a leaf level header regardless of what the nesting structure is.

                                                                                    Available since: 4.0.0

                                                                                    Parameters

                                                                                    Fires

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

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

                                                                                      Available since: 4.0.0

                                                                                      Returns

                                                                                      For use by column headers in determining whether there are any hideable columns when deciding whether or not the head...

                                                                                      For use by column headers in determining whether there are any hideable columns when deciding whether or not the header menu should be disabled.

                                                                                      Available since: 4.0.5

                                                                                      Parameters

                                                                                      Fires

                                                                                        Retrieves the id of this component. ...

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

                                                                                        Available since: 1.1.0

                                                                                        Returns

                                                                                        Fires

                                                                                          Overrides: Ext.AbstractComponent.getId

                                                                                          Ext.grid.column.Column
                                                                                          view source
                                                                                          ( ) : Number
                                                                                          Returns the true grid column index associated with this column only if this column is a base level Column. ...

                                                                                          Returns the true grid column index associated with this column only if this column is a base level Column. If it is a group column, it returns false.

                                                                                          Available since: 4.0.0

                                                                                          Returns

                                                                                          Fires

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

                                                                                            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

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

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

                                                                                            Available since: 4.0.0

                                                                                            Returns

                                                                                            Fires

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

                                                                                              Gets the Ext.ComponentLoader for this Component.

                                                                                              Available since: 4.0.0

                                                                                              Returns

                                                                                              Gets the menu (and will create it if it doesn't already exist) ...

                                                                                              Gets the menu (and will create it if it doesn't already exist)

                                                                                              Available since: 4.0.0

                                                                                              Fires

                                                                                              Returns an array of menu items to be placed into the shared menu across all headers in this header container. ...

                                                                                              Returns an array of menu items to be placed into the shared menu across all headers in this header container.

                                                                                              Available since: 4.0.0

                                                                                              Returns

                                                                                              Fires

                                                                                                Include margins ...

                                                                                                Include margins

                                                                                                Available since: 4.0.0

                                                                                                Ext.grid.column.Column
                                                                                                view source
                                                                                                ( )private
                                                                                                Find the topmost HeaderContainer: An ancestor which is NOT a Header. ...

                                                                                                Find the topmost HeaderContainer: An ancestor which is NOT a Header. Group Headers are themselves HeaderContainers

                                                                                                Available since: 4.0.0

                                                                                                Fires

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

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

                                                                                                  Available since: 4.0.0

                                                                                                  Parameters

                                                                                                  Returns

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

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

                                                                                                  Deprecate 5.0

                                                                                                  Available since: 4.0.0

                                                                                                  ...

                                                                                                  Available since: 4.0.0

                                                                                                  Used by ComponentQuery to retrieve all of the items which can potentially be considered a child of this Container. ...

                                                                                                  Used by ComponentQuery to retrieve all of the items which can potentially be considered a child of this Container. This should be overriden by components which have child items that are not contained in items. For example dockedItems, menu, etc IMPORTANT note for maintainers: Items are returned in tree traversal order. Each item is appended to the result array followed by the results of that child's getRefItems call. Floating child items are appended after internal child items.

                                                                                                  Available since: 4.0.0

                                                                                                  Parameters

                                                                                                  Deprecate 5.0 ...

                                                                                                  Deprecate 5.0

                                                                                                  Available since: 4.0.0

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

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

                                                                                                  Ext.grid.column.Column
                                                                                                  view source
                                                                                                  ( ) : String
                                                                                                  Returns the parameter to sort upon when sorting this header. ...

                                                                                                  Returns the parameter to sort upon when sorting this header. By default this returns the dataIndex and will not need to be overriden in most cases.

                                                                                                  Available since: 4.0.0

                                                                                                  Returns

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

                                                                                                  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

                                                                                                  Overrides: Ext.state.Stateful.getState, Ext.AbstractComponent.getState

                                                                                                  Gets the state id for this object. ...

                                                                                                  Gets the state id for this object.

                                                                                                  Available since: 4.0.0

                                                                                                  Returns

                                                                                                  • String

                                                                                                    The state id, null if not found.

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

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

                                                                                                  Available since: 4.0.0

                                                                                                  ...

                                                                                                  Available since: 4.0.0

                                                                                                  Parameters

                                                                                                  Fires

                                                                                                    Deprecate 5.0 ...

                                                                                                    Deprecate 5.0

                                                                                                    Available since: 4.0.0

                                                                                                    Returns an array of the visible columns in the grid. ...

                                                                                                    Returns an array of the visible columns in the grid. This goes down to the lowest column header level, and does not return grouped headers which contain sub headers.

                                                                                                    Available since: 4.0.0

                                                                                                    Parameters

                                                                                                    • refreshCache : Boolean

                                                                                                      If omitted, the cached set of columns will be returned. Pass true to refresh the cache.

                                                                                                    Returns

                                                                                                    Fires

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

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

                                                                                                      Available since: 4.0.0

                                                                                                      Returns

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

                                                                                                      Gets the xtype for this component as registered with Ext.ComponentManager. For a list of all available 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

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

                                                                                                      Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the 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

                                                                                                      Finds the ancestor Container responsible for allocating zIndexes for the passed Component. ...

                                                                                                      Finds the ancestor Container responsible for allocating zIndexes for the passed Component.

                                                                                                      That will be the outermost floating Container (a Container which has no ownerCt and has floating:true).

                                                                                                      If we have no ancestors, or we walk all the way up to the document body, there's no zIndexParent, and the global Ext.WindowManager will be used.

                                                                                                      Available since: 4.0.0

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

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

                                                                                                      Available since: 4.0.0

                                                                                                      This method has been deprecated since 4.0

                                                                                                      Replaced by getActiveAnimation

                                                                                                      Returns

                                                                                                      Checks to see if this object has any listeners for a specified event ...

                                                                                                      Checks to see if this object has any listeners for a specified event

                                                                                                      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, else false

                                                                                                      Checks if there is currently a specified uiCls ...

                                                                                                      Checks if there is currently a specified uiCls

                                                                                                      Available since: 4.0.0

                                                                                                      Parameters

                                                                                                      Ext.grid.column.Column
                                                                                                      view source
                                                                                                      ( ) : Ext.Component
                                                                                                      Hides this Component, setting it to invisible using the configured hideMode. ...

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

                                                                                                      Available since: 4.0.0

                                                                                                      Returns

                                                                                                      Fires

                                                                                                      Overrides: Ext.Component.hide

                                                                                                      ...

                                                                                                      Available since: 4.0.0

                                                                                                      Fires

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

                                                                                                        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.

                                                                                                        Ext.grid.column.Column
                                                                                                        view source
                                                                                                        ( )private
                                                                                                        The initComponent template method is an important initialization step for a Component. ...

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

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

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

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

                                                                                                        Available since: 4.0.0

                                                                                                        Fires

                                                                                                          Overrides: Ext.grid.header.Container.initComponent

                                                                                                          ( config ) : Objectchainableprotected
                                                                                                          Initialize configuration for this class. ...

                                                                                                          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);
                                                                                                          
                                                                                                                  return this;
                                                                                                              }
                                                                                                          });
                                                                                                          
                                                                                                          var awesome = new My.awesome.Class({
                                                                                                              name: 'Super Awesome'
                                                                                                          });
                                                                                                          
                                                                                                          alert(awesome.getName()); // 'Super Awesome'
                                                                                                          

                                                                                                          Available since: 4.0.0

                                                                                                          Parameters

                                                                                                          Returns

                                                                                                          • Object

                                                                                                            mixins The mixin prototypes as key - value pairs

                                                                                                          Fires

                                                                                                            Adds ctCls to container. ...

                                                                                                            Adds ctCls to container.

                                                                                                            Available since: 4.0.0

                                                                                                            Parameters

                                                                                                            Returns

                                                                                                            Initializes this components contents. ...

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

                                                                                                            Available since: 4.0.0

                                                                                                            Fires

                                                                                                              Ext.grid.column.Column
                                                                                                              view source
                                                                                                              ( )private
                                                                                                              Header does not use the typical ComponentDraggable class and therefore we override this with an emptyFn. ...

                                                                                                              Header does not use the typical ComponentDraggable class and therefore we override this with an emptyFn. It is controlled at the HeaderDragZone.

                                                                                                              Available since: 4.0.0

                                                                                                              Overrides: Ext.Component.initDraggable

                                                                                                              ...

                                                                                                              Available since: 4.0.0

                                                                                                              Fires

                                                                                                                ...

                                                                                                                Available since: 4.0.0

                                                                                                                Fires

                                                                                                                  ...

                                                                                                                  Available since: 4.0.0

                                                                                                                  Fires

                                                                                                                    ...

                                                                                                                    Available since: 4.0.0

                                                                                                                    Parameters

                                                                                                                    Ext.grid.column.Column
                                                                                                                    view source
                                                                                                                    ( ) : Objectprivate
                                                                                                                    Initialized the renderData to be used when rendering the renderTpl. ...

                                                                                                                    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

                                                                                                                    Fires

                                                                                                                      Overrides: Ext.AbstractComponent.initRenderData

                                                                                                                      Initializes the renderTpl. ...

                                                                                                                      Initializes the renderTpl.

                                                                                                                      Available since: 4.0.0

                                                                                                                      Returns

                                                                                                                      Fires

                                                                                                                        ...

                                                                                                                        Available since: 4.0.0

                                                                                                                        Parameters

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

                                                                                                                        Initializes the state of the object upon construction.

                                                                                                                        Available since: 4.0.0

                                                                                                                        Fires

                                                                                                                        Initializes any state events for this object. ...

                                                                                                                        Initializes any state events for this object.

                                                                                                                        Available since: 4.0.0

                                                                                                                        Fires

                                                                                                                          Converts style definitions to String. ...

                                                                                                                          Converts style definitions to String.

                                                                                                                          Available since: 4.0.0

                                                                                                                          Returns

                                                                                                                          • String

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

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

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

                                                                                                                          Available since: Ext 2

                                                                                                                          Parameters

                                                                                                                          • index : Number

                                                                                                                            The index at which the Component will be inserted into the Container's items collection

                                                                                                                          • component : Ext.Component

                                                                                                                            The child Component to insert.

                                                                                                                            Ext uses lazy rendering, and will only render the inserted Component should it become necessary.

                                                                                                                            A Component config object may be passed in order to avoid the overhead of constructing a real Component object if lazy rendering might mean that the inserted Component will not be rendered immediately. To take advantage of this 'lazy instantiation', set the Ext.Component.xtype config property to the registered type of the Component wanted.

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

                                                                                                                          Returns

                                                                                                                          • Ext.Component

                                                                                                                            component The Component (or config object) that was inserted with the Container's default config values applied.

                                                                                                                          Fires

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

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

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

                                                                                                                            Available since: 4.0.0

                                                                                                                            Parameters

                                                                                                                            Returns

                                                                                                                            Fires

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

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

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

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

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

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

                                                                                                                              Available since: 4.0.0

                                                                                                                              Returns

                                                                                                                              • Boolean

                                                                                                                                the hidden state of this Component.

                                                                                                                              Ext.grid.column.Column
                                                                                                                              view source
                                                                                                                              ( e )private
                                                                                                                              ...

                                                                                                                              Available since: 4.0.0

                                                                                                                              Parameters

                                                                                                                              Ext.grid.column.Column
                                                                                                                              view source
                                                                                                                              ( e )private
                                                                                                                              ...

                                                                                                                              Available since: 4.0.0

                                                                                                                              Parameters

                                                                                                                              Returns true if this component is visible. ...

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

                                                                                                                              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.

                                                                                                                              Fires

                                                                                                                                ...

                                                                                                                                Available since: 4.0.0

                                                                                                                                Parameters

                                                                                                                                Fires

                                                                                                                                  private ...

                                                                                                                                  private

                                                                                                                                  Available since: 4.0.0

                                                                                                                                  Parameters

                                                                                                                                  ( name, cls )private
                                                                                                                                  Used internally by the mixins pre-processor ...

                                                                                                                                  Used internally by the mixins pre-processor

                                                                                                                                  Available since: 4.0.6

                                                                                                                                  Parameters

                                                                                                                                  Fires

                                                                                                                                    ( item, ename, [fn], [scope], [opt] )
                                                                                                                                    Shorthand for addManagedListener. ...

                                                                                                                                    Shorthand for addManagedListener.

                                                                                                                                    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.

                                                                                                                                    • opt : Object (optional)

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

                                                                                                                                    Moves a Component within the Container ...

                                                                                                                                    Moves a Component within the Container

                                                                                                                                    Available since: 4.0.0

                                                                                                                                    Parameters

                                                                                                                                    • fromIdx : Number

                                                                                                                                      The index the Component you wish to move is currently at.

                                                                                                                                    • toIdx : Number

                                                                                                                                      The new index for the Component.

                                                                                                                                    Returns

                                                                                                                                    • Ext.Component

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

                                                                                                                                    Fires

                                                                                                                                      ...

                                                                                                                                      Available since: 4.0.0

                                                                                                                                      Parameters

                                                                                                                                      Fires

                                                                                                                                      ( item, ename, [fn], [scope] )
                                                                                                                                      Shorthand for removeManagedListener. ...

                                                                                                                                      Shorthand for removeManagedListener.

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

                                                                                                                                      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

                                                                                                                                      Returns

                                                                                                                                      • Ext.Component

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

                                                                                                                                      Fires

                                                                                                                                        Returns the next sibling of this Component. ...

                                                                                                                                        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

                                                                                                                                        Returns

                                                                                                                                        • Ext.Component

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

                                                                                                                                        ( eventName, fn, [scope], [options] )
                                                                                                                                        Shorthand for addListener. ...

                                                                                                                                        Shorthand for addListener.

                                                                                                                                        Available since: 1.1.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}
                                                                                                                                          });
                                                                                                                                          
                                                                                                                                        Ext.grid.column.Column
                                                                                                                                        view source
                                                                                                                                        ( childHeader )private
                                                                                                                                        Invalidate column cache on add We cannot refresh the View on every add because this method is called when the HeaderD...

                                                                                                                                        Invalidate column cache on add We cannot refresh the View on every add because this method is called when the HeaderDropZone moves Headers around, that will also refresh the view

                                                                                                                                        Available since: 4.0.0

                                                                                                                                        Parameters

                                                                                                                                        Fires

                                                                                                                                          Overrides: Ext.grid.header.Container.onAdd

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

                                                                                                                                          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

                                                                                                                                          Fires

                                                                                                                                          ...

                                                                                                                                          Available since: 4.0.0

                                                                                                                                          Parameters

                                                                                                                                          ...

                                                                                                                                          Available since: 4.0.0

                                                                                                                                          Parameters

                                                                                                                                          Ext.grid.column.Column
                                                                                                                                          view source
                                                                                                                                          ( )private
                                                                                                                                          Template method to contribute functionality at destroy time. ...

                                                                                                                                          Template method to contribute functionality at destroy time.

                                                                                                                                          Available since: 4.0.0

                                                                                                                                          Fires

                                                                                                                                            Overrides: Ext.grid.header.Container.onDestroy

                                                                                                                                            Disable all immediate children that was previously disabled ...

                                                                                                                                            Disable all immediate children that was previously disabled

                                                                                                                                            Available since: 4.0.0

                                                                                                                                            Fires

                                                                                                                                              Overrides: Ext.Component.onDisable

                                                                                                                                              Ext.grid.column.Column
                                                                                                                                              view source
                                                                                                                                              ( e )private
                                                                                                                                              ...

                                                                                                                                              Available since: 4.0.0

                                                                                                                                              Parameters

                                                                                                                                              Fires

                                                                                                                                                Ext.grid.column.Column
                                                                                                                                                view source
                                                                                                                                                ( e, t )private
                                                                                                                                                ...

                                                                                                                                                Available since: 4.0.0

                                                                                                                                                Parameters

                                                                                                                                                Fires

                                                                                                                                                  Ext.grid.column.Column
                                                                                                                                                  view source
                                                                                                                                                  ( e, t )private
                                                                                                                                                  Double click ...

                                                                                                                                                  Double click

                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                  Parameters

                                                                                                                                                  Fires

                                                                                                                                                    Enable all immediate children that was previously disabled ...

                                                                                                                                                    Enable all immediate children that was previously disabled

                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                    Fires

                                                                                                                                                      Overrides: Ext.Component.onEnable

                                                                                                                                                      Ext.grid.column.Column
                                                                                                                                                      view source
                                                                                                                                                      ( e )private
                                                                                                                                                      ...

                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                      Parameters

                                                                                                                                                      Fires

                                                                                                                                                        ...

                                                                                                                                                        Available since: 4.0.0

                                                                                                                                                        Fires

                                                                                                                                                        • beforehide
                                                                                                                                                        ...

                                                                                                                                                        Available since: 4.0.0

                                                                                                                                                        Fires

                                                                                                                                                        • beforeshow
                                                                                                                                                        ...

                                                                                                                                                        Available since: 4.0.0

                                                                                                                                                        Fires

                                                                                                                                                          ...

                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                          Parameters

                                                                                                                                                          Fires

                                                                                                                                                          ( header, suppressLayout )private
                                                                                                                                                          ...

                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                          Parameters

                                                                                                                                                          Fires

                                                                                                                                                          ( header, fromIdx, toIdx )private
                                                                                                                                                          ...

                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                          Parameters

                                                                                                                                                          Fires

                                                                                                                                                          ( header, w, suppressFocus )private
                                                                                                                                                          ...

                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                          Parameters

                                                                                                                                                          Fires

                                                                                                                                                            ( header, preventLayout )private
                                                                                                                                                            ...

                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                            Parameters

                                                                                                                                                            Fires

                                                                                                                                                            ...

                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                            Parameters

                                                                                                                                                            Fires

                                                                                                                                                            ( animateTarget, cb, scope )private
                                                                                                                                                            Possibly animate down to a target element. ...

                                                                                                                                                            Possibly animate down to a target element.

                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                            Parameters

                                                                                                                                                            Fires

                                                                                                                                                            remove the trigger open class when the menu is hidden ...

                                                                                                                                                            remove the trigger open class when the menu is hidden

                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                            Fires

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

                                                                                                                                                            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

                                                                                                                                                            Ext.grid.column.Column
                                                                                                                                                            view source
                                                                                                                                                            ( childHeader )private
                                                                                                                                                            Invalidate column cache on remove We cannot refresh the View on every remove because this method is called when the H...

                                                                                                                                                            Invalidate column cache on remove We cannot refresh the View on every remove because this method is called when the HeaderDropZone moves Headers around, that will also refresh the view

                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                            Parameters

                                                                                                                                                            Fires

                                                                                                                                                              Overrides: Ext.grid.header.Container.onRemove

                                                                                                                                                              Method to manage awareness of when components are removed from their respective Container, firing an removed event. ...

                                                                                                                                                              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

                                                                                                                                                              Fires

                                                                                                                                                              Ext.grid.column.Column
                                                                                                                                                              view source
                                                                                                                                                              ( )private
                                                                                                                                                              ...

                                                                                                                                                              Available since: 4.0.0

                                                                                                                                                              Fires

                                                                                                                                                                Overrides: Ext.AbstractComponent.onRender

                                                                                                                                                                Deprecate 5.0 ...

                                                                                                                                                                Deprecate 5.0

                                                                                                                                                                Available since: 4.0.0

                                                                                                                                                                Overrides: Ext.AbstractComponent.onResize

                                                                                                                                                                Private. ...

                                                                                                                                                                Private. Override in subclasses where more complex behaviour is needed.

                                                                                                                                                                Available since: 4.0.0

                                                                                                                                                                Fires

                                                                                                                                                                Overrides: Ext.AbstractComponent.onShow

                                                                                                                                                                ...

                                                                                                                                                                Available since: 4.0.4

                                                                                                                                                                Parameters

                                                                                                                                                                Fires

                                                                                                                                                                sort asc when clicking on item in menu ...

                                                                                                                                                                sort asc when clicking on item in menu

                                                                                                                                                                Available since: 4.0.0

                                                                                                                                                                Fires

                                                                                                                                                                sort desc when clicking on item in menu ...

                                                                                                                                                                sort desc when clicking on item in menu

                                                                                                                                                                Available since: 4.0.0

                                                                                                                                                                Fires

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

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

                                                                                                                                                                Available since: 4.0.0

                                                                                                                                                                Fires

                                                                                                                                                                Ext.grid.column.Column
                                                                                                                                                                view source
                                                                                                                                                                ( )private
                                                                                                                                                                ...

                                                                                                                                                                Available since: 4.0.0

                                                                                                                                                                Ext.grid.column.Column
                                                                                                                                                                view source
                                                                                                                                                                ( )private
                                                                                                                                                                ...

                                                                                                                                                                Available since: 4.0.0

                                                                                                                                                                ( name, value )private
                                                                                                                                                                ...

                                                                                                                                                                Available since: 4.0.6

                                                                                                                                                                Parameters

                                                                                                                                                                Fires

                                                                                                                                                                  ( name, fn )private
                                                                                                                                                                  ...

                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                  Parameters

                                                                                                                                                                  Lay out any descendant containers who queued a layout operation during the time this was hidden This is also called b...

                                                                                                                                                                  Lay out any descendant containers who queued a layout operation during the time this was hidden This is also called by Panel after it expands because descendants of a collapsed Panel allso queue any layout ops.

                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                  ( data, rowIdx, record, view, panel )
                                                                                                                                                                  Maps the record data to base it on the header id's. ...

                                                                                                                                                                  Maps the record data to base it on the header id's. This correlates to the markup/template generated by TableChunker.

                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                  Parameters

                                                                                                                                                                  Fires

                                                                                                                                                                    ...

                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                    Parameters

                                                                                                                                                                    Fires

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

                                                                                                                                                                      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

                                                                                                                                                                      Returns

                                                                                                                                                                      • Ext.Component

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

                                                                                                                                                                      Fires

                                                                                                                                                                        Returns the previous sibling of this Component. ...

                                                                                                                                                                        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

                                                                                                                                                                        Returns

                                                                                                                                                                        • Ext.Component

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

                                                                                                                                                                        Ext.grid.column.Column
                                                                                                                                                                        view source
                                                                                                                                                                        ( type, view, cell, recordIndex, cellIndex, e )private
                                                                                                                                                                        Process UI events from the view. ...

                                                                                                                                                                        Process UI events from the view. The owning TablePanel calls this method, relaying events from the TableView

                                                                                                                                                                        Available since: 3.4.0

                                                                                                                                                                        Parameters

                                                                                                                                                                        • type : String

                                                                                                                                                                          Event type, eg 'click'

                                                                                                                                                                        • view : Ext.view.Table

                                                                                                                                                                          TableView Component

                                                                                                                                                                        • cell : HTMLElement

                                                                                                                                                                          Cell HtmlElement the event took place within

                                                                                                                                                                        • recordIndex : Number

                                                                                                                                                                          Index of the associated Store Model (-1 if none)

                                                                                                                                                                        • cellIndex : Number

                                                                                                                                                                          Cell index within the row

                                                                                                                                                                        • e : Ext.EventObject

                                                                                                                                                                          Original event

                                                                                                                                                                        ...

                                                                                                                                                                        Available since: 4.0.0

                                                                                                                                                                        ...

                                                                                                                                                                        Available since: 1.1.0

                                                                                                                                                                        ...

                                                                                                                                                                        Available since: 4.0.0

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

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

                                                                                                                                                                        Available since: 4.0.0

                                                                                                                                                                        Parameters

                                                                                                                                                                        • selector : String (optional)

                                                                                                                                                                          Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned.

                                                                                                                                                                        Returns

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

                                                                                                                                                                        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

                                                                                                                                                                        Relays selected events from the specified Observable as if the events were fired by this. ...

                                                                                                                                                                        Relays selected events from the specified Observable as if the events were fired by this.

                                                                                                                                                                        Available since: 2.3.0

                                                                                                                                                                        Parameters

                                                                                                                                                                        • origin : Object

                                                                                                                                                                          The Observable whose events this object is to relay.

                                                                                                                                                                        • events : String[]

                                                                                                                                                                          Array of event names to relay.

                                                                                                                                                                        • prefix : String

                                                                                                                                                                        Fires

                                                                                                                                                                          Removes a component from this container. ...

                                                                                                                                                                          Removes a component from this container. Fires the beforeremove event before removing, then fires the remove event after the component has been removed.

                                                                                                                                                                          Available since: Ext 2

                                                                                                                                                                          Parameters

                                                                                                                                                                          Returns

                                                                                                                                                                          Fires

                                                                                                                                                                          Removes all components from this container. ...

                                                                                                                                                                          Removes all components from this container.

                                                                                                                                                                          Available since: Ext 2

                                                                                                                                                                          Parameters

                                                                                                                                                                          Returns

                                                                                                                                                                          Fires

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

                                                                                                                                                                          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

                                                                                                                                                                          ...

                                                                                                                                                                          Available since: Ext 2

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

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

                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                          Parameters

                                                                                                                                                                          Returns

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

                                                                                                                                                                          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

                                                                                                                                                                          Fires

                                                                                                                                                                            Removes an event handler. ...

                                                                                                                                                                            Removes an event handler.

                                                                                                                                                                            Available since: 1.1.0

                                                                                                                                                                            Parameters

                                                                                                                                                                            • eventName : String

                                                                                                                                                                              The type of event the handler was associated with.

                                                                                                                                                                            • fn : Function

                                                                                                                                                                              The handler to remove. This must be a reference to the function passed into the addListener call.

                                                                                                                                                                            • scope : Object (optional)

                                                                                                                                                                              The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

                                                                                                                                                                            Fires

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

                                                                                                                                                                              Removes listeners that were added by the mon method.

                                                                                                                                                                              Available since: 4.0.0

                                                                                                                                                                              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.

                                                                                                                                                                              Fires

                                                                                                                                                                                inherit docs ...

                                                                                                                                                                                inherit docs

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

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

                                                                                                                                                                                Method which removes a specified UI from the components element.

                                                                                                                                                                                Available since: 4.0.0

                                                                                                                                                                                Fires

                                                                                                                                                                                  ( container, position )private
                                                                                                                                                                                  ...

                                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                                  Parameters

                                                                                                                                                                                  Fires

                                                                                                                                                                                  Resumes firing events (see suspendEvents). ...

                                                                                                                                                                                  Resumes firing events (see suspendEvents).

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

                                                                                                                                                                                  Available since: 2.3.0

                                                                                                                                                                                  ( propName, state, [stateName] ) : Boolean
                                                                                                                                                                                  Conditionally saves a single property from this object to the given state object. ...

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

                                                                                                                                                                                  Available since: 4.0.4

                                                                                                                                                                                  Parameters

                                                                                                                                                                                  • propName : String

                                                                                                                                                                                    The name of the property to save.

                                                                                                                                                                                  • state : Object

                                                                                                                                                                                    The state object in to which to save the property.

                                                                                                                                                                                  • stateName : String (optional)

                                                                                                                                                                                    The name to use for the property in state.

                                                                                                                                                                                  Returns

                                                                                                                                                                                  • Boolean

                                                                                                                                                                                    True if the property was saved, false if not.

                                                                                                                                                                                  Fires

                                                                                                                                                                                    ...

                                                                                                                                                                                    Available since: 4.0.4

                                                                                                                                                                                    Parameters

                                                                                                                                                                                    Fires

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

                                                                                                                                                                                      Saves the state of the object to the persistence store.

                                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                                      Fires

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

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

                                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                                      Returns

                                                                                                                                                                                      ( [active], [newActive] )
                                                                                                                                                                                      This method is called internally by Ext.ZIndexManager to signal that a floating Component has either been moved to th...

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

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

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

                                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                                      Parameters

                                                                                                                                                                                      • active : Boolean (optional)

                                                                                                                                                                                        True to activate the Component, false to deactivate it.

                                                                                                                                                                                        Defaults to: false

                                                                                                                                                                                      • newActive : Ext.Component (optional)

                                                                                                                                                                                        The newly active Component which is taking over topmost zIndex position.

                                                                                                                                                                                      Fires

                                                                                                                                                                                      • activate
                                                                                                                                                                                      • deactivate
                                                                                                                                                                                      Sets the overflow on the content element of the component. ...

                                                                                                                                                                                      Sets the overflow on the content element of the component.

                                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                                      Parameters

                                                                                                                                                                                      • scroll : Boolean

                                                                                                                                                                                        True to allow the Component to auto scroll.

                                                                                                                                                                                      Returns

                                                                                                                                                                                      Fires

                                                                                                                                                                                        ( width, height, callingContainer )private
                                                                                                                                                                                        ...

                                                                                                                                                                                        Available since: 4.0.0

                                                                                                                                                                                        Parameters

                                                                                                                                                                                        Fires

                                                                                                                                                                                          ...

                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          ( config ) : Ext.Basechainableprivate
                                                                                                                                                                                          ...

                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Returns

                                                                                                                                                                                          Fires

                                                                                                                                                                                            Enable or disable the component. ...

                                                                                                                                                                                            Enable or disable the component.

                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                            Parameters

                                                                                                                                                                                            • disabled : Boolean

                                                                                                                                                                                              True to disable.

                                                                                                                                                                                            ...

                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                            Fires

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

                                                                                                                                                                                              Sets the dock position of this component in its parent panel. Note that this only has effect if this item is part 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.grid.column.Column
                                                                                                                                                                                              view source
                                                                                                                                                                                              ( field )
                                                                                                                                                                                              Sets the form field to be used for editing. ...

                                                                                                                                                                                              Sets the form field to be used for editing. Note: This method only has an implementation if an Editing plugin has been enabled on the grid.

                                                                                                                                                                                              Available since: 3.4.0

                                                                                                                                                                                              Parameters

                                                                                                                                                                                              • field : Object

                                                                                                                                                                                                An object representing a field to be created. If no xtype is specified a 'textfield' is assumed.

                                                                                                                                                                                              ...

                                                                                                                                                                                              Available since: 4.0.0

                                                                                                                                                                                              Parameters

                                                                                                                                                                                              Fires

                                                                                                                                                                                                Sets the height of the component. ...

                                                                                                                                                                                                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

                                                                                                                                                                                                Fires

                                                                                                                                                                                                  ...

                                                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                                                  Parameters

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

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

                                                                                                                                                                                                  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.

                                                                                                                                                                                                  Fires

                                                                                                                                                                                                    Ext.grid.column.Column
                                                                                                                                                                                                    view source
                                                                                                                                                                                                    ( headerHeight )private
                                                                                                                                                                                                    private After the container has laid out and stretched, it calls this to correctly pad the inner to center the text v...

                                                                                                                                                                                                    private After the container has laid out and stretched, it calls this to correctly pad the inner to center the text vertically Total available header height must be passed to enable padding for inner elements to be calculated.

                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                    Parameters

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

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

                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                    • x : Number

                                                                                                                                                                                                      The new x position

                                                                                                                                                                                                    • y : Number

                                                                                                                                                                                                      The new y position

                                                                                                                                                                                                    • animate : Boolean/Object (optional)

                                                                                                                                                                                                      True to animate the Component into its new position. You may also pass an animation configuration.

                                                                                                                                                                                                    Returns

                                                                                                                                                                                                    Fires

                                                                                                                                                                                                    ( left, top, [animate] ) : Ext.Componentchainable
                                                                                                                                                                                                    Sets the left and top of the component. ...

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

                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                    • left : Number

                                                                                                                                                                                                      The new left

                                                                                                                                                                                                    • top : Number

                                                                                                                                                                                                      The new top

                                                                                                                                                                                                    • animate : Boolean/Object (optional)

                                                                                                                                                                                                      If true, the Component is animated into its new position. You may also pass an animation configuration.

                                                                                                                                                                                                    Returns

                                                                                                                                                                                                    Fires

                                                                                                                                                                                                    Overrides: Ext.AbstractComponent.setPosition, Ext.Component.setPosition

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

                                                                                                                                                                                                    Sets the width and height of this Component. This method fires the resize event. This method can accept 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

                                                                                                                                                                                                    Fires

                                                                                                                                                                                                      Ext.grid.column.Column
                                                                                                                                                                                                      view source
                                                                                                                                                                                                      ( state, skipClear, initial )private
                                                                                                                                                                                                      setSortState: function(state, updateUI) { setSortState: function(state, doSort) { ...

                                                                                                                                                                                                      setSortState: function(state, updateUI) { setSortState: function(state, doSort) {

                                                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      Fires

                                                                                                                                                                                                        Ext.grid.column.Column
                                                                                                                                                                                                        view source
                                                                                                                                                                                                        ( text )
                                                                                                                                                                                                        Sets the header text for this Column. ...

                                                                                                                                                                                                        Sets the header text for this Column.

                                                                                                                                                                                                        Available since: 4.0.0

                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                        • text : String

                                                                                                                                                                                                          The header to display on this Column.

                                                                                                                                                                                                        Sets the UI for the component. ...

                                                                                                                                                                                                        Sets the UI for the component. This will remove any existing UIs on the component. It will also loop through any 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

                                                                                                                                                                                                        Fires

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

                                                                                                                                                                                                          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.grid.column.Column
                                                                                                                                                                                                          view source
                                                                                                                                                                                                          ( width )
                                                                                                                                                                                                          Sets the width of this Column. ...

                                                                                                                                                                                                          Sets the width of this Column.

                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                          Fires

                                                                                                                                                                                                            Overrides: Ext.AbstractComponent.setWidth

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

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

                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                            Ext.grid.column.Column
                                                                                                                                                                                                            view source
                                                                                                                                                                                                            ( ) : Ext.Componentchainable
                                                                                                                                                                                                            Shows this Component, rendering it first if autoRender or floating are true. ...

                                                                                                                                                                                                            Shows this Component, rendering it first if autoRender or floating are true.

                                                                                                                                                                                                            After being shown, a floating Component (such as a Ext.window.Window), is activated it and brought to the front of its z-index stack.

                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                            Returns

                                                                                                                                                                                                            Fires

                                                                                                                                                                                                            Overrides: Ext.container.AbstractContainer.show

                                                                                                                                                                                                            Displays component at specific xy position. ...

                                                                                                                                                                                                            Displays component at specific xy position. A floating component (like a menu) is positioned relative to its ownerCt if any. Useful for popping up a context menu:

                                                                                                                                                                                                            listeners: {
                                                                                                                                                                                                                itemcontextmenu: function(view, record, item, index, event, options) {
                                                                                                                                                                                                                    Ext.create('Ext.menu.Menu', {
                                                                                                                                                                                                                        width: 100,
                                                                                                                                                                                                                        height: 100,
                                                                                                                                                                                                                        margin: '0 0 10 0',
                                                                                                                                                                                                                        items: [{
                                                                                                                                                                                                                            text: 'regular item 1'
                                                                                                                                                                                                                        },{
                                                                                                                                                                                                                            text: 'regular item 2'
                                                                                                                                                                                                                        },{
                                                                                                                                                                                                                            text: 'regular item 3'
                                                                                                                                                                                                                        }]
                                                                                                                                                                                                                    }).showAt(event.getXY());
                                                                                                                                                                                                                }
                                                                                                                                                                                                            }
                                                                                                                                                                                                            

                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                            • x : Number

                                                                                                                                                                                                              The new x position

                                                                                                                                                                                                            • y : Number

                                                                                                                                                                                                              The new y position

                                                                                                                                                                                                            • animate : Boolean/Object (optional)

                                                                                                                                                                                                              True to animate the Component into its new position. You may also pass an animation configuration.

                                                                                                                                                                                                            Fires

                                                                                                                                                                                                            ...

                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                            Fires

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

                                                                                                                                                                                                            Get the reference to the class from which this object was instantiated. Note that unlike self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

                                                                                                                                                                                                            Ext.define('My.Cat', {
                                                                                                                                                                                                                statics: {
                                                                                                                                                                                                                    totalCreated: 0,
                                                                                                                                                                                                                    speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
                                                                                                                                                                                                                },
                                                                                                                                                                                                            
                                                                                                                                                                                                                constructor: function() {
                                                                                                                                                                                                                    var statics = this.statics();
                                                                                                                                                                                                            
                                                                                                                                                                                                                    alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                                                                                                                                                                                                                                    // equivalent to: My.Cat.speciesName
                                                                                                                                                                                                            
                                                                                                                                                                                                                    alert(this.self.speciesName);   // dependent on 'this'
                                                                                                                                                                                                            
                                                                                                                                                                                                                    statics.totalCreated++;
                                                                                                                                                                                                            
                                                                                                                                                                                                                    return this;
                                                                                                                                                                                                                },
                                                                                                                                                                                                            
                                                                                                                                                                                                                clone: function() {
                                                                                                                                                                                                                    var cloned = new this.self;                      // dependent on 'this'
                                                                                                                                                                                                            
                                                                                                                                                                                                                    cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName
                                                                                                                                                                                                            
                                                                                                                                                                                                                    return cloned;
                                                                                                                                                                                                                }
                                                                                                                                                                                                            });
                                                                                                                                                                                                            
                                                                                                                                                                                                            
                                                                                                                                                                                                            Ext.define('My.SnowLeopard', {
                                                                                                                                                                                                                extend: 'My.Cat',
                                                                                                                                                                                                            
                                                                                                                                                                                                                statics: {
                                                                                                                                                                                                                    speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
                                                                                                                                                                                                                },
                                                                                                                                                                                                            
                                                                                                                                                                                                                constructor: function() {
                                                                                                                                                                                                                    this.callParent();
                                                                                                                                                                                                                }
                                                                                                                                                                                                            });
                                                                                                                                                                                                            
                                                                                                                                                                                                            var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'
                                                                                                                                                                                                            
                                                                                                                                                                                                            var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
                                                                                                                                                                                                            
                                                                                                                                                                                                            var clone = snowLeopard.clone();
                                                                                                                                                                                                            alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
                                                                                                                                                                                                            alert(clone.groupName);                 // alerts 'Cat'
                                                                                                                                                                                                            
                                                                                                                                                                                                            alert(My.Cat.totalCreated);             // alerts 3
                                                                                                                                                                                                            

                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                            Returns

                                                                                                                                                                                                            Stops any running effects and clears this object's internal effects queue if it contains any additional effects that ...

                                                                                                                                                                                                            Stops any running effects and clears this object's internal effects queue if it contains any additional effects that haven't started yet.

                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                            Returns

                                                                                                                                                                                                            ...

                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                            This method has been deprecated since 4.0

                                                                                                                                                                                                            Replaced by stopAnimation Stops any running effects and clears this object's internal effects queue if it contains any additional effects that haven't started yet.

                                                                                                                                                                                                            Returns

                                                                                                                                                                                                            Suspends the firing of all events. ...

                                                                                                                                                                                                            Suspends the firing of all events. (see resumeEvents)

                                                                                                                                                                                                            Available since: 2.3.0

                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                            • queueSuspended : Boolean

                                                                                                                                                                                                              Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events.

                                                                                                                                                                                                            Ensures that all effects queued after syncFx is called on this object are run concurrently. ...

                                                                                                                                                                                                            Ensures that all effects queued after syncFx is called on this object are run concurrently. This is the opposite of sequenceFx.

                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                            Returns

                                                                                                                                                                                                            private ...

                                                                                                                                                                                                            private

                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                            Temporarily lock the headerCt. ...

                                                                                                                                                                                                            Temporarily lock the headerCt. This makes it so that clicking on headers don't trigger actions like sorting or opening of the header menu. This is done because extraneous events may be fired on the headers after interacting with a drag drop operation.

                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                            Sends this Component to the back of (lower z-index than) any other visible windows ...

                                                                                                                                                                                                            Sends this Component to the back of (lower z-index than) any other visible windows

                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                            Returns

                                                                                                                                                                                                            Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManag...

                                                                                                                                                                                                            Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManager

                                                                                                                                                                                                            If this Component is modal, inserts the modal mask just below this Component in the z-index stack.

                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                            • preventFocus : Boolean (optional)

                                                                                                                                                                                                              Specify true to prevent the Component from being focused.

                                                                                                                                                                                                              Defaults to: false

                                                                                                                                                                                                            Returns

                                                                                                                                                                                                            Fires

                                                                                                                                                                                                              Ext.grid.column.Column
                                                                                                                                                                                                              view source
                                                                                                                                                                                                              ( )private
                                                                                                                                                                                                              ...

                                                                                                                                                                                                              Available since: 4.0.0

                                                                                                                                                                                                              Fires

                                                                                                                                                                                                                ( eventName, fn, [scope] )
                                                                                                                                                                                                                Shorthand for removeListener. ...

                                                                                                                                                                                                                Shorthand for removeListener.

                                                                                                                                                                                                                Available since: 1.1.0

                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                • eventName : String

                                                                                                                                                                                                                  The type of event the handler was associated with.

                                                                                                                                                                                                                • fn : Function

                                                                                                                                                                                                                  The handler to remove. This must be a reference to the function passed into the addListener call.

                                                                                                                                                                                                                • scope : Object (optional)

                                                                                                                                                                                                                  The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

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

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

                                                                                                                                                                                                                Example:

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

                                                                                                                                                                                                                Available since: 4.0.0

                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                • selector : String (optional)

                                                                                                                                                                                                                  The simple selector to test.

                                                                                                                                                                                                                Returns

                                                                                                                                                                                                                ( htmlOrData, [loadScripts], [callback] )
                                                                                                                                                                                                                Update the content area of a component. ...

                                                                                                                                                                                                                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

                                                                                                                                                                                                                Fires

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

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

                                                                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                  • box : Object

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

                                                                                                                                                                                                                  Returns

                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                  ...

                                                                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                    Defined By

                                                                                                                                                                                                                    Static methods

                                                                                                                                                                                                                    ( members ) : Ext.Basechainablestatic
                                                                                                                                                                                                                    Add / override static properties of this class. ...

                                                                                                                                                                                                                    Add / override static properties of this class.

                                                                                                                                                                                                                    Ext.define('My.cool.Class', {
                                                                                                                                                                                                                        ...
                                                                                                                                                                                                                    });
                                                                                                                                                                                                                    
                                                                                                                                                                                                                    My.cool.Class.addStatics({
                                                                                                                                                                                                                        someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
                                                                                                                                                                                                                        method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
                                                                                                                                                                                                                        method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
                                                                                                                                                                                                                    });
                                                                                                                                                                                                                    

                                                                                                                                                                                                                    Available since: 4.0.2

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                    ( fromClass, members ) : Ext.Basechainablestatic
                                                                                                                                                                                                                    Borrow another class' members to the prototype of this class. ...

                                                                                                                                                                                                                    Borrow another class' members to the prototype of this class.

                                                                                                                                                                                                                    Ext.define('Bank', {
                                                                                                                                                                                                                        money: '$$$',
                                                                                                                                                                                                                        printMoney: function() {
                                                                                                                                                                                                                            alert('$$$$$$$');
                                                                                                                                                                                                                        }
                                                                                                                                                                                                                    });
                                                                                                                                                                                                                    
                                                                                                                                                                                                                    Ext.define('Thief', {
                                                                                                                                                                                                                        ...
                                                                                                                                                                                                                    });
                                                                                                                                                                                                                    
                                                                                                                                                                                                                    Thief.borrow(Bank, ['money', 'printMoney']);
                                                                                                                                                                                                                    
                                                                                                                                                                                                                    var steve = new Thief();
                                                                                                                                                                                                                    
                                                                                                                                                                                                                    alert(steve.money); // alerts '$$$'
                                                                                                                                                                                                                    steve.printMoney(); // alerts '$$$$$$$'
                                                                                                                                                                                                                    

                                                                                                                                                                                                                    Available since: 4.0.2

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    • fromClass : Ext.Base

                                                                                                                                                                                                                      The class to borrow members from

                                                                                                                                                                                                                    • members : String/String[]

                                                                                                                                                                                                                      The names of the members to borrow

                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                    Create a new instance of this Class. ...

                                                                                                                                                                                                                    Create a new instance of this Class.

                                                                                                                                                                                                                    Ext.define('My.cool.Class', {
                                                                                                                                                                                                                        ...
                                                                                                                                                                                                                    });
                                                                                                                                                                                                                    
                                                                                                                                                                                                                    My.cool.Class.create({
                                                                                                                                                                                                                        someConfig: true
                                                                                                                                                                                                                    });
                                                                                                                                                                                                                    

                                                                                                                                                                                                                    All parameters are passed to the constructor of the class.

                                                                                                                                                                                                                    Available since: 4.0.2

                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                    ( alias, origin )static
                                                                                                                                                                                                                    Create aliases for existing prototype methods. ...

                                                                                                                                                                                                                    Create aliases for existing prototype methods. Example:

                                                                                                                                                                                                                    Ext.define('My.cool.Class', {
                                                                                                                                                                                                                        method1: function() { ... },
                                                                                                                                                                                                                        method2: function() { ... }
                                                                                                                                                                                                                    });
                                                                                                                                                                                                                    
                                                                                                                                                                                                                    var test = new My.cool.Class();
                                                                                                                                                                                                                    
                                                                                                                                                                                                                    My.cool.Class.createAlias({
                                                                                                                                                                                                                        method3: 'method1',
                                                                                                                                                                                                                        method4: 'method2'
                                                                                                                                                                                                                    });
                                                                                                                                                                                                                    
                                                                                                                                                                                                                    test.method3(); // test.method1()
                                                                                                                                                                                                                    
                                                                                                                                                                                                                    My.cool.Class.createAlias('method5', 'method3');
                                                                                                                                                                                                                    
                                                                                                                                                                                                                    test.method5(); // test.method3() -> test.method1()
                                                                                                                                                                                                                    

                                                                                                                                                                                                                    Available since: 4.0.2

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Get the current class' name in string format. ...

                                                                                                                                                                                                                    Get the current class' name in string format.

                                                                                                                                                                                                                    Ext.define('My.cool.Class', {
                                                                                                                                                                                                                        constructor: function() {
                                                                                                                                                                                                                            alert(this.self.getName()); // alerts 'My.cool.Class'
                                                                                                                                                                                                                        }
                                                                                                                                                                                                                    });
                                                                                                                                                                                                                    
                                                                                                                                                                                                                    My.cool.Class.getName(); // 'My.cool.Class'
                                                                                                                                                                                                                    

                                                                                                                                                                                                                    Available since: 4.0.4

                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                    Add methods / properties to the prototype of this class. ...

                                                                                                                                                                                                                    Add methods / properties to the prototype of this class.

                                                                                                                                                                                                                    Ext.define('My.awesome.Cat', {
                                                                                                                                                                                                                        constructor: function() {
                                                                                                                                                                                                                            ...
                                                                                                                                                                                                                        }
                                                                                                                                                                                                                    });
                                                                                                                                                                                                                    
                                                                                                                                                                                                                     My.awesome.Cat.implement({
                                                                                                                                                                                                                         meow: function() {
                                                                                                                                                                                                                            alert('Meowww...');
                                                                                                                                                                                                                         }
                                                                                                                                                                                                                     });
                                                                                                                                                                                                                    
                                                                                                                                                                                                                     var kitty = new My.awesome.Cat;
                                                                                                                                                                                                                     kitty.meow();
                                                                                                                                                                                                                    

                                                                                                                                                                                                                    Available since: 4.0.2

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    ( members ) : Ext.Basechainablestatic
                                                                                                                                                                                                                    Override prototype members of this class. ...

                                                                                                                                                                                                                    Override prototype members of this class. Overridden methods can be invoked via callOverridden

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

                                                                                                                                                                                                                    Available since: 4.0.2

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                    Defined By

                                                                                                                                                                                                                    Events

                                                                                                                                                                                                                    Fires after a Component has been visually activated. ...

                                                                                                                                                                                                                    Fires after a Component has been visually activated.

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    ( this, component, index, eOpts )
                                                                                                                                                                                                                    Fires after any Ext.Component is added or inserted into the container. ...

                                                                                                                                                                                                                    Fires after any Ext.Component is added or inserted into the container. (bubbles)

                                                                                                                                                                                                                    Available since: Ext 2

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    ( this, container, pos, eOpts )
                                                                                                                                                                                                                    Fires after a Component had been added to a Container. ...

                                                                                                                                                                                                                    Fires after a Component had been added to a Container.

                                                                                                                                                                                                                    Available since: Ext 3

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fires when the components in this container are arranged by the associated layout manager. ...

                                                                                                                                                                                                                    Fires when the components in this container are arranged by the associated layout manager.

                                                                                                                                                                                                                    Available since: Ext 2

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fires after the component rendering is finished. ...

                                                                                                                                                                                                                    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

                                                                                                                                                                                                                    Fires before a Component has been visually activated. ...

                                                                                                                                                                                                                    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

                                                                                                                                                                                                                    Fires before any Ext.Component is added or inserted into the container. ...

                                                                                                                                                                                                                    Fires before any Ext.Component is added or inserted into the container. A handler can return false to cancel the add.

                                                                                                                                                                                                                    Available since: Ext 2

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fires before a Component has been visually deactivated. ...

                                                                                                                                                                                                                    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

                                                                                                                                                                                                                    Fires before the component is destroyed. ...

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

                                                                                                                                                                                                                    Available since: Ext 1

                                                                                                                                                                                                                    Parameters

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

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

                                                                                                                                                                                                                    Available since: Ext 1

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fires before any Ext.Component is removed from the container. ...

                                                                                                                                                                                                                    Fires before any Ext.Component is removed from the container. A handler can return false to cancel the remove.

                                                                                                                                                                                                                    Available since: Ext 2

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fires before the component is rendered. ...

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

                                                                                                                                                                                                                    Available since: Ext 1

                                                                                                                                                                                                                    Parameters

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

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

                                                                                                                                                                                                                    Available since: Ext 1

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fires before the state of the object is restored. ...

                                                                                                                                                                                                                    Fires before the state of the object is restored. Return false from an event handler to stop the restore.

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    • this : Ext.state.Stateful
                                                                                                                                                                                                                    • state : Object

                                                                                                                                                                                                                      The hash of state values returned from the StateProvider. If this event is not vetoed, then the state object is passed to applyState. By default, that simply copies property values into this object. The method maybe overriden to provide custom state restoration.

                                                                                                                                                                                                                    • eOpts : Object

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

                                                                                                                                                                                                                    Fires before the state of the object is saved to the configured state provider. ...

                                                                                                                                                                                                                    Fires before the state of the object is saved to the configured state provider. Return false to stop the save.

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    ...

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    ( ct, column, fromIdx, toIdx, eOpts )
                                                                                                                                                                                                                    ...

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    ...

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    ...

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fires after a Component has been visually deactivated. ...

                                                                                                                                                                                                                    Fires after a Component has been visually deactivated.

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fires after the component is destroyed. ...

                                                                                                                                                                                                                    Fires after the component is destroyed.

                                                                                                                                                                                                                    Available since: Ext 1

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fires after the component is disabled. ...

                                                                                                                                                                                                                    Fires after the component is disabled.

                                                                                                                                                                                                                    Available since: Ext 1

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fires after the component is enabled. ...

                                                                                                                                                                                                                    Fires after the component is enabled.

                                                                                                                                                                                                                    Available since: Ext 1

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    ...

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    ...

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fires after the component is hidden. ...

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

                                                                                                                                                                                                                    Available since: Ext 1

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fired immediately after the column header menu is created. ...

                                                                                                                                                                                                                    Fired immediately after the column header menu is created.

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fires after the component is moved. ...

                                                                                                                                                                                                                    Fires after the component is moved.

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fires after any Ext.Component is removed from the container. ...

                                                                                                                                                                                                                    Fires after any Ext.Component is removed from the container. (bubbles)

                                                                                                                                                                                                                    Available since: Ext 2

                                                                                                                                                                                                                    Parameters

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

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

                                                                                                                                                                                                                    Available since: Ext 3

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fires after the component markup is rendered. ...

                                                                                                                                                                                                                    Fires after the component markup is rendered.

                                                                                                                                                                                                                    Available since: Ext 1

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    ( this, adjWidth, adjHeight, eOpts )
                                                                                                                                                                                                                    Fires after the component is resized. ...

                                                                                                                                                                                                                    Fires after the component is resized.

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters

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

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

                                                                                                                                                                                                                    Available since: Ext 1

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    ( ct, column, direction, eOpts )
                                                                                                                                                                                                                    ...

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Fires after the state of the object is restored. ...

                                                                                                                                                                                                                    Fires after the state of the object is restored.

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    • this : Ext.state.Stateful
                                                                                                                                                                                                                    • state : Object

                                                                                                                                                                                                                      The hash of state values returned from the StateProvider. This is passed to applyState. By default, that simply copies property values into this object. The method maybe overriden to provide custom state restoration.

                                                                                                                                                                                                                    • eOpts : Object

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

                                                                                                                                                                                                                    Fires after the state of the object is saved to the configured state provider. ...

                                                                                                                                                                                                                    Fires after the state of the object is saved to the configured state provider.

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    Parameters