Ext.grid.column.Column xtype: gridcolumn

baseCls : String

The base CSS class to apply to this components's element. This will also be prepended to elements within this compone...

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

cls : String

An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for ...

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

componentCls : String

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

disabledCls : String

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

overCls : String

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. (defaults to ''). This can be useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.

styleHtmlCls : String

The class that is added to the content target when you set styleHtmlContent to true. Defaults to 'x-html'

tdCls : String

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

Other Configs

activeItem : String/Number

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

align : String

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

autoDestroy : Boolean

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.

autoEl : Mixed

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

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

autoRender : Mixed

This config is intended mainly for floating Components which may or may not be shown. Instead of using renderTo in th...

This config is intended mainly for 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.

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

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

This defaults to true for the Window class.

autoScroll : Boolean

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

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

autoShow : Boolean

True to automatically show the component upon creation. This config option may only be used for floating components o...

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.

baseCls : String

The base CSS class to apply to this components's element. This will also be prepended to elements within this compone...

border : Number/String

Specifies the border for this component. The border can be a single numeric value to apply to all sides or it can be ...

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

bubbleEvents : Array

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

An array of events that, when fired, should be bubbled to any parent container. See Ext.util.Observable.enableBubble. Defaults to ['add', 'remove'].

cls : String

An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for ...

columns : Array

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

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.

componentCls : String

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

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

contentEl : String

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

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

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

data : Mixed

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

dataIndex : String

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

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

defaultType : String

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

defaultWidth : Number

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

defaults : Object|Function

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.

If an added item is a config object, and not an instantiated Component, then the default properties are unconditionally applied. If the added item is an instantiated Component, then the default properties are applied conditionally so as not to override existing properties in the item.

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: [
    {
        xtype: 'panel',   // defaults do not have precedence over
        id: 'panel1',     // options in config objects, so the defaults
        autoScroll: false // will not be applied here, panel1 will be autoScroll:false
    },
    new Ext.panel.Panel({       // defaults do have precedence over options
        id: 'panel2',     // options in components, so the defaults
        autoScroll: false // will be applied here, panel2 will be autoScroll:true.
    })
]

disabled : Boolean

Defaults to false.

disabledCls : String

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

draggable : Boolean

Indicates whether or not the header can be drag and drop re-ordered. Defaults to true.

floating : Boolean

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

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.

focusOnToFront : Boolean

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

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

frame : Boolean

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.

groupable : Boolean

Optional. If the grid uses a Ext.grid.feature.Grouping, this option may be used to disable the header menu item to gr...

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

height : Number

The height of this component in pixels.

hidden : Boolean

Defaults to false.

hideMode : String

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

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

hideable : Boolean

Optional. Specify as false to prevent the user from hiding this column (defaults to true).

html : String/Object

An HTML fragment, or a DomHelper specification to use as the layout element content (defaults to ''). The HTML conten...

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

id : String

The unique id of this component instance (defaults to an auto-assigned id). It should not be necessary to use this ...

The unique id of this component instance (defaults to an auto-assigned id).

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.

itemId : String

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, query, down and child.

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

items : Object/Array

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

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

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

Example:

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

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

Each item may be:

A Component
A Component configuration object

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

Every Component class has its own xtype.

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

Notes:

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

Do not specify contentEl or html with items.

layout : String/Object

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

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

Auto Default
card
fit
hbox
vbox
anchor
table

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: {
    type: 'vbox',
    padding: '5',
    align: 'left'
}

layout

The layout type to be used for this container (see list of valid layout type values above).

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

listeners : Object

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

(optional)

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 ExtJs Components

While some ExtJs 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 click 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'); }
        }
    }
});

loader : Ext.ComponentLoader/Object

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

maintainFlex : Boolean

Only valid when a sibling element of a Splitter within a VBox or HBox layout. Specifies that if an immediate siblin...

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

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

margin : Number/String

Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can be ...

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

maxHeight : Number

The maximum value in pixels which this Component will set its height to. Warning: This will override any size manag...

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

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

maxWidth : Number

The maximum value in pixels which this Component will set its width to. Warning: This will override any size manage...

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

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

menuDisabled : Boolean

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

minHeight : Number

The minimum value in pixels which this Component will set its height to. Warning: This will override any size manag...

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

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

minWidth : Number

The minimum value in pixels which this Component will set its width to. Warning: This will override any size manage...

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

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

overCls : String

An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and...

padding : Number/String

Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it can b...

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

plugins : Object/Array

An object or array of objects that will provide custom functionality for this component. The only requirement for a ...

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

renderSelectors : Object

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 rendered an image, and description into its element might use the following properties coded into its prototype:

renderTpl: '&lt;img src="{imageUrl}" class="x-image-component-img">&lt;div class="x-image-component-desc">{description}&gt;/div&lt;',

renderSelectors: {
    image: 'img.x-image-component-img',
    descEl: 'div.x-image-component-desc'
}

After rendering, the Component would have a property image referencing its child img Element, and a property descEl referencing the div Element which contains the description.

renderTo : Mixed

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

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

Notes :

See render also.

renderTpl : Mixed

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

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

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

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

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

renderer : Function

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

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

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

resizable : Mixed

Specify as true to apply a Resizer to this Component after rendering. May also be specified as a config object to b...

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

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

resizeHandles : String

A valid Ext.resizer.Resizer handles config string (defaults to 'all'). Only applies when resizable = true.

saveBuffer : Number

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

shadow : String/Boolean

Specifies whether the floating component should be given a shadow. Set to true to automatically create an Ext.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'.)

sortable : Boolean

Optional. true if sorting is to be allowed on this column. Whether local/remote sorting is used is specified in Ext.d...

Optional. true if sorting is to be allowed on this column. Whether local/remote sorting is used is specified in Ext.data.Store.remoteSort.

stateEvents : Array

An array of events that, when fired, should trigger this object to save its state (defaults to none). stateEvents may...

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.

stateId : String

The unique id for this object to use for state management purposes. See stateful for an explanation of saving and re...

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

See stateful for an explanation of saving and restoring state.

stateful : Boolean

A flag which causes the object to attempt to restore the state of internal properties from a saved state on startup. ...

A flag which causes the object to attempt to restore the state of internal properties from a saved state on startup. The object must have a stateId for state to be managed. Auto-generated ids are not guaranteed to be stable across page loads and cannot be relied upon to save and restore the same state for a object.

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

To set the state provider for the current page:

Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
    expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now
}));

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

To save state, a stateful object first serializes its state by calling getState. By default, this function does nothing. The developer must provide an implementation which returns an object hash which represents the restorable state of the object.

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

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

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

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

style : String

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

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

styleHtmlCls : String

The class that is added to the content target when you set styleHtmlContent to true. Defaults to 'x-html'

styleHtmlContent : String

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

suspendLayout : Boolean

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

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

tdCls : String

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

text : String

Optional. The header text to be used as innerHTML (html tags are accepted) to display in the Grid. Note: to have a c...

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

toFrontOnShow : Boolean

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

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

tpl : Mixed

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

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

tplWriteMode : String

The Ext.(X)Template method to use when updating the content area of the Component. Defaults to 'overwrite' (see Ext.X...

The Ext.(X)Template method to use when updating the content area of the Component. Defaults to 'overwrite' (see Ext.XTemplate.overwrite).

ui : String/Array

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

weight : Number

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

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.

width : Number

The width of this component in pixels.

Defined By

Properties

draggable : Boolean

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

floatParent : Ext.Container

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

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

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

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

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

See floating and zIndexManager

frameSize : Object

Read-only property indicating the width of any framing elements which were added within the encapsulating element to ...

Read-only property indicating the width of any framing elements which were added within the encapsulating element to provide graphical, rounded borders. See the frame config.

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

top The width of the top framing element in pixels.
right The width of the right framing element in pixels.
bottom The width of the bottom framing element in pixels.
left The width of the left framing element in pixels.

hasActiveFx : Object

@deprecated 4.0 Replaced by getActiveAnimation Returns thq current animation if this object has any effects actively ...

@deprecated 4.0 Replaced by getActiveAnimation Returns thq current animation if this object has any effects actively running or queued, else returns false.

isGroupHeader : Boolean

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

items : Ext.util.MixedCollection

The MixedCollection containing all the child items of this container.

maskOnDisable : Boolean

This is an internal flag that you use when creating custom components. By default this is set to true which means tha...

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

ownerCt : Ext.Container

This Component's owner Container (defaults to undefined, and is set automatically when this Component is added to a C...

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

Note: to access items within the Container see itemId.

rendered : Boolean

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

stopFx : Object

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.

textEl : Ext.core.Element

triggerEl : Ext.core.Element

zIndexManager : Ext.ZIndexManager

Optional. Only present for floating Components after they have been rendered. A reference to the ZIndexManager whic...

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

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

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

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

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

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

See floating and floatParent

Defined By

Methods

Column( Ext.core.Element/String/Object config) : void

Parameters

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

void

add( ...Object/Array Component) : Ext.Component/Array

Adds Component(s) to this Container. Description: Fires the beforeadd event before adding. The Container's default...

Adds Component(s) to this Container.

Description:

Fires the beforeadd event before adding.
The Container's default config values will be applied accordingly (see defaults for details).
Fires the add event after the component has been added.

Notes:

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

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

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

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

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

Warning:##

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

Parameters

Component : ...Object/Array
Either one or more Components to add or an Array of Components to add. See items for additional information.

Returns

Ext.Component/Array
The Components that were added.

addClass( String cls) : Ext.Component

@deprecated 4.0 Replaced by {link:#addCls} Adds a CSS class to the top level element representing this component.

Parameters

cls : String
The CSS class name to add

Returns

Ext.Component
Returns the Component to allow method chaining.

addCls( String cls) : Ext.Component

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

Parameters

cls : String
The CSS class name to add

Returns

Ext.Component
Returns the Component to allow method chaining.

addClsWithUI( String/Array cls) : void

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

Parameters

cls : String/Array
A string or an array of strings to add to the uiCls

Returns

void

addEvents( Object/String o, String ) : void

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

Parameters

o : Object/String
Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.
: String
[additional] Optional additional event names if multiple event names are being passed as separate parameters. Usage:
```
this.addEvents('storeloaded', 'storecleared');
```

Returns

void

addListener( String eventName, Function handler, [Object scope], [Object options]) : void

Appends an event handler to this object.

Parameters

eventName : String
The name of the event to listen for. May also be an object who's property names are event names. See
handler : Function
The method the event invokes.
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. properties. This may contain any of the following properties:
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
- target : Observable
  Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
- element : String
  This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.
  
  This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
```
new Ext.panel.Panel({
    title: 'The title',
    listeners: {
        click: this.handlePanelClick,
        element: 'body'
    }
});
```
  When added in this way, the options available are the options applicable to Ext.core.Element.addListener
Combining Options
Using the options argument, it is possible to combine different types of listeners:

A delayed, one-time listener.
```
myPanel.on('hide', this.handleClick, this, {
single: true,
delay: 100
});
```
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
```
myGridPanel.on({
    cellClick: this.onCellClick,
    mouseover: this.onMouseOver,
    mouseout: this.onMouseOut,
    scope: this // Important. Ensure "this" is correct during handler execution
});
```
.

Returns

void

addManagedListener( Observable/Element item, Object/String ename, Function fn, Object scope, Object opt) : void

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

Parameters

item : Observable/Element
The item to which to add a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function
Optional. If the ename parameter was an event name, this is the handler function.
scope : Object
Optional. If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.
opt : Object
Optional. If the ename parameter was an event name, this is the addListener options.

Returns

void

addStateEvents( String/Array events) : void

Add events that will trigger the state to be saved.

Parameters

events : String/Array
The event name or an array of event names.

Returns

void

afterComponentLayout( Number adjWidth, Number adjHeight, Boolean isSetSize, Ext.Component layoutOwner) : void

Parameters

adjWidth : Number
The box-adjusted width that was set
adjHeight : Number
The box-adjusted height that was set
isSetSize : Boolean
Whether or not the height/width are stored on the component permanently
layoutOwner : Ext.Component
Component which sent the layout. Only used when isSetSize is false.

Returns

void

alignTo( Mixed element, String position, [Array offsets]) : Component

Aligns this floating Component to the specified element

Parameters

element : Mixed
The element or Ext.Component to align to. If passing a component, it must be a omponent instance. If a string id is passed, it will be used as an element id.
position : String
(optional, defaults to "tl-bl?") The position to align to (see Ext.core.Element.alignTo for more details).
offsets : Array
(optional) Offset the positioning by [x, y]

Returns

Component
this

animate( Object config) : Object

Perform custom animation on this object. This method is applicable to both the the Component class and the Element cl...

Perform custom animation on this object.

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

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

Properties include

from
An object which specifies start values for the properties being animated. If not supplied, properties are animated from current settings. The actual properties which may be animated depend upon ths object being animated. See the sections below on Element and Component animation.
to
An object which specifies end values for the properties being animated.
duration
The duration in milliseconds for which the animation will run.
easing
A string value describing an easing type to modify the rate of change from the default linear to non-linear. Values may be one of:ease easeIn easeOut easeInOut backIn backOut elasticIn elasticOut bounceIn bounceOut
keyframes
This is an object which describes the state of animated properties at certain points along the timeline. it is an object containing properties who's names are the percentage along the timeline being described and who's values specify the animation state at that point.
listeners
This is a standard listeners configuration object which may be used to inject behaviour at either the beforeanimate event or the afteranimate event.

Animating an Element

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

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

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

Animating a Component

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

x
The Component's page X position in pixels.
y
The Component's page Y position in pixels
left
The Component's left value in pixels.
top
The Component's top value in pixels.
width
The Component's width value in pixels.
width
The Component's width value in pixels.
dynamic
Specify as true to update the Component's layout (if it is a Container) at every frame of the animation. Use sparingly as laying out on every intermediate size change is an expensive operation.

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

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

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

Parameters

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

Returns

Object
this

applyState( Object state) : void

Applies the state to the object. This should be overridden in subclasses to do more complex state operations. By defa...

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

state : Object
The state

Returns

void

beforeComponentLayout( Number adjWidth, Number adjHeight, Boolean isSetSize, Ext.Component layoutOwner) : void

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

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

Parameters

adjWidth : Number
The box-adjusted width that was set
adjHeight : Number
The box-adjusted height that was set
isSetSize : Boolean
Whether or not the height/width are stored on the component permanently
layoutOwner : Ext.Component
Component which sent the layout. Only used when isSetSize is false.

Returns

void

beforeLayout : void

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

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

Returns

void

bubble( Function fn, [Object scope], [Array args]) : Ext.Component

Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of...

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 (default to passing the current component)

Returns

Ext.Component
this

capture( Observable o, Function fn, [Object scope]) : void

Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + ...

Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + standard signature of the event before the event is fired. If the supplied function returns false, the event will not fire.

Parameters

o : Observable
The Observable to capture events from.
fn : Function
The function to call when an event is fired.
scope : Object
(optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

Returns

void

cascade( Function fn, [Object scope], [Array args]) : Ext.Container

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.

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

Ext.Container
this

center : Component

Center this Component in its container.

Returns

Component
this

child( String selector) : void

Retrieves the first direct child of this container which matches the passed selector. The passed in selector must com...

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

Parameters

selector : String
An Ext.ComponentQuery selector

Returns

void
Ext.Component

clearListeners : void

Removes all listeners for this object including the managed listeners

Returns

void

clearManagedListeners : void

Removes all managed listeners for this object.

Returns

void

cloneConfig( Object overrides) : Ext.Component

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

Ext.Component
clone The cloned copy of this component

destroy : void

Destroys this stateful object.

Returns

void

disable( Boolean silent) : void

Disable the component.

Parameters

silent : Boolean
Passing true, will supress the 'disable' event from being fired.

Returns

void

doAutoRender : void

Handles autoRender. Floating Components may have an ownerCt. If they are asking to be constrained, constrain them wit...

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

Returns

void

doComponentLayout( Object width, Object height, Object isSetSize, Object ownerCt) : Ext.container.Container

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.

Parameters

width : Object
height : Object
isSetSize : Object
ownerCt : Object

Returns

Ext.container.Container
this

doConstrain( Mixed constrainTo) : void

Moves this floating Component into a constrain region. By default, this Component is constrained to be within the c...

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 : Mixed
Optional. The Element or Region into which this Component is to be constrained.

Returns

void

doLayout : Ext.container.Container

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

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

Returns

Ext.container.Container
this

down( String selector) : void

Retrieves the first descendant of this container which matches the passed selector. The passed in selector must compl...

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

Parameters

selector : String
An Ext.ComponentQuery selector

Returns

void
Ext.Component

enable( Boolean silent) : void

Enable the component

Parameters

silent : Boolean
Passing false will supress the 'enable' event from being fired.

Returns

void

enableBubble( String/Array events) : void

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

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

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

Example:

Ext.override(Ext.form.field.Base, {
//  Add functionality to Field's initComponent to enable the change event to bubble
initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
    this.enableBubble('change');
}),

//  We know that we want Field's events to bubble directly to the FormPanel.
getBubbleTarget : function() {
    if (!this.formPanel) {
        this.formPanel = this.findParentByType('form');
    }
    return this.formPanel;
}
});

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

Parameters

events : String/Array
The event name to bubble, or an Array of event names.

Returns

void

findLayoutController : void

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

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

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

Returns

void

findParentBy( Function fn) : Ext.container.Container

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

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

Parameters

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

Returns

Ext.container.Container
The first Container for which the custom function returns true

findParentByType( String/Class xtype) : Ext.container.Container

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

Parameters

xtype : String/Class
The xtype string for a component, or the class of the component directly

Returns

Ext.container.Container
The first Container which matches the given xtype or class

fireEvent( String eventName, Object... args) : Boolean

Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Ob...

Fires the specified event with the passed parameters (minus the event name).

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.

focus( [Boolean selectText], [Boolean/Number delay]) : Ext.Component

Try to focus this component.

Parameters

selectText : Boolean
(optional) If applicable, true to also select the text in this component
delay : Boolean/Number
(optional) Delay the focus this number of milliseconds (true for 10 milliseconds).

Returns

Ext.Component
this

getActiveAnimation : Mixed

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

Returns

Mixed
anim if element has active effects, else false

getBox( [Boolean local]) : Object

Gets the current box measurements 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

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

Ext.container.Container
view source

getBubbleTarget : Ext.container.Container

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

Returns

Ext.container.Container
the Container which owns this Component.

getChildByElement( Object el) : Component

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

Parameters

el : Object
The element to test.

Returns

Component
The child item which contains the passed element.

getColumnCount : void

Returns the number of grid columns descended from this HeaderContainer. Group Columns are HeaderContainers. All grid ...

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

Returns

void

getColumnMenu( Object headerContainer) : void

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

headerContainer : Object

Returns

void

getComponent( String/Number comp) : void

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

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

void
Ext.Component The component (if found).

getEditor( Object record, Mixed defaultField) : Ext.form.field.Field

Retrieves the editing field for editing associated with this header. Returns false if there is no field associated wi...

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

Parameters

record : Object
The Model instance being edited.
defaultField : Mixed
An object representing a default field to be created

Returns

Ext.form.field.Field
field

getEl : void

Retrieves the top level element representing this component.

Returns

void

getFullWidth( Object flushCache) : void

Gets the full width of all columns that are visible.

Parameters

flushCache : Object

Returns

void

getGridColumns( Boolean refreshCache) : Array

Returns an array of all columns which map to Store fields. This goes down to the lowest column header level, and does...

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

Parameters

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

Returns

Array

getHeaderAtIndex( Object index) : void

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

Parameters

index : Object

Returns

void

getHeaderIndex( Object header) : void

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

Parameters

header : Object

Returns

void

getHeight : Number

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

Returns

Number

getId : void

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

Returns

void

getIndex : void

Returns the true grid column index assiciated with this Column only if this column is a base level Column. If it is a...

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

Returns

void

getInsertPosition( String/Number/Element/HTMLElement position) : HTMLElement

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

position : String/Number/Element/HTMLElement
Index, element id or element you want to put this component before.

Returns

HTMLElement
DOM element that you can use in the insertBefore

getLayout : Ext.layout.container.AbstractContainer

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

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

Returns

Ext.layout.container.AbstractContainer
The layout

getLoader : Ext.ComponentLoader

Gets the Ext.ComponentLoader for this Component.

Returns

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

getMenuItems : Array

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

Returns

Array
menuItems

getPlugin( Object pluginId) : Ext.AbstractPlugin

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

Parameters

pluginId : Object

Returns

Ext.AbstractPlugin
pluginInstance

getPosition( [Boolean local]) : Array

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

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

getSize : Object

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

Returns

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

getSortParam : void

Returns the parameter to sort upon when sorting this header. By default this returns the dataIndex and will not need ...

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

void

getState : Object

Gets the current state of the object. By default this function returns null, it should be overridden in subclasses to...

Gets the current state of the object. By default this function returns null, it should be overridden in subclasses to implement methods for getting the state.

Returns

Object
The current state

getStateId : String

Gets the state id for this object.

Returns

String
The state id, null if not found.