ExtReact Docs Help

Introduction

The documentation for the ExtReact product diverges somewhat from the documentation of other Sencha products. The sections below describe documentation for all products except where indicated as unique to ExtReact.

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

Or in the case of an ExtReact component class this indicates a member of type prop

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

ExtReact component classes do not hoist the getter / setter methods into the prop. All methods will be described in the Methods section

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

ExtAngular 6.7.0


top

List Ext.dataview.List

Summary

List is a custom styled DataView which allows Grouping, Indexing, Icons, and a Disclosure.

A more advanced example showing a list of people grouped by last name:

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.

No members found using the current filters

properties

Required Properties

store : Ext.data.Store / Object
required req

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.

Defaults to:

undefined

Optional Properties

activeAnimation
readonly ro private pri

Defaults to:

null

activeChildTabIndex : Number
immutable imm

DOM tabIndex attribute to set on the active Focusable child of this container when using the "Roaming tabindex" technique.

Defaults to:

0

activeItem : Ext.Component / Object / String / Number

The item from the cfg-items collection that will be active first. This is usually only meaningful in a Ext.layout.Card, where only one item can be active at a time. If passed a string, it will be assumed to be a Ext.ComponentQuery selector. A number will reference an index or a Ext.Component instance may be passed as well. An object config will be created as a new component.

Defaults to:

0

allowFocusingDisabledChildren : Boolean
immutable imm

Set this to true to enable focusing disabled child items via keyboard.

Defaults to:

false

ariaAttributes : Object

An object containing ARIA attributes to be set on this Component's ARIA element. Use this to set the attributes that cannot be determined by the Component's state, such as aria-live, aria-flowto, etc.

Note that this config is only meaningful at the Component rendering time, and setting it after that will do nothing.

ariaDescribedBy : String
immutable imm

DOM selector for a child element that is to be used as description for this Component, set in aria-describedby attribute. The selector works the same way as ariaLabelledBy.

ariaLabel : String
immutable imm

ARIA label for this Component. It is best to use ariaLabelledBy option instead, because screen readers prefer aria-labelledby attribute to aria-label. ariaLabel and ariaLabelledBy config options are mutually exclusive.

ariaLabelledBy : String
immutable imm

DOM selector for a child element that is to be used as label for this Component, set in aria-labelledby attribute. If the selector is by #id, the label element can be any existing element, not necessarily a child of the main Component element.

ariaLabelledBy and ariaLabel config options are mutually exclusive, and ariaLabelledBy has the higher precedence.

associatedData : Boolean / Object

Set this config to false to limit rendering data to just the record's data or to an object to describe the desired associated data. This data is used to satisfy the itemTpl. The default of true will gather all associated data that is currently loaded. This can be expensive. If only a small amount of the available data is needed, this config can speed up the rendering process.

For example, if an OrderItem needs the Item data but not its parent Order, this config can be set like so:

 associatedData: {
     item: true
 }

Given the above, only the item association (to the Item record) will be gathered into the render data.

For more details, see getData.

Defaults to:

true

Available since: 6.5.0

autoDestroy : Boolean

If true, child items will be destroyed as soon as they are removed from this container.

Defaults to:

true

autoSize : Boolean

May be set to false for improved layout performance if auto-sizing is not required.

Some versions of Safari, both desktop and mobile, have very slow performance if the application has deeply nested containers due to the following WebKit bug: https://bugs.webkit.org/show_bug.cgi?id=150445

Applications that experience performance issues in the affected versions of Safari may need to turn off autoSizing globally for all Container instances by placing the following override in the application's "overrides" directory:

Ext.define('MyApp.overrides.Container', {
    override: 'Ext.Container',
    config: {
        autoSize: false
    }
});

Once auto-sizing support has turned off by default, it can be selectively turned back on only on those container instances that explicitly need auto-sizing behavior by setting autoSize to true.

This option can also be used to allow children to be sized in percentage units as a workaround for the following browser bug: https://bugs.webkit.org/show_bug.cgi?id=137730

To illustrate, the following example should render a 200px by 200px green box (the container) with a yellow box inside of it (the child item). The child item's height and width are both set to '50%' so the child should render exactly 100px by 100px in size.

<Container
    height={200}
    width={200}
    style="background: green"
>
    <Component
        style="background: yellow"
        height="50%"
        width="50%"
    />
</Container>

All browsers except for Safari render the previous example correctly, but Safari does not assign a height to the component. To make percentage-sized children work in Safari, simply set autoSize to false on the container.

Since the underlying implementation works by absolutely positioning the container's body element, this option can only be used when the container is not "shrink wrapping" the content in either direction. When autoSize is set to false, shrink wrapped dimension(s) will collapse to 0.

Defaults to:

null

axisLock : Boolean

If true, then, when showBy or alignTo fallback on constraint violation only takes place along the major align axis.

That is, if alignment "l-r" is being used, and axisLock: true is used, then if constraints fail, only fallback to "r-l" is considered.

Defaults to:

null

border : Boolean

Enables or disables bordering on this component. The following values are accepted:

  • null or `true (default): Do nothing and allow the border to be specified by the theme.
  • false: suppress the default border provided by the theme.

Please note that enabling bordering via this config will not add a border-color or border-style CSS property to the component; you provide the border-color and border-style via CSS rule or style configuration (if not already provide by the theme).

Defaults to:

null

bottom : Number / String

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 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

bufferSize : Number

The number of items an infinite list will render beyond those immediately visible.

To prevent the rendering of items while scrolling, these extra items are rendered out of view. When the scroller approaches within minimumBufferSize of the end of the rendered range, the extra items trailing the scroll will be repositioned (and reconfigured) ahead of the scroll.

Defaults to:

20

bufferSize : Number

The amount of items we render additionally 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

buttonAlign : String
immutable imm

The alignment of any buttons added to this panel. Valid values are 'right', 'left' and 'center' (defaults to 'right' for buttons/fbar, 'left' for other toolbar types).

NOTE: The preferred way to specify toolbars is to use the items config specifying the docked config on the item. Instead of buttonAlign you would add the layout: { pack: 'start' | 'center' | 'end' } option to the docked item config.

Defaults to:

null

Available since: 6.5.0

cardSwitchAnimation : String / Object / Boolean
immutable imm removed rem

Animation to be used during transitions of cards.

This method has been REMOVED since 2.0.0

centered : Boolean

Configure this as true to have this Component centered within its Container. Setting this value to true will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

false

classCls
readonly ro

Defaults to:

Ext.baseCSSPrefix + 'list'

cls : String / String[]

The CSS class to add to this widget's element, in addition to the baseCls. In many cases, this property will be specified by the derived widget class. See userCls for adding additional CSS classes to widget instances (such as items in a Container).

Defaults to:

null

container : Object

This config is used to control the internal Container created to manage this list's items. One common use for this is to apply a userCls to the item container.

 {
     xtype: 'list',
     container: {
         userCls: 'mylist-cls'
     },
     ...
 }

Available since: 6.0.1

contentEl : Ext.dom.Element / HTMLElement / String

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.

Defaults to:

null

data : Object[]

An array of records to display. Use in place of store when fetching data directly or using static data rather than fetching data with an ExtReact proxy.

 <List
     data={[
         { name: 'Apple', symbol: 'AAPL' },
         { name: 'Microsoft', symbol: 'MSFT' },
         { name: 'Oracle', symbol: 'ORCL' }
     ]}
     itemTpl={data => (
         <div>
             <div style={{ fontWeight: 'bold' }}>{data.name}</div>
             <div>{data.symbol}</div>
         </div>
     )}
 />

Defaults to:

null

dataItems : Ext.dom.Element[] / Ext.Component[]
readonly ro private pri

The array of data items. This array is maintained in store order. The type of objects in this array depend on the type of this dataview. Further, infinite lists only put the actually rendered portion of the store in this array.

NOTE: This is not the same thing as the items maintained by this Container since there could be items in the container that are not associated to any record in the store.

Defaults to:

[]

defaultBindProperty
readonly ro

Defaults to:

'store'

defaultFocus : String

Specifies a child Component to receive focus when this Container's method-focus method is called. Should be a valid Ext.ComponentQuery selector.

Defaults to:

null

defaults : Object

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:

Defaults to:

null

deferEmptyText : Boolean

Set to false to not defer emptyText being applied until the store's first load.

Defaults to:

true

deselectOnContainerClick : Boolean

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

disableSelection : Boolean

Set to true to disable selection styling. This only affects the presentation of the selection not the internal selection state.

Defaults to:

false

disabled : Boolean

Whether or not this component is disabled

Defaults to:

null

disclosureProperty : String

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'

disclosureProperty : String

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'

displayed : Boolean

Set to true to call show and false to call hide. Unlike the hidden config, changing this config will potentially involve animations to show or hide the component.

Defaults to:

null

Available since: 6.5.0

dockPositions
readonly ro private pri

Defaults to:

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

docked : String

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

Defaults to:

null

draggable : Boolean / Object / Ext.drag.Source

Set to true to allow this component to be dragged. This can also be the config object for the Ext.drag.Source that will manage the drag.

Defaults to:

null

emptyItemText : String

The text to render when the rendering of the item via itemTpl produces no text.

Defaults to:

'\xa0'

emptyState : Boolean
private pri

Defaults to:

null

emptyText : String / Boolean

The text to display in the view when there is no data to display. Set this to true to display the default message.

Defaults to:

null

emptyTextDefaults : Object / Ext.Component

This component config object is used to create the emptyText component.

Defaults to:

{
    xtype: 'emptytext'
}

Available since: 6.5.0

emptyTextProperty : String
immutable imm

The config to set on the emptyText component to contain the desired text.

Defaults to:

'html'

Available since: 6.5.0

enableTextSelection : Boolean
deprecated dep

True to enable text selection inside this view.

Defaults to:

null

Deprecated since version 6.5.1
Use Ext.Component#userSelectable instead.

enterAnimation : String / Mixed
deprecated dep

Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'.

Defaults to:

null

Deprecated since version 2.0.0
Please use showAnimation instead.

exitAnimation : String / Mixed
deprecated dep

Animation effect to apply when the Component is being hidden.

Defaults to:

null

Deprecated since version 2.0.0
Please use hideAnimation instead. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'.

factoryConfig : Object
readonly ro

If this property is specified by the target class of this mixin its properties are used to configure the created Ext.Factory.

floatingCls
readonly ro

Defaults to:

Ext.baseCSSPrefix + 'floating'

focusCls : String
immutable imm

CSS class that will be added to focused component's focusClsEl, and removed when component blurs.

Defaults to:

'x-focused'

focusClsEl : Ext.dom.Element
readonly ro

The element that will have the focusCls applied when component's focusEl is focused.

focusEl : Ext.dom.Element
readonly ro

The element that will be focused when focus method is called on this component. Usually this is the same element that receives focus via mouse clicks, taps, and pressing Tab key.

Defaults to:

'el'

focusable
readonly ro

Defaults to:

true

focusableContainer : Boolean
immutable imm

Enable or disable navigation with arrow keys for this FocusableContainer. This option may be useful with nested FocusableContainers, when only the root container should handle keyboard events.

Defaults to:

false

focusableContainerEl : String / Ext.dom.Element
readonly ro

The name of the element that FocusableContainer should bind its keyboard handler to. Similar to ariaEl, this name is resolved to the Ext.dom.Element instance after rendering.

Defaults to:

"el"

fullscreen : Boolean
immutable imm

Force the component to take up 100% width and height available, by adding it to Ext.Viewport.

groupFooter : Object / Ext.dataview.ItemHeader

The counterpart to groupHeader, this config controls the footer that is displayed below each group in a grouped list.

Defaults to:

null

Available since: 6.5.0

groupHeader : Object / Ext.dataview.ItemHeader

This config is used to configure a header to display above each group in a grouped list. One of the more common uses of this config is to set the tpl.

 groupHeader: {
     tpl: 'Group: {name}'
 }

Defaults to:

{
    xtype: 'itemheader',
    tpl: '{html} ({count})'
}

Available since: 6.5.0

groupHeaderTpl : String / String[] / Ext.XTemplate

A single string or an array of strings (optionally followed by an object containing template methods) used to create an Ext.XTemplate, or an Ext.XTemplate instance.

A single string:

  groupHeaderTpl: 'Group: {name}'

Using a string array (followed by an options object):

  groupHeaderTpl: [
      'Group: ',
      '<div>{name:this.formatName}</div>',
      {
          formatName: function(name) {
              return Ext.String.trim(name);
          }
      }
  ]

The data object available to the template provides the following properties:

  • name The grouping string of the groupField for the group header. This string is the string produced by grouper's groupFn.
  • value The value of the groupField for the group header being rendered.
  • columnName The column header associated with the field being grouped by if there is a column for the field, falls back to the groupField.
  • groupField The field name being grouped by.
  • html The rendering of the value as handled by the cell (for a grid, otherwise the same as name).
  • children An array containing the child records for the group. This is not available if the store is a Ext.data.BufferedStore.

Available since: 6.5.0

grouped : Boolean

Set to false turn off all grouping. This setting is only meaningful if the underlying store has a grouper.

Defaults to:

true

grouped : Boolean

Whether or not to group items in the provided Store with a header for each item.

Defaults to:

null

height : Number / String

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.

Defaults to:

null

hidden : Boolean

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

Defaults to true for floated Components.

Defaults to:

null

hideAnimation : String / Mixed

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.

Defaults to:

null

hideOnMaskTap : Boolean

When using a modal Component, setting this to true will hide the modal mask and the Container when the mask is tapped on.

Defaults to:

null

horizontalOverflow
private pri

Defaults to:

null

Available since: 6.5.0

html : String / Ext.dom.Element / HTMLElement

Optional HTML content to render inside this Component, or a reference to an existing element on the page.

Defaults to:

null

inactiveChildTabIndex : Number
immutable imm

DOM tabIndex attribute to set on inactive Focusable children of this container when using the "Roaming tabindex" technique. This value rarely needs to be changed from its default.

Defaults to:

-1

indexBar : Boolean / Object / Ext.dataview.IndexBar

Set to true to render an alphabet IndexBar docked on the right. This can also be a config object for the Ext.dataview.IndexBar component.

Defaults to:

null

indexBar : Boolean / Object

Set to true to render an alphabet IndexBar docked on the right. This can also be a config object for the Ext.dataview.IndexBar component.

Defaults to:

false

infinite : Boolean

Set to true to if this list should anticipate too many rows to render to the DOM at one time. When set to true, only a fixed number of rows is rendered at once, depending on the height or maxHeight of the list.

When using this mode in an auto-height situation (where the list should be the height of its items), a maxHeight setting is required. This is due to the fact that the rendered items are absolutely positioned. As such they do not directly contribute to the list's height.

When maxHeight is set, however, an infinite list uses that setting to decide how many items to render and will set an appropriate height on its innermost element, thereby allowing the list to achieve the proper height.

Note that this configuration can not be dynamically changed after the list has instantiated.

Defaults to:

false

infinite : Boolean

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

inline : Boolean / Object

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.

Defaults to:

null

innerCls : String

A string to add to the immediate parent element of the inner items of this container. That is, items that are not docked, positioned or floated. In some containers, positioned items may be in this same element.

Defaults to:

null

Available since: 6.5.0

innerCtHeight
private pri

Defaults to:

null

Available since: 6.5.0

innerWidth
private pri

Defaults to:

null

Available since: 6.5.0

isComponent
readonly ro private pri

Defaults to:

true

isContainer : Boolean
readonly ro

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

Defaults to:

true

isDataView : Boolean
readonly ro

true in this class to identify an object this type, or subclass thereof.

Defaults to:

true

isObservable : Boolean
readonly ro

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

Defaults to:

true

itemButtonMode : Boolean

True to cause items to act like buttons for interaction styling. in ButtonMode items will maintain pressed state whenever pressed down. they will not remove this state for tap distance cancellation or mouse out.

Defaults to:

false

itemCache : Ext.Component[]
readonly ro private pri

The array of component items previously created for this view but not in current use. This array will contain no more then maxItemCache items.

Defaults to:

[]

itemCls : String

An additional CSS class to apply to items within the DataView.

Defaults to:

null

itemConfig : Object / Ext.Component

The object is used to configure the data items created by this data view. The xtype property of this config overrides the container's defaultType.

Defaults to:

{
    xtype: 'simplelistitem'
}

itemContentCls : String

A class to add to the element that immediate wraps the item content produced by the itemTpl (the "inner-html" element).

Defaults to:

null

Available since: 6.5.0

itemDataMap : Object

This object allows you to map Ext.data.Model fields to specific configs on component items.

The itemDataMap object's keys describe the target objects to receive data from the associated record. These keys are either '#' (for the item itself) or a reference to a component contained in the item.

For each target listed in itemDataMap, the value is another map describing the config name (in the key) and the data field name (as the value).

For example:

 itemDataMap: {
     '#': {
         title: 'fullName'
     },
     text: {
         html: 'name'
     }
 }

The above is equivalent to:

 item.setTitle(item.getRecord().get('fullName'));
 item.lookup('text').setHtml(item.getRecord().get('name'));

For more complex mapping of data to item, you should use the data binding as described in the class documentation.

Defaults to:

null

Available since: 6.5.0

itemHeight : Number

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:

null

itemInnerCls : String

A class to add to the inner element of items.

Defaults to:

null

Available since: 6.5.0

itemTpl : String / String[] / Ext.XTemplate

The tpl to use for each of the items displayed in this DataView. This template produces HTML and can use the follow CSS class names to influence the response to tapping/clicking child elements:

  • x-no-ripple - Disables itemRipple (primarily for theme-material)
  • x-item-no-select - Disables item selection
  • x-item-no-tap - Disables all click or tap processing

For example:

 itemTpl: '<div>' +
              '...' +
              '<div class="x-item-no-select x-fa fa-gear"></div>' +
              '...' +
          '</div>'

Because this template produces HTML from record data it can expose applications to security issues if user-provided data is not properly encoded. For example, in previous releases this template was:

 itemTpl: '<div>{text}</div>'

If the 'text' field contained HTML scripts, these would be evaluated into the application. The itemTpl in version 6.5 is now:

 itemTpl: '<div>{text:htmlEncode}</div>'

Defaults to:

'<div>{text:htmlEncode}</div>'

itemsFocusable : Boolean
private pri

For use by subclasses, not applications.

By default the dataview items are focusable, and navigable using an Ext.dataview.NavigationModel.

Grid set this to false to make rows non-focusable in favour of cells.

Defaults to:

true

keyMap : Object

An object containing handlers for keyboard events. The property names of this object are the key name and any modifiers. The values of the properties are the descriptors of how to handle each event.

The handler descriptor can be simply the handler function (either the literal function or the method name), or it can be an object with these properties:

  • handler: The function or its name to call to handle the event.
  • scope: The this pointer context (can be "this" or "controller").
  • event: An optional override of the key event to which to listen.

Important: Calls to setKeyMap do not replace the entire keyMap but instead update the provided mappings. That is, unless null is passed as the value of the keyMap which will clear the keyMap of all entries.

Properties

scope : String

The default scope to apply to key handlers which do not specify a scope. This is processed the same way as the scope of cfg-listeners. It defaults to the "controller", but using 'this' means that an instance method will be used.

keyMapEnabled : Boolean

Enables or disables processing keys in the keyMap. This value starts as null and if it is null when initKeyMap is called, it will automatically be set to true. Since initKeyMap is called by Ext.Component at the proper time, this is not something application code normally handles.

Defaults to:

null

layout : Object / String

Configuration for this Container's layout. Example:

Defaults to:

'auto'

left : Number / String

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 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

listeners : Object

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.

DOM events from Ext JS Ext.Component

While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

loadingHeight : Number

If specified, gives an explicit height for a floated data view when it is showing the loadingText, if that is specified. This is useful to prevent the view's height from collapsing to zero when the loading mask is applied and there are no other contents in the data view.

Defaults to:

null

loadingText : String / Boolean

A string to display during data load operations. 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...'

maintainChildNodes : Boolean
immutable imm private pri

Set to true to maintain the order of rendered items in the DOM childNodes. In an infinite list this is not normally done for performance reasons but this can create accessibility issues.

Defaults to:

false

Available since: 6.5.0

manageBorders : Boolean
immutable imm protected pro

true to enable border management of docked items. When enabled, borders of docked items will collapse where they meet to avoid duplicated borders.

Defaults to:

false

margin : Number / String

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'

Defaults to:

null

markDirty : Boolean

true to mark items as dirty when the underlying record has been modified.

By default there is no special styling for dirty items in data views and List. When this config is set to true each item's element will have a CSS class name of x-mark-dirty added to it. When the underlying record for an item has been modified the item will have the x-dirty CSS class.

Grid style "dirty" cells using a red triangle icon in the corner of the cell. See $gridcell-dirty-icon

Defaults to:

false

Available since: 6.5.1

masked : Boolean / String / Object / Ext.Mask / Ext.LoadMask

A configuration to allow you to mask this container.

If the value is a string, it will be used as the message config for an Ext.LoadMask.

For more precise control over the mask, 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.

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

Defaults to:

null

maxHeight : Number / String

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 'positioned' (absolutely positioned or centered)

Defaults to:

null

maxItemCache : Number

The number of components to cache when no longer needed (as opposed to calling destroy on them).

Defaults to:

20

maxWidth : Number / String

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 'positioned' (absolutely positioned or centered)

Defaults to:

null

minButtonWidth : Number
immutable imm

Minimum width of all footer toolbar buttons in pixels. If set, this will be used as the default value for the Ext.Button#minWidth config of each Button added to the footer toolbar via the fbar or buttons configurations. It will be ignored for buttons that have a minWidth configured some other way, e.g. in their own config object or via the defaults of their parent container.

Defaults to:

null

Available since: 6.5.0

minHeight : Number / String

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.

Defaults to:

null

minWidth : Number / String

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:

null

minimumBufferDistance : Number

The minimum number of items beyond the visible area of an infinite list to allow before repositioning items on the opposite side to balance the visible area inside the rendered range.

Defaults to:

5

modal : Boolean

true to make this Component modal. This will create a mask underneath the Component that covers its parent and does not allow the user to interact with any other Components until this Component is dismissed.

Defaults to:

null

modelValidation : Boolean
immutable imm

This config enables binding to your Ext.data.Model#validators. This is only processed by form fields (e.g., Ext.field.*) at present, however, this setting is inherited and so can be set on a parent container.

When set to true by a component (or by an ancestor container), the validators of for any {@Ext.data.Model record} fields will be used wherever the value is bound to such data fields.

While this config can be set arbitrarily high in the component hierarchy, doing so can create a lot overhead if most of your form fields do not actually rely on validators in your data model.

Using this setting for a form that is bound to an Ext.data.Model might look like this:

 {
     xtype: 'panel',
     modelValidation: true,
     items: [{
         xtype: 'textfield',
         bind: '{theUser.firstName}'
     },{
         xtype: 'textfield',
         bind: '{theUser.lastName}'
     },{
         xtype: 'textfield',
         bind: '{theUser.phoneNumber}'
     },{
         xtype: 'textfield',
         bind: '{theUser.email}'
     }]
 }

Defaults to:

null

Available since: 6.5.0

name : String
immutable imm

Name for the widget to be used with Ext.Container#lookupName et al.

Defaults to:

null

nameHolder : Boolean
immutable imm

When true child components are tracked by their name property and can be retrieved using the lookupName method.

Defaults to:

false

onItemDisclosure : Boolean / Function / String / Object

Set to true to display a disclosure icon on each list item. The list will then fire the disclose event, and the event can be stopped before childtap. By setting this config to a function, the function passed will be called when the disclosure is tapped. This can be either a function object or the name of a controller method.

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.

Defaults to:

null

onItemDisclosure : Boolean / Function / String / Object

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.

Defaults to:

null

padding : Number / String

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'

Defaults to:

null

pinFooters : Boolean

Whether or not to pin footers on bottom of item groups while scrolling.

Defaults to:

false

Available since: 6.5.0

pinHeaders : Boolean

Whether or not to pin headers on top of item groups while scrolling. Only applicable for infinite lists.

Defaults to:

true

pinHeaders : Boolean

Whether or not to pin headers on top of item groups while scrolling for an iPhone native list experience.

Defaults to:

true

pinnedFooter : Object

A config object for the pinned footer. Only applicable when pinFooters and grouped are true.

Defaults to:

null

Available since: 6.5.0

pinnedFooterHeight
private pri

Defaults to:

null

Available since: 6.5.0

pinnedHeader : Object

A config object for the pinned header. Only applicable when pinHeaders and grouped are true.

Defaults to:

{
    xtype: 'itemheader'
}

pinnedHeader : Object
immutable imm

A config object for the pinned header. Only applicable when pinHeaders is true.

pinnedHeaderHeight
private pri

Defaults to:

null

Available since: 6.5.0

plugins : Object / String / Object[] / String[]

An object or array of objects that will provide custom functionality for this component. If a string is provided or a string is one of the elements of the array, that string is treated as the type alias. For example, "listpaging" is the type alias for Ext.plugin.ListPaging. The full alias includes the "plugin." prefix (i.e., 'plugin.listpaging').

Plugins should derive from Ext.plugin.Abstract but this is not required. The only requirement for a valid plugin is that it contain an init() method that accepts a reference to the owning 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.

Example code

A plugin by alias:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: 'listpaging'
 });

Multiple plugins by alias:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['listpaging', 'pullrefresh']
 });

Single plugin by class name with config options:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: {
         type: 'listpaging',
         autoPaging: true
     }
 });

Multiple plugins by type and class name with config options:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: [{
         xclass: 'Ext.plugin.PullRefresh',
         pullRefreshText: 'Pull to refresh...'
     }, {
         type: 'listpaging',
         autoPaging: true
     }]
 });

positioned
readonly ro private pri

Defaults to:

false

pressedDelay : Number

The amount of delay between the tapstart and adding the pressedCls.

Defaults to:

100

preventSelectionOnDisclose : Boolean

When true item selection is prevented when the user taps a disclose icon.

Defaults to:

true

preventSelectionOnDisclose : Boolean

true to prevent the item selection when the user taps a disclose icon.

Defaults to:

true

preventSelectionOnTool : Boolean

When true item selection is prevented when the user taps on a tool. This can be overridden on specific tools by placing the preventSelection property on the tool:

 tools: [{
     type: 'gear',
     preventSelection: false
 }]

Defaults to:

true

Available since: 6.5.0

publishes
immutable imm

Defaults to:

{
    selection: 1
}

record : Ext.data.Model

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.

Defaults to:

null

referenceHolder : Boolean
immutable imm

If true, this container will be marked as being a point in the hierarchy where references to items with a specified reference config will be held. The container will automatically become a referenceHolder if a controller is specified.

See the introductory docs for Ext.container.Container for more information about references & reference holders.

Defaults to:

false

refreshCounter : Number
readonly ro

The number of refreshes this DataView has had.

Defaults to:

0

refreshHeightOnUpdate : Boolean

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

renderInfo : Object
readonly ro private pri

This object tracks coordinate and index information for the rendered range of records for an infinite list.

Defaults to:

{
    //
    //  :      ...      :  indexTop ( = 100)
    //  :               :
    //  +---------------+ <-- top  (approx indexTop * rowHeight)
    //  | item 100      | \
    //  +---------------+  \
    //  | item 101      |   > height
    //  +---------------+  /
    //  | item 102      | /
    //  +---------------+ <-- bottom ( = top + height)
    //  :               :
    //  :      ...      : count - indexBottom ( = 103)
    //
    atBegin: false,
    atEnd: false,
    bottom: 0,
    height: 0,
    top: 0,
    indexBottom: 0,
    indexTop: 0
}

Properties

atBegin : Number

Set to true if the rendered range is at the beginning of the store (indexTop is 0).

atEnd : Number

Set to true if the rendered range is at the end of the store (indexBottom === store.getCount()).

top : Number

The y coordinate of the top-most row in the rendered range.

bottom : Number

The y coordinate just beyond the bottom of the rendered range.

height : Number

The height of the rendered range.

indexTop : Number

The store index of the top-most record in the rendered range.

indexBottom : Number

The store index one beyond the last record in the rendered range. This ensures that subtracting indexBottom - indexTop is the number of records in the rendered range.

rendered : Boolean
readonly ro

The rendered flag is set when a widget is inserted into the document for the first time.

Note that this is a one-way operation. The first time a widget is inserted into the document, this flag is set, and it is never unset.

resetFocusPosition : Boolean
immutable imm

When true, FocusableContainer will reset last focused position whenever focus leaves the container. Subsequent tabbing into the container will always focus the first eligible child item.

When false, subsequent tabbing into the container will focus the child item that was last focused before.

Defaults to:

false

restoreFocus : Boolean
readonly ro

By default, using the TAB key to reenter a grid restores focus to the cell which was last focused.

Setting this to false means that TAB from above focuses the first rendered cell and TAB from below focuses the last rendered cell.

Be aware that due to buffered rendering, the last row of a 1,000,000 row grid may not be available to receive immediate focus.

Defaults to:

true

right : Number / String

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 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

rowHeight : Number
readonly ro private pri

The height of rows in the list. If variableHeights is true this is the minimum row height.

Defaults to:

0

rowLines : Boolean

Set this to false to suppress the borders in between the items in this list. By default the presence of borders between items is determined by the stylesheet.

Defaults to:

true

rowLines : Boolean

Set this to false to suppress the borders in between the items in this list. By default the presence of borders in between the items is determined by the stylesheet.

Defaults to:

null

scrollDock : String

The dock position of a list's child items relative to the list itself. Can be top or bottom.

Ext.create('Ext.List', {
     fullscreen: true,
     itemTpl: '{firstName}',
     data: [
         { firstName: 'Peter'},
         { firstName: 'Raymond'},
         { firstName: 'Egon'},
         { firstName: 'Winston'}
     ],
     items: [{
          xtype: 'component',
          html: 'Docked!',
          docked: 'top'
     },{
          xtype: 'component',
          html: 'Scroll Docked!',
          scrollDock: 'top'
     }]
 });

Defaults to:

null

scrollToTopOnRefresh : Boolean

Scroll the DataView to the top when the DataView is refreshed.

Defaults to:

true

scrollable : Boolean / String / Object

Configuration options to make this Component scrollable. Acceptable values are:

  • true to enable auto scrolling.
  • false (or null) to disable scrolling - this is the default.
  • x or horizontal to enable horizontal scrolling only
  • y or vertical to enable vertical scrolling only

Also accepts a configuration object for a Ext.scroll.Scroller if if advanced configuration is needed.

The getter for this config returns the Ext.scroll.Scroller instance. You can use the Scroller API to read or manipulate the scroll position:

// scrolls the component to 5 on the x axis and 10 on the y axis
component.getScrollable().scrollTo(5, 10);

Defaults to:

{
    x: false,
    y: true
}

selectable : Object / Ext.dataview.selection.Model

A configuration object which allows passing of configuration options to create or reconfigure a Ext.dataview.selection.Model.

Defaults to:

true

Properties

mode : 'single','simple','multi'

Simple and Multi are similar in that click toggle selection. Multi allows SHIFT+click and CTRL+click. Single simply toggles an item between selected and unselected (unless deselectable is set to false).

deselectable : Boolean

Set to false to disallow deselecting down to zero selections.

selection : Ext.data.Model
immutable imm readonly ro

The selected record.

selectionModel : String
readonly ro private pri

The selection model type to create. Defaults to 'dataview' for DataViews and Lists.

Defaults to:

'dataview'

showAnimation : String / Mixed

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.

Defaults to:

null

stateId : String

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

Defaults to:

null

stateful : Boolean / Object / String[]

This config specifies the config properties that will be persisted using the Ext.state.Provider. If this config is set to true, the configs specified by statefulDefaults will be assumed.

 stateful: true

Otherwise, this config can be an array of strings of the properties to save:

 stateful: [
     'width',
     'height',
     'collapsed'
 ]

The above is equivalent to:

 stateful: {
     width: true,
     height: true,
     collapsed: true
 }

Note: To be truly stateful, an id or stateId must also be assigned.

A stateful object will save its state when any of these config properties change value.

Defaults to:

false

statefulDefaults : Object / String[]
protected pro

The default set of stateful properties. The form of this config is the same as stateful except this config cannot be a Boolean.

This config is intended for classes to specify so that instances can simply enable statefulness using stateful: true.

Defaults to:

null

striped : Boolean

Set this to true if you want the items in the list to be zebra striped, alternating their background color.

Defaults to:

false

style : String / Object

Additional CSS styles that will be rendered into an inline style attribute when the widget 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.

Defaults to:

null

tabIndex : Number

DOM tabIndex attribute for this component's focusEl.

Defaults to:

0

template
readonly ro

Defaults to:

[
    {
        reference: 'bodyElement',
        cls: Ext.baseCSSPrefix + 'body-el',
        uiCls: 'body-el',
        children: [
            {
                // This el is width:100% and flex:1 (for full height)
                reference: 'outerCt',
                className: Ext.baseCSSPrefix + 'list-outer-ct',
                children: [
                    {
                        // This el is just width:100% or explicitly sized of hscroll
                        reference: 'innerCt',
                        className: Ext.baseCSSPrefix + 'list-inner-ct'
                    }
                ]
            }
        ]
    }
]

tooltip : String / Object

The tooltip for this component - can be a string to be used as innerHTML (html tags are accepted) or ToolTip config object.

The default behavior is to use a shared tip instance. The tooltip configuration is registered with the Ext.tip.Manager. To enable this, your application can set the Ext.app.Application#quickTips config, or an instance of the Ext.tip.Manager may be created manually.

To force a unique tooltip instance to be created, specify autoCreate: true on this configuration.

Configuring this with autoHide: false implies autoCreate: true so that the desired persistent behavior can be obtained with other targets still showing the singleton instance.

Defaults to:

null

top : Number / String

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 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

topRenderedIndex
private pri

Defaults to:

null

Available since: 6.5.0

touchAction : Object
immutable imm

Emulates the behavior of the CSS touch-action property in a cross-browser compatible manner.

Keys in this object are touch action names, and values are false to disable a touch action or true to enable it. Accepted keys are:

  • panX
  • panY
  • pinchZoom
  • doubleTapZoom

All touch actions are enabled (true) by default, so it is usually only necessary to specify which touch actions to disable. For example, the following disables only horizontal scrolling and pinch-to-zoom on the component's main element:

touchAction: {
    panX: false,
    pinchZoom: false
}

Touch actions can be specified on reference elements using the reference element name, for example:

// disables horizontal scrolling on the main element, and double-tap-zoom
// on the child element named "body"
touchAction: {
    panY: false
    body: {
        doubleTapZoom: false
    }
}

The primary motivation for setting the touch-action of an element is to prevent the browser's default handling of a gesture such as pinch-to-zoom, or drag-to-scroll, so that the application can implement its own handling of that gesture on the element. Suppose, for example, a component has a custom drag handler on its element and wishes to prevent horizontal scrolling of its container while it is being dragged:

Ext.create('Ext.Widget', {
    touchAction: {
        panX: false
    },
    listeners: {
        drag: function(e) {
            // implement drag logic
        }
    }
});

Defaults to:

null

tpl : String / String[] / Ext.Template / Ext.XTemplate[]

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.

Defaults to:

null

tplWriteMode : String

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'

triggerCtEvent : 'tap' / 'singletap'

Determines what type of touch event is recognized as a touch on the container.

Defaults to:

'tap'

triggerEvent : 'childtap' / 'childsingletap' / 'childdoubletap' / 'childswipe' / 'childtaphold' / 'childlongpress'

Determines what type of touch event causes an item to be selected.

Defaults to:

'childtap'

twoWayBindable
immutable imm

Defaults to:

{
    selection: 1
}

ui : String / String[]
immutable imm

The ui or uis to be used on this Component

When a ui is configured, CSS class names are added to the element, created by appending the ui name(s) to each classCls and/or baseCls.

Defaults to:

null

useSimpleItems : Boolean
deprecated dep

Setting this to false changes the xtype of the itemConfig to the more flexible Ext.dataview.ListItem instead of the more efficient setting of Ext.dataview.SimpleListItem.

Defaults to:

true

Deprecated since version 6.5.0
Set the xtype of itemConfig instead.

useSimpleItems : Boolean

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

userCls : String / String[]
immutable imm

One or more CSS classes to add to the component's primary element. This config is intended solely for use by the component instantiator (the "user"), not by derived classes.

For example:

 items: [{
     xtype: 'button',
     userCls: 'my-button'
 ...
 }]

Defaults to:

null

userSelectable : Boolean / String / Object

Set to true to allow users to select text within this component.

Can also be any valid value for the CSS3 user-select property.

A value of true implies auto, while false implies none.

May also be an object keyed by child element name.

By default, the user cannot click+drag+select text/elements of the UI. Applications may want to enable user selection for specific DOM elements, such as the bodyElement of a component used as a tab panel. The tab and tab text would not be user selectable in this example, but the content area when the tab is selected would.

 userSelectable: {
     element: true,       // allow the element to be user selectable
     bodyElement: true    // allow the component's body element to be user selectable
 }

Defaults to:

false

Available since: 6.5.1

userSelectableClsMap
readonly ro private pri

Defaults to:

{
    "true": Ext.baseCSSPrefix + 'user-selectable-auto',
    "false": Ext.baseCSSPrefix + 'user-selectable-none',
    all: Ext.baseCSSPrefix + 'user-selectable-all',
    auto: Ext.baseCSSPrefix + 'user-selectable-auto',
    text: Ext.baseCSSPrefix + 'user-selectable-text',
    none: Ext.baseCSSPrefix + 'user-selectable-none'
}

variableHeights : Boolean

Set to true if the items in this list do not all have the same height. This is false by default to avoid measure each row to determine its height.

Defaults to:

false

Available since: 6.5.0

verticalOverflow : Boolean
private pri

This config is set to true when an infinite list has vertical overflow.

Defaults to:

null

Available since: 6.5.0

visibleHeight : Number
private pri

The height of the container in pixels. This is a config to simplify processing changes in container height.

Defaults to:

null

Available since: 6.5.0

visibleLeft
private pri

Defaults to:

null

Available since: 6.5.0

visibleTop : Number
private pri

The top-most visible pixel coordinate. This is the same as the y value of the Scroller but is a config to simplify processing scrolling changes.

Defaults to:

null

Available since: 6.5.0

visibleWidth
private pri

Defaults to:

null

Available since: 6.5.0

weight : Number

This value controls this item's order in a weighted Container (see parent).

Lower values gravitate towards the start of the container - the top in vertical layouts, the locale start side in horizontal layouts.

Defaults to:

0

width : Number / String

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.

Defaults to:

null

xtype : String
immutable imm

The xtype configuration option can be used to optimize Component creation and rendering. It serves as a shortcut to the full component name. For example, the component Ext.button.Button has an xtype of button.

You can define your own xtype on a custom Ext.Component by specifying the alias config option with a prefix of widget. For example:

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

Any Component can be created implicitly as an object config with an xtype specified, allowing it to be declared and passed into the rendering pipeline without actually being instantiated as an object. Not only is rendering deferred, but the actual creation of the object itself is also deferred, saving memory and resources until they are actually needed. In complex, nested layouts containing many Components, this can make a noticeable improvement in performance.

// Explicit creation of contained Components:
var panel = new Ext.Panel({
   // ...
   items: [
      Ext.create('Ext.button.Button', {
         text: 'OK'
      })
   ]
});

// Implicit creation using xtype:
var panel = new Ext.Panel({
   // ...
   items: [{
      xtype: 'button',
      text: 'OK'
   }]
});

In the first example, the button will always be created immediately during the panel's initialization. With many added Components, this approach could potentially slow the rendering of the page. In the second example, the button will not be created or rendered until the panel is actually displayed in the browser. If the panel is never displayed (for example, if it is a tab that remains hidden) then the button will never be created and will never consume any resources whatsoever.

zIndex : Number

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

Not valid for floated Components. The Z ordering of floated Components is managed by ordering of the DOM elements.

Defaults to:

null

methods

Instance Methods

_flushStateful
private pri

This method is called before destroy to ensure that this instance's stateful properties are saved to persistent storage. Since this object is about to be destroyed, this cannot be delayed.

_getStateId String
private pri

Returns the state id for this object.

Returns

:String

The stateId or the configured id.

add ( newItems ) : Ext.Component/Ext.Component[]

Adds one or more Components to this Container. Example:

var myPanel = Ext.create({
    xtype: 'panel',
    html : 'This will be added to a Container'
});

var items = myContainer.add([myPanel]); // Array returned
var item  = myContainer.add(myPanel);   // One item is returned

Parameters

newItems :  Object/Object[]/Ext.Component/Ext.Component[]

The new item(s) to add to the Container. Note that if an array of items to add was passed in, an array of added items will be returned as well even if there was only one item.

Returns

:Ext.Component/Ext.Component[]

The Component(s) that were added.

addListener ( eventName, [fn], [scope], [options], [order] ) : Object

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, this);

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

myGridPanel.on({
    cellclick: this.onCellClick,
    select: this.onSelect,
    viewready: this.onViewReady,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellclick: {fn: this.onCellClick, scope: this, single: true},
    viewready: {fn: panel.onViewReady, scope: panel}
});

Names of methods in a specified scope may also be used:

myGridPanel.on({
    cellclick: {fn: 'onCellClick', scope: this, single: true},
    viewready: {fn: 'onViewReady', scope: panel}
});

Parameters

eventName :  String/Object

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

fn :  Function/String (optional)

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

scope :  Object (optional)

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

options :  Object (optional)

An object containing handler configuration.

Note: The options object will also be passed as the last argument to every event handler.

This object may contain any of the following properties:

scope :  Object

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

delay :  Number

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

single :  Boolean

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

buffer :  Number

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

onFrame :  Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

target :  Ext.util.Observable

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

element :  String

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

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

  var panel = new Ext.panel.Panel({
      title: 'The title',
      listeners: {
          click: this.handlePanelClick,
          element: 'body'
      }
  });

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

 panel.body.un(...)

delegate :  String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture :  Boolean (optional)

When set to true, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopPropagation on the event object before firing the handler.

preventDefault :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call preventDefault on the event object before firing the handler.

stopEvent :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopEvent on the event object before firing the handler.

args :  Array (optional)

Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.

destroyable :  Boolean (optional)

When specified as true, the function returns a destroyable object. An object which implements the destroy method which removes all listeners added in this call. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to:

false

priority :  Number (optional)

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

order :  String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the priority option instead. Available options are:

  • 'before': equal to a priority of 100
  • 'current': equal to a priority of 0 or default priority
  • 'after': equal to a priority of -100

Defaults to:

'current'

order :  String (optional)

A shortcut for the order event option. Provided for backward compatibility. Please use the priority event option instead.

Combining Options

Using the options argument, it is possible to combine different types of listeners:

A delayed, one-time listener.

myPanel.on('hide', this.handleClick, this, {
    single: true,
    delay: 100
});

Attaching multiple handlers in 1 call

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.

grid.on({
    itemclick: 'onItemClick',
    itemcontextmenu: grid.onItemContextmenu,
    destroy: {
        fn: function () {
            // function called within the 'altCmp' scope instead of grid
        },
        scope: altCmp // unique scope for the destroy handler
    },
    scope: grid       // default scope - provided for example clarity
});

Delegate

This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

var panel = Ext.create({
    xtype: 'panel',
    renderTo: document.body,
    title: 'Delegate Handler Example',
    frame: true,
    height: 220,
    width: 220,
    html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});

// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
    click: function (e) {
        console.log(e.getTarget().innerHTML);
    },
    element: 'body',
    delegate: 'h1.myTitle'
 });

Defaults to: 'current'

Returns

:Object

Only when the destroyable option is specified.

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

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

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

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

The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Ext.define('Foo', {
    extend: 'Ext.Component',

    initComponent: function () {
        this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
        this.callParent();
    }
});

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

Parameters

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

The item to which to add a listener/listeners.

ename :  Object/String

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

fn :  Function/String (optional)

If the ename parameter was an event name, this is the handler function or the name of a method on the specified scope.

scope :  Object (optional)

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

options :  Object (optional)

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

Returns

:Object

Only when the destroyable option is specified.

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

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

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

addPlugin ( plugin )

Adds a plugin. For example:

 list.addPlugin('pullrefresh');

Or:

 list.addPlugin({
     type: 'pullrefresh',
     pullRefreshText: 'Pull to refresh...'
 });

Available since: 6.2.0

Parameters

plugin :  Object/String/Ext.plugin.Abstract

The plugin or config object or alias to add.

afterEdit
private pri

Used to handle joining of a record to a tpl

afterErase
private pri

Used to handle joining of a record to a tpl

alignTo ( component, alignment, options )
private pri

Parameters

component :  Object

alignment :  Object

options :  Object

animateActiveItem ( activeItem, animation )

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.layout.card.fx.Abstract

Card animation configuration or instance.

applyActiveItem ( activeItem, currentActiveItem ) : Number
private pri

Parameters

activeItem :  Object

currentActiveItem :  Object

Returns

:Number

applyCentered ( centered ) : Boolean
private pri

Parameters

centered :  Boolean

Returns

:Boolean

applyControl ( selectors )
private pri

Parameters

selectors :  Object

applyItemDefaults ( item ) : Object/Ext.Component
private pri

Applies the container's defaults onto a child item. The item can be a config object or an instance but has to be an inner item.

Parameters

item :  Object/Ext.Component

The item to apply the defaults to.

Returns

:Object/Ext.Component

The item that was passed in

applyMasked ( masked ) : Object

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/String/Ext.Mask/Ext.LoadMask

Returns

:Object

applyTpl ( tpl )
private pri

Parameters

tpl :  Object

center Ext.Component
chainable ch

Center this floated or positioned Component in its parent.

Returns

:Ext.Component

this

changeItem ( itemIndex, recordIndex )
private pri

This method changes the record bound to the specified item.

Parameters

itemIndex :  Number

The index of the item in dataItems. Negative numbers are used to index backwards such that -1 is the last item.

recordIndex :  Number

The record's index in the store.

child ( [selector] ) : Ext.Component

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

Parameters

selector :  String/Ext.Component (optional)

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

Returns

:Ext.Component

The matching child Ext.Component (or null if no match was found).

clearListeners

Removes all listeners for this object including the managed listeners

clearManagedListeners

Removes all managed listeners for this object.

constructor ( config )

Creates new Component.

Parameters

config :  Object

The standard configuration object.

destroyPlugin ( plugin ) : Ext.plugin.Abstract

Removes and destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

doAdd ( item, instanced )
private pri

Parameters

item :  Ext.Component

instanced :  Boolean

when received.

doDestroy

Perform the actual destruction sequence. This is the method to override in your subclasses to add steps specific to the destruction of custom Component.

If the Component is currently added to a Container it will first be removed from that Container. All Ext.Element references are also deleted and the Component is de-registered from Ext.ComponentManager.

As a rule of thumb, subclasses should destroy their child Components, Elements, and/or other objects before calling parent method. Any object references will be nulled after this method has finished, to prevent the possibility of memory leaks.

Available since: 6.2.0

doInsert ( index, item, instanced )
private pri

Parameters

index :  Number

item :  Ext.Component

instanced :  Boolean

down ( [selector] ) : Ext.Component

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

Parameters

selector :  String/Ext.Component (optional)

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

Returns

:Ext.Component

The matching descendant Ext.Component (or null if no match was found).

enableBubble ( eventNames )

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

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

Example:

Ext.define('Ext.overrides.form.field.Base', {
    override: 'Ext.form.field.Base',

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

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

Parameters

eventNames :  String/String[]

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

ensureVisible ( [record], [options] )

Scrolls the specified record into view.

Parameters

record :  Number/Ext.data.Model (optional)

The record or the 0-based position to which to scroll. If this parameter is not passed, the options argument must be passed and contain either record or recordIndex.

options :  Object (optional)

An object containing options to modify the operation.

animation :  Boolean (optional)

Pass true to animate the row into view.

focus :  Boolean (optional)

Pass as true to focus the specified row.

highlight :  Boolean (optional)

Pass true to highlight the row with a glow animation when it is in view.

record :  Ext.data.Model (optional)

The record to which to scroll.

recordIndex :  Number (optional)

The 0-based position to which to scroll.

select :  Boolean (optional)

Pass as true to select the specified row.

ensureVisiblePlan ( [record], [plan] )
private pri

This method builds up a plan object with flags and a pop-off "steps" array of method names to be called in order to fullfil the passed options of an ensureVisible call.

Parameters

record :  Number/Ext.data.Model (optional)

The record or the 0-based position to which to scroll. If this parameter is not passed, the options argument must be passed and contain either record or recordIndex.

plan :  Object (optional)

An object containing options to modify the operation.

animation :  Boolean (optional)

Pass true to animate the row into view.

focus :  Boolean (optional)

Pass as true to focus the specified row.

highlight :  Boolean (optional)

Pass true to highlight the row with a glow animation when it is in view.

record :  Ext.data.Model (optional)

The record to which to scroll.

recordIndex :  Number (optional)

The 0-based position to which to scroll.

select :  Boolean (optional)

Pass as true to select the specified row.

factoryItem ( item ) : Ext.Component
protected pro

Called when an item is added to this container either during initialization of the cfg-items config, or when new items are {@link #method!add added), or inserted.

If the passed object is not an instanced component, it converts the passed object into an instanced child component.

It applies cfg-defaults applied for contained child items - that is items which are not positiond using left, top, bottom, right, centered or docked.

Derived classes can override this method to process context appropriate short-hands such as Toolbar and "->" to insert a spacer.

Parameters

item :  Mixed

The item being added. May be a raw config object or an instanced Component or some other short-hand understood by the container.

Returns

:Ext.Component

The component to be added.

findDefaultFocus

Finds the configured default focus item. See defaultFocus.

findPlugin ( type ) : Ext.plugin.Abstract

Retrieves plugin by its type alias. For example:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['listpaging', 'pullrefresh']
 });

 list.findPlugin('pullrefresh').setPullRefreshText('Pull to refresh...');

Note: See also getPlugin.

Available since: 6.2.0

Parameters

type :  String

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

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

fireEvent ( eventName, args ) : Boolean

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

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

Parameters

eventName :  String

The name of the event to fire.

args :  Object...

Variable number of parameters are passed to handlers.

Returns

:Boolean

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

fireEventArgs ( eventName, args ) : Boolean

Fires the specified event with the passed parameter list.

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

Parameters

eventName :  String

The name of the event to fire.

args :  Object[]

An array of parameters which are passed to handlers.

Returns

:Boolean

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

fireEventedAction ( eventName, args, fn, [scope], [fnArgs] )

Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow.

By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events.

Parameters

eventName :  String

The name of the event to fire.

args :  Array

Arguments to pass to handlers and to the action function.

fn :  Function/String

The action function.

scope :  Object (optional)

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

fnArgs :  Array/Boolean (optional)

Optional arguments for the action fn. If not given, the normal args will be used to call fn. If false is passed, the args are used but if the first argument is this instance it will be removed from the args passed to the action function.

focus ( [selectText] ) : Boolean

Try to focus this component.

If this component is disabled or otherwise not focusable, a close relation will be targeted for focus instead to keep focus localized for keyboard users.

Parameters

selectText :  Boolean/Number[] (optional)

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

Returns

:Boolean

true if focus target was found and focusing was attempted, false if no focusing attempt was made.

getAt ( index ) : Ext.Component

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.

getComponent ( component ) : Ext.Component

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

getData : Object[]

Sets the value of data

getDockedComponent ( component ) : Ext.Component/Boolean

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.

getDockedItems Array

Returns all the Ext.Component#docked items in this container.

Returns

:Array

The docked items of this container.

getFirstReferences
private pri

This method is in place on the instance during construction to ensure that any lookup or getReferences calls have the items initialized prior to the lookup.

getFocusEl Ext.dom.Element
protected pro

Returns the focus holder element associated with this Container. By default, this is the Container's focusEl element; however if defaultFocus is defined, the child component referenced by that property will be found and returned instead.

Returns

:Ext.dom.Element

the focus holding element.

getGrouped : Boolean

Sets the value of grouped

getGrouped : Boolean

Sets the value of grouped

getHtml : String / Ext.dom.Element / HTMLElement

Sets the value of html

getInherited ( [inner] ) : Object

This method returns an object containing the inherited properties for this instance.

Available since: 5.0.0

Parameters

inner :  Boolean (optional)

Pass true to return inheritedStateInner instead of the normal inheritedState object. This is only needed internally and should not be passed by user code.

Defaults to: false

Returns

:Object

The inheritedState object containing inherited properties.

getInheritedConfig ( property, [skipThis] ) : Mixed

This method returns the value of a config property that may be inherited from some ancestor.

In some cases, a config may be explicitly set on a component with the intent of only being presented to its children while that component should act upon the inherited value (see referenceHolder for example). In these cases the skipThis parameter should be specified as true.

Available since: 5.0.0

Parameters

property :  String

The name of the config property to return.

skipThis :  Boolean (optional)

Pass true if the property should be ignored if found on this instance. In other words, true means the property must be inherited and not explicitly set on this instance.

Defaults to: false

Returns

:Mixed

The value of the requested property.

getInnerCtHeight
private

Sets the value of innerCtHeight

getInnerItems Array

Returns all inner items of this container. inner means that the item is not docked or positioned.

Returns

:Array

The inner items of this container.

getInnerWidth
private

Sets the value of innerWidth

getItem ( record ) : Ext.dataview.component.(Simple)ListItem

Gets a list item by record.

Parameters

record :  Ext.data.Model

The record

Returns

:Ext.dataview.component.(Simple)ListItem

The list item, if found. null if no matching item exists.

getItemAt ( index ) : Ext.dom.Element/Ext.dataview.DataItem

Returns an item at the specified index.

Parameters

index :  Number

Index of the item.

Returns

:Ext.dom.Element/Ext.dataview.DataItem

item Item at the specified index.

getItemFromPagePoint ( x, y ) : Ext.dom.Element/Ext.Widget
private pri

Returns the item (an element or widget) at the given page coordinates.

Parameters

x :  Number

y :  Number

Returns

:Ext.dom.Element/Ext.Widget

getItemFromPoint ( x, y ) : Ext.dom.Element/Ext.Widget
private pri

Returns the item (an element or widget) at the given client coordinates.

Parameters

x :  Number

y :  Number

Returns

:Ext.dom.Element/Ext.Widget

getItemIndex ( item ) : Number

Returns an index for the specified item.

Parameters

item :  Number

The item to locate.

Returns

:Number

Index for the specified item.

getMaxHeightElement
private pri

In IE11 vertically flexed elements (such as container body-el or panel body-wrap-el) are not flexed properly when the container has a max-height, but no height. We can workaround the issue by wrapping the vertical box in a horizontal box. See EXTJS-24498

getModalSibling
private pri

Returns the topmost modal floated component (other then this one).

getNamedItems Object

Returns an object holding the descendants of this container keyed by their name. This object should not be held past the scope of the function calling this method. It will not be valid if items are added or removed from this or any sub-container.

The intended usage is shown here (assume there are 3 components with names of "foo", "bar" and "baz" at some level below this container):

 onClick: function () {
     var items = this.getNamedItems();

     // using "items" we can access any descendant by its "name"

     items.foo.getValue() + items.bar.getValue() + items.baz.getValue();
 }

If this component has a name assigned to it, it is not included in this object. That name is understood to belong to the ancestor container configured as the nameHolder.

Available since: 6.5.0

Returns

:Object

An object with each named child. This will be null if this container has no descendants with a name specified.

getParent Ext.Component

Returns the parent of this component, if it has one.

Returns

:Ext.Component

The parent of this component.

getPlugin ( id ) : Ext.plugin.Abstract

Retrieves a plugin by its id.

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: {
         xclass: 'Ext.plugin.PullRefresh',
         id: 'foo'
     }
 });

 list.getPlugin('foo').setPullRefreshText('Pull to refresh...');

Note: See also findPlugin.

Available since: 6.2.0

Parameters

id :  String

The id of the plugin.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

getPositionedItemTarget ( item ) : Ext.dom.Element
private pri

Similar to getRenderTarget but for positioned items.

Available since: 6.5.0

Parameters

item :  Ext.Component

The positioned item being added.

Returns

:Ext.dom.Element

getRefItems ( deep )
private pri

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

getReferences Object

Returns an object holding the descendants of this view keyed by their reference. This object should not be held past the scope of the function calling this method. It will not be valid if items are added or removed from this or any sub-container.

The intended usage is shown here (assume there are 3 components with reference values of "foo", "bar" and "baz" at some level below this container):

 onClick: function () {
     var refs = this.getReferences();

     // using "refs" we can access any descendant by its "reference"

     refs.foo.getValue() + refs.bar.getValue() + refs.baz.getValue();
 }

If this component has a reference assigned to it, that is not included in this object. That reference is understood to belong to the ancestor container configured as the referenceHolder.

Available since: 5.0.0

Returns

:Object

An object with each child reference. This will be null if this container has no descendants with a reference specified.

getRenderTarget Ext.dom.Element
private pri

Returns the element into which the html content and items should be rendered. This defaults to the bodyElement but derived classes can override this method to use a different element.

For containers his only applies to inner items, not docked items. The positioned items are rendered to the element returned by the {@link Ext.Container#getPositionedItemTarget method.

Available since: 6.5.0

Returns

:Ext.dom.Element

getScrollDockedItems Ext.Component[]

Returns all the items that are docked in the scroller in this list.

Returns

:Ext.Component[]

An array of the scrollDock items

getScrollableClientRegion Ext.util.Region
private pri

This method is required by the Scroller to return the scrollable client region

Returns

:Ext.util.Region

The scrolling viewport region.

getStateBuilder ( [cache] ) : Ext.state.Builder
private pri

Creates a state builder to access or edit this instance's state object. If this instance has a getStatefulOwner, the returned builder will have a parent reference that owner's state builder. This can be an arbitrarily deep chain but does proceed all the way up to the root instance (with no owner) since that is the instance that determines the ultimate state storage key.

Parameters

cache :  Boolean (optional)

Pass true to return a cached builder.

Defaults to: false

Returns

:Ext.state.Builder

getStatefulOwner Ext.state.Stateful/Array
private pri

This method allows a class to specify an owning stateful object. This is used by Ext.plugin.Abstract to save their state as part of their owning Ext.Component.

The return value can be either a Stateful object or an array whose first element is a Stateful object. This object's state will be stored inside the state object of the returned Stateful object. If an array is returned, the elements beyond the first are sub-keys in the state object.

For example, Ext.plugin.Abstract implement this method like so:

 getStatefulOwner: function() {
     return [ this.cmp, 'plugins' ];
 }

The effect of this is to produce a state object like so:

 {
     plugins: {
         pluginId1: {
             //...
         }
     }
 }

In order for a child object's state to be saved and restored, all of its parents must also be stateful (i.e., have a stateId).

Returns

:Ext.state.Stateful/Array

getStriped : Boolean

Sets the value of striped

getTabIndex Number

Return the actual tabIndex for this Focusable.

Returns

:Number

tabIndex attribute value

getTriggerCtEvent : 'tap' / 'singletap'

Sets the value of triggerCtEvent

getTriggerEvent : 'childtap' / 'childsingletap' / 'childdoubletap' / 'childswipe' / 'childtaphold' / 'childlongpress'

Sets the value of triggerEvent

getViewItems Ext.dom.Element[]/Ext.dataview.DataItem[]

Returns an array of the current items in the DataView.

Returns

:Ext.dom.Element[]/Ext.dataview.DataItem[]

Array of Items.

getVisibleHeight : Number
private

Sets the value of visibleHeight

getVisibleLeft
private

Sets the value of visibleLeft

getVisibleTop : Number
private

Sets the value of visibleTop

getVisibleWidth
private

Sets the value of visibleWidth

getXTypes String

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.

has ( item )
private pri

Parameters

item :  Object

hasInnerItem ( item )
private pri

Parameters

item :  Object

hasListener ( eventName ) : Boolean

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

Parameters

eventName :  String

The name of the event to check for

Returns

:Boolean

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

hasParent Boolean

Returns true if this component has a parent.

Returns

:Boolean

true if this component has a parent.

hide ( [animation] ) : Ext.Component
chainable ch

Hides this Component optionally using an animation.

Parameters

animation :  Object/Boolean (optional)

You can specify an animation here or a bool to use the hideAnimation config.

Returns

:Ext.Component

indexModifiedFields ( modified ) : String[]/Object
template tpl private pri

This method is called to convert the modified field names array received from the store when records are modified. Grids want to convert that array into an object keyed by modified name for efficient decisions about which cells need to be refreshed.

Available since: 6.5.1

Parameters

modified :  String[]

Returns

:String[]/Object

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

indexOf ( item )
private pri

Parameters

item :  Object

initDragConstraints ( draggable )
template tpl

This method is called when a drag is initializing. This method should adjust the drag constraints to ensure all drag movements are properly restricted. See Ext.drag.Source#constrain.

Available since: 6.5.0

Parameters

draggable :  Ext.drag.Source

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

initInheritedState ( inheritedState )
protected pro

Called by getInherited to initialize the inheritedState the first time it is requested.

Parameters

inheritedState :  Object

initialize
template tpl protected pro

Allows addition of behavior to the rendering phase.

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

insert ( index, item ) :
chainable ch

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

index :  Number

The index to insert the Component at.

item :  Object

The Component to insert.

Returns

:

insertAfter ( item, relativeToItem ) :
chainable ch private pri

Parameters

item :  Object

relativeToItem :  Object

Returns

:

insertBefore ( item, relativeToItem )
private pri

Parameters

item :  Object

relativeToItem :  Object

insertFirst ( item )
private pri

Parameters

item :  Object

insertInner ( item, index ) :
chainable ch private pri

Parameters

item :  Ext.Component

index :  Number

Returns

:

insertLast ( item )
private pri

Parameters

item :  Object

is Boolean
template tpl

Selector processing function for use by nextSibling,previousibling, nextNode,and previousNode, to filter candidate nodes.

The base implementation returns true. Classes which mix in Traversable may implement their own implementations. @link{Ext.Widget} does this to implement Ext.ComponentQuery based filterability.

Returns

:Boolean

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

isAncestor ( possibleDescendant )

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

Parameters

possibleDescendant :  Ext.Component

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

isCentered Boolean
private pri

Returns

:Boolean

isDescendantOf ( ancestor ) : Boolean

Determines whether this component is the descendant of a passed component.

Parameters

ancestor :  Ext.Component

A Component which may contain this Component.

Returns

:Boolean

true if the component is the descendant of the passed component, otherwise false.

isFocusable ( [deep] ) : Boolean

Determine if this Focusable can receive focus at this time.

Note that Containers can be non-focusable themselves while delegating focus treatment to a child Component; see Container for more information.

Parameters

deep :  Boolean (optional)

Optionally determine if the container itself is focusable, or if container's focus is delegated to a child component and that child is focusable.

Defaults to: false

Returns

:Boolean

True if component is focusable, false if not.

isRecordRendered ( recordIndex ) : Boolean

For infinite lists, not all records are represented in the DOM.

This method will return true if the passed record index or Ext.data.Model is represented in the DOM.

Parameters

recordIndex :  Number/Ext.data.Model

The Ext.data.Model or record index to test.

Returns

:Boolean

true if the record is rendered.

isSuspended ( [event] ) : Boolean

Checks if all events, or a specific event, is suspended.

Parameters

event :  String (optional)

The name of the specific event to check

Returns

:Boolean

true if events are suspended

itemAs ( item, as ) : Number/HTMLElement/Ext.dom.Element/Ext.Component
private pri

Parameters

item :  Ext.dom.Element/Ext.Component

The item from which to navigate.

as :  "cmp"/"dom"/"el"

Pass "dom" to always return an HTMLElement for the item. For component dataviews this is the component's main element. Pass "el" to return the Ext.dom.Element form of the item. For component dataviews this will be the component's main element. For other dataviews the returned instance is produced by Ext.fly() and should not be retained. Pass "cmp" to return the Ext.Component reference for the item (if one exists).

Returns

:Number/HTMLElement/Ext.dom.Element/Ext.Component

loadState ( state, stateful ) : Object
private pri

This method is called to load state from the provided state builder. This method should return the config properties loaded from state.

This method, like saveState, can be overridden by derived classes:

 loadState: function(state) {
     var ret = this.callParent([ state ]);

     if (ret.foo) {
         // use custom data...

         delete ret.foo;  // remove it since it isn't a config
     }

     return ret;
 }

When overriding this method, it is also likely necessary to override saveState.

Parameters

state :  Ext.state.Builder

stateful :  Object

The stateful properties as an object keyed by config name.

Returns

:Object

lookup ( ref ) : Ext.Component

Gets a reference to the component with the specified reference value.

The method is a short-hand for the lookupReference method.

Available since: 6.0.1

Parameters

ref :  String

The value of the reference to lookup.

Returns

:Ext.Component

The referenced component or null if it is not found.

lookupName ( name ) : Ext.Component

Gets a reference to the component with the specified name property.

Available since: 6.5.0

Parameters

name :  String

The name of the descendant to lookup.

Returns

:Ext.Component

The component or null if it is not found.

lookupReferences ( ref ) : Ext.Component

Gets a reference to the component with the specified reference value.

The lookup method is a short-hand version of this method.

Available since: 5.0

Parameters

ref :  String

The name of the reference to lookup.

Returns

:Ext.Component

The referenced component or null if it is not found.

mapToItem ( value, [as] ) : HTMLElement/Ext.dom.Element/Ext.Component

Converts the given indexOrRecord to an "item".

An "item" can be either an Ext.dom.Element or an Ext.Component depending on the type of dataview. For convenience the as parameter can be used to convert the returned item to a common type such as Ext.dom.Element or HTMLElement.

Be aware that the Ext.List subclass can optionally render only some records, in which case not all records will have an associated item in the view and this method will return null.

An index value is a view index. These will only match the record's index in the store when no extra items are added to this dataview (so called "non-record" items). These are often unaligned in Ext.List due to group headers as well as infinite mode where not all records are rendered into the view at one time.

Negative index values are treated as relative to the end such that -1 is the last item, -2 is the next-to-last and so on.

For example:

 // Add "foo" class to the last item in the view
 view.mapToItem(-1, 'el').addCls('foo');

 // Add "foo" class to the last data item in the view
 view.mapToItem(view.getStore().last(), 'el').addCls('foo');

To handle a record's index in the store:

 item = view.mapToItem(view.mapToViewIndex(storeIndex));

Available since: 6.5.0

Parameters

value :  Number/Ext.data.Model/Ext.event.Event

The event, view index or Ext.data.Model.

as :  "dom"/"el" (optional)

Pass "dom" to always return an HTMLElement for the item. For component dataviews this is the component's main element. Pass "el" to return the Ext.dom.Element form of the item. For component dataviews this will be the component's main element. For other dataviews the returned instance is produced by Ext.fly() and should not be retained.

Returns

:HTMLElement/Ext.dom.Element/Ext.Component

mapToRecord ( value ) : Ext.data.Model

Converts the given parameter to a Ext.data.Model. Not all items in a dataview correspond to records (such as group headers in Ext.List). In these cases null is returned.

An "item" can be simply an element or a component depending on the type of dataview.

An index value is a view index. These will only match the record's index in the store when no extra items are added to this dataview (so called "non-record" items). These are often unaligned in Ext.List due to group headers as well as infinite mode where not all records are rendered into the view at one time.

Negative index values are treated as relative to the end such that -1 is the last item, -2 is the next-to-last and so on.

Available since: 6.5.0

Parameters

value :  Ext.event.Event/Number/HTMLElement/Ext.dom.Element/Ext.Component

Returns

:Ext.data.Model

The associated record or null if there is none.

mapToRecordIndex ( value ) : Number

Converts the given parameter to the record's index in the store. Not all items in a dataview correspond to records (such as group headers in Ext.List). In these cases -1 is returned.

An "item" can be simply an element or a component depending on the type of dataview.

An input index value is a view index. These will only match the record's index in the store when no extra items are added to this dataview (so called "non-record" items). These are often unaligned in Ext.List due to group headers as well as infinite mode where not all records are rendered into the view at one time.

Negative index values are treated as relative to the end such that -1 is the last item, -2 is the next-to-last and so on.

Available since: 6.5.0

Parameters

value :  Ext.event.Event/Number/HTMLElement/Ext.dom.Element/Ext.Component/Ext.data.Model

Returns

:Number

The record's index in the store or -1 if not found.

mapToViewIndex ( value ) : Number

Converts the given parameter to the equivalent record index in the store.

In this method alone, the index parameter is a store index not a view index.

Be aware that the Ext.List subclass can optionally render only some records, in which case not all records will have an associated item in the view and this method will return -1.

Negative index values are treated as relative to the end such that -1 is the last record, -2 is the next-to-last and so on.

An "item" can be simply an element or a component depending on the type of dataview.

The view index will only match the record's index in the store when no extra items are added to this dataview (so called "non-record" items). These are often unaligned in Ext.List due to group headers as well as infinite mode where not all records are rendered into the view at one time.

Available since: 6.5.0

Parameters

value :  Ext.event.Event/Number/HTMLElement/Ext.dom.Element/Ext.Component/Ext.data.Model

Returns

:Number

The view index or -1 if not found.

mask ( mask )

Convenience method which calls setMasked with a value of true (to show the mask). For additional functionality, call the setMasked function direction (See the masked configuration documentation for more information).

Parameters

mask :  Object

mon ( item, ename, [fn], [scope], [options] ) : Object

Shorthand for addManagedListener. The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Ext.define('Foo', {
    extend: 'Ext.Component',

    initComponent: function () {
        this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
        this.callParent();
    }
});

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

Parameters

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

The item to which to add a listener/listeners.

ename :  Object/String

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

fn :  Function/String (optional)

If the ename parameter was an event name, this is the handler function or the name of a method on the specified scope.

scope :  Object (optional)

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

options :  Object (optional)

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

Returns

:Object

Only when the destroyable option is specified.

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

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

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

mun ( item, ename, [fn], [scope] )

Shorthand for removeManagedListener. Removes listeners that were added by the mon method.

Parameters

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

The item from which to remove a listener/listeners.

ename :  Object/String

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

fn :  Function (optional)

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

scope :  Object (optional)

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

nextItem ( item, [as] ) : Number/HTMLElement/Ext.dom.Element/Ext.Component

Returns the item following the passed item in the view. For infinite lists, this traversal can encounter unrendered records. In this case, the record index of the unrendered record is returned.

If as is specified, the item is converted to the desired form, if possible. If that conversion cannot be performed, null is returned.

Parameters

item :  Ext.dom.Element/Ext.Component

The item from which to navigate.

as :  "cmp"/"dom"/"el" (optional)

Pass "dom" to always return an HTMLElement for the item. For component dataviews this is the component's main element. Pass "el" to return the Ext.dom.Element form of the item. For component dataviews this will be the component's main element. For other dataviews the returned instance is produced by Ext.fly() and should not be retained. Pass "cmp" to return the Ext.Component reference for the item (if one exists).

Returns

:Number/HTMLElement/Ext.dom.Element/Ext.Component

nextNode ( [selector] ) : Ext.Component

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

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree to attempt to find a match. Contrast with nextSibling.

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the following nodes.

Returns

:Ext.Component

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

nextSibling ( [selector] ) : Ext.Component

Returns the next sibling of this Component.

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

May also be referred to as next()

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

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the following items.

Returns

:Ext.Component

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

on ( eventName, [fn], [scope], [options], [order] ) : Object

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, this);

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

myGridPanel.on({
    cellclick: this.onCellClick,
    select: this.onSelect,
    viewready: this.onViewReady,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellclick: {fn: this.onCellClick, scope: this, single: true},
    viewready: {fn: panel.onViewReady, scope: panel}
});

Names of methods in a specified scope may also be used:

myGridPanel.on({
    cellclick: {fn: 'onCellClick', scope: this, single: true},
    viewready: {fn: 'onViewReady', scope: panel}
});

Parameters

eventName :  String/Object

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

fn :  Function/String (optional)

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

scope :  Object (optional)

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

options :  Object (optional)

An object containing handler configuration.

Note: The options object will also be passed as the last argument to every event handler.

This object may contain any of the following properties:

scope :  Object

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

delay :  Number

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

single :  Boolean

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

buffer :  Number

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

onFrame :  Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

target :  Ext.util.Observable

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

element :  String

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

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

  var panel = new Ext.panel.Panel({
      title: 'The title',
      listeners: {
          click: this.handlePanelClick,
          element: 'body'
      }
  });

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

 panel.body.un(...)

delegate :  String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture :  Boolean (optional)

When set to true, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopPropagation on the event object before firing the handler.

preventDefault :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call preventDefault on the event object before firing the handler.

stopEvent :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopEvent on the event object before firing the handler.

args :  Array (optional)

Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.

destroyable :  Boolean (optional)

When specified as true, the function returns a destroyable object. An object which implements the destroy method which removes all listeners added in this call. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to:

false

priority :  Number (optional)

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

order :  String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the priority option instead. Available options are:

  • 'before': equal to a priority of 100
  • 'current': equal to a priority of 0 or default priority
  • 'after': equal to a priority of -100

Defaults to:

'current'

order :  String (optional)

A shortcut for the order event option. Provided for backward compatibility. Please use the priority event option instead.

Combining Options

Using the options argument, it is possible to combine different types of listeners:

A delayed, one-time listener.

myPanel.on('hide', this.handleClick, this, {
    single: true,
    delay: 100
});

Attaching multiple handlers in 1 call

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.

grid.on({
    itemclick: 'onItemClick',
    itemcontextmenu: grid.onItemContextmenu,
    destroy: {
        fn: function () {
            // function called within the 'altCmp' scope instead of grid
        },
        scope: altCmp // unique scope for the destroy handler
    },
    scope: grid       // default scope - provided for example clarity
});

Delegate

This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

var panel = Ext.create({
    xtype: 'panel',
    renderTo: document.body,
    title: 'Delegate Handler Example',
    frame: true,
    height: 220,
    width: 220,
    html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});

// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
    click: function (e) {
        console.log(e.getTarget().innerHTML);
    },
    element: 'body',
    delegate: 'h1.myTitle'
 });

Defaults to: 'current'

Returns

:Object

Only when the destroyable option is specified.

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

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

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

onAfter ( eventName, fn, [scope], [options] )

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.

onBefore ( eventName, fn, [scope], [options] )

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.

onFirstItemAdd ( item )
private pri

Initialize layout and event listeners the very first time an item is added

Parameters

item :  Object

onInitialized ( fn, scope, args )
private pri

Parameters

fn :  Object

scope :  Object

args :  Object

onItemAdd ( item, index )
private pri

Parameters

item :  Object

index :  Object

onItemMove ( item, toIndex, fromIndex )
private pri

Parameters

item :  Object

toIndex :  Object

fromIndex :  Object

onItemRemove ( item, index, destroying )
private pri

Parameters

item :  Object

index :  Object

destroying :  Object

onNavigate ( e )

This method is called by the navigationModel when navigation events are detected within this DataView.

It may be overridden to control the linkage of navigation events such as taps, clicks or keystrokes detected by the navigationModel to the selectionModel.

callParent if you wish selection to proceed from the passed event.

Parameters

e :  Ext.event.Event

The UI event which caused the navigation.

onRelease
private pri

Called by Ext.GlobalEvents#setPressedComponent when the global mouseup event fires and there's a registered pressed component.

onResize ( width, height, oldWidth, oldHeight )
template tpl protected pro

Optional template method. If implemented, this is called asynchronously after a browser layout caused by a component resize. This may be triggered for any or several of the following reasons:

Parameters

width :  Number

The new width.

height :  Number

The new height.

oldWidth :  Number

The previous width.

oldHeight :  Number

The previous height.

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

onScrollEnd ( x, y )
template tpl protected pro

Invoked when a scroll operation is completed via this component's scroller.

Parameters

x :  Number

The current x position

y :  Number

The current y position

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

onScrollMove ( x, y )
template tpl protected pro

Invoked when this component is scrolled via its scroller.

Parameters

x :  Number

The current x position

y :  Number

The current y position

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

onScrollStart ( x, y )
template tpl protected pro

Invoked when a scroll is initiated on this component via its scroller.

Parameters

x :  Number

The current x position

y :  Number

The current y position

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

onStatefulChange
private pri

This method is called when any of the stateful configs are modified.

persistState
private pri

Saves the state of this instance to the persistence store. This method is called by the Ext.state.Provider when it is ready to save state to storage.

prepareData ( data, index, record ) : Array/Object

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

:Array/Object

The formatted data in a format expected by the internal template's overwrite() method. (either an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'}))

preprocessShow ( component, alignment, options )
private pri

This is the private method to ensure everything is set up for showing. This is called by both show and showBy to set a component up. the user-facing method is beforeShow, this setup must have happened by the time that is called.

Parameters

component :  Object

alignment :  Object

options :  Object

previousItem ( item, [as] ) : Number/HTMLElement/Ext.dom.Element/Ext.Component

Returns the item preceding the passed item in the view. For infinite lists, this traversal can encounter unrendered records. In this case, the record index of the unrendered record is returned.

If as is specified, the item is converted to the desired form, if possible. If that conversion cannot be performed, null is returned.

Parameters

item :  Ext.dom.Element/Ext.Component

The item from which to navigate.

as :  "cmp"/"dom"/"el" (optional)

Pass "dom" to always return an HTMLElement for the item. For component dataviews this is the component's main element. Pass "el" to return the Ext.dom.Element form of the item. For component dataviews this will be the component's main element. For other dataviews the returned instance is produced by Ext.fly() and should not be retained. Pass "cmp" to return the Ext.Component reference for the item (if one exists).

Returns

:Number/HTMLElement/Ext.dom.Element/Ext.Component

previousNode ( [selector] ) : Ext.Component

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

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree in reverse order to attempt to find a match. Contrast with previousSibling.

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the preceding nodes.

Returns

:Ext.Component

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

previousSibling ( [selector] ) : Ext.Component

Returns the previous sibling of this Component.

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

May also be referred to as prev()

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

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the preceding items.

Returns

:Ext.Component

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

query ( [selector] ) : Ext.Component[]

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

Parameters

selector :  String (optional)

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

Returns

:Ext.Component[]

Components which matched the selector

queryBy ( fn, [scope] ) : Ext.Component[]

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

Parameters

fn :  Function

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

scope :  Object (optional)

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

Returns

:Ext.Component[]

Components matched by the passed function

queryById ( id ) : Ext.Component

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

Parameters

id :  String

The id to find

Returns

:Ext.Component

The matching id, null if not found

readStateObject Object
private pri

Returns this instance's state object from the persistence store. This object should contain config properties.

Returns

:Object

refresh

Refreshes the view by reloading the data from the store and re-rendering the template.

relayEvents ( origin, events, [prefix] ) : Object

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

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

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

The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).

Parameters

origin :  Object

The Observable whose events this object is to relay.

events :  String[]/Object

Array of event names to relay or an Object with key/value pairs translating to ActualEventName/NewEventName respectively. For example: this.relayEvents(this, {add:'push', remove:'pop'});

Would now redispatch the add event of this as a push event and the remove event as a pop event.

prefix :  String (optional)

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

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

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

Returns

:Object

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

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

Can be undone by calling

Ext.destroy(this.storeRelayers);

or this.store.relayers.destroy();

remove ( which, [destroy] ) : Ext.Component

Removes an item from this Container, optionally destroying it.

Parameters

which :  Ext.Component/String/Number/Array

The component instance, id or index to remove or an array of these.

destroy :  Boolean (optional)

true to automatically call Component's destroy method.

Returns

:Ext.Component

The Component that was removed.

removeAll ( [destroy], [everything] ) : Ext.Component[]

Removes all items currently in the Container, optionally destroying them all.

Parameters

destroy :  Boolean (optional)

Pass true to destroy each removed Component. Defaults to autoDestroy.

everything :  Boolean (optional)

Pass true to completely remove all items including docked, floated and positioned items.

Returns

:Ext.Component[]

The removed components

removeAt ( index, [destroy] ) : Ext.Component

Removes the Component at the specified index:

myContainer.removeAt(0); // removes the first item

Parameters

index :  Number

The index of the Component to remove.

destroy :  Boolean (optional)

true to automatically call Component's destroy method.

Returns

:Ext.Component

The removed Component

removeInner ( item ) :
chainable ch private pri

Parameters

item :  Ext.Component

Returns

:

removeInnerAt ( index ) : Ext.Component

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

The removed Component

removeListener ( eventName, fn, [scope] )

Removes an event handler.

Parameters

eventName :  String

The type of event the handler was associated with.

fn :  Function

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

scope :  Object (optional)

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

Convenience Syntax

You can use the addListener destroyable: true config option in place of calling un(). For example:

var listeners = cmp.on({
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide,
    destroyable: true
});

// Remove listeners
listeners.destroy();
// or
cmp.un(
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide
);

Exception - DOM event handlers using the element config option

You must go directly through the element to detach an event handler attached using the addListener element option.

panel.on({
    element: 'body',
    click: 'onBodyCLick'
});

panel.body.un({
    click: 'onBodyCLick'
});

removeManagedListener ( item, ename, [fn], [scope] )

Removes listeners that were added by the mon method.

Parameters

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

The item from which to remove a listener/listeners.

ename :  Object/String

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

fn :  Function (optional)

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

scope :  Object (optional)

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

removePlugin ( plugin, [destroy] ) : Ext.plugin.Abstract

Removes and (optionally) destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

destroy :  Boolean (optional)

Pass true to not call destroy() on the plugin.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

reorderItem ( item, ref, [offset] )
private pri

Moves the given item to be before the ref item or index. For infinite lists this does not impact the DOM childNodes unless maintainChildNodes is specified. In this case the reordering only impacts this container's items and innerItems collections.

Maintaining the order of dataItems is a separate concern.

Parameters

item :  Ext.Component

The item to reorder.

ref :  Number/Ext.Component

The item before which item will be placed or the index in innerItems where item will be inserted.

offset :  Number (optional)

An optional adjustment to add to ref. Pass 1 to insert item after ref.

Defaults to: 0

resetFloating
deprecated dep

Resets top, right, bottom and left configurations to null, which will cause this component to stop being 'positioned' and to take its place in its owning container's layout.

Deprecated since version 6.2
Use resetPositioned instead.

resetPositioned

Resets top, right, bottom and left configurations to null, which will cause this component to stop being 'positioned' and to take its place in its owning container's layout.

resumeEvent ( eventName )

Resumes firing of the named event(s).

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

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

Parameters

eventName :  String...

Multiple event names to resume.

resumeEvents ( [discardQueue] )

Resumes firing events (see suspendEvents).

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

Parameters

discardQueue :  Boolean (optional)

true to prevent any previously queued events from firing while we were suspended. See suspendEvents.

saveFocusState Function
private pri

Called prior to an operation which mey remove focus from this view by some kind of DOM operation.

If this view contains focus, this method returns a function which, when called after the disruptive DOM operation will restore focus to the same record, or, if the record has been removed to the same item index..

Returns

:Function

A function that will restore focus if focus was within this view, or a function which does nothing is focus is not in this view.

saveState ( state, stateful )
private pri

Saves the current state of this object to the provided state builder. By default this method saves the configs specified as stateful.

This method can also be overridden by subclasses to store custom data directly to the state builder:

 saveState: function(state) {
     this.callParent([ state ]);

     state.set('foo', 42);
 }

When overriding this method, it is also likely necessary to override loadState.

Parameters

state :  Ext.state.Builder

The state builder to which to save state.

stateful :  Object

The stateful properties as an object keyed by config name.

scrollToRecord ( record, [animation] )

Scrolls the list so that the specified record is at the top.

Parameters

record :  Ext.data.Model

Record in the store to scroll to.

animation :  Boolean (optional)

Determines if scrolling is animated.

Defaults to: false

scrollToRecord ( record, [animate], [overscroll] )

Scrolls the list so that the specified record is at the top. <-- NO. Scroll into view. === TODO: fix scrollTo API

Parameters

record :  Ext.data.Model

Record in the store to scroll to.

animate :  Boolean (optional)

Determines if scrolling is animated.

Defaults to: false

overscroll :  Boolean (optional)

Determines if list can be overscrolled.

Defaults to: true

setActiveItem ( activeItem )

Returns the value of activeItem

setAriaAttributes ( ariaAttributes )

Returns the value of ariaAttributes

setAssociatedData ( associatedData )

Returns the value of associatedData

setAutoDestroy ( autoDestroy )

Returns the value of autoDestroy

setAutoSize ( autoSize )

Returns the value of autoSize

setAxisLock ( axisLock )

Returns the value of axisLock

setBorder ( border )

Returns the value of border

setBottom ( bottom )

Returns the value of bottom

setBufferSize ( bufferSize )

Returns the value of bufferSize

setBufferSize ( bufferSize )

Returns the value of bufferSize

setCentered ( centered )

Returns the value of centered

setCls ( cls )

Returns the value of cls

setContainer ( container )

Returns the value of container

setContentEl ( contentEl )

Returns the value of contentEl

setControl ( control )

Returns the value of control

setData ( data )

Returns the value of data

setDefaultFocus ( defaultFocus )

Returns the value of defaultFocus

setDefaultType ( defaultType )

Returns the value of defaultType

setDefaults ( defaults )

Returns the value of defaults

setDeferEmptyText ( deferEmptyText )

Returns the value of deferEmptyText

setDisableSelection ( disableSelection )

Returns the value of disableSelection

setDisabled ( disabled )

Returns the value of disabled

setDisclosureProperty ( disclosureProperty )

Returns the value of disclosureProperty

setDisclosureProperty ( disclosureProperty )

Returns the value of disclosureProperty

setDisplayed ( displayed )

Returns the value of displayed

setDocked ( docked )

Returns the value of docked

setDraggable ( draggable )

Returns the value of draggable

setEmptyItemText ( emptyItemText )

Returns the value of emptyItemText

setEmptyState ( emptyState )
private

Returns the value of emptyState

setEmptyText ( emptyText )

Returns the value of emptyText

setEmptyTextDefaults ( emptyTextDefaults )

Returns the value of emptyTextDefaults

setEnableTextSelection ( enableTextSelection )

Returns the value of enableTextSelection

setEnterAnimation ( enterAnimation )

Returns the value of enterAnimation

setExitAnimation ( exitAnimation )

Returns the value of exitAnimation

setGroupFooter ( groupFooter )

Returns the value of groupFooter

setGroupHeader ( groupHeader )

Returns the value of groupHeader

setGroupHeaderTpl ( groupHeaderTpl )

Returns the value of groupHeaderTpl

setGrouped ( grouped )

Returns the value of grouped

setGrouped ( grouped )

Returns the value of grouped

setHeight ( height )

Returns the value of height

setHidden ( hidden )

Returns the value of hidden

setHideAnimation ( hideAnimation )

Returns the value of hideAnimation

setHideOnMaskTap ( hideOnMaskTap )

Returns the value of hideOnMaskTap

setHorizontalOverflow ( horizontalOverflow )
private

Returns the value of horizontalOverflow

setHtml ( html )

Returns the value of html

setIndexBar ( indexBar )

Returns the value of indexBar

setIndexBar ( indexBar )

Returns the value of indexBar

setInfinite ( infinite )

Returns the value of infinite

setInfinite ( infinite )

Returns the value of infinite

setInline ( inline )

Returns the value of inline

setInnerCls ( innerCls )

Returns the value of innerCls

setInnerCtHeight ( innerCtHeight )
private

Returns the value of innerCtHeight

setInnerWidth ( innerWidth )
private

Returns the value of innerWidth

setItemButtonMode ( itemButtonMode )

Returns the value of itemButtonMode

setItemCls ( itemCls )

Returns the value of itemCls

setItemConfig ( itemConfig )

Returns the value of itemConfig

setItemContentCls ( itemContentCls )

Returns the value of itemContentCls

setItemDataMap ( itemDataMap )

Returns the value of itemDataMap

setItemHeight ( itemHeight )

Returns the value of itemHeight

setItemInnerCls ( itemInnerCls )

Returns the value of itemInnerCls

setItemRipple ( itemRipple )

Returns the value of itemRipple

setItemTpl ( itemTpl )

Returns the value of itemTpl

setItems ( items )

Returns the value of items

setItemsFocusable ( itemsFocusable )
private

Returns the value of itemsFocusable

setKeyMap ( keyMap )

Returns the value of keyMap

setKeyMapEnabled ( keyMapEnabled )

Returns the value of keyMapEnabled

setLayout ( layout )

Returns the value of layout

setLeft ( left )

Returns the value of left

setListeners ( listeners )

An alias for addListener. In versions prior to 5.1, listeners had a generated setter which could be called to add listeners. In 5.1 the listeners config is not processed using the config system and has no generated setter, so this method is provided for backward compatibility. The preferred way of adding listeners is to use the on method.

Parameters

listeners :  Object

The listeners

setLoadingHeight ( loadingHeight )

Returns the value of loadingHeight

setLoadingText ( loadingText )

Returns the value of loadingText

setMargin ( margin )

Returns the value of margin

setMarkDirty ( markDirty )

Returns the value of markDirty

setMasked ( masked )

Returns the value of masked

setMaxHeight ( maxHeight )

Returns the value of maxHeight

setMaxItemCache ( maxItemCache )

Returns the value of maxItemCache

setMaxWidth ( maxWidth )

Returns the value of maxWidth

setMinHeight ( minHeight )

Returns the value of minHeight

setMinWidth ( minWidth )

Returns the value of minWidth

setMinimumBufferDistance ( minimumBufferDistance )

Returns the value of minimumBufferDistance

setModal ( modal )

Returns the value of modal

setOnItemDisclosure ( onItemDisclosure )

Returns the value of onItemDisclosure

setOnItemDisclosure ( onItemDisclosure )

Returns the value of onItemDisclosure

setPadding ( padding )

Returns the value of padding

setPinFooters ( pinFooters )

Returns the value of pinFooters

setPinHeaders ( pinHeaders )

Returns the value of pinHeaders

setPinHeaders ( pinHeaders )

Returns the value of pinHeaders

setPinnedFooter ( pinnedFooter )

Returns the value of pinnedFooter

setPinnedFooterHeight ( pinnedFooterHeight )
private

Returns the value of pinnedFooterHeight

setPinnedHeader ( pinnedHeader )

Returns the value of pinnedHeader

setPinnedHeaderHeight ( pinnedHeaderHeight )
private

Returns the value of pinnedHeaderHeight

setPlugins ( plugins )

Returns the value of plugins

setPressedDelay ( pressedDelay )

Returns the value of pressedDelay

setPreventSelectionOnDisclose ( preventSelectionOnDisclose )

Returns the value of preventSelectionOnDisclose

setPreventSelectionOnDisclose ( preventSelectionOnDisclose )

Returns the value of preventSelectionOnDisclose

setPreventSelectionOnTool ( preventSelectionOnTool )

Returns the value of preventSelectionOnTool

setRecord ( record )

Returns the value of record

setRefreshHeightOnUpdate ( refreshHeightOnUpdate )

Returns the value of refreshHeightOnUpdate

setRight ( right )

Returns the value of right

setRowLines ( rowLines )

Returns the value of rowLines

setRowLines ( rowLines )

Returns the value of rowLines

setScrollDock ( scrollDock )

Returns the value of scrollDock

setScrollToTopOnRefresh ( scrollToTopOnRefresh )

Returns the value of scrollToTopOnRefresh

setScrollable ( scrollable )

Returns the value of scrollable

setSelectable ( selectable )

Returns the value of selectable

setShowAnimation ( showAnimation )

Returns the value of showAnimation

setStateId ( stateId )

Returns the value of stateId

setStateful ( stateful )

Returns the value of stateful

setStatefulDefaults ( statefulDefaults )
protected

Returns the value of statefulDefaults

setStore ( store )

Returns the value of store

setStriped ( striped )

Returns the value of striped

setStyle ( style )

Returns the value of style

setTabIndex ( newTabIndex )

Set the tabIndex property for this Focusable. If the focusEl is available, set tabIndex attribute on it, too.

Parameters

newTabIndex :  Number

new tabIndex to set

setTooltip ( tooltip )

Returns the value of tooltip

setTop ( top )

Returns the value of top

setTopRenderedIndex ( topRenderedIndex )
private

Returns the value of topRenderedIndex

setTpl ( tpl )

Returns the value of tpl

setTplWriteMode ( tplWriteMode )

Returns the value of tplWriteMode

setTriggerCtEvent ( triggerCtEvent )

Returns the value of triggerCtEvent

setTriggerEvent ( triggerEvent )

Returns the value of triggerEvent

setUseSimpleItems ( useSimpleItems )

Returns the value of useSimpleItems

setUseSimpleItems ( useSimpleItems )

Returns the value of useSimpleItems

setUserSelectable ( userSelectable )

Returns the value of userSelectable

setVariableHeights ( variableHeights )

Returns the value of variableHeights

setVerticalOverflow ( verticalOverflow )
private

Returns the value of verticalOverflow

setVisibility ( isVisible )
private pri

Parameters

isVisible :  Object

setVisibleHeight ( visibleHeight )
private

Returns the value of visibleHeight

setVisibleLeft ( visibleLeft )
private

Returns the value of visibleLeft

setVisibleTop ( visibleTop )
private

Returns the value of visibleTop

setVisibleWidth ( visibleWidth )
private

Returns the value of visibleWidth

setWeight ( weight )

Returns the value of weight

setWidth ( width )

Returns the value of width

setXY ( x, y, animation )
private pri

This method has the same arguments as element's setXY method, but is used to maintain the x and y configs (for floated components) or the left and top config for positioned components.

Available since: 6.5.0

Parameters

x :  Object

y :  Object

animation :  Object

setZIndex ( zIndex )

Returns the value of zIndex

show ( [animation] ) : Ext.Component
chainable ch

Shows this component optionally using an animation.

Parameters

animation :  Object/Boolean (optional)

You can specify an animation here or a bool to use the showAnimation config.

Returns

:Ext.Component

showAt ( x, [y] ) : Ext.Component
chainable ch

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

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

Parameters

x :  Number/Number[]/Object

The new x position or array of [x,y], or an object {x:10, y:10}.

y :  Number (optional)

The new y position.

Returns

:Ext.Component

this

showBy ( component, [alignment], [options] )

Shows this component by another component. If you specify no alignment, it will automatically position this component relative to the reference component depending upon the alignment parameter.

The alignment parameter describes the edge-to-edge alignment of this component with the target. It can be specified thus:

  • Blank: Defaults to positioning where the component will fit trying 'l-r?', 'r-l?', 'b-t?' then 't-b?' in that order.
  • Two anchors: If two values from the table below are passed separated by a dash, the first value is used as the element's anchor point, and the second value is used as the target's anchor point.
  • Two edge/offset descriptors: An edge/offset descriptor is an edge initial (t/r/b/l) followed by a percentage along that side. This describes a point to align with a similar point in the target. So 't0-b0' would be the same as 'tl-bl', 'l0-r50' would place the top left corner of this item halfway down the right edge of the target item. This allows more flexibility and also describes which two edges are considered adjacent when positioning a tip pointer.

Following are all of the supported predefined anchor positions:

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

You can put a '?' at the end of the alignment string to constrain the positioned element to the Ext.Viewport. The element will attempt to align as specified, but the position will be adjusted to constrain to the viewport if necessary. Note that the element being aligned might be swapped to align to a different position than that specified in order to enforce the viewport constraints.

Example Usage:

// 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");

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

// align the 25% point on the bottom edge of this panel
// with the 75% point on the top edge of button.
panel.showBy(button, 'b25-t75');

Parameters

component :  Ext.Component

The target component to show this component by.

alignment :  String (optional)

The alignment string, eg: 'tl-bl'.

options :  Object/Array (optional)

An object containing options for the Ext.util.Region#alignTo method, if an Array is used, it will be assumed to be the offset.

suspendEvent ( eventName )

Suspends firing of the named event(s).

After calling this method to suspend events, the events will no longer fire when requested to fire.

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

Parameters

eventName :  String...

Multiple event names to suspend.

suspendEvents ( queueSuspended )

Suspends the firing of all events. (see resumeEvents)

Parameters

queueSuspended :  Boolean

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

transformStatefulConfig ( instanceConfig, configurator ) : Object
private pri

This method is called internally by initConfig to apply whatever changes are needed from persistent storage.

Parameters

instanceConfig :  Object

The base config object

configurator :  Ext.Configurator

Returns

:Object

The config object to use.

un ( eventName, fn, [scope] )

Shorthand for removeListener. Removes an event handler.

Parameters

eventName :  String

The type of event the handler was associated with.

fn :  Function

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

scope :  Object (optional)

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

Convenience Syntax

You can use the addListener destroyable: true config option in place of calling un(). For example:

var listeners = cmp.on({
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide,
    destroyable: true
});

// Remove listeners
listeners.destroy();
// or
cmp.un(
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide
);

Exception - DOM event handlers using the element config option

You must go directly through the element to detach an event handler attached using the addListener element option.

panel.on({
    element: 'body',
    click: 'onBodyCLick'
});

panel.body.un({
    click: 'onBodyCLick'
});

unAfter ( eventName, fn, [scope], [options] )

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.

unBefore ( eventName, fn, [scope], [options] )

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.

unmask

Convenience method which calls setMasked with a value of false (to hide the mask). For additional functionality, call the setMasked function direction (See the masked configuration documentation for more information).

up ( [selector], [limit] ) : Ext.Container

Walks up the ownership hierarchy looking for an ancestor Component which matches the passed simple selector.

Example:

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

Parameters

selector :  String (optional)

The simple selector to test.

limit :  String/Number/Ext.Component (optional)

This may be a selector upon which to stop the upward scan, or a limit of the number of steps, or Component reference to stop on.

Returns

:Ext.Container

The matching ancestor Container (or undefined if no match was found).

updateData ( newData )
private pri

Parameters

newData :  Object

visitPostOrder ( selector, fn, [scope], [extraArgs] )

Traverses the tree rooted at this node in post-order mode, calling the passed function on the nodes at each level. That is the function is called upon each node after being called on its children).

This method is used at each level down the cascade. Currently Ext.Components and Ext.data.TreeModels are queryable.

If you have tree-structured data, you can make your nodes queryable, and use ComponentQuery on them.

Parameters

selector :  Object

A ComponentQuery selector used to filter candidate nodes before calling the function. An empty string matches any node.

fn :  Function

The function to call. Return false to aborl the traverse.

node :  Object

The node being visited.

scope :  Object (optional)

The context (this reference) in which the function is executed.

extraArgs :  Array (optional)

A set of arguments to be appended to the function's argument list to pass down extra data known to the caller after the node being visited.

visitPreOrder ( selector, fn, [scope], [extraArgs] )

Traverses the tree rooted at this node in pre-order mode, calling the passed function on the nodes at each level. That is the function is called upon each node before being called on its children).

This method is used at each level down the cascade. Currently Ext.Components and Ext.data.TreeModels are queryable.

If you have tree-structured data, you can make your nodes queryable, and use ComponentQuery on them.

Parameters

selector :  Object

A ComponentQuery selector used to filter candidate nodes before calling the function. An empty string matches any node.

fn :  Function

The function to call. Return false to aborl the traverse.

node :  Object

The node being visited.

scope :  Object (optional)

The context (this reference) in which the function is executed.

extraArgs :  Array (optional)

A set of arguments to be appended to the function's argument list to pass down extra data known to the caller after the node being visited.

whenVisible ( fn, [args] ) : Boolean
private pri

Queue a function to run when the component is visible & painted. If those conditions are met, the function will execute immediately, otherwise it will wait until it is visibl