Alternate names
Ext.ListHierarchy
Mixins
Inherited mixins
Requires
Subclasses
Files
Guide
Using ListList is a custom styled DataView which allows Grouping, Indexing, Icons, and a Disclosure. See the Guide and Video for more.
Ext.create('Ext.List', {
fullscreen: true,
itemTpl: '{title}',
data: [
{ title: 'Item 1' },
{ title: 'Item 2' },
{ title: 'Item 3' },
{ title: 'Item 4' }
]
});
A more advanced example showing a list of people grouped by last name:
Ext.define('Contact', {
extend: 'Ext.data.Model',
config: {
fields: ['firstName', 'lastName']
}
});
var store = Ext.create('Ext.data.Store', {
model: 'Contact',
sorters: 'lastName',
grouper: {
groupFn: function(record) {
return record.get('lastName')[0];
}
},
data: [
{ firstName: 'Tommy', lastName: 'Maintz' },
{ firstName: 'Rob', lastName: 'Dougan' },
{ firstName: 'Ed', lastName: 'Spencer' },
{ firstName: 'Jamie', lastName: 'Avins' },
{ firstName: 'Aaron', lastName: 'Conran' },
{ firstName: 'Dave', lastName: 'Kaneda' },
{ firstName: 'Jacky', lastName: 'Nguyen' },
{ firstName: 'Abraham', lastName: 'Elias' },
{ firstName: 'Jay', lastName: 'Robinson'},
{ firstName: 'Nigel', lastName: 'White' },
{ firstName: 'Don', lastName: 'Griffin' },
{ firstName: 'Nico', lastName: 'Ferrero' },
{ firstName: 'Jason', lastName: 'Johnston'}
]
});
Ext.create('Ext.List', {
fullscreen: true,
itemTpl: '<div class="contact">{firstName} <strong>{lastName}</strong></div>',
store: store,
grouped: true
});
If you want to dock items to the bottom or top of a List, you can use the scrollDock configuration on child items in this List. The following example adds a button to the bottom of the List.
Ext.define('Contact', {
extend: 'Ext.data.Model',
config: {
fields: ['firstName', 'lastName']
}
});
var store = Ext.create('Ext.data.Store', {
model: 'Contact',
sorters: 'lastName',
grouper: {
groupFn: function(record) {
return record.get('lastName')[0];
}
},
data: [
{ firstName: 'Tommy', lastName: 'Maintz' },
{ firstName: 'Rob', lastName: 'Dougan' },
{ firstName: 'Ed', lastName: 'Spencer' },
{ firstName: 'Jamie', lastName: 'Avins' },
{ firstName: 'Aaron', lastName: 'Conran' },
{ firstName: 'Dave', lastName: 'Kaneda' },
{ firstName: 'Jacky', lastName: 'Nguyen' },
{ firstName: 'Abraham', lastName: 'Elias' },
{ firstName: 'Jay', lastName: 'Robinson'},
{ firstName: 'Nigel', lastName: 'White' },
{ firstName: 'Don', lastName: 'Griffin' },
{ firstName: 'Nico', lastName: 'Ferrero' },
{ firstName: 'Jason', lastName: 'Johnston'}
]
});
Ext.create('Ext.List', {
fullscreen: true,
itemTpl: '<div class="contact">{firstName} <strong>{lastName}</strong></div>',
store: store,
items: [{
xtype: 'button',
scrollDock: 'bottom',
docked: 'bottom',
text: 'Load More...'
}]
});
Config options
The item from the items collection that will be active first. This is usually only meaningful in a card layout, where only one item can be active at a time. If passes a string, it will be assumed to be a Ext.ComponentQuery selector.
Defaults to: 0
Allow users to deselect a record in a DataView, List or Grid. Only applicable when the Selectable's mode is
'SINGLE'.
Defaults to: false
If true, child items will be destroyed as soon as they are removed
from this container.
Defaults to: true
The base CSS class to apply to this component's element. This will also be prepended to other elements within this component. To add specific styling for sub-classes, use the cls config.
Defaults to: Ext.baseCSSPrefix + 'list'
Overrides: Ext.dataview.DataView.baseCls
Set this to true to ignore datachanged events on the bound store.
Set this to true to ignore datachanged events on the bound store.
This cfg has been removed since 2.0.0
The border width to use on this Component. Can be specified as a number (in which case all edges get the same border width) or a CSS string like '5 10 10 10'.
Please note that this will not add
a border-color or border-style CSS property to the component; you must do that manually using either CSS or
the style configuration.
Using style:
Ext.Viewport.add({
centered: true,
width: 100,
height: 100,
border: 3,
style: 'border-color: blue; border-style: solid;'
// ...
});
Using CSS:
Ext.Viewport.add({
centered: true,
width: 100,
height: 100,
border: 3,
cls: 'my-component'
// ...
});
And your CSS file:
.my-component {
border-color: red;
border-style: solid;
}
The absolute bottom position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
Explicitly setting this value will make this Component become 'floating', which means its layout will no
longer be affected by the Container that it resides in.
The event name to bubble, or an Array of event names.
The event name to bubble, or an Array of event names.
Animation to be used during transitions of cards.
Animation to be used during transitions of cards.
This cfg has been removed since 2.0.0
Please use Ext.layout.Card.animation instead
Whether or not this Component is absolutely centered inside its Container
Whether or not this Component is absolutely centered inside its Container
CSS class to add to this Component. Deprecated, please use cls instead
This cfg has been deprecated since 2.0.0
The configured element will automatically be added as the content of this component. When you pass a string, we expect it to be an element id. If the content element is hidden, we will automatically show it.
Enables you to easily control Components inside this Container by listening to their events and taking some action. For example, if we had a container with a nested Disable button, and we wanted to hide the Container when the Disable button is tapped, we could do this:
Ext.create('Ext.Container', {
control: {
'button[text=Disable]': {
tap: 'hideMe'
}
},
hideMe: function () {
this.hide();
}
});
We used a Ext.ComponentQuery selector to listen to the tap event on any
button anywhere inside the Container that has the text 'Disable'.
Whenever a Component matching that selector fires the tap event our hideMe function is called. hideMe is
called with scope: this (e.g. this is the Container instance).
Defaults to: {}
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.
Overrides: Ext.Component.data
The xtype used for the component based DataView. Defaults to dataitem. Note this is only used when useComponents is true.
Overrides: Ext.dataview.DataView.defaultType, Ext.dataview.List.defaultType
A set of default configurations to apply to all child Components in this Container. It's often useful to specify defaults when creating more than one items with similar configurations. For example here we can specify that each child is a panel and avoid repeating the xtype declaration for each one:
Ext.create('Ext.Container', {
defaults: {
xtype: 'panel'
},
items: [
{
html: 'Panel 1'
},
{
html: 'Panel 2'
}
]
});
true to defer emptyText being applied until the store's first load.
Defaults to: true
When set to true, tapping on the DataView's background (i.e. not on an item in the DataView) will deselect any currently selected items.
Defaults to: true
true to disable selection.
This configuration will lock the selection model that the DataView uses.
The CSS class to add to the component when it is disabled
Defaults to: "x-item-disabled"
A property to check on each record to display the disclosure on a per record basis. This property must be false to prevent the disclosure from being displayed on the item.
Defaults to: 'disclosure'
The dock position of this component in its container. Can be left, top, right or bottom.
Notes
You must use a HTML5 doctype for docked bottom to work. To do this, simply add the following code to the HTML file:
<!doctype html>
So your index.html file should look a little like this:
<!doctype html>
<html>
<head>
<title>MY application title</title>
...
This cfg has been deprecated since 2.0.0
This has been deprecated. Please use docked instead.
The dock position of this component in its container. Can be left, top, right or bottom.
Notes
You must use a HTML5 doctype for docked bottom to work. To do this, simply add the following code to the HTML file:
<!doctype html>
So your index.html file should look a little like this:
<!doctype html>
<html>
<head>
<title>MY application title</title>
...
Configuration options to make this Component draggable
Configuration options to make this Component draggable
The text to display in the view when there is no data to display
The text to display in the view when there is no data to display
Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'.
This cfg has been deprecated since 2.0.0
Please use showAnimation instead.
Animation effect to apply when the Component is being hidden.
This cfg has been deprecated since 2.0.0
Please use hideAnimation instead. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'.
The flex of this item if this item item is inside a Ext.layout.HBox or Ext.layout.VBox layout.
You can also update the flex of a component dynamically using the Ext.layout.FlexBox.setItemFlex method.
Deprecated, please use left, top, right or bottom instead.
Ext.Viewport.add({
top: 100,
left: 100,
width: 500,
height: 200,
html: 'Floating component!'
});
This cfg has been deprecated since 2.0.0
The CSS class to add to this component when it is floatable.
Defaults to: "x-floating"
Force the component to take up 100% width and height available, by adding it to Ext.Viewport.
Force the component to take up 100% width and height available, by adding it to Ext.Viewport.
Whether or not to group items in the provided Store with a header for each item.
Whether or not to group items in the provided Store with a header for each item.
The height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
By default, if this is not explicitly set, this Component's element will simply have its own natural size.
If set to auto, it will set the width to null meaning it will have its own natural size.
Animation effect to apply when the Component is being hidden. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'. For more animations, check the Ext.fx.Animation.type config.
When using a modal Component, setting this to true will hide the modal
mask and the Container when the mask is tapped on.
Overrides: Ext.Component.hideOnMaskTap
Optional HTML content to render inside this Component, or a reference to an existing element on the page.
Optional HTML content to render inside this Component, or a reference to an existing element on the page.
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 Ext.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.
Defaults to an auto-assigned id.
true to render an alphabet IndexBar docked on the right.
This can also be a config object that will be passed to Ext.IndexBar.
Defaults to: false
Set this to false to render all items in this list, and render them relatively. Note that this configuration can not be dynamically changed after the list has instantiated.
Defaults to: false
When set to true the items within the DataView will have their display set to inline-block
and be arranged horizontally. By default the items will wrap to the width of the DataView.
Passing an object with { wrap: false } will turn off this wrapping behavior and overflowed
items will need to be scrolled to horizontally.
An additional CSS class to apply to items within the DataView.
An additional CSS class to apply to items within the DataView.
A configuration object that is passed to every item created by a component based DataView. Because each item that a List renders is a Component, we can pass configuration options to each component to easily customize how each child component behaves.
Overrides: Ext.dataview.DataView.itemConfig
This allows you to set the default item height and is used to roughly calculate the amount of items needed to fill the list. By default items are around 50px high.
Defaults to: 42
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.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.
Also see id, Ext.Container.query, Ext.Container.down and Ext.Container.child.
A simple CSS selector that will be used to determine what nodes this DataView will be working with.
A simple CSS selector that will be used to determine what nodes this DataView will be working with.
This cfg has been removed since 2.0.0
The tpl to use for each of the items displayed in this DataView.
Defaults to: '<div>{text}</div>'
The child items to add to this Container. This is usually an array of Component configurations or instances, for example:
Ext.create('Ext.Container', {
items: [
{
xtype: 'panel',
html: 'This is an item'
}
]
});
Hide layout config in DataView. It only causes confusion.
Defaults to: 'fit'
Overrides: Ext.dataview.DataView.layout
true to automatically re-layout this component on orientation change.
true to automatically re-layout this component on orientation change.
This cfg has been removed since 2.0.0
The absolute left position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
Explicitly setting this value will make this Component become 'floating', which means its layout will no
longer be affected by the Container that it resides in.
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.
See the Event guide for more
Note: It is bad practice to specify a listener's config when you are defining a class using Ext.define().
Instead, only specify listeners when you are instantiating your class with Ext.create().
A string to display during data load operations. If specified, this text will be displayed in a loading div and the view's contents will be cleared while loading, otherwise the view's contents will continue to display normally until the new data is loaded and the contents are replaced.
Defaults to: 'Loading...'
true to disable selection.
This configuration will lock the selection model that the DataView uses.
This cfg has been deprecated since 2.0.0
Please use disableSelection instead.
The margin to use on this Component. Can be specified as a number (in which case all edges get the same margin) or a CSS string like '5 10 10 10'
A configuration to allow you to mask this container.
You can optionally pass an object block with and xtype of loadmask, and an optional message value to
display a loading mask. Please refer to the Ext.LoadMask component to see other configurations.
masked: {
xtype: 'loadmask',
message: 'My message'
}
Alternatively, you can just call the setter at any time with true/false to show/hide the mask:
setMasked(true); //show the mask
setMasked(false); //hides the mask
There are also two convenient methods, mask and unmask, to allow you to mask and unmask this container at any time.
Remember, the Ext.Viewport is always a container, so if you want to mask your whole application at anytime, can call:
Ext.Viewport.setMasked({
xtype: 'loadmask',
message: 'Hello'
});
The maximum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
If set to auto, it will set the width to null meaning it will have its own natural size.
Note that this config will not apply if the Component is 'floating' (absolutely positioned or centered)
Maintains a cache of reusable components when using a component based DataView. Improving performance at the cost of memory. Note this is currently only used when useComponents is true.
Overrides: Ext.dataview.DataView.maxItemCache
The maximum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
If set to auto, it will set the width to null meaning it will have its own natural size.
Note that this config will not apply if the Component is 'floating' (absolutely positioned or centered)
The minimum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
If set to auto, it will set the width to null meaning it will have its own natural size.
The minimum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
If set to auto, it will set the width to null meaning it will have its own natural size.
true to make this Container modal. This will create a mask underneath the Container
that covers its parent and does not allow the user to interact with any other Components until this
Container is dismissed.
Overrides: Ext.Component.modal, Ext.Container.modal
Modes of selection.
Valid values are 'SINGLE', 'SIMPLE', and 'MULTI'.
Defaults to: 'SINGLE'
true to monitor Orientation change.
true to monitor Orientation change.
This cfg has been removed since 2.0.0
true to allow selection of more than one item at a time.
true to allow selection of more than one item at a time.
This cfg has been removed since 2.0.0
multiSelect is deprecated. Please use mode instead
true to display a disclosure icon on each list item.
The list will still fire the disclose event, and the event can be stopped before itemtap.
By setting this config to a function, the function passed will be called when the disclosure
is tapped.
Finally you can specify an object with a 'scope' and 'handler'
property defined. This will also be bound to the tap event listener
and is useful when you want to change the scope of the handler.
A CSS class to apply to each item in the view on mouseover.
A CSS class to apply to each item in the view on mouseover.
This cfg has been removed since 2.0.0
The padding to use on this Component. Can be specified as a number (in which case all edges get the same padding) or a CSS string like '5 10 10 10'
Whether or not to pin headers on top of item groups while scrolling for an iPhone native list experience.
Defaults to: true
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.
For examples of plugins, see Ext.plugin.PullRefresh and Ext.plugin.ListPaging
Example code
A plugin by alias:
Ext.create('Ext.dataview.List', {
config: {
plugins: 'listpaging',
itemTpl: '<div class="item">{title}</div>',
store: 'Items'
}
});
Multiple plugins by alias:
Ext.create('Ext.dataview.List', {
config: {
plugins: ['listpaging', 'pullrefresh'],
itemTpl: '<div class="item">{title}</div>',
store: 'Items'
}
});
Single plugin by class name with config options:
Ext.create('Ext.dataview.List', {
config: {
plugins: {
xclass: 'Ext.plugin.ListPaging', // Reference plugin by class
autoPaging: true
},
itemTpl: '<div class="item">{title}</div>',
store: 'Items'
}
});
Multiple plugins by class name with config options:
Ext.create('Ext.dataview.List', {
config: {
plugins: [
{
xclass: 'Ext.plugin.PullRefresh',
pullRefreshText: 'Pull to refresh...'
},
{
xclass: 'Ext.plugin.ListPaging',
autoPaging: true
}
],
itemTpl: '<div class="item">{title}</div>',
store: 'Items'
}
});
The CSS class to apply to an item on the view while it is being pressed.
Defaults to: 'x-item-pressed'
The amount of delay between the tapstart and the moment we add the pressedCls.
Settings this to true defaults to 100ms.
Defaults to: 100
true to prevent the item selection when the user
taps a disclose icon.
Defaults to: true
A model instance which updates the Component's html based on it's tpl. Similar to the data configuration, but tied to to a record to make allow dynamic updates. This must be a model instance and not a configuration of one.
Set this to false if you make many updates to your list (like in an interval), but updates won't affect the item's height. Doing this will increase the performance of these updates.
Defaults to: true
Optional element to render this Component to. Usually this is not needed because a Component is normally full screen or automatically rendered inside another Container
The absolute right position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
Explicitly setting this value will make this Component become 'floating', which means its layout will no
longer be affected by the Container that it resides in.
Configuration options to make this Container scrollable. Acceptable values are:
'horizontal','vertical','both'to enabling scrolling for that direction.true/falseto explicitly enable/disable scrolling.
Alternatively, you can give it an object which is then passed to the scroller instance:
scrollable: {
direction: 'vertical',
directionLock: true
}
Please look at the Ext.scroll.Scroller documentation for more example on how to use this.
This cfg has been deprecated since 2.0.0
Please use the scrollable configuration.
Returns
- Ext.scroll.View
The scroll view.
Overrides: Ext.Component.scroll
Scroll the DataView to the top when the DataView is refreshed.
Defaults to: true
The CSS class to apply to an item on the view while it is selected.
Defaults to: 'x-item-selected'
A CSS class to apply to each selected item in the view.
A CSS class to apply to each selected item in the view.
This cfg has been removed since 2.0.0
Please use selectedCls instead
Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'. For more animations, check the Ext.fx.Animation.type config.
true to enable multi-selection by clicking on multiple items without requiring
the user to hold Shift or Ctrl, false to force the user to hold Ctrl or Shift
to select more than on item.
This cfg has been removed since 2.0.0
Please use mode instead
true to allow selection of exactly one item at a time, false to allow no selection at all.
true to allow selection of exactly one item at a time, false to allow no selection at all.
This cfg has been removed since 2.0.0
Please use mode instead
true to stop the event that fires when you click outside the floating component.
true to stop the event that fires when you click outside the floating component.
This cfg has been removed since 2.0.0
Can be either a Store instance or a configuration object that will be turned into a Store. The Store is used to populate the set of items that will be rendered in the DataView. See the DataView intro documentation for more information about the relationship between Store and DataView.
Set this to true if you want the items in the list to be zebra striped, alternating their background color.
Defaults to: false
Optional CSS styles that will be rendered into an inline style attribute when the Component is rendered.
You can pass either a string syntax:
style: 'background:red'
Or by using an object:
style: {
background: 'red'
}
When using the object syntax, you can define CSS Properties by using a string:
style: {
'border-left': '1px solid red'
}
Although the object syntax is much easier to read, we suggest you to use the string syntax for better performance.
The class that is added to the content target when you set styleHtmlContent to true.
Defaults to: "x-html"
true to automatically style the HTML inside the content target of this component (body for panels).
Defaults to: false
The absolute top position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
Explicitly setting this value will make this Component become 'floating', which means its layout will no
longer be affected by the Container that it resides in.
A String, Ext.Template, Ext.XTemplate or an Array of strings to form an Ext.XTemplate. Used in conjunction with the data and tplWriteMode configurations.
Note The data configuration must be set for any content to be shown in the component when using this configuration.
The Ext.(X)Template method to use when updating the content area of the Component. Valid modes are:
- append
- insertAfter
- insertBefore
- insertFirst
- overwrite
Defaults to: 'overwrite'
true to enable mouseenter and mouseleave events.
true to enable mouseenter and mouseleave events.
This cfg has been removed since 2.0.0
Determines what type of touch event is recognized as a touch on the container. Valid options are 'tap' and 'singletap'.
Defaults to: 'tap'
Determines what type of touch event causes an item to be selected. Valid options are: 'itemtap', 'itemsingletap', 'itemdoubletap', 'itemswipe', 'itemtaphold'.
Defaults to: 'itemtap'
The style of this list. Available options are normal and round.
Please note: if you use the round UI, pinHeaders will be automatically turned off as
it is not supported.
Defaults to: 'normal'
Overrides: Ext.Component.ui
Flag the use a component based DataView implementation. This allows the full use of components in the DataView at the cost of some performance.
Checkout the DataView Guide for more information on using this configuration.
Overrides: Ext.dataview.DataView.useComponents
Set this to true if you just want to have the list create simple items that use the itemTpl. These simple items still support headers, grouping and disclosure functionality but avoid container layouts and deeply nested markup. For many Lists using this configuration will drastically increase the scrolling and render performance.
Defaults to: true
This configuration allows you optimize the list by not having it read the DOM heights of list items. Instead it will assume (and set) the height to be the itemHeight.
Defaults to: false
The width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
By default, if this is not explicitly set, this Component's element will simply have its own natural size.
If set to auto, it will set the width to null meaning it will have its own natural size.
List of xtypes for Ext.Component. XTypes must not contain periods.
Ext.define('MyApp.CoolPanel', {
extend: 'Ext.panel.Panel',
xtype: 'coolpanel',
config: {
html : 'Yeah!'
}
});
// Using Ext.create
Ext.create('widget.coolpanel');
// Using the shorthand for widgets and in xtypes
Ext.widget('panel', {
items: [
{xtype: 'coolpanel', html: 'Foo'},
{xtype: 'coolpanel', html: 'Bar'}
]
});
Properties
Instance properties
The amount of items we render additionaly besides the ones currently visible. We try to prevent the rendering of items while scrolling until the next time you stop scrolling. If you scroll close to the end of the buffer, we start rendering individual items to always have the minimumBufferSize prepared.
Defaults to: 20
The set of all items in this Container.
This property has been deprecated since 2.0.0
Please use getItems method instead.
Defaults to: /^(?:delegate|single|delay|buffer|args|prepend|element)$/
Overrides: Ext.mixin.Observable.listenerOptionsRegex
Defaults to: {id: 'bindable'}
Overrides: Ext.mixin.Selectable.mixinConfig, Ext.mixin.Traversable.mixinConfig
Defaults to: 'component'
Overrides: Ext.mixin.Observable.observableType
Defaults to: {addrecords: 'onSelectionStoreAdd', removerecords: 'onSelectionStoreRemove', updaterecord: 'onSelectionStoreUpdate', load: 'refreshSelection', refresh: 'refreshSelection'}
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'
Methods
Instance methods
Adds one or more Components to this Container. Example:
var myPanel = Ext.create('Ext.Panel', {
html: 'This will be added to a Container'
});
myContainer.add([myPanel]);
Parameters
- newItems : Object/Object[]/Ext.Component/Ext.Component[]
The new items to add to the Container.
Returns
- Ext.Component
The last item added to the Container from the
newItemsarray.
Fires
Appends an after-event handler.
Same as addListener with order set to 'after'.
Parameters
- eventName : String/String[]/Object
The name of the event to listen for.
- fn : Function/String
The method the event invokes.
- scope : Object (optional)
The scope for
fn. - options : Object (optional)
An object containing handler configuration.
Fires
Appends a before-event handler. Returning false from the handler will stop the event.
Same as addListener with order set to 'before'.
Parameters
- eventName : String/String[]/Object
The name of the event to listen for.
- fn : Function/String
The method the event invokes.
- scope : Object (optional)
The scope for
fn. - options : Object (optional)
An object containing handler configuration.
Fires
Adds the specified events to the list of events which this Observable may fire.
This method has been deprecated since 2.0
It's no longer needed to add events before firing.
Parameters
Appends an event handler to this object. You can review the available handlers by looking at the 'events' section of the documentation for the component you are working with.
Combining Options
Using the options argument, it is possible to combine different types of listeners:
A delayed, one-time listener:
container.addListener('tap', this.handleTap, 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:
container.addListener({
tap : this.onTap,
swipe: this.onSwipe,
scope: this // Important. Ensure "this" is correct during handler execution
});
One can also specify options for each event handler separately:
container.addListener({
tap : { fn: this.onTap, scope: this, single: true },
swipe: { fn: button.onSwipe, scope: button }
});
See the Events Guide for more.
Parameters
- eventName : String/String[]/Object
The name of the event to listen for. May also be an object who's property names are event names.
- fn : Function/String (optional)
The method the event invokes. Will be called with arguments given to fireEvent plus the
optionsparameter described below. - scope : Object (optional)
The scope (
thisreference) 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.
This object may contain any of the following properties:
- scope : Object (optional)
The scope (
thisreference) in which the handler function is executed. If omitted, defaults to the object which fired the event. - delay : Number (optional)
The number of milliseconds to delay the invocation of the handler after the event fires.
- single : Boolean (optional)
trueto add a handler to handle just the next firing of the event, and then remove itself. - order : String (optional)
The order of when the listener should be added into the listener queue.
If you set an order of
beforeand the event you are listening to is preventable, you can returnfalseand it will stop the event.Available options are
before,currentandafter.Defaults to:
current - buffer : Number (optional)
Causes the handler to be 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.
- element : String (optional)
Allows you to add a listener onto a element of this component using the elements reference.
Ext.create('Ext.Component', { listeners: { element: 'element', tap: function() { alert('element tap!'); } } });All components have the
elementreference, which is the outer most element of the component. Ext.Container also has theinnerElementelement which contains all children. In most caseselementis adequate. - delegate : String (optional)
Uses Ext.ComponentQuery to delegate events to a specified query selector within this item.
// Create a container with a two children; a button and a toolbar var container = Ext.create('Ext.Container', { items: [ { xtype: 'toolbar', docked: 'top', title: 'My Toolbar' }, { xtype: 'button', text: 'My Button' } ] }); container.addListener({ // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate delegate: 'button', tap: function() { alert('Button tapped!'); } });
- scope : Object (optional)
- order : String (optional)
The order of when the listener should be added into the listener queue. Possible values are
before,currentandafter.Defaults to:
'current'
Fires
Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.
This method has been deprecated since 2.0
All listeners are now automatically managed where necessary. Simply use addListener.
Parameters
- object : Ext.mixin.Observable/HTMLElement
The item to which to add a listener/listeners.
- eventName : Object/String
The event name, or an object containing event name properties.
- fn : Function (optional)
If the
eventNameparameter was an event name, this is the handler function. - scope : Object (optional)
If the
eventNameparameter was an event name, this is the scope in which the handler function is executed. - options : Object (optional)
If the
eventNameparameter was an event name, this is the addListener options.
Significantly improve instantiation time for Component with multiple references Ext.Element instance of the reference domNode is only created the very first time it's ever used.
Parameters
Used to handle joining of a record to a tpl
Fires
Used to handle joining of a record to a tpl
Fires
Animates to the supplied activeItem with a specified animation. Currently this only works
with a Card layout. This passed animation will override any default animations on the
container, for a single card switch. The animation will be destroyed when complete.
Parameters
- activeItem : Object/Number
The item or item index to make active.
- animation : Object/Ext.fx.layout.Card
Card animation configuration or instance.
Fires
Changes the masked configuration when its setter is called, which will convert the value into a proper object/instance of Ext.Mask/Ext.LoadMask. If a mask already exists, it will use that instead.
Parameters
- masked : Boolean/Object/Ext.Mask/Ext.LoadMask
Returns
Fires
We create complex instance arrays and objects in beforeInitialize so that we can use these inside of the initConfig process.
Fires
Overrides: Ext.Component.beforeInitialize
Call the original method that was previously overridden with override,
This method is deprecated as callParent does the same thing.
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
var instance = this.callOverridden();
alert("Meeeeoooowwww");
return instance;
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
Parameters
- args : Array/Arguments
The arguments, either an array or the
argumentsobject from the current method, for example:this.callOverridden(arguments)
Returns
- Object
Returns the result of calling the overridden method
Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext.define).
Ext.define('My.Base', {
constructor: function (x) {
this.x = x;
},
statics: {
method: function (x) {
return x;
}
}
});
Ext.define('My.Derived', {
extend: 'My.Base',
constructor: function () {
this.callParent([21]);
}
});
var obj = new My.Derived();
alert(obj.x); // alerts 21
This can be used with an override as follows:
Ext.define('My.DerivedOverride', {
override: 'My.Derived',
constructor: function (x) {
this.callParent([x*2]); // calls original My.Derived constructor
}
});
var obj = new My.Derived();
alert(obj.x); // now alerts 42
This also works with static methods.
Ext.define('My.Derived2', {
extend: 'My.Base',
statics: {
method: function (x) {
return this.callParent([x*2]); // calls My.Base.method
}
}
});
alert(My.Base.method(10)); // alerts 10
alert(My.Derived2.method(10)); // alerts 20
Lastly, it also works with overridden static methods.
Ext.define('My.Derived2Override', {
override: 'My.Derived2',
statics: {
method: function (x) {
return this.callParent([x*2]); // calls My.Derived2.method
}
}
});
alert(My.Derived2.method(10)); // now alerts 40
To override a method and replace it and also call the superclass method, use callSuper. This is often done to patch a method to fix a bug.
Parameters
- args : Array/Arguments
The arguments, either an array or the
argumentsobject from the current method, for example:this.callParent(arguments)
Returns
- Object
Returns the result of calling the parent method
This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.
Consider:
Ext.define('Ext.some.Class', {
method: function () {
console.log('Good');
}
});
Ext.define('Ext.some.DerivedClass', {
method: function () {
console.log('Bad');
// ... logic but with a bug ...
this.callParent();
}
});
To patch the bug in DerivedClass.method, the typical solution is to create an
override:
Ext.define('App.paches.DerivedClass', {
override: 'Ext.some.DerivedClass',
method: function () {
console.log('Fixed');
// ... logic but with bug fixed ...
this.callSuper();
}
});
The patch method cannot use callParent to call the superclass method since
that would call the overridden method containing the bug. In other words, the
above patch would only produce "Fixed" then "Good" in the console log, whereas,
using callParent would produce "Fixed" then "Bad" then "Good".
Parameters
- args : Array/Arguments
The arguments, either an array or the
argumentsobject from the current method, for example:this.callSuper(arguments)
Returns
- Object
Returns the result of calling the superclass method
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
Fires
Deselects any currently selected records and clears all stored selections.
This method has been deprecated since 2.0.0
Please use deselectAll instead.
Function which can be overridden which returns the data object passed to this DataView's template to render the whole DataView.
This method has been removed since 2.0.0
Deselects the given record(s). If many records are currently selected, it will only deselect those you pass in.
Parameters
- records : Number/Array/Ext.data.Model
The record(s) to deselect. Can also be a number to reference by index.
- suppressEvent : Boolean
If
truethedeselectevent will not be fired.
Fires
Deselects a record instance by record instance or index.
This method has been deprecated since 2.0.0
Please use deselect instead.
Parameters
- records : Ext.data.Model/Number
An array of records or an index.
- suppressEvent : Boolean
Set to
falseto not fire a deselect event.
invoked by the selection model to maintain visual UI cues
Parameters
Fires
Overrides: Ext.dataview.DataView.doItemSelect
Selects a record instance by record instance or index.
This method has been deprecated since 2.0.0
Please use select instead.
Parameters
- records : Ext.data.Model/Number
An array of records or an index.
- keepExisting : Boolean
- suppressEvent : Boolean
Set to
falseto not fire a select event.
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
Fires
Returns the template node the passed child belongs to, or null if it doesn't belong to one.
This method has been removed since 2.0.0
Returns the template node by the Ext.EventObject or null if it is not found.
This method has been removed since 2.0.0
Fires the specified event with the passed parameters and execute a function (action)
at the end if there are no listeners that return false.
Parameters
- eventName : String
The name of the event to fire.
- args : Array
Arguments to pass to handers.
- fn : Function
Action.
- scope : Object
Scope of fn.
Returns
Fires
Fires the specified event with the passed parameters (minus the event name, plus the options object passed
to addListener).
The first argument is the name of the event. Every other argument passed will be available when you listen for the event.
Example
Firstly, we set up a listener for our new event.
this.on('myevent', function(arg1, arg2, arg3, arg4, options, e) {
console.log(arg1); // true
console.log(arg2); // 2
console.log(arg3); // { test: 'foo' }
console.log(arg4); // 14
console.log(options); // the options added when adding the listener
console.log(e); // the event object with information about the event
});
And then we can fire off the event.
this.fireEvent('myevent', true, 2, { test: 'foo' }, 14);
An event may be set to bubble up an Observable parent hierarchy 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
falseif any of the handlers returnfalse.
Fires
Returns the Component for a given index in the Container's items.
Parameters
- index : Number
The index of the Component to return.
Returns
- Ext.Component
The item at the specified
index, if found.
Examines this container's items property
and gets a direct child component of this container.
Parameters
- component : String/Number
This parameter may be any of the following:
- {String} : representing the
itemIdoridof the child component. - {Number} : representing the position of the child component
within the
itemsproperty.
For additional information see Ext.util.MixedCollection.get.
- {String} : representing the
Returns
- Ext.Component
The component (if found).
Fires
Returns the number of selections.
This method has been deprecated since 2.0.0
Please use getSelectionCount instead.
Returns
Current Alignment information from the last alignTo call
Returns the value of deselectOnContainerClick.
Returns
Finds a docked item of this container using a reference, idor an index of its location
in getDockedItems.
Parameters
Returns
- Ext.Component/Boolean
The docked component, if found.
Fires
Returns all the Ext.Component.docked items in this container.
Returns
- Array
The docked items of this container.
Fires
Retrieves the top level element representing this component.
This method has been deprecated since 2.0.0
Please access the Component's element from the element property instead, i.e:
var element = component.element;
Returns
Returns
Overrides: Ext.Component.getElementConfig
Returns the value of enterAnimation.
This method has been deprecated since 2.0.0
Please use showAnimation instead.
Returns
- String/Mixed
Returns the value of exitAnimation.
This method has been deprecated since 2.0.0
Please use hideAnimation instead. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'.
Returns
- String/Mixed
Retrieves the id of this component. Will autogenerate an id if one has not already been set.
Returns
- String
id
Fires
Returns an item at the specified index.
Parameters
- index : Number
Index of the item.
Returns
- Ext.dom.Element/Ext.dataview.component.DataItem
item Item at the specified index.
Overrides: Ext.dataview.DataView.getItemAt
Returns an index for the specified item.
Parameters
- item : Number
The item to locate.
Returns
- Number
Index for the specified item.
Overrides: Ext.dataview.DataView.getItemIndex
Returns the array of previously selected items.
This method has been deprecated since 2.0.0
Returns
- Array
The previous selection.
Gets a template node.
This method has been removed since 2.0.0
Gets a range nodes.
This method has been removed since 2.0.0
Returns the parent of this component, if it has one.
Returns
- Ext.Component
The parent of this component.
Gets an array of the records from an array of nodes.
This method has been removed since 2.0.0
Used by ComponentQuery to retrieve all of the items
which can potentially be considered a child of this Container.
This should be overridden by components which have child items
that are not contained in items. For example dockedItems, menu, etc
Parameters
- deep : Object
Fires
Returns all the items that are docked in the scroller in this list.
Returns
- Array
An array of the scrollDock items
Gets the currently selected nodes.
This method has been removed since 2.0.0
Gets an array of the selected records.
This method has been removed since 2.0.0
Returns an array of the current items in the DataView.
Returns
- Ext.dom.Element[]/Ext.dataview.component.DataItem[]
Array of Items.
Overrides: Ext.dataview.DataView.getViewItems
Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext.Component header.
Note: 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.field.Text();
alert(t.getXTypes()); // alerts 'component/field/textfield'
Returns
- String
The xtype hierarchy string.
Method called when the Store's Reader throws an exception
Fires
Finds the index of the passed node.
This method has been removed since 2.0.0
Overrides: Ext.Container.indexOf
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
- instanceConfig : Object
Returns
- Object
mixins The mixin prototypes as key - value pairs
Fires
We override DataView's initialize method with an empty function
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.initialize, Ext.dataview.DataView.initialize, Ext.dataview.List.initialize
Adds a child Component at the given index. For example, here's how we can add a new item, making it the first child Component of this Container:
myContainer.insert(0, {xtype: 'panel', html: 'new item'});
Parameters
Fires
Returns true if this Component is currently disabled.
Returns
- Boolean
trueif currently disabled.
Fires
Returns true if the Selectable is currently locked.
This method has been deprecated since 2.0.0
Please use getDisableSelection instead.
Returns
- Boolean
True if currently locked
Returns true if the specified row is selected.
Parameters
- record : Ext.data.Model/Number
The record or index of the record to check.
Returns
Fires
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.field.Text();
var isText = t.isXType('textfield'); // true
var isBoxSubclass = t.isXType('field'); // true, descended from Ext.field.Field
var isBoxInstance = t.isXType('field', true); // false, not a direct Ext.field.Field instance
Parameters
- xtype : String
The xtype to check for this Component.
- shallow : Boolean (optional)
falseto check whether this Component is descended from the xtype (this is the default), ortrueto check whether this Component is directly of the specified xtype.
Returns
- Boolean
trueif this component descends from the specified xtype,falseotherwise.
Alias for addManagedListener.
This method has been deprecated since 2.0.0
This is now done automatically
Parameters
- object : Ext.mixin.Observable/HTMLElement
The item to which to add a listener/listeners.
- eventName : Object/String
The event name, or an object containing event name properties.
- fn : Function (optional)
If the
eventNameparameter was an event name, this is the handler function. - scope : Object (optional)
If the
eventNameparameter was an event name, this is the scope in which the handler function is executed. - options : Object (optional)
If the
eventNameparameter was an event name, this is the addListener options.
Alias for removeManagedListener.
This method has been deprecated since 2.0.0
This is now done automatically
Parameters
- object : Ext.mixin.Observable/HTMLElement
The item to which to add a listener/listeners.
- eventName : Object/String
The event name, or an object containing event name properties.
- fn : Function (optional)
If the
eventNameparameter was an event name, this is the handler function. - scope : Object (optional)
If the
eventNameparameter was an event name, this is the scope in which the handler function is executed.
Alias for addListener.
Parameters
- eventName : String/String[]/Object
The name of the event to listen for. May also be an object who's property names are event names.
- fn : Function/String (optional)
The method the event invokes. Will be called with arguments given to fireEvent plus the
optionsparameter described below. - scope : Object (optional)
The scope (
thisreference) 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.
This object may contain any of the following properties:
- scope : Object (optional)
The scope (
thisreference) in which the handler function is executed. If omitted, defaults to the object which fired the event. - delay : Number (optional)
The number of milliseconds to delay the invocation of the handler after the event fires.
- single : Boolean (optional)
trueto add a handler to handle just the next firing of the event, and then remove itself. - order : String (optional)
The order of when the listener should be added into the listener queue.
If you set an order of
beforeand the event you are listening to is preventable, you can returnfalseand it will stop the event.Available options are
before,currentandafter.Defaults to:
current - buffer : Number (optional)
Causes the handler to be 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.
- element : String (optional)
Allows you to add a listener onto a element of this component using the elements reference.
Ext.create('Ext.Component', { listeners: { element: 'element', tap: function() { alert('element tap!'); } } });All components have the
elementreference, which is the outer most element of the component. Ext.Container also has theinnerElementelement which contains all children. In most caseselementis adequate. - delegate : String (optional)
Uses Ext.ComponentQuery to delegate events to a specified query selector within this item.
// Create a container with a two children; a button and a toolbar var container = Ext.create('Ext.Container', { items: [ { xtype: 'toolbar', docked: 'top', title: 'My Toolbar' }, { xtype: 'button', text: 'My Button' } ] }); container.addListener({ // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate delegate: 'button', tap: function() { alert('Button tapped!'); } });
- scope : Object (optional)
- order : String (optional)
The order of when the listener should be added into the listener queue. Possible values are
before,currentandafter.Defaults to:
'current'
Initialize layout and event listeners the very first time an item is added
Fires
invoked by the selection model to maintain visual UI cues
Parameters
Fires
Overrides: Ext.mixin.Selectable.onItemDeselect
invoked by the selection model to maintain visual UI cues
Parameters
Fires
Overrides: Ext.mixin.Selectable.onItemSelect
Parameters
- store : Ext.data.Store
- records : Array
Fires
- itemindexchange
Overrides: Ext.dataview.DataView.onStoreAdd
Parameters
- store : Ext.data.Store
- records : Array
- indices : Array
Fires
- itemindexchange
Overrides: Ext.dataview.DataView.onStoreRemove
Parameters
- store : Ext.data.Store
- record : Ext.data.Model
- newIndex : Number
- oldIndex : Number
Fires
- itemindexchange
Overrides: Ext.dataview.DataView.onStoreUpdate
Function which can be overridden to provide custom formatting for each Record that is used by this DataView's template to render each node.
Parameters
- data : Object/Object[]
The raw data object that was used to create the Record.
- index : Number
the index number of the Record being prepared for rendering.
- record : Ext.data.Model
The Record being prepared for rendering.
Returns
Retrieves all descendant components which match the passed selector. Executes an Ext.ComponentQuery.query using this container as its root.
Parameters
- selector : String
Selector complying to an Ext.ComponentQuery selector.
Returns
- Array
Ext.Component's which matched the selector.
Refreshes the view by reloading the data from the store and re-rendering the template.
Fires
Refreshes an individual node's data from the store.
This method has been removed since 2.0.0
Removes an item from this Container, optionally destroying it.
Parameters
- item : Object
The item to remove.
- destroy : Boolean (optional)
Calls the Component's destroy method if
true.
Returns
- Ext.Component
this
Fires
Removes a before-event handler.
Same as removeListener with order set to 'after'.
Parameters
- eventName : String/String[]/Object
The name of the event the handler was associated with.
- fn : Function/String
The handler to remove.
- scope : Object (optional)
The scope originally specified for
fn. - options : Object (optional)
Extra options object.
Fires
Removes all items currently in the Container, optionally destroying them all.
Parameters
- destroy : Boolean
If
true, destroys each removed Component. - everything : Boolean
If
true, completely remove all items including docked / centered and floating items.
Returns
- Ext.Component
this
Fires
Removes the Component at the specified index:
myContainer.removeAt(0); // removes the first item
Parameters
- index : Number
The index of the Component to remove.
Returns
- Ext.Container
this
Fires
Removes a before-event handler.
Same as removeListener with order set to 'before'.
Parameters
- eventName : String/String[]/Object
The name of the event the handler was associated with.
- fn : Function/String
The handler to remove.
- scope : Object (optional)
The scope originally specified for
fn. - options : Object (optional)
Extra options object.
Fires
Removes a docked item from this Container.
This method has been deprecated since 2.0.0
Please use remove instead.
Parameters
Returns
- Ext.Component
this
Removes an inner Component at the specified index:
myContainer.removeInnerAt(0); // removes the first item of the innerItems property
Parameters
- index : Number
The index of the Component to remove.
Returns
- Ext.Container
this
Fires
Removes an event handler.
Parameters
- eventName : String/String[]/Object
The type of event the handler was associated with.
- fn : Function/String
The handler to remove. This must be a reference to the function passed into the addListener call.
- scope : Object (optional)
The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.
- options : Object (optional)
Extra options object. See addListener for details.
- order : String (optional)
The order of the listener to remove. Possible values are
before,currentandafter.Defaults to:
'current'
Fires
Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.
This method has been deprecated since 2.0
All listeners are now automatically managed where necessary. Simply use removeListener.
Parameters
- object : Ext.mixin.Observable/HTMLElement
The item to which to add a listener/listeners.
- eventName : Object/String
The event name, or an object containing event name properties.
- fn : Function (optional)
If the
eventNameparameter was an event name, this is the handler function. - scope : Object (optional)
If the
eventNameparameter was an event name, this is the scope in which the handler function is executed.
Replaces specified classes with the newly specified classes. It uses the addCls and removeCls methods, so if the class(es) you are removing don't exist, it will still add the new classes.
Parameters
- oldCls : String
The class(es) to remove.
- newCls : String
The class(es) to add.
- prefix : String (optional)
Optional prefix to prepend before each class.
Defaults to:
"" - suffix : String (optional)
Optional suffix to append to each class.
Defaults to:
""
Fires
Resumes firing events (see suspendEvents).
Parameters
- discardQueuedEvents : Boolean
Pass as true to discard any queued events.
Scrolls the list so that the specified record is at the top.
Parameters
- record : Object
{Ext.data.Model} Record in the lists store to scroll to
- animate : Object
{Boolean} Determines if scrolling is animated to a cut
- overscroll : Object
{Boolean} Determines if list can be overscrolled
Fires
Adds the given records to the currently selected set.
Parameters
- records : Ext.data.Model/Array/Number
The records to select.
- keepExisting : Boolean
If
true, the existing selection will be added to (if not, the old selection is replaced). - suppressEvent : Boolean
If
true, theselectevent will not be fired.
Fires
Selects a range of rows if the selection model getDisableSelection is not locked.
All rows in between startRecord and endRecord are also selected.
Parameters
- startRecord : Number
The index of the first row in the range.
- endRecord : Number
The index of the last row in the range.
- keepExisting : Boolean (optional)
trueto retain existing selections.
Fires
Provides differentiation of logic between MULTI, SIMPLE and SINGLE selection modes.
Parameters
- record : Object
Fires
Sets the value of defaultType.
Parameters
- defaultType : String
Overrides: Ext.dataview.DataView.setDefaultType
Sets the value of enterAnimation.
This method has been deprecated since 2.0.0
Please use showAnimation instead.
Parameters
- enterAnimation : String/Mixed
Sets the value of exitAnimation.
This method has been deprecated since 2.0.0
Please use hideAnimation instead. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'.
Parameters
- exitAnimation : String/Mixed
Sets the value of itemConfig.
Parameters
- itemConfig : Object
Overrides: Ext.dataview.DataView.setItemConfig
This was an internal function accidentally exposed in 1.x and now deprecated. Calling it has no effect
This method has been deprecated since 2.0.0
Sets the value of maxItemCache.
Parameters
- maxItemCache : Number
Overrides: Ext.dataview.DataView.setMaxItemCache
Sets the value of scrollable.
Parameters
- scrollable : Object
Overrides: Ext.dataview.DataView.setScrollable
Sets the value of useComponents.
Parameters
- useComponents : Boolean
Overrides: Ext.dataview.DataView.setUseComponents
Shows this component optionally using an animation.
Returns
Fires
Overrides: Ext.Component.show, Ext.Container.show
Shows this component by another component. If you specify no alignment, it will automatically position this component relative to the reference component.
For example, say we are aligning a Panel next to a Button, the alignment string would look like this:
[panel-vertical (t/b/c)][panel-horizontal (l/r/c)]-[button-vertical (t/b/c)][button-horizontal (l/r/c)]
where t = top, b = bottom, c = center, l = left, r = right.
Examples
tl-trmeans top-left corner of the Panel to the top-right corner of the Buttontc-bcmeans top-center of the Panel to the bottom-center of the Button
You can put a '?' at the end of the alignment string to constrain the floating element to the Viewport
// show `panel` by `button` using the default positioning (auto fit)
panel.showBy(button);
// align the top left corner of `panel` with the top right corner of `button` (constrained to viewport)
panel.showBy(button, "tl-tr?");
// align the bottom right corner of `panel` with the center left edge of `button` (not constrained by viewport)
panel.showBy(button, "br-cl");
Parameters
- component : Ext.Component
The target component to show this component by.
- alignment : String (optional)
The specific alignment.
Fires
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
Suspends the firing of all events.
All events will be queued but you can discard the queued events by passing false in the resumeEvents call
Add or removes a class based on if the class is already added to the Component.
Parameters
- className : String
The class to toggle.
Returns
- Ext.Component
this
Fires
Alias for removeListener.
Parameters
- eventName : String/String[]/Object
The type of event the handler was associated with.
- fn : Function/String
The handler to remove. This must be a reference to the function passed into the addListener call.
- scope : Object (optional)
The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.
- options : Object (optional)
Extra options object. See addListener for details.
- order : String (optional)
The order of the listener to remove. Possible values are
before,currentandafter.Defaults to:
'current'
Walks up the ownerCt axis looking for an ancestor Container which matches
the passed simple selector.
Example:
var owningTabPanel = grid.up('tabpanel');
Parameters
- selector : String (optional)
The simple selector to test.
Returns
- Ext.Container
The matching ancestor Container (or
undefinedif no match was found).
Sets a record as the last focused record. This does NOT mean that the record has been selected.
Parameters
- newRecord : Ext.data.Record
- oldRecord : Ext.data.Record
Fires
Static methods
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 : Object
Add / override static properties of this class.
Ext.define('My.cool.Class', {
// this.se
});
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
- members : Object
Returns
- Ext.Base
this
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
- Ext.Base
this
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
- Object
the created instance.
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
- alias : String/Object
The new method name, or an object to set multiple aliases. See flexSetter
- origin : String/Object
The original method name
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
- String
className
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!");
var instance = this.callParent(arguments);
alert("Meeeeoooowwww");
return instance;
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
As of 2.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!");
var instance = this.callParent(arguments);
alert("Meeeeoooowwww");
return instance;
}
});
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 deprecated since 2.1.0
Please 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
- Ext.Base
this class
Events
Fires whenever item within the Container is activated.
Parameters
- newActiveItem : Object
The new active item within the container.
- this : Ext.Container
The Container instance.
- oldActiveItem : Object
The old active item within the container.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the activeItem configuration is changed by setActiveItem.
Parameters
- this : Ext.Container
The Ext.Container instance.
- value : Object/String/Number
The new value being set.
- oldValue : Object/String/Number
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before orientation changes.
This event has been removed since 2.0.0
This event is now only available onBefore the Viewport's Ext.Viewport.orientationchange
Parameters
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before an item is selected.
This event has been deprecated since 2.0.0
Please listen to the selectionchange event with an order of before instead.
This action following this event is preventable. When any of the listeners returns false, the action is cancelled.
Parameters
- this : Ext.mixin.Selectable
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the bottom configuration is changed by setBottom.
Parameters
- this : Ext.Component
The Ext.Component instance.
- value : Number/String
The new value being set.
- oldValue : Number/String
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the centered configuration is changed by setCentered.
Parameters
- this : Ext.Component
The Ext.Component instance.
- value : Boolean
The new value being set.
- oldValue : Boolean
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a tap occurs and it is not on a template node.
This event has been removed since 2.0.0
Parameters
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever item within the Container is deactivated.
Parameters
- oldActiveItem : Object
The old active item within the container.
- this : Ext.Container
The Container instance.
- newActiveItem : Object
The new active item within the container.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is deselected
This action following this event is preventable. When any of the listeners returns false, the action is cancelled.
Parameters
- this : Ext.dataview.DataView
- record : Ext.data.Model
The record associated to the item
- supressed : Boolean
Flag to suppress the event
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the component is destroyed
Parameters
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the disabled configuration is changed by setDisabled.
Parameters
- this : Ext.Component
The Ext.Component instance.
- value : Boolean
The new value being set.
- oldValue : Boolean
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever a disclosure is handled
This action following this event is preventable. When any of the listeners returns false, the action is cancelled.
Parameters
- this : Ext.dataview.List
The List instance
- record : Ext.data.Model
The record associated to the item
- target : HTMLElement
The element disclosed
- index : Number
The index of the item disclosed
- e : Ext.EventObject
The event object
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the docked configuration is changed by setDocked.
Parameters
- this : Ext.Component
The Ext.Component instance.
- value : String
The new value being set.
- oldValue : String
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the component is no longer displayed in the DOM. Listening to this event will degrade performance not recommend for general use.
Parameters
- this : Ext.Component
The component instance
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the flex configuration is changed by setFlex.
Parameters
- this : Ext.Component
The Ext.Component instance.
- value : Number
The new value being set.
- oldValue : Number
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever there is a change in the floating status of a component
Parameters
- this : Ext.Component
The component instance
- floating : Boolean
The component's new floating state
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever a Component with the fullscreen config is instantiated
Parameters
- this : Ext.Component
The component instance
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the height configuration is changed by setHeight.
Parameters
- this : Ext.Component
The Ext.Component instance.
- value : Number/String
The new value being set.
- oldValue : Number/String
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever the Component is hidden
Parameters
- this : Ext.Component
The component instance
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the component has been initialized
Parameters
- this : Ext.Component
The component instance
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is doubletapped
Parameters
- this : Ext.dataview.DataView
- index : Number
The index of the item doubletapped
- target : Ext.Element/Ext.dataview.component.DataItem
The element or DataItem doubletapped
- record : Ext.data.Model
The record associated to the item
- e : Ext.EventObject
The event object
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is singletapped
Parameters
- this : Ext.dataview.DataView
- index : Number
The index of the item singletapped
- target : Ext.Element/Ext.dataview.component.DataItem
The element or DataItem singletapped
- record : Ext.data.Model
The record associated to the item
- e : Ext.EventObject
The event object
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is swiped
Parameters
- this : Ext.dataview.DataView
- index : Number
The index of the item swiped
- target : Ext.Element/Ext.dataview.component.DataItem
The element or DataItem swiped
- record : Ext.data.Model
The record associated to the item
- e : Ext.EventObject
The event object
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is tapped
Parameters
- this : Ext.dataview.DataView
- index : Number
The index of the item tapped
- target : Ext.Element/Ext.dataview.component.DataItem
The element or DataItem tapped
- record : Ext.data.Model
The record associated to the item
- e : Ext.EventObject
The event object
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item's taphold event fires
Parameters
- this : Ext.dataview.DataView
- index : Number
The index of the item touched
- target : Ext.Element/Ext.dataview.component.DataItem
The element or DataItem touched
- record : Ext.data.Model
The record associated to the item
- e : Ext.EventObject
The event object
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is touched
Parameters
- this : Ext.dataview.DataView
- index : Number
The index of the item touched
- target : Ext.Element/Ext.dataview.component.DataItem
The element or DataItem touched
- record : Ext.data.Model
The record associated to the item
- e : Ext.EventObject
The event object
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is moved
Parameters
- this : Ext.dataview.DataView
- index : Number
The index of the item moved
- target : Ext.Element/Ext.dataview.component.DataItem
The element or DataItem moved
- record : Ext.data.Model
The record associated to the item
- e : Ext.EventObject
The event object
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is touched
Parameters
- this : Ext.dataview.DataView
- index : Number
The index of the item touched
- target : Ext.Element/Ext.dataview.component.DataItem
The element or DataItem touched
- record : Ext.data.Model
The record associated to the item
- e : Ext.EventObject
The event object
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the left configuration is changed by setLeft.
Parameters
- this : Ext.Component
The Ext.Component instance.
- value : Number/String
The new value being set.
- oldValue : Number/String
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the maxHeight configuration is changed by setMaxHeight.
Parameters
- this : Ext.Component
The Ext.Component instance.
- value : Number/String
The new value being set.
- oldValue : Number/String
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the maxWidth configuration is changed by setMaxWidth.
Parameters
- this : Ext.Component
The Ext.Component instance.
- value : Number/String
The new value being set.
- oldValue : Number/String
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the minHeight configuration is changed by setMinHeight.
Parameters
- this : Ext.Component
The Ext.Component instance.
- value : Number/String
The new value being set.
- oldValue : Number/String
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the minWidth configuration is changed by setMinWidth.
Parameters
- this : Ext.Component
The Ext.Component instance.
- value : Number/String
The new value being set.
- oldValue : Number/String
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when orientation changes.
This event has been removed since 2.0.0
This event is now only available on the Viewport's Ext.Viewport.orientationchange
Parameters
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever this Element actually becomes visible (painted) on the screen. This is useful when you need to perform 'read' operations on the DOM element, i.e: calculating natural sizes and positioning.
Note: This event is not available to be used with event delegation. Instead painted only fires if you explicitly
add at least one listener to it, for performance reasons.
Parameters
- element : Ext.Element
The component's outer element (this.element)
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever the DataView is refreshed
This action following this event is preventable. When any of the listeners returns false, the action is cancelled.
Parameters
- this : Ext.dataview.DataView
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is rendered into a container or derendered from a Container.
Parameters
- this : Ext.Container
The Container instance.
- item : Object
The item in the Container.
- rendered : Boolean
The current rendered status of the item.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Important note: For the best performance on mobile devices, use this only when you absolutely need to monitor a Element's size.
Note: This event is not available to be used with event delegation. Instead resize only fires if you explicitly
add at least one listener to it, for performance reasons.
Parameters
- element : Ext.Element
The component's outer element (this.element)
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the right configuration is changed by setRight.
Parameters
- this : Ext.Component
The Ext.Component instance.
- value : Number/String
The new value being set.
- oldValue : Number/String
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the scrollable configuration is changed by setScrollable.
Parameters
- this : Ext.Container
The Ext.Container instance.
- value : Boolean/String/Object
The new value being set.
- oldValue : Boolean/String/Object
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Returns
- Ext.scroll.View
The scroll view.
Fires whenever an item is selected
This action following this event is preventable. When any of the listeners returns false, the action is cancelled.
Parameters
- this : Ext.dataview.DataView
- record : Ext.data.Model
The record associated to the item
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a selection changes.
Parameters
- this : Ext.mixin.Selectable
- records : Ext.data.Model[]
The records whose selection has changed.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever the Component is shown
Parameters
- this : Ext.Component
The component instance
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the top configuration is changed by setTop.
Parameters
- this : Ext.Component
The Ext.Component instance.
- value : Number/String
The new value being set.
- oldValue : Number/String
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever the data of the component is updated
Parameters
- this : Ext.Component
The component instance
- newData : Object
The new data
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the width configuration is changed by setWidth.
Parameters
- this : Ext.Component
The Ext.Component instance.
- value : Number/String
The new value being set.
- oldValue : Number/String
The existing value.
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
CSS Variables
Optionally disable all list gradients, text-shadows, and box-shadows. Useful for CSS debugging, non-performant browsers, or minimalist designs.
Defaults to: $include-highlights
Background-color for selected list rows.
Defaults to: $active-color
Gradient style for selected list rows.
Defaults to: $base-gradient
Background-color for list rows.
Defaults to: #f7f7f7
Default size (width/height) for disclosure icons in a list with a round ui.
Defaults to: 1.5em
Default size (width/height) for disclosure icons.
Defaults to: 32px
Background-color for list header rows (in grouped lists).
Defaults to: lighten ( saturate ( $base-color , 10% ) , 20% )
Gradient style for list header rows (in grouped lists).
Defaults to: $base-gradient
Background-color for pressed list rows.
Defaults to: lighten ( $active-color , 50% )
Default padding for lists with a round ui.
Defaults to: 13px
Default border-radius for items in rounded list
Defaults to: .4em
Optionally zebra-stripe the list (alternating background colors).
Defaults to: false