Ext JS 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', 'seniority', 'dep', 'hired'],
    data:[
        {firstname:"Michael", lastname:"Scott", seniority:7, dep:"Management", hired:"01/10/2004"},
        {firstname:"Dwight", lastname:"Schrute", seniority:2, dep:"Sales", hired:"04/01/2004"},
        {firstname:"Jim", lastname:"Halpert", seniority:3, dep:"Sales", hired:"02/22/2006"},
        {firstname:"Kevin", lastname:"Malone", seniority:4, dep:"Accounting", hired:"06/10/2007"},
        {firstname:"Angela", lastname:"Martin", seniority: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} ({seniority})'}
    ],
    width: 400,
    forceFit: true,
    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
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: 2.3.0

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. Possible values are: 'left', 'center', and 'right'.

Defaults to: 'left'

Defines the anchoring size of container. ...

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

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

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

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

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

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

The above is the same as:

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

Don't use it together with loader config.

This cfg has been deprected since 4.1.1

Use loader config instead.

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 omitted as if it is true.

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

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

Defaults to: false

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. This should not be combined with overflowX or overflowY.

Defaults to: false

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

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

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

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

Overrides: Ext.grid.header.Container.baseCls

Specifies the border size for this component. ...

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

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

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

To turn off the border, use border: false.

Defaults to: true

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.

Available since: 3.4.0

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.

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

Defines the column width inside column layout. ...

Defines the column width inside column layout.

Can be specified as a number or as a percentage.

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.

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.

Ext.grid.column.Column
view source
: String/Object
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.

Defaults to: 'columncomponent'

Overrides: Ext.AbstractComponent.componentLayout

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

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

Defaults to: false

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

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

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

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

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

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

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

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.

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

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

Defaults to: "tl-bl?"

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

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

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

Ext.grid.column.Column
view source
: Boolean
So that when removing from group headers which are then empty and then get destroyed, there's no child DOM left ...

So that when removing from group headers which are then empty and then get destroyed, there's no child DOM left

Defaults to: true

Overrides: Ext.grid.header.Container.detachOnRemove

true to disable the component. ...

true to disable the component.

Defaults to: false

Available since: 2.3.0

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

CSS class to add when the Component is disabled.

Defaults to: 'x-item-disabled'

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

Overrides: Ext.Component.draggable

Ext.grid.column.Column
view source
: Function
A renderer to be used in conjunction with RowEditing. ...

A renderer to be used in conjunction with RowEditing. This renderer is used to display a custom value for non-editable fields.

Defaults to: false

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.

Ext.grid.column.Column
view source
: String
The text to diplay in empty cells (cells with a value of undefined, null, or ''). ...

The text to diplay in empty cells (cells with a value of undefined, null, or '').

Defaults to &#160; aka &nbsp;.

False to disable column hiding within this grid. ...

False to disable column hiding within this grid.

Defaults to: true

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

Alias for editor.

This cfg has been deprected since 4.0.5

Use editor instead.

Ext.grid.column.Column
view source
: Booleandeprecated
True to prevent the column from being resizable. ...

True to prevent the column from being resizable.

This cfg has been deprected since 4.0

Use resizable instead.

Overrides: Ext.util.Floating.fixed

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

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

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

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

Defaults to: false

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.

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.

Ext.grid.column.Column
view source
: Stringdeprecated
The header text. ...

The header text.

This cfg has been deprected since 4.0

Use text instead.

The height of this component in pixels.

The height of this component in pixels.

true to hide the component. ...

true to hide the component.

Defaults to: false

Available since: 2.3.0

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

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

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

Defaults to: 'display'

Available since: 1.1.0

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

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

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

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

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

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

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

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

Available since: 3.4.0

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

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

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 listed in Ext.enums.Layout.

  • 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 Ext.enums.Layout for list of valid values).

    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.

Configuring the default layout type

If a certain Container class has a default layout (For example a Toolbar with a default Box layout), then to simply configure the default layout, use an object, but without the type property:

xtype: 'toolbar',
layout: {
    pack: 'center'
}

Available since: 2.3.0

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

Ext.create('Ext.Component', {
    loader: {
        url: 'content.html',
        autoLoad: true
    },
    renderTo: Ext.getBody()
});
Ext.grid.column.Column
view source
: Boolean
If the grid is configured with enableLocking, or has columns which are configured with a locked value, this option ma...

If the grid is configured with enableLocking, or has columns which are configured with a locked value, this option may be used to disable user-driven locking or unlocking of this column. This column will remain in the side into which its own locked configuration placed it.

Ext.grid.column.Column
view source
: Boolean
True to lock this column in place. ...

True to lock this column in place. Implicitly enables locking on the grid. See also Ext.grid.Panel.enableLocking.

Defaults to: false

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

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.

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.

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

Ext.grid.column.Column
view source
: String
The text to render in the column visibility selection menu for this column. ...

The text to render in the column visibility selection menu for this column. If not specified, will default to the text value.

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.

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.

Ext.grid.column.Column
view source
: Booleanprivate
The default setting indicates that external CSS rules dictate that the title is white-space: nowrap and therefore, wi...

The default setting indicates that external CSS rules dictate that the title is white-space: nowrap and therefore, width cannot affect the measured height by causing text wrapping. This is what the Sencha-supplied styles set. If you change those styles to allow text wrapping, you must set this to false.

Defaults to: true

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

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

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

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

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

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

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

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

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

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

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

By using config object with ptype:

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

Or with just a ptype:

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

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

Available since: 2.3.0

: "north"/"south"/"east"/"west"/"center"
Defines the region inside border layout. ...

Defines the region inside border layout.

Possible values:

  • north - Positions component at top.
  • south - Positions component at bottom.
  • east - Positions component at right.
  • west - Positions component at left.
  • center - Positions component at the remaining space. There must be a component with region: "center" in every border layout.
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.

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 renders a title and description into its element:

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

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

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

Available since: 2.3.0

Ext.grid.column.Column
view source
: Ext.XTemplate/String/String[]protected
End Definitions ...

End Definitions

Defaults to: ['<div id="{id}-titleEl" role="presentation" {tipMarkup}class="', Ext.baseCSSPrefix, 'column-header-inner', '<tpl if="empty"> ', Ext.baseCSSPrefix, 'column-header-inner-empty</tpl>">', '<span id="{id}-textEl" class="', Ext.baseCSSPrefix, 'column-header-text', '{childElCls}">', '{text}', '</span>', '<tpl if="!menuDisabled">', '<div id="{id}-triggerEl" role="presentation" class="', Ext.baseCSSPrefix, 'column-header-trigger', '{childElCls}"></div>', '</tpl>', '</div>', '{%this.renderContainer(out,values)%}']

Overrides: Ext.container.AbstractContainer.renderTpl

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

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

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

Additionally a string naming an Ext.util.Format method can be passed:

{
    renderer: 'uppercase'
}

Defaults to: false

  • 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

  • return : String

    The HTML string to be rendered.

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

False to prevent the column from being resizable.

Defaults to: true

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

True to layout this component and its descendants in "rtl" (right-to-left) mode. ...

True to layout this component and its descendants in "rtl" (right-to-left) mode. Can be explicitly set to false to override a true value inherited from an ancestor.

Defined in override Ext.rtl.AbstractComponent.

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

Ext.grid.column.Column
view source
: Object

The scope to use when calling the renderer function.

The scope to use when calling the renderer function.

Specify as true to constrain column dragging so that a column cannot be dragged into or out of this column. ...

Specify as true to constrain column dragging so that a column cannot be dragged into or out of this column.

Note that this config is only valid for column headers which contain child column headers, eg: { sealed: true text: 'ExtJS', columns: [{ text: '3.0.4', dataIndex: 'ext304' }, { text: '4.1.0', dataIndex: 'ext410' } }

Defaults to: false

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'

Number of pixels to offset the shadow.

Number of pixels to offset the shadow.

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

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

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

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

Defaults to: 2

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

Overrides: Ext.grid.header.Container.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.

Ext.grid.column.Column
view source
: String
An identifier which identifies this column uniquely within the owning grid's state. ...

An identifier which identifies this column uniquely within the owning grid's state.

This does not have to be globally unique. A column's state is not saved standalone. It is encapsulated within the owning grid's state.

Overrides: Ext.state.Stateful.stateId

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()+(10006060247)), //7 days from now }));

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

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

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

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

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

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

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

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

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

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

Defaults to: false

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

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.

Defaults to: ''

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

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

Ext.grid.column.Column
view source
: String

A tooltip to display for this column header

A tooltip to display for this column header

Ext.grid.column.Column
view source
: String
The type of tooltip to use. ...

The type of tooltip to use. Either 'qtip' for QuickTips or 'title' for title attribute.

Defaults to: "qtip"

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

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

A UI style for a component. ...

A UI style for a component.

Defaults to: 'default'

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: []

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

Overrides: Ext.AbstractComponent.weight

The width of this component in pixels.

The width of this component in pixels.

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

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

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

But by using xtype, the above becomes:

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

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

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

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

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

 // or alternatively:

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

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

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

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

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

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

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

Available since: 2.3.0

Properties

Defined By

Instance properties

...

Defaults to: 'Ext.Base'

...

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

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

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

Defaults to: false

...

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

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

Defaults to: 'columnheader'

Overrides: Ext.container.AbstractContainer.ariaRole

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

Defaults to: Ext.baseCSSPrefix + 'column-header-sort-ASC'

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

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

Defaults to: false

private ...

private

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

...

Defaults to: []

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

Defaults to: ['titleEl', 'triggerEl', 'textEl']

Overrides: Ext.util.ElementContainer.childEls

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

Defaults to: 'titleEl'

...

Defaults to: 'Columns'

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

The number of component layout calls made on this object.

Defaults to: 0

...

Defaults to: {}

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

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

Defaults to: 'padding'

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

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

...

Defaults to: 'autocomponent'

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

Defaults to: Ext.baseCSSPrefix + 'column-header-sort-DESC'

...

Defaults to: 'top'

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

Indicates whether or not the component can be dragged.

Defaults to: false

Initial suspended call count. ...

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

Defaults to: 0

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

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

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

These differences are abstracted away by the up method.

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

See floating and zIndexManager

...

Defaults to: Ext.baseCSSPrefix + 'frame'

...

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

...

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

...

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

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

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

Defaults to: {}

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

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

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

  • top : Number (optional)

    The width of the top framing element in pixels.

    Defaults to: 0

  • right : Number (optional)

    The width of the right framing element in pixels.

    Defaults to: 0

  • bottom : Number (optional)

    The width of the bottom framing element in pixels.

    Defaults to: 0

  • left : Number (optional)

    The width of the left framing element in pixels.

    Defaults to: 0

  • width : Number (optional)

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

    Defaults to: 0

  • height : Number (optional)

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

    Defaults to: 0

...

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

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

Defaults to: Ext.baseCSSPrefix + 'group-header'

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

Defaults to: Ext.baseCSSPrefix + 'group-sub-header'

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

Defaults to: 4

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

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

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

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

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

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'

...

Defaults to: []

...

Defaults to: {}

...

Defaults to: true

Ext.grid.column.Column
view source
: Booleanreadonly
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 simple column headers.

Defaults to: true

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

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

Defaults to: true

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

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

Defaults to: true

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.

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

Defaults to: true

This property has been deprected

see isColumn 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

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

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

Defaults to: true

...

Defaults to: true

The MixedCollection containing all the child items of this container.

The MixedCollection containing all the child items of this container.

Available since: 2.3.0

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

The number of container layout calls made on this object.

Defaults to: 0

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 it's disabled. Components like FieldContainer, FieldSet, Field, Button, Tab override this property to false since they want to implement custom disable logic.

Defaults to: true

...

Defaults to: Ext.baseCSSPrefix + 'cols-icon'

...

Defaults to: Ext.baseCSSPrefix + 'hmenu-sort-asc'

...

Defaults to: Ext.baseCSSPrefix + 'hmenu-sort-desc'

...

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

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

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

These differences are abstracted away by the up method.

Note: to access items within the Container see itemId.

Available since: 2.3.0

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

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

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

Indicates whether or not the component has been rendered.

Defaults to: false

Available since: 1.1.0

...

Defaults to: Ext.baseCSSPrefix + 'body'

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

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

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

This object has the following properties:

  • x : Boolean

    true if this Component is scrollable horizontally - style setting may be 'auto' or 'scroll'.

  • y : Boolean

    true if this Component is scrollable vertically - style setting may be 'auto' or 'scroll'.

  • both : Boolean

    true if this Component is scrollable both horizontally and vertically.

  • overflowX : String

    The overflow-x style setting, 'auto' or 'scroll' or ''.

  • overflowY : String

    The overflow-y style setting, 'auto' or 'scroll' or ''.

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'
    },

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

Defaults to: 'Sort Ascending'

...

Defaults to: 'Clear Sort'

...

Defaults to: 'Sort Descending'

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

Element that contains the text in column header.

Element that contains the text in column header.

private; will probably be removed by 4.0 ...

private; will probably be removed by 4.0

Defaults to: false

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.

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. If no floating ancestor is found, the global ZIndexManager is used.

See floating and zIndexParent

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

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

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

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

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

See floating and zIndexManager

Defined By

Static properties

...

Defaults to: []

Methods

Defined By

Instance methods

Creates new Component. ...

Creates new Component.

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

Overrides: Ext.AbstractComponent.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
// add multiple items.
// (defaultType for Toolbar is 'button')
tb.add([{text:'Button 1'}, {text:'Button 2'}]);

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

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

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.

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

This method has been deprected since 4.1

Use addCls instead.

Parameters

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.

Parameters

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.

Parameters

  • classes : String/String[]

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

  • skip : Object

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

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

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

Parameters

  • eventNames : Object/String...

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

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

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

    this.addEvents('storeloaded', 'storecleared');
    
Sets up the focus listener on this Component's focusEl if it has one. ...

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

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

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

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

Appends an event handler to this object. For example:

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

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

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

One can also specify options for each event handler separately:

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

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

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

Parameters

Returns

  • Object

    Only when the destroyable option is specified.

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

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

    And when those listeners need to be removed:

    Ext.destroy(this.btnListeners);
    

    or

    this.btnListeners.destroy();
    

Overrides: Ext.util.Observable.addListener

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

Parameters

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

    The item to which to add a listener/listeners.

  • ename : Object/String

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

  • fn : Function (optional)

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

  • scope : Object (optional)

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

  • options : Object (optional)

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

Returns

  • Object

    Only when the destroyable option is specified.

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

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

    And when those listeners need to be removed:

    Ext.destroy(this.btnListeners);
    

    or

    this.btnListeners.destroy();
    
Adds a plugin. ...

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

Parameters

( state, propName, [value] ) : Booleanprotected
Save a property to the given state object if it is not its default or configured value. ...

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

Parameters

  • state : Object

    The state object.

  • propName : String

    The name of the property on this object to save.

  • value : String (optional)

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

Returns

  • Boolean

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

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

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

Parameters

  • events : String/String[]

    The event name or an array of event names.

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.

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.

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

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

Parameters

...

Parameters

Ext.grid.column.Column
view source
( width, height, oldWidth, oldHeight )protectedtemplate
private Inform the header container about the resize ...

private Inform the header container about the resize

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

Parameters

Overrides: Ext.container.AbstractContainer.afterComponentLayout

...

Parameters

Fires

  • boxready
  • move
( [callback], [scope] )protectedtemplate
Invoked after the Component has been hidden. ...

Invoked after the Component has been hidden.

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

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

Parameters

Fires

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

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

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

Parameters

Fires

Ext.grid.column.Column
view source
( )protectedtemplate
Allows addition of behavior after rendering is complete. ...

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

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

Overrides: Ext.Component.afterRender

( ax, ay )protectedtemplate
Template method called after a Component has been positioned. ...

Template method called after a Component has been positioned.

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

Parameters

Fires

Overrides: Ext.AbstractComponent.afterSetPosition

( [animateTarget], [callback], [scope] )protectedtemplate
Invoked after the Component is shown (after onShow is called). ...

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

Gets passed the same parameters as show.

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

Parameters

Fires

( element, [position], [offsets], [animate] ) : Ext.util.Positionablechainable
Aligns the element with another element relative to the specified anchor points. ...

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

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

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

Value  Description
-----  -----------------------------
tl     The top left corner (default)
t      The center of the top edge
tr     The top right corner
l      The center of the left edge
c      In the center of the element
r      The center of the right edge
bl     The bottom left corner
b      The center of the bottom edge
br     The bottom right corner

Example Usage:

// align el to other-el using the default positioning
// ("tl-bl", non-constrained)
el.alignTo("other-el");

// align the top left corner of el with the top right corner of other-el
// (constrained to viewport)
el.alignTo("other-el", "tr?");

// align the bottom right corner of el with the center left edge of other-el
el.alignTo("other-el", "br-l?");

// align the center of el with the bottom left corner of other-el and
// adjust the x position by -6 pixels (and the y position by 0)
el.alignTo("other-el", "c-bl", [-6, 0]);

Parameters

  • element : Ext.util.Positionable/HTMLElement/String

    The Positionable, HTMLElement, or id of the element to align to.

  • position : String (optional)

    The position to align to

    Defaults to: "tl-bl?"

  • offsets : Number[] (optional)

    Offset the positioning by [x, y]

  • animate : Boolean/Object (optional)

    true for the default animation or a standard Element animation config object

Returns

( element, [position], [offsets], [animate], [monitorScroll], [callback] ) : Ext.util.Positionablechainable
Anchors an element to another element and realigns it when the window is resized. ...

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

Parameters

  • element : Ext.util.Positionable/HTMLElement/String

    The Positionable, HTMLElement, or id of the element to align to.

  • position : String (optional)

    The position to align to

    Defaults to: "tl-bl?"

  • offsets : Number[] (optional)

    Offset the positioning by [x, y]

  • animate : Boolean/Object (optional)

    true for the default animation or a standard Element animation config object

  • monitorScroll : Boolean/Number (optional)

    True to monitor body scroll and reposition. If this parameter is a number, it is used as the buffer delay in milliseconds.

    Defaults to: 50

  • callback : Function (optional)

    The function to call after the animation finishes

Returns

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

Parameters

Performs custom animation on this object. ...

Performs custom animation on this object.

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

Animating a Component

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

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

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

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

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

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

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

  • dynamic - Specify as true to update the Component's layout (if it is a Container) at every frame of the animation. 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.

Parameters

Returns

Overrides: Ext.util.Animate.animate

Sets references to elements inside the component. ...

Sets references to elements inside the component.

Parameters

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

Parameters

Fires

...

Parameters

Fires

...

Parameters

Sets references to elements inside the component. ...

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

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.

Parameters

The targetCls is a CSS class that the layout needs added to the targetEl. ...

The targetCls is a CSS class that the layout needs added to the targetEl. The targetEl is where the container's children are rendered and is usually just the main el. Some containers (e.g. panels) use a body instead.

In general, if a class overrides getTargetEl it will also need to override this method. This is necessary to avoid a post-render step to add the targetCls.

Parameters

Ext.grid.column.Column
view source
( The )
Sizes this Column to fit the max content width. ...

Sizes this Column to fit the max content width. Note that group columns shrinkwrap around the size of leaf columns. Auto sizing a group column autosizes descendant leaf columns.

Parameters

...

Parameters

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

Template method to do any pre-blur processing.

Parameters

( adjWidth, adjHeight )protectedtemplate
Occurs before componentLayout is run. ...

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

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

Parameters

  • adjWidth : Number

    The box-adjusted width that was set.

  • adjHeight : Number

    The box-adjusted height that was set.

Invoked before the Component is destroyed. ...

Invoked before the Component is destroyed.

Available since: 2.3.0

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

Overrides: Ext.AbstractComponent.beforeDestroy

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

Template method to do any pre-focus processing.

Parameters

Occurs before componentLayout is run. ...

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

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

Overrides: Ext.AbstractComponent.beforeLayout

Ext.grid.column.Column
view source
( )private
Template method called before a Component is positioned. ...

Template method called before a Component is positioned.

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

Overrides: Ext.AbstractComponent.beforeSetPosition

Invoked before the Component is shown. ...

Invoked before the Component is shown.

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

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

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

( [anchor], [extraX], [extraY], [size] ) : Number[]private
Calculates x,y coordinates specified by the anchor position on the element, adding extraX and extraY values. ...

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

Parameters

  • anchor : String (optional)

    The specified anchor position. See alignTo for details on supported anchor positions.

    Defaults to: 'tl'

  • extraX : Number (optional)

    value to be added to the x coordinate

  • extraY : Number (optional)

    value to be added to the y coordinate

  • size : Object (optional)

    An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size)

Returns

  • Number[]

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

( [constrainTo], [proposedPosition], [local], [proposedSize] ) : Number[]
Calculates the new [x,y] position to move this Positionable into a constrain region. ...

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

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

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

An alternative constraint may be passed.

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 Positionable was rendered, or this Component's {@link Ext.Component.constrainTo.

  • proposedPosition : Number[] (optional)

    A proposed [X, Y] position to test for validity and to coerce into constraints instead of using this Positionable's current position.

  • local : Boolean (optional)

    The proposedPosition is local (relative to floatParent if a floating Component)

  • proposedSize : Number[] (optional)

    A proposed [width, height] size to use when calculating constraints instead of using this Positionable's current size.

Returns

  • Number[]

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

( args ) : Objectdeprecatedprotected
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!");
    }
});

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

        this.callOverridden();

        alert("Meeeeoooowwww");
    }
});

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

This method has been deprected

as of 4.1. Use callParent instead.

Parameters

  • args : Array/Arguments

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

Returns

  • Object

    Returns the result of calling the overridden method

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

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

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

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

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

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

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

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

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

 var obj = new My.Derived();

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

This also works with static methods.

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

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

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

Lastly, it also works with overridden static methods.

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

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

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

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

Parameters

  • args : Array/Arguments

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

Returns

  • Object

    Returns the result of calling the parent method

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

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

Consider:

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

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

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

         this.callParent();
     }
 });

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

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

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

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

         this.callSuper();
     }
 });

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

Parameters

  • args : Array/Arguments

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

Returns

  • Object

    Returns the result of calling the superclass method

Cancel any deferred focus on this component ...

Cancel any deferred focus on this component

...

Parameters

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

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.

Returns

Fires

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

Retrieves the first direct child of this container which matches the passed selector or component. The passed in selector must comply with an Ext.ComponentQuery selector, or it can be an actual Ext.Component.

Parameters

Returns

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

Removes all listeners for this object including the managed listeners

Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

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

invoked internally by a header when not using triStateSorting

Parameters

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

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

Parameters

  • overrides : Object

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

Returns

...

Parameters

  • ptype : String/Object

    string or config object containing a ptype property.

    Constructs a plugin according to the passed config object/ptype string.

    Ensures that the constructed plugin always has a cmp reference back to this component. The setting up of this is done in PluginManager. The PluginManager ensures that a reference to this component is passed to the constructor. It also ensures that the plugin's setCmp method (if any) is called.

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

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

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

Determines whether the passed Component is either an immediate child of this Container, or whether it is a descendant. ...

Determines whether the passed Component is either an immediate child of this Container, or whether it is a descendant.

Parameters

  • comp : Ext.Component

    The Component to test.

  • deep : Boolean (optional)

    Pass true to test for the Component being a descendant at any level.

    Defaults to: false

Returns

  • Boolean

    true if the passed Component is contained at the specified level.

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

Continue to fire event.

Parameters

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

Defined in override Ext.rtl.AbstractComponent.

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.

Parameters

  • newName : String

    The name under which to refire the passed parameters.

  • beginEnd : Array (optional)

    The caller can specify on which indices to slice.

Returns

Ext.grid.column.Column
view source
( )protectedtemplate
When defined this will take precedence over the renderer config. ...

When defined this will take precedence over the renderer config. This is meant to be defined in subclasses that wish to supply their own renderer.

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

Detach a component from the DOM ...

Detach a component from the DOM

Parameters

Inherit docs Disable all immediate children that was previously disabled Override disable because onDisable only gets...

Inherit docs Disable all immediate children that was previously disabled Override disable because onDisable only gets called when rendered

Available since: 1.1.0

Returns

Fires

Overrides: Ext.AbstractComponent.disable

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

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

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

Parameters

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

Fires

  • afterrender
  • beforerender
  • move
  • render
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.

Returns

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.

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

Returns

...

Parameters

...

Parameters

...

Parameters

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

Parameters

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, or it can be an actual Ext.Component.

Parameters

Returns

Enable all immediate children that was previously disabled Override enable because onEnable only gets called when ren...

Enable all immediate children that was previously disabled Override enable because onEnable only gets called when rendered

Available since: 1.1.0

Returns

Fires

Overrides: Ext.AbstractComponent.enable

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.define('Ext.overrides.form.field.Base', {
    override: 'Ext.form.field.Base',

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

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

Parameters

  • eventNames : String/String[]

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

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

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

Parameters

  • runLayout : Boolean (optional)

    True to run the component's layout.

    Defaults to: false

Fires

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

See also the up method.

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.

Parameters

  • xtype : String/Ext.Class

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

Returns

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

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

Parameters

  • ptype : String

    The Plugin's ptype as specified by the class's alias configuration.

Returns

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

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

Parameters

  • containerIdx : Number

    The index into the Container items of this Component.

Fires

  • afterrender
  • move
  • render
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.

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 the specified event with the passed parameter list. ...

Fires the specified event with the passed parameter list.

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

Parameters

  • eventName : String

    The name of the event to fire.

  • args : Object[]

    An array of parameters which are passed to handlers.

Returns

  • Boolean

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

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

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

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

TODO: merge this functionality with Ext.globalEvents

Parameters

...

Parameters

Fires

  • move
( [selectText], [delay], [callback], [scope] ) : Ext.Component
Try to focus this component. ...

Try to focus this component.

Parameters

  • selectText : Mixed (optional)

    If applicable, true to also select all the text in this component, or an array consisting of start and end (defaults to start) position of selection.

  • delay : Boolean/Number (optional)

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

  • callback : Function (optional)

    Only needed if the delay parameter is used. A function to call upon focus.

  • scope : Function (optional)

    Only needed if the delay parameter is used. The scope (this reference) in which to execute the callback.

Returns

  • Ext.Component

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

Forces this component to redo its componentLayout. ...

Forces this component to redo its componentLayout.

This method has been deprected since 4.1.0

Use updateLayout instead.

Deprecate 5.0 ...

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

Returns

( element, [position], [offsets] ) : Number[]
Gets the x,y coordinates to align this element with another element. ...

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

Parameters

  • element : Ext.util.Positionable/HTMLElement/String

    The Positionable, HTMLElement, or id of the element to align to.

  • position : String (optional)

    The position to align to

    Defaults to: "tl-bl?"

  • offsets : Number[] (optional)

    Offset the positioning by [x, y]

Returns

private ...

private

( el, [anchor], [local], [size] ) : Number[]private
Begin Positionable methods Overridden in Ext.rtl.AbstractComponent. ...

Begin Positionable methods


Overridden in Ext.rtl.AbstractComponent.

Parameters

  • el : Ext.dom.Element

    The element

  • anchor : String (optional)

    The specified anchor position. See alignTo for details on supported anchor positions.

    Defaults to: 'tl'

  • local : Boolean (optional)

    True to get the local (element top/left-relative) anchor position instead of page coordinates

  • size : Object (optional)

    An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size)

Returns

  • Number[]

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

Overrides: Ext.util.Positionable.getAnchorToXY

( [anchor], [local], [size] ) : Number[]
Gets the x,y coordinates specified by the anchor position on the element. ...

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

Parameters

  • anchor : String (optional)

    The specified anchor position. See alignTo for details on supported anchor positions.

    Defaults to: 'tl'

  • local : Boolean (optional)

    True to get the local (element top/left-relative) anchor position instead of page coordinates

  • size : Object (optional)

    An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size)

Returns

  • Number[]

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

...

Parameters

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Returns

  • Object

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

Overrides: Ext.util.Positionable.getBorderPadding

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

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

Parameters

  • contentBox : Boolean (optional)

    If true a box for the content of the element is returned.

  • local : Boolean (optional)

    If true the element's left and top relative to its offsetParent are returned instead of page x/y.

Returns

  • Object

    box An object in the format:

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

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

Gets the bubbling parent for an Observable ...

Gets the bubbling parent for an Observable

Returns

Implements an upward event bubbling policy. ...

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

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

Overrides: Ext.AbstractComponent.getBubbleTarget

Ext.grid.column.Column
view source
( )private
...
Ext.grid.column.Column
view source
( )private
...
Ext.grid.column.Column
view source
( )private
...
Return the immediate child Component in which the passed element is located. ...

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

Parameters

  • el : Ext.Element/HTMLElement/String

    The element to test (or ID of element).

  • deep : Boolean

    If true, returns the deepest descendant Component which contains the passed element.

Returns

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

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

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.

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.

Parameters

Ext.grid.column.Column
view source
( )private
...
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: 2.3.0

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

Parameters

...

Parameters

( [constrainTo], [proposedPosition], [proposedSize] ) : Number[]/Boolean
Returns the [X, Y] vector by which this Positionable's element must be translated to make a best attempt to constrain...

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

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

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

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

Parameters

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

    The Positionable, HTMLElement, element id, or Region into which the element is to be constrained.

  • proposedPosition : Number[] (optional)

    A proposed [X, Y] position to test for validity and to produce a vector for instead of using the element's current position

  • proposedSize : Number[] (optional)

    A proposed [width, height] size to constrain instead of using the element's current size

Returns

  • Number[]/Boolean

    If the element needs to be translated, an [X, Y] vector by which this element must be translated. Otherwise, false.

Ext.grid.column.Column
view source
( )private
...
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 have an implementation if an Editing plugin has been enabled on the grid.

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

Returns

Overrides: Ext.AbstractComponent.getEl

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

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

Returns

Overrides: Ext.AbstractComponent.getFocusEl

Private ...

Private

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

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

...

Parameters

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

Gets the full width of all columns that are visible.

Returns an array of all columns which appear in the grid's View. ...

Returns an array of all columns which appear in the grid's View. This goes down to the leaf column header level, and does not return grouped headers which contain sub headers.

It includes hidden headers even though they are not rendered. This is for collection of menu items for the column hide/show menu.

Headers which have a hidden ancestor have a hiddenAncestor: true property injected so that they can also be rendered at zero width without interrogating that header's ownerCt axis for a hidden ancestor.

Parameters

Returns

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.

Parameters

  • index : Number

    The column index for which to retrieve the column.

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

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

If a group header is passed, the index of the first leaf level header within it is returned.

Parameters

Returns

  • Number

    The index of the specified column header

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

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

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.

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

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

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

To set a hierarchical "hidden" value:

this.getHierarchyState().hidden = true;

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

delete this.getHierarchyState().hidden;

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

Parameters

Retrieves the id of this component. ...

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

Returns

Overrides: Ext.AbstractComponent.getId

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

Returns the index of this column only if this column is a base level Column. If it is a group column, it returns false.

Returns

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

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

Parameters

  • name : String (optional)

    Name of the config option to return.

Returns

  • Object/Mixed

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

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

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

Parameters

Returns

  • HTMLElement

    DOM element that you can use in the insertBefore

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

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

Returns

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

Returns

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

Gets the Ext.ComponentLoader for this Component.

Returns

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Returns

Overrides: Ext.util.Positionable.getLocalX

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Returns

  • Number[]

    The local XY position of the element

Overrides: Ext.util.Positionable.getLocalXY

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

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

Returns

Overrides: Ext.util.Positionable.getLocalY

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)

Fires

...

Parameters

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.

Returns

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

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

Parameters

Returns

  • Number[]

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

Include margins ...

Include margins

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

Get an el for overflowing, defaults to the target el

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

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

Find the topmost HeaderContainer ...

Find the topmost HeaderContainer

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

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

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

Returns

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

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

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

Returns

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

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

Parameters

Returns

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

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

Parameters

  • local : Boolean (optional)

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

    Defaults to: false

Returns

  • Number[]

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

Deprecate 5.0 ...

Deprecate 5.0

Used by ComponentQuery, child and down to retrieve all of the items which can potentially be considered a child of th...

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

This may be overriden by Components which have ownership of Components that are not contained in the items collection.

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

Parameters

Overrides: Ext.Queryable.getRefItems

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

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

By default this returns the Container which contains this Component.

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

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

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

Returns

...

Fires

  • beforerender
Deprecate 5.0 ...

Deprecate 5.0

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

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

Parameters

  • contentSize : Boolean (optional)

    true to get the width/size minus borders and padding

Returns

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

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

Parameters

Returns

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.

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.

Returns

Overrides: Ext.state.Stateful.getState

Ext.grid.column.Column
view source
( ) : Stringprivate
Gets the state id for this object. ...

Gets the state id for this object.

Returns

  • String

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

Overrides: Ext.state.Stateful.getStateId

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

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

Parameters

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.

...

Parameters

Returns the content region of this element. ...

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

Returns

  • Ext.util.Region

    A Region containing "top, left, bottom, right" member data.

Deprecate 5.0 ...

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

Returns

When passed a column index, returns the closet visible column to that. ...

When passed a column index, returns the closet visible column to that. If the column at the passed index is visible, that is returned. If it is hidden, either the next visible, or the previous visible column is returned.

Parameters

  • index : Number

    Position at which to find the closest visible column.

Ext.grid.column.Column
view source
( ) : Number
Returns the index of this column in the list of visible columns only if this column is a base level Column. ...

Returns the index of this column in the list of visible columns only if this column is a base level Column. If it is a group column, it returns false.

Returns

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

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

Returns

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

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

Returns

  • Number

    The X position of the element

Overrides: Ext.util.Positionable.getX

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'

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

Returns

  • String

    The xtype hierarchy string

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

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

Returns

  • Number[]

    The XY position of the element

Overrides: Ext.util.Positionable.getXY

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

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

Returns

  • Number

    The Y position of the element

Overrides: Ext.util.Positionable.getY

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

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

This method has been deprected since 4.0

Replaced by getActiveAnimation

Returns

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

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

Parameters

  • className : String

    The CSS class to check for.

Returns

  • Boolean

    true if the class exists, else false.

...

Parameters

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

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

Parameters

  • eventName : String

    The name of the event to check for

Returns

  • Boolean

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

Ext.grid.column.Column
view source
( result )private
Private bubble function used in determining whether this column is lockable. ...

Private bubble function used in determining whether this column is lockable. Executes in the scope of each component in the bubble sequence

Parameters

Ext.grid.column.Column
view source
( result )private
Private bubble function used in determining whether this column is hideable. ...

Private bubble function used in determining whether this column is hideable. Executes in the scope of each component in the bubble sequence

Parameters

Checks if there is currently a specified uiCls. ...

Checks if there is currently a specified uiCls.

Parameters

  • cls : String

    The cls to check.

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

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

Parameters

Returns

Fires

Overrides: Ext.Component.hide

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

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

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

Ext.grid.column.Column
view source
( )privateprotected
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.

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

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

Overrides: Ext.grid.header.Container.initComponent

( config ) : Ext.Basechainableprotected
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);
    }
});

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

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

Parameters

Returns

...

Parameters

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.

Overrides: Ext.Component.initDraggable

Initialize any events on this component ...

Initialize any events on this component

Create the framingTpl from the string. ...

Create the framingTpl from the string. Poke in a reference to applyRenderTpl(frameInfo, out)

Parameters

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

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

Overridden in Ext.rtl.AbstractComponent.

Parameters

Ext.grid.column.Column
view source
( )private
Initializes padding by applying it to the target element, or if the layout manages padding ensures that the padding o...

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

Parameters

...

Parameters

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

Initialized the renderData to be used when rendering the renderTpl.

Returns

  • Object

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

Overrides: Ext.util.Renderable.initRenderData

Initializes the renderTpl. ...

Initializes the renderTpl.

Returns

Ext.grid.column.Column
view source
( )private
We need to override the default component resizable behaviour here ...

We need to override the default component resizable behaviour here

Overrides: Ext.Component.initResizable

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

Initializes the state of the object upon construction.

Fires

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

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

Parameters

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

Parameters

  • index : Number

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

  • component : Ext.Component/Object

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

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.

Parameters

  • selector : String

    The selector string to test against.

Returns

  • Boolean

    true if this Component matches the selector.

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

Determines whether this Container is an ancestor of the passed Component. This will return true if the passed Component is anywhere within the subtree beneath this Container.

Parameters

  • possibleDescendant : Ext.Component

    The Component to test for presence within this Container's subtree.

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

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

...

Parameters

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

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

Parameters

Returns

  • Boolean

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

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

Method to determine whether this Component is currently disabled.

Returns

  • Boolean

    the disabled state of this Component.

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

Method to determine whether this Component is draggable.

Returns

  • Boolean

    the draggable state of this component.

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

Method to determine whether this Component is droppable.

Returns

  • Boolean

    the droppable state of this component.

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

Method to determine whether this Component is floating.

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.

Returns

  • Boolean

    the hidden state of this Component.

Ext.grid.column.Column
view source
( )
Determines whether the UI should be allowed to offer an option to hide this column. ...

Determines whether the UI should be allowed to offer an option to hide this column.

A column may not be hidden if to do so would leave the grid with no visible columns.

This is used to determine the enabled/disabled state of header hide menu items.

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

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

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

Overrides: Ext.AbstractComponent.isLayoutRoot

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

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

Returns

  • Boolean

    true layout of this component is suspended.

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

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

Defined in override Ext.rtl.AbstractComponent.

Returns

Ext.grid.column.Column
view source
( )
Determines whether the UI should be allowed to offer an option to lock or unlock this column. ...

Determines whether the UI should be allowed to offer an option to lock or unlock this column. Note that this includes dragging a column into the opposite side of a lockable grid.

A column may not be moved from one side to the other of a lockable grid if to do so would leave one side with no visible columns.

This is used to determine the enabled/disabled state of the lock/unlock menu item used in lockable grids, and to determine dropppabilty when dragging a header.

Ext.grid.column.Column
view source
( )private
Determines whether this column is in the locked side of a grid. ...

Determines whether this column is in the locked side of a grid. It may be a descendant node of a locked column and as such will not have the locked flag set.

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

Parameters

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

Parameters

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

Defined in override Ext.rtl.AbstractComponent.

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

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

Defined in override Ext.rtl.AbstractComponent.

Returns

Returns true if this component is visible. ...

Returns true if this component is visible.

Available since: 1.1.0

Parameters

  • deep : Boolean (optional)

    Pass true to interrogate the visibility status of all parent Containers to 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: 2.3.0

Parameters

  • xtype : String

    The xtype to check for this Component

  • shallow : Boolean (optional)

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

    Defaults to: false

Returns

  • Boolean

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

...

Parameters

( msg, msgCls, elHeight )private
...

Parameters

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

Shorthand for addManagedListener.

Parameters

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

    The item to which to add a listener/listeners.

  • ename : Object/String

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

  • fn : Function (optional)

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

  • scope : Object (optional)

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

  • options : Object (optional)

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

Returns

  • Object

    Only when the destroyable option is specified.

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

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

    And when those listeners need to be removed:

    Ext.destroy(this.btnListeners);
    

    or

    this.btnListeners.destroy();
    
Moves a Component within the Container ...

Moves a Component within the Container

Parameters

Returns

Overrides: Ext.util.Positionable.move

...

Parameters

Fires

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

Shorthand for removeManagedListener.

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.

...

Parameters

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.

Parameters

Returns

  • Ext.Component

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

Returns the next sibling of this Component. ...

Returns the next sibling of this Component.

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

May also be referred to as next()

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

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] ) : Object
Shorthand for addListener. ...

Shorthand for addListener.

Parameters

  • eventName : String/Object

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

  • fn : Function (optional)

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

  • scope : Object (optional)

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

  • options : Object (optional)

    An object containing handler configuration.

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

    This object may contain any of the following properties:

    • scope : Object

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

    • delay : Number

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

    • single : Boolean

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

    • buffer : Number

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

    • target : Ext.util.Observable

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

    • element : String

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

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

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

      When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

      Defaults to: false

    • priority : Number (optional)

      An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code.

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

Returns

  • Object

    Only when the destroyable option is specified.

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

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

    And when those listeners need to be removed:

    Ext.destroy(this.btnListeners);
    

    or

    this.btnListeners.destroy();
    
Ext.grid.column.Column
view source
( child )protectedtemplate
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

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

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.

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

Available since: 3.4.0

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

Fires

Overrides: Ext.AbstractComponent.onAdded

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

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

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

Parameters

private ...

private

Parameters

Fires

( width, height )protectedtemplate
Invoked when this component has first achieved size. ...

Invoked when this component has first achieved size. Occurs after the componentLayout has completed its initial run.

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

Parameters

  • width : Number

    The width of this component

  • height : Number

    The height of this component

Fires

...

Parameters

Private Called whenever a column is added or removed or moved. ...

Private Called whenever a column is added or removed or moved. Ensures that the gridColumns caches are cleared.

Fires

( names, callback, scope )private
...

Parameters

Ext.grid.column.Column
view source
( )protectedtemplate
Allows addition of behavior to the destroy operation. ...

Allows addition of behavior to the destroy operation. After calling the superclass's onDestroy, the Component will be destroyed.

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

Overrides: Ext.grid.header.Container.onDestroy

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

Allows addition of behavior to the disable operation. After calling the superclass's onDisable, the Component will be disabled.

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

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

Parameters

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

Allows addition of behavior to the enable operation. After calling the superclass's onEnable, the Component will be enabled.

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

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

Parameters

private ...

private

Parameters

Fires

...

Parameters

Fires

( header, colsToMove, fromIdx, toIdx )private
...

Parameters

Fires

( header, w, suppressFocus )private
...

Parameters

Fires

...

Parameters

Fires

( [animateTarget], [callback], [scope] )protectedtemplate
Possibly animates down to a target element. ...

Possibly animates down to a target element.

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

Gets passed the same parameters as hide.

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

Parameters

Fires

Overrides: Ext.AbstractComponent.onHide

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

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

Parameters

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

remove the trigger open class when the menu is hidden

Parameters

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

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

Parameters

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.

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

Overrides: Ext.AbstractComponent.onPosition

Ext.grid.column.Column
view source
( child )protectedtemplate
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

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

Parameters

Fires

Overrides: Ext.grid.header.Container.onRemove

( destroying )protectedtemplate
Method to manage awareness of when components are removed from their respective Container, firing a removed event. ...

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

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

Available since: 3.4.0

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

Parameters

  • destroying : Boolean

    Will be passed as true if the Container performing the remove operation will delete this Component upon remove.

Fires

( parentNode, containerIdx )protectedtemplate
Template method called when this Component's DOM structure is created. ...

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

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

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

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

Parameters

  • parentNode : Ext.core.Element

    The parent Element in which this Component's encapsulating element is contained.

  • containerIdx : Number

    The index within the parent Container's child collection of this Component.

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

Allows addition of behavior to the resize operation.

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

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

Fires

Overrides: Ext.AbstractComponent.onResize

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

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

Override in subclasses where more complex behaviour is needed.

Gets passed the same parameters as show.

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

Fires

Overrides: Ext.Component.onShow

( [callback], [scope] )protectedtemplate
Invoked after the afterShow method is complete. ...

Invoked after the afterShow method is complete.

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

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

Parameters

Fires

sort asc when clicking on item in menu ...

sort asc when clicking on item in menu

Fires

sort desc when clicking on item in menu ...

sort desc when clicking on item in menu

Fires

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

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

Fires

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

Parameters

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

Parameters

Ext.grid.column.Column
view source
( e )private
Double click handler which, if on left or right edges, auto-sizes the column to the left. ...

Double click handler which, if on left or right edges, auto-sizes the column to the left.

Parameters

Ext.grid.column.Column
view source
( )private
...
Ext.grid.column.Column
view source
( )private
...
Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Parameters

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

Template method to do any post-blur processing.

Parameters

Prepares a given class for observable instances. ...

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

Parameters

  • T : Function

    The class constructor to prepare.

...

Parameters

...

Parameters

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.

Parameters

Returns

  • Ext.Component

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

Returns the previous sibling of this Component. ...

Returns the previous sibling of this Component.

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

May also be referred to as prev()

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

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

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

...

Parameters

...

Parameters

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.

Parameters

  • selector : String (optional)

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

Returns

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

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

Parameters

  • fn : Function

    The matcher function. It will be called with a single argument, the component being tested.

  • scope : Object (optional)

    The scope in which to run the function. If not specified, it will default to the active component.

Returns

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

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

Parameters

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

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.

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

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

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

Parameters

  • origin : Object

    The Observable whose events this object is to relay.

  • events : String[]

    Array of event names to relay.

  • prefix : String (optional)

    A common prefix to prepend to the event names. For example:

    this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
    

    Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

Returns

  • Object

    A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

    this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
    

    Can be undone by calling

    Ext.destroy(this.storeRelayers);
    

    or this.store.relayers.destroy();

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

Parameters

Returns

Fires

Removes all components from this container. ...

Removes all components from this container.

Available since: 2.3.0

Parameters

Returns

Fires

Remove any anchor to this element. ...

Remove any anchor to this element. See anchorTo.

Returns

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.

Parameters

...

Available since: 2.3.0

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

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

Parameters

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.

Parameters

  • cls : String/String[]

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

Removes an event handler. ...

Removes an event handler.

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 Ext.util.Observable.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 Ext.util.Observable.addListener or the listener will not be removed.

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

Removes listeners that were added by the mon method.

Parameters

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

    The item from which to remove a listener/listeners.

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

inherit docs ...

inherit docs

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

...

Parameters

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.

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.

( [container], [position] )
Renders the Component into the passed HTML element. ...

Renders the Component into the passed HTML element.

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

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

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

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

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

Parameters

  • container : Ext.Element/HTMLElement/String (optional)

    The element this Component should be rendered into. If it is being created from existing markup, this should be omitted.

  • position : String/Number (optional)

    The element ID or DOM node index within the container before which this component will be inserted (defaults to appending to the end of the container)

Fires

  • afterrender
  • beforerender
  • move
  • render
Resumes firing of the named event(s). ...

Resumes firing of the named event(s).

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

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

Parameters

  • eventName : String...

    Multiple event names to resume.

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.

...

Parameters

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

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.

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

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

Parameters

  • propNames : String/String[]

    The name (or array of names) of the property to save.

  • state : Object

    The state object in to which to save the property values.

Returns

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

Saves the state of the object to the persistence store.

Fires

( deltaX, deltaY, animate )
Scrolls this Component's target element by the passed delta values, optionally animating. ...

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

All of the following are equivalent:

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

Parameters

  • deltaX : Number/Number[]/Object

    Either the x delta, an Array specifying x and y deltas or an object with "x" and "y" properties.

  • deltaY : Number/Boolean/Object

    Either the y delta, or an animate flag or config object.

  • animate : Boolean/Object

    Animate flag/config object if the delta values were passed separately.

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.

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.

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.

Parameters

  • scroll : Boolean

    True to allow the Component to auto scroll.

Returns

...

Parameters

  • border : String/Number

    The border, see border. If a falsey value is passed the border will be removed.

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

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

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

Parameters

  • region : String

    The new region value ("north", "south", "east" or "west").

Returns

  • String

    The previous value of the region property.

Sets the element's box. ...

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

Parameters

  • box : Object

    The box to fill {x, y, width, height}

  • animate : Boolean/Object (optional)

    true for the default animation or a standard Element animation config object

Returns

Fires

  • move
...

Parameters

( config, applyIfNotSet ) : Ext.Basechainableprivate
...

Parameters

Returns

Enable or disable the component. ...

Enable or disable the component.

Parameters

  • disabled : Boolean

    true to disable.

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)

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.

Parameters

  • field : Object

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

...

Parameters

Sets the height of the component. ...

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

Parameters

  • height : Number

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

    • 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

...

Parameters

...

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.

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.

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Parameters

Returns

Overrides: Ext.util.Positionable.setLocalX

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Parameters

Returns

Overrides: Ext.util.Positionable.setLocalXY

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

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

Parameters

Returns

Overrides: Ext.util.Positionable.setLocalY

Sets the margin on the target element. ...

Sets the margin on the target element.

Parameters

Ext.grid.column.Column
view source
( isMenuOpen )private
Called when the column menu is activated/deactivated. ...

Called when the column menu is activated/deactivated. Change the UI to indicate active/inactive menu

Parameters

( overflowX, overflowY ) : Ext.Componentchainable
Sets the overflow x/y on the content element of the component. ...

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

Parameters

  • overflowX : String

    The overflow-x value.

  • overflowY : String

    The overflow-y value.

Returns

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.

Parameters

  • x : Number/Number[]

    The new x position or an array of [x,y].

  • y : Number (optional)

    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

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

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

Parameters

  • x : Number/Number[]/Object

    The new left, an array of [x,y], or animation config object containing x and y properties.

  • y : Number (optional)

    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

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

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

Parameters

  • region : Ext.util.Region

    The region to fill

  • animate : Boolean/Object (optional)

    true for the default animation or a standard Element animation config object

Returns

Fires

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

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

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

Parameters

  • weight : Number

    The new weight value.

Returns

  • Number

    The previous value of the weight property.

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

Parameters

  • width : Number/String/Object

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

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

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

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

Returns

Ext.grid.column.Column
view source
( state, skipClear, initial )private
...

Parameters

Overrides: Ext.grid.header.Container.setSortState

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

Sets the header text for this Column.

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.

Parameters

  • ui : String

    The new UI for the component.

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

Convenience function to hide or show this component by Boolean.

Available since: 1.1.0

Parameters

  • visible : Boolean

    true to show, false to hide.

Returns

Sets the width of the component. ...

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

Parameters

  • width : Number

    The new width to setThis may be one of:

Returns

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

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

Parameters

Returns

Overrides: Ext.util.Positionable.setX

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

Sets the position of the DOM element in page coordinates.

Parameters

Returns

Overrides: Ext.util.Positionable.setXY

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

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

Parameters

Returns

Overrides: Ext.util.Positionable.setY

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

z-index is managed by the zIndexManager and may be overwritten at any time. 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.

Parameters

Inject a reference to the function which applies the render template into the framing template. ...

Inject a reference to the function which applies the render template into the framing template. The framing template wraps the content.

Parameters

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

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

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.

Parameters

Returns

Fires

Overrides: Ext.Component.show

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

Parameters

  • x : Number/Number[]

    The new x position or array of [x,y].

  • y : Number (optional)

    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

( component, [position], [offsets] ) : Ext.Componentchainable
Shows this component by the specified Component or Element. ...

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

Parameters

Returns

Fires

...

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++;
    },

    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

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.

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.

This method has been deprected since 4.0

Replaced by stopAnimation

Returns

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

Suspends firing of the named event(s).

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

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

Parameters

  • eventName : String...

    Multiple event names to suspend.

Suspends the firing of all events. ...

Suspends the firing of all events. (see resumeEvents)

Parameters

  • queueSuspended : Boolean

    Pass as true to queue up suspended events to be fired 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.

Returns

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

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

Fires

  • afterrender
  • beforehide
  • beforerender
  • beforeshow
  • move
  • render
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.

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

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

Returns

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.

Parameters

  • preventFocus : Boolean (optional)

    Specify true to prevent the Component from being focused.

    Defaults to: false

Returns

Ext.grid.column.Column
view source
( )private
...
Translates the passed page coordinates into left/top css values for the element ...

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

Parameters

  • x : Number/Array

    The page x or an array containing [x, y]

  • y : Number (optional)

    The page y, required if x is not an array

Returns

  • Object

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

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

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

Parameters

  • x : Number/Array

    The page x or an array containing [x, y]

  • y : Number (optional)

    The page y, required if x is not an array

Returns

  • Object

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

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

Shorthand for removeListener.

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 Ext.util.Observable.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 Ext.util.Observable.addListener or the listener will not be removed.

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Parameters

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

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

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

These differences are abstracted away by this method.

Example:

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

Parameters

  • selector : String/Ext.Component (optional)

    The selector component or actual component to test. If not passed the immediate owner/activater is returned.

  • limit : String/Number/Ext.Component (optional)

    This may be a selector upon which to stop the upward scan, or a limit of the number of steps, or Component reference to stop on.

Returns

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

Update the content area of a component.

Available since: 3.4.0

Parameters

  • htmlOrData : String/Object

    If this component has been configured with a template via the tpl config then 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.

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

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

Parameters

  • box : Object

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

Returns

Fires

Updates this component's layout. ...

Updates this component's layout. If this update affects this components ownerCt, that component's updateLayout method will be called to perform the layout instead. Otherwise, just this component (and its child items) will layout.

Parameters

  • options : Object (optional)

    An object with layout options.

    • defer : Boolean

      true if this layout should be deferred.

    • isRoot : Boolean

      true if this layout should be the root of the layout.

Defined By

Static methods

( config )privatestatic
...

Parameters

( members )chainableprivatestatic
...

Parameters

( name, member )chainableprivatestatic
...

Parameters

( members )chainablestatic
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.addMembers({
     meow: function() {
        alert('Meowww...');
     }
 });

 var kitty = new My.awesome.Cat;
 kitty.meow();

Parameters

( 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() { ... };
});

Parameters

Returns

( xtype )chainableprivatestatic
...

Parameters

( fromClass, members ) : Ext.Basechainableprivatestatic
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 '$$$$$$$'

Parameters

  • fromClass : Ext.Base

    The class to borrow members from

  • members : Array/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.

Returns

Overrides: Ext.layout.Layout.create

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

Parameters

( config )privatestatic
...

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'

Returns

( )deprecatedstatic
Adds members to class. ...

Adds members to class.

This method has been deprected since 4.1

Use addMembers instead.

( name, mixinClass )privatestatic
Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

( fn, scope )chainableprivatestatic
...

Parameters

( members ) : Ext.Basechainabledeprecatedstatic
Override members of this class. ...

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

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

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

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

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

As of 4.1, direct use of this method is deprecated. Use Ext.define instead:

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

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

This method has been deprected since 4.1.0

Use Ext.define instead

Parameters

  • members : Object

    The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

Defined By

Events

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

Fires after a Component has been visually activated.

Note This event is only fired if this Component is a child of a Ext.container.Container that uses Ext.layout.container.Card as it's layout or this Component is a floating Component.

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.

This event bubbles: 'add' will also be fired when Component is added to any of the child containers or their childern or ...

Available since: 2.3.0

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

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

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 postprocessed by any afterRender method defined for the Component.

Available since: 3.4.0

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.

Note This event is only fired if this Component is a child of a Ext.container.Container that uses Ext.layout.container.Card as it's layout.

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

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.

Note This event is only fired if this Component is a child of a Ext.container.Container that uses Ext.layout.container.Card as it's layout.

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

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

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

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

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

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.

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.

Parameters

Fires when this Component loses focus. ...

Fires when this Component loses focus.

Parameters

( this, width, height, eOpts )
Fires one time - after the component has been laid out for the first time at its initial size. ...

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

Parameters

...

Parameters

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

Parameters

...

Parameters

Fired after the columns change in any way, when a column has been hidden or shown, or when a column is added to or re...

Fired after the columns change in any way, when a column has been hidden or shown, or when a column is added to or removed from this header container.

Parameters

...

Parameters

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

Fires after a Component has been visually deactivated.

Note This event is only fired if this Component is a child of a Ext.container.Container that uses Ext.layout.container.Card as it's layout or this Component is a floating Component.

Parameters

Fires after the component is destroyed. ...

Fires after the component is destroyed.

Available since: 1.1.0

Parameters

Fires after the component is disabled. ...

Fires after the component is disabled.

Available since: 1.1.0

Parameters

Fires after the component is enabled. ...

Fires after the component is enabled.

Available since: 1.1.0

Parameters

Fires when this Component receives focus. ...

Fires when this Component receives focus.

Parameters

...

Parameters

...

Parameters

...

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

Parameters

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

Fired immediately after the column header menu is created.

Parameters

Fires after the component is moved. ...

Fires after the component is moved.

Parameters

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

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

This event bubbles: 'remove' will also be fired when Component is removed from any of the child containers or their children or ...

Available since: 2.3.0

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

Parameters

Fires after the component markup is rendered. ...

Fires after the component markup is rendered.

Available since: 1.1.0

Parameters

( this, width, height, oldWidth, oldHeight, eOpts )
Fires after the component is resized. ...

Fires after the component is resized. Note that this does not fire when the component is first laid out at its initial size. To hook that point in the life cycle, use the boxready event.

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

Parameters

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

Parameters

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

Fires after the state of the object is restored.

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.

Parameters

Defined By

CSS Variables

Ext.grid.column.Column
view source
: string
The border-style of grid column headers ...

The border-style of grid column headers

Defaults to: solid

Ext.grid.column.Column
view source
: number
The border-width of grid column headers ...

The border-width of grid column headers

Defaults to: 1px

Ext.grid.column.Column
view source
: color
The text color of grid column headers ...

The text color of grid column headers

Defaults to: #000

Ext.grid.column.Column
view source
: string
The font-family of grid column headers ...

The font-family of grid column headers

Defaults to: $font-family

Ext.grid.column.Column
view source
: number
The font-size of grid column headers ...

The font-size of grid column headers

Defaults to: $font-size

Ext.grid.column.Column
view source
: string
The font-weight of grid column headers ...

The font-weight of grid column headers

Defaults to: normal

Ext.grid.column.Column
view source
: number
The line-height of grid column headers ...

The line-height of grid column headers

Defaults to: round ( $grid-row-cell-font-size * 1.15 )

Ext.grid.column.Column
view source
: string
The text-overflow of grid column headers ...

The text-overflow of grid column headers

Defaults to: ellipsis

The background-color of grid headers ...

The background-color of grid headers

Defaults to: #ddd

The background-gradient of grid headers. ...

The background-gradient of grid headers. Can be either the name of a predefined gradient or a list of color stops. Used as the $type parameter for Global_CSS.background-gradient.

Defaults to: 'grid-header'

The border-color of grid headers ...

The border-color of grid headers

Defaults to: #333

The border-style of grid headers ...

The border-style of grid headers

Defaults to: solid

The border-width of grid headers ...

The border-width of grid headers

Defaults to: 1px

The background-color of a grid header when its menu is open ...

The background-color of a grid header when its menu is open

Defaults to: transparent

The background-color of grid headers when the cursor is over the header ...

The background-color of grid headers when the cursor is over the header

Defaults to: #eee

The background-gradient of grid headers when the cursor is over the header. ...

The background-gradient of grid headers when the cursor is over the header. Can be either the name of a predefined gradient or a list of color stops. Used as the $type parameter for Global_CSS.background-gradient.

Defaults to: 'grid-header-over'

The padding to apply to grid headers ...

The padding to apply to grid headers

Defaults to: 5px

The space between the grid header sort icon and the grid header text ...

The space between the grid header sort icon and the grid header text

Defaults to: 3px

The width of the grid header sort icon ...

The width of the grid header sort icon

Defaults to: 9px

The background-color of the header trigger ...

The background-color of the header trigger

Defaults to: transparent

The background-color of the header trigger when the menu is open ...

The background-color of the header trigger when the menu is open

Defaults to: transparent

The background-position of the header trigger ...

The background-position of the header trigger

Defaults to: 0 center

The type of cursor to display when the cursor is over a grid header trigger ...

The type of cursor to display when the cursor is over a grid header trigger

Defaults to: pointer

The height of grid header triggers ...

The height of grid header triggers

Defaults to: 22px

The amount of space between the header trigger and text ...

The amount of space between the header trigger and text

Defaults to: 1px

The width of grid header triggers ...

The width of grid header triggers

Defaults to: 14px