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

Set this to true to ignore datachanged events on the bound store.

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.

Animation to be used during transitions of cards.

Whether or not this Component is absolutely centered inside its Container

The CSS class to add to this component's element, in addition to the baseCls

CSS class to add to this Component. Deprecated, please use cls instead

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.

Overrides: Ext.Component.data

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

Overrides: Ext.mixin.Selectable.deselectOnContainerClick

true to disable selection. This configuration will lock the selection model that the DataView uses.

Whether or not this component is disabled

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

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

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

Animation effect to apply when the Component is being hidden.

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

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.

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.

Whether or not this Component is hidden (its CSS display property is set to none)

The CSS class to add to the component when it is hidden

Defaults to: "x-item-hidden"

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.

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

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.

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

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.

Defaults to: {}

A simple CSS selector that will be used to determine what nodes this DataView will be working with.

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.

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.

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.

Defaults to: 5

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 allow selection of more than one item at a time.

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.

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/false to 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.

Returns

• Ext.scroll.View

  The scroll view.

Overrides: Ext.Component.scroll

Overrides: Ext.dataview.DataView.scrollable

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.

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.

true to allow selection of exactly one item at a time, false to allow no selection at all.

true to stop the event that fires when you click outside the floating component.

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.

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.

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

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

The z-index to give this Component when it is rendered

Defaults to: 2

Defaults to: 4

Defaults to: 1

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

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

Defaults to: 'ext-'

Defaults to: '-'

Defaults to: {top: true, right: true, bottom: true, left: true}

Defaults to: false

Defaults to: false

Defaults to: false

Defaults to: /\.|[^\w\-]/g

Defaults to: false

Defaults to: true

Defaults to: true

Defaults to: true

Defaults to: true

Defaults to: true

The set of all items in this Container.

Defaults to: false

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: 'identifiable'

Defaults to: {SINGLE: true, SIMPLE: true, MULTI: true}

Defaults to: '#'

Defaults to: 'component'

Overrides: Ext.mixin.Observable.observableType

Defaults to: [{theme: ['Windows'], itemHeight: 44}, {theme: ['Cupertino'], itemHeight: 43}]

Defaults to: 'reference'

Defaults to: '[reference]'

Defaults to: false

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'

Defaults to: 0

Defaults to: false

Defaults to: {beforeload: 'onBeforeLoad', load: 'onLoad', refresh: 'refresh', addrecords: 'onStoreAdd', removerecords: 'onStoreRemove', updaterecord: 'onStoreUpdate'}

Defaults to: []

Defaults to: 0

Defaults to: 0

Defaults to: /^([\w\-]+)$/

Defaults to: 0

Defaults to: false

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

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

Adds an array of Components to this Container.

Parameters

• items : Array

  The array of items to add to this container.

Returns

• Array

  The array of items after they have been added.

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 a CSS class (or classes) to this Component's rendered element.

Parameters

• cls : String

  The CSS class to add.

• prefix : String (optional)

  Optional prefix to add to each class.

  Defaults to: ""

• suffix : String (optional)

  Optional suffix to add to each class.

  Defaults to: ""

Fires

Parameters

• selector : Object
• name : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Fires

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

Parameters

• eventNames : Object/String...

  Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate 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 options parameter described below.

• scope : Object (optional)

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

• options : Object (optional)

  An object containing handler configuration.

  This object may contain any of the following properties:

  • scope : Object (optional)

    The scope (this reference) 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)

    true to 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 before and the event you are listening to is preventable, you can return false and it will stop the event.

    Available options are before, current and after.

    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 element reference, which is the outer most element of the component. Ext.Container also has the innerElement element which contains all children. In most cases element is 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!');
        }
    });
    

• order : String (optional)

  The order of when the listener should be added into the listener queue. Possible values are before, current and after.

  Defaults to: 'current'

Fires

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

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 eventName parameter was an event name, this is the handler function.

• scope : Object (optional)

  If the eventName parameter was an event name, this is the scope in which the handler function is executed.

• options : Object (optional)

  If the eventName parameter 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

• name : Object
• domNode : Object

Used to handle joining of a record to a tpl

Fires

Used to handle joining of a record to a tpl

Fires

Parameters

• component : Object
• alignment : Object

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

Parameters

• animation : Object
• component : Object
• newState : Object
• oldState : Object
• options : Object
• controller : Object

Fires

Parameters

• activeItem : Object
• currentActiveItem : Object

Fires

Parameters

• baseCls : Object

Parameters

• bottom : Object

Fires

Parameters

• bubbleEvents : Object

Fires

Parameters

• centered : Boolean

Returns

• Boolean

Fires

• innerstatechange

Checks if the cls is a string. If it is, changed it into an array.

Parameters

• cls : String/Array

Returns

• Array/null

Parameters

• contentEl : Object

Parameters

• selectors : Object

Fires

Parameters

• data : Object

Parameters

• defaultType : Object

Fires

Parameters

• defaults : Object

Parameters

• disabled : Object

Parameters

• docked : Object

Fires

• innerstatechange

Parameters

• config : Object

Fires

Parameters

• flex : Object

Parameters

• height : Object

Fires

Parameters

• hidden : Object

Parameters

• indexBar : Object

Fires

Parameters

• config : Object

Parameters

• itemId : Object

Fires

Parameters

• itemMap : Object

Fires

Parameters

• config : Object

Parameters

• items : Object
• collection : Object

Fires

• remove

Parameters

• left : Object

Fires

Parameters

• listeners : Object

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

• Object

Fires

Parameters

• height : Object

Fires

Parameters

• width : Object

Fires

Parameters

• height : Object

Fires

Parameters

• width : Object

Fires

Parameters

• modal : Object
• currentModal : Object

Parameters

• mode : Object

Parameters

• config : Object

Parameters

• config : Object

Parameters

• config : Object

Parameters

• right : Object

Fires

Parameters

• config : Object

Fires

Parameters

• store : Object

Parameters

• config : Object

Parameters

• top : Object

Fires

Parameters

• config : Object

Parameters

• config : Object

Fires

Parameters

• value : Object

Fires

Parameters

• width : Object

Fires

Parameters

• zIndex : Object

Parameters

• config : Object

Fires

Parameters

• instance : Object
• boundMethod : Object
• bindingMethod : Object
• preventDefault : Object
• extraArgs : Object

Returns

• Ext.mixin.Bindable

  this

Binds a new Store to this DataView.

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 arguments object from the current method, for example: this.callOverridden(arguments)

Returns

• Object

  Returns the result of calling the overridden method

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

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

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

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

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

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

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

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

 var obj = new My.Derived();

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

This also works with static methods.

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

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

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

Lastly, it also works with overridden static methods.

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

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

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

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

Parameters

• args : Array/Arguments

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

Returns

• Object

  Returns the result of calling the parent method

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

Consider:

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

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

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

         this.callParent();
     }
 });

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

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

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

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

         this.callSuper();
     }
 });

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

Parameters

• args : Array/Arguments

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

Returns

• Object

  Returns the result of calling the superclass method

Parameters

• actionFn : Object
• eventName : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Returns

• Ext.mixin.Observable

  this

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

• Ext.Component

Fires

Removes all listeners for this object.

Fires

Parameters

• object : Object

Fires

Deselects any currently selected records and clears all stored selections.

Function which can be overridden which returns the data object passed to this DataView's template to render the whole DataView.

Parameters

• name : Object

Fires

Creates an event handling function which re-fires the event from this object as the passed event name.

Parameters

• newName : String

Returns

• Function

Fires

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 true the deselect event will not be fired.

Fires

Deselects all records.

Parameters

• supress : Object

Fires

Fires

Overrides: Ext.mixin.Observable.destroy, Ext.Container.destroy, Ext.dataview.DataView.destroy, Ext.Base.destroy, Ext.draw.sprite.Sprite.destroy, Ext.Component.destroy

Disables this Component

Fires

Parameters

• item : Ext.Component

Fires

Parameters

• name : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Returns

• Boolean

Fires

Overrides: Ext.mixin.Observable.doAddListener

Parameters

• record : Object

Fires

Deselects a record instance by record instance or index.

Parameters

• records : Ext.data.Model/Number

  An array of records or an index.

• suppressEvent : Boolean

  Set to false to not fire a deselect event.

Parameters

• me : Object
• record : Object
• item : Object
• index : Object
• e : Object

Parameters

• eventName : Object
• args : Object
• action : Object
• connectedController : Object

Fires

Parameters

• index : Number
• item : Ext.Component

Fires

• move

Parameters

• me : Object
• record : Object

Fires

Overrides: Ext.dataview.DataView.doItemDeselect

Parameters

• item : Object
• index : Object

Fires

Parameters

• item : Object
• toIndex : Object
• fromIndex : Object

Fires

Parameters

• item : Object
• index : Object
• destroying : Object

Fires

invoked by the selection model to maintain visual UI cues

Parameters

• me : Object
• record : Object

Fires

Overrides: Ext.dataview.DataView.doItemSelect

Parameters

• me : Object
• index : Object
• target : Object
• record : Object

Selects a set of multiple records.

Parameters

• records : Object
• keepExisting : Object
• suppressEvent : Object

Fires

Fires

• itemindexchange

Overrides: Ext.dataview.DataView.doRefresh

Fires

• floatingchange
• innerstatechange

Fires

• sizeflagschange
• sizestatechange

Parameters

• item : Object
• index : Object
• destroy : Object

Fires

• remove

Parameters

• name : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Fires

Overrides: Ext.mixin.Observable.doRemoveListener

Parameters

• innerIndex : Object

Fires

Selects a record instance by record instance or index.

Parameters

• records : Ext.data.Model/Number

  An array of records or an index.

• keepExisting : Boolean
• suppressEvent : Boolean

  Set to false to not fire a select event.

Parameters

• me : Object
• value : Object
• oldValue : Object
• options : Object

Parameters

• newActiveItem : Object
• oldActiveItem : Object

Parameters

• bottom : Object

Fires

Parameters

• centered : Object

Fires

• innerstatechange

Parameters

• disabled : Object

Fires

Parameters

• docked : Object
• oldDocked : Object

Fires

• afterdockedchange
• innerstatechange

Parameters

• height : Object

Fires

Parameters

• hidden : Object

Fires

Overrides: Ext.Component.doSetHidden

Parameters

• left : Object

Fires

Parameters

• height : Object

Parameters

• width : Object

Parameters

• height : Object

Fires

Parameters

• width : Object

Parameters

• right : Object

Fires

Parameters

• top : Object

Fires

Parameters

• width : Object

Fires

Selects a single record.

Parameters

• record : Object
• suppressEvent : Object

Fires

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

• Ext.Component

Fires

Enables this Component

Fires

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.

Parameters

• events : String/String[]

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

Fires

Parameters

• item : Object

Parameters

• item : Object

Fires

Parameters

• value : Object

Returns the template node the passed child belongs to, or null if it doesn't belong to one.

Returns the template node by the Ext.EventObject or null if it is not found.

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

• Object

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 false if any of the handlers return false.

Fires

Parameters

• records : Object

Fires

Returns the value of activeItem.

Returns

• Object/String/Number

Prepares information on aligning this to component using alignment. Also checks to see if this is already aligned to component according to alignment.

Parameters

• component : Object
• alignment : Object

Fires

Returns the value of allowDeselect.

Returns

• Boolean

Fires

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.

Returns the value of autoDestroy.

Returns

• Boolean

Returns the value of border.

Returns

• Number/String

Returns the value of bottom.

Returns

• Number/String

Returns the value of bubbleEvents.

Returns

• String/String[]

Fires

Overrides: Ext.mixin.Observable.getBubbleTarget

Returns the value of centered.

Returns

• Boolean

Returns the value of cls.

Returns

• String/String[]

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 itemId or id of the child component.
  • {Number} : representing the position of the child component within the items property.

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

Returns

• Ext.Component

  The component (if found).

Fires

Parameters

• name : Object

Returns the value of contentEl.

Returns

• Ext.Element/HTMLElement/String

Returns the value of control.

Returns

• Object

Returns the number of selections.

Returns

• Number

Current Alignment information from the last alignTo call

Returns the value of data.

Returns

• Object[]

Overrides: Ext.Component.getData

Returns the value of defaults.

Returns

• Object

Returns the value of deferEmptyText.

Returns

• Boolean

Returns the value of deselectOnContainerClick.

Returns

• Boolean

Overrides: Ext.mixin.Selectable.getDeselectOnContainerClick

Returns the value of disableSelection.

Returns

• Boolean

Returns the value of disabled.

Returns

• Boolean

Returns the value of disabledCls.

Returns

• String

Returns the value of disclosureProperty.

Returns

• String

Returns the value of docked.

Returns

• String

Finds a docked item of this container using a reference, idor an index of its location in getDockedItems.

Parameters

• component : String/Number

  The id or index of the component to find.

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

Fires

Retrieves the top level element representing this component.

 var element = component.element;

Returns

• Ext.dom.Element

Returns

• Object
  • reference : String
  • classList : Array
  • children : Object

Overrides: Ext.Component.getElementConfig

Returns the value of emptyText.

Returns

• String

Returns the value of enterAnimation.

Returns

• String/Mixed

Fires

Returns the value of exitAnimation.

Returns

• String/Mixed

Returns the value of flex.

Returns

• Number

Returns the value of floatingCls.

Returns

• String

Returns the value of grouped.

Returns

• Boolean

Returns the value of height.

Returns

• Number/String

Returns the value of hidden.

Returns

• Boolean

Returns the value of hiddenCls.

Returns

• String

Returns the value of hideAnimation.

Returns

• String/Mixed

Returns the value of hideOnMaskTap.

Returns

• Boolean

Returns the value of html.

Returns

• String/Ext.Element/HTMLElement

Returns the value of icon.

Returns

• Object