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.
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.
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.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
ExtReact component classes display
configuration options as props
ExtReact component classes do not list
properties as a dedicated member type, but rather as
read only props
static label next to the
method name. *See Static below.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).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)Ext.Component in this case). This may be omitted for methods that do not
return anything other than undefined or may display as multiple possible values
separated by a forward slash / signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false if unsuccessful which would be displayed as
Ext.Component/Boolean).PROTECTED in
this example - see the Flags section below)Ext.container.Container in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)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.
All ExtReact props are bindable
unless decorated as immutable
Immutable ExtReact props may not be use as a configurable prop when instantiating a component
classInstance.method1().method2().etc();false is returned from
an event handler- 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
- 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
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.
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
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.
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.
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:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.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.
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:
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.
Ext.Mixin
Ext.mixin.Accessible
Ext.mixin.Bindable
Ext.mixin.ComponentDelegation
Ext.mixin.ConfigProxy
Ext.mixin.Container
Ext.mixin.Factoryable
Ext.mixin.Focusable
Ext.mixin.FocusableContainer
Ext.mixin.Identifiable
Ext.mixin.Inheritable
Ext.mixin.ItemRippler
Ext.mixin.Keyboard
Ext.mixin.Observable
Ext.mixin.Pluggable
Ext.mixin.Queryable
Ext.mixin.Traversable
Ext.state.Stateful
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
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.
DOM tabIndex attribute to set on the active Focusable child of this container when using the "Roaming tabindex" technique.
Defaults to:
0
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
Returns the value of activeItem
Ext.Component / Object / String / Number
Sets the value of activeItem
activeItem : Ext.Component / Object / String / Number
Set this to true
to enable focusing disabled child items via keyboard.
Defaults to:
false
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.
Defaults to:
null
Sets the value of ariaAttributes
ariaAttributes : Object
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.
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.
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.
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
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
If true, child items will be destroyed as soon as they are
removed from this container.
Defaults to:
true
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
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
Setting this config option adds or removes data bindings for other configs.
For example, to bind the title config:
var panel = Ext.create({
xtype: 'panel',
bind: {
title: 'Hello {user.name}'
}
});
To dynamically add bindings:
panel.setBind({
title: 'Greetings {user.name}!'
});
To remove bindings:
panel.setBind({
title: null
});
The bind expressions are presented to Ext.app.ViewModel#bind. The
ViewModel instance is determined by lookupViewModel.
Note: If bind is passed as a string, it will use the Ext.Component#property-defaultBindProperty for the binding.
Defaults to:
null
The CSS class to add to this container's body element.
Defaults to:
null
Available since: 7.0
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
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
Animation to be used during transitions of cards.
This method has been REMOVED since 2.0.0
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
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
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
Returns the value of contentEl
Ext.dom.Element / HTMLElement / String
Sets the value of contentEl
contentEl : Ext.dom.Element / HTMLElement / String
Enables you to easily control Components inside this Container by listening to their events and taking some action. For example, if we had a container with a nested Disable button, and we wanted to hide the Container when the Disable button is tapped, we could do this:
We used a Ext.ComponentQuery selector to listen to the tap
event on any Button anywhere inside the Container that has the
text 'Disable'. Whenever a Component matching that selector
fires the tap event our hideMe function is called. hideMe is called with scope:
this (e.g. this is the Container instance).
Defaults to:
null
A string alias, a configuration object or an instance of a ViewController for
this container. Sample usage:
Ext.define('MyApp.UserController', {
alias: 'controller.user'
});
Ext.define('UserContainer', {
extend: 'Ext.container.container',
controller: 'user'
});
// Or
Ext.define('UserContainer', {
extend: 'Ext.container.container',
controller: {
type: 'user',
someConfig: true
}
});
// Can also instance at runtime
var ctrl = new MyApp.UserController();
var view = new UserContainer({
controller: ctrl
});
Defaults to:
null
Returns the Ext.app.ViewController instance associated with this component via the controller config or setController method.
Returns this component's ViewController or null if one was not configured
The initial set of data to apply to the tpl to
update the content area of the Component.
Defaults to:
null
The initial set of data to apply to the tpl to
update the content area of the Component.
Defaults to:
null
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
If true, this component will be the default scope (this pointer) for events
specified with string names so that the scope can be dynamically resolved. The
component will automatically become the defaultListenerScope if a
controller is specified.
See the introductory docs for Ext.container.Container for some sample usages.
NOTE: This value can only be reliably set at construction time. Setting it after that time may not correctly rewire all of the potentially effected listeners.
Defaults to:
false
Sets the value of defaultListenerScope
defaultListenerScope : Boolean
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
The default Ext.Component of child Components to create in this Container when a child item is specified as a raw configuration object, rather than as an instantiated Component.
Defaults to:
container
Set to false to not defer emptyText being applied until the store's first
load.
Defaults to:
true
Sets the value of deferEmptyText
deferEmptyText : Boolean
Set to false to not defer emptyText being applied until the store's first
load.
Defaults to:
true
When set to true, tapping on the DataView's background (i.e. not on an item in the DataView) will deselect any currently selected items.
Defaults to:
true
Sets the value of deselectOnContainerClick
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
Set to true to disable selection styling. This only affects the presentation
of the selection not the internal selection state.
Defaults to:
false
Sets the value of disableSelection
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
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
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
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
Sets the value of draggable
draggable : Boolean / Object / Ext.drag.Source
The text to render when the rendering of the item via itemTpl produces no
text.
Defaults to:
'\xa0'
The text to render when the rendering of the item via itemTpl produces no text.
Defaults to:
'\xA0'
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
The text to display in the view when there is no data to display.
Set this to true to display the default message.
This component config object is used to create the emptyText component.
Defaults to:
{
xtype: 'emptytext'
}
Available since: 6.5.0
Sets the value of emptyTextDefaults
emptyTextDefaults : Object / Ext.Component
This component config object is used to create the emptyText component.
Available since: 6.5.0
The config to set on the emptyText component to contain the desired text.
Defaults to:
'html'
Available since: 6.5.0
The config to set on the emptyText component to contain the desired text.
Defaults to:
"html"
Available since: 6.5.0
True to enable text selection inside this view.
Defaults to:
null
Deprecated since version 6.5.1
Use Ext.Component#userSelectable instead.
Sets the value of enableTextSelection
enableTextSelection : Boolean
True to enable text selection inside this view.
Defaults to:
false
Sets the value of enableTextSelection
enableTextSelection : Boolean
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.
Sets the value of enterAnimation
enterAnimation : String / Mixed
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'.
Sets the value of exitAnimation
exitAnimation : String / Mixed
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
CSS class that will be added to focused component's focusClsEl, and removed when component blurs.
Defaults to:
'x-focused'
Force the component to take up 100% width and height available, by adding it to Ext.Viewport.
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
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
Sets the value of hideAnimation
hideAnimation : String / Mixed
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
Optional HTML content to render inside this Component, or a reference to an existing element on the page.
Defaults to:
null
Returns the value of html
String / Ext.dom.Element / HTMLElement
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
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
When set to true the items within the DataView will have their display set to
inline-block and be arranged horizontally. By default the items will wrap to
the width of the DataView. Passing an object with { wrap: false } will turn
off this wrapping behavior and overflowed items will need to be scrolled to
horizontally.
A 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
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
Sets the value of itemButtonMode
itemButtonMode : Boolean
Defaults to:
null
Available since: 6.5.0
color : String
The background color of the ripple. Default ripple Ext.Widget#ripple settings for each item in the data view
For complex items, individual elements can suppress ripples by adding the
x-no-ripple class to disable rippling for a tree of elements.
The child items to add to this Container. This is usually an array of Component configurations or instances, for example:
This may also be specified as an object, the property names of which are itemIds, and
the property values are child Component config objects, for example:
Defaults to:
null
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
Sets the value of itemsFocusable
itemsFocusable : Boolean
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
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 selectionx-item-no-tap - Disables all click or tap processingFor 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>'
Sets the value of itemTpl
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 selectionx-item-no-tap - Disables all click or tap processingFor 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>
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.
Defaults to:
null
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.
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
The name of the member that should be used to listen for keydown/keypress events. This is intended to be controlled at the class level not per instance.
Defaults to:
'el'
Configuration for this Container's layout. Example:
Defaults to:
'auto'
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
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'); }
}
}
});
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.
listeners : Object
The listeners
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
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.
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.
Note: For virtual stores, the load mask will be shown frequently as the user scrolls. To inhibit that, set loadingText to the empty string.
Defaults to:
'Loading...'
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...'
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
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
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
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
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
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
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
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
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
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
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
Set to true for this component's name property to be tracked by its containing
nameHolder.
Defaults to:
false
When true child components are tracked by their name property and can be
retrieved using the lookupName method.
Defaults to:
false
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
This config describes one or more plugin config objects used to create plugin instances for this component.
Plugins are a way to bundle and reuse custom functionality. Plugins should extend
Ext.plugin.Abstract but technically the only requirement for a valid plugin
is that it contain an init method that accepts a reference to its owner. Once
a plugin is created, the owner will call the init method, passing a reference
to itself. Each plugin can then call methods or respond to events on its owner
as needed to provide its functionality.
This config's value can take several different forms.
The value can be a single string with the plugin's Ext.enums.Plugin:
var list = Ext.create({
xtype: 'list',
itemTpl: '<div class="item">{title}</div>',
store: 'Items',
plugins: 'listpaging'
});
In the above examples, the string "listpaging" is the type alias for
listpaging. The full alias includes the "plugin." prefix
(i.e., 'plugin.listpaging').
The preferred form for multiple plugins or to configure plugins is the keyed-object form (new in version 6.5):
var list = Ext.create({
xtype: 'list',
itemTpl: '<div class="item">{title}</div>',
store: 'Items',
plugins: {
pullrefresh: true,
listpaging: {
autoPaging: true,
weight: 10
}
}
});
The object keys are the id's as well as the default type alias. This form
allows the value of the plugins to be merged from base class to derived class
and finally with the instance configuration. This allows classes to define a
set of plugins that derived classes or instantiators can further configure or
disable. This merge behavior is a feature of the
config.
The plugins config can also be an array of plugin aliases (arrays are not
merged so this form does not respect plugins defined by the class author):
var list = Ext.create({
xtype: 'list',
itemTpl: '<div class="item">{title}</div>',
store: 'Items',
plugins: ['listpaging', 'pullrefresh']
});
An array can also contain elements that are config objects with a type
property holding the type alias:
var list = Ext.create({
xtype: 'list',
itemTpl: '<div class="item">{title}</div>',
store: 'Items',
plugins: ['pullrefresh', {
type: 'listpaging',
autoPaging: true
}]
});
Defaults to:
null
Returns the value of plugins
Sets the value of plugins
plugins : Array / Ext.enums.Plugin / Object / Ext.plugin.Abstract
The amount of delay between the tapstart and adding the pressedCls.
Defaults to:
100
The amount of delay between the tapstart and adding the pressedCls.
Defaults to:
100
One or more names of config properties that this component should publish to its ViewModel. Generally speaking, only properties defined in a class config block (including ancestor config blocks and mixins) are eligible for publishing to the viewModel. Some components override this and publish their most useful configs by default.
Note: We'll discuss publishing properties not found in the config block below.
Values determined to be invalid by component (often form fields and model validations) will not be published to the ViewModel.
This config uses the cfg-reference to determine the name of the data
object to place in the ViewModel. If reference is not set then this config
is ignored.
By using this config and cfg-reference you can bind configs between
components. For example:
...
items: [{
xtype: 'textfield',
reference: 'somefield', // component's name in the ViewModel
publishes: 'value' // value is not published by default
},{
...
},{
xtype: 'displayfield',
bind: 'You have entered "{somefield.value}"'
}]
...
Classes must provide this config as an Object:
Ext.define('App.foo.Bar', {
publishes: {
foo: true,
bar: true
}
});
This is required for the config system to properly merge values from derived classes.
For instances this value can be specified as a value as show above or an array or object as follows:
{
xtype: 'textfield',
reference: 'somefield',
publishes: [
'value',
'rawValue',
'dirty'
]
}
// This achieves the same result as the above array form.
{
xtype: 'textfield',
reference: 'somefield',
publishes: {
value: true,
rawValue: true,
dirty: true
}
}
In some cases, users may want to publish a property to the viewModel that is not found in a class config block. In these situations, you may utilize publishState if the property has a setter method. Let's use setFieldLabel as an example:
setFieldLabel: function(fieldLabel) {
this.callParent(arguments);
this.publishState('fieldLabel', fieldLabel);
}
With the above chunk of code, fieldLabel may now be published to the viewModel.
Defaults to:
{
selection: 1
}
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
Specifies a name for this component inside its component hierarchy. This name must be unique within its view or its ViewController. See the documentation in Ext.container.Container for more information about references.
Note: Valid identifiers start with a letter or underscore and are followed by zero or more additional letters, underscores or digits. References are case sensitive.
Defaults to:
null
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
Optional element to render this Component to. Not required if this component is an item of a Container of a Container.
Defaults to:
null
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
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
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 onlyy or vertical to enable vertical scrolling onlyAlso 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:
true
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 onlyy or vertical to enable vertical scrolling onlyAlso 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:
true
This property is placed on the child items added to this container. The value placed on the child items determines the position of that item with respect to the data items.
Ext.Viewport.add({
xtype: 'dataview',
itemTpl: '{firstName}',
data: [
{ firstName: 'Peter'},
{ firstName: 'Raymond'},
{ firstName: 'Egon'},
{ firstName: 'Winston'}
],
items: [{
xtype: 'component',
html: 'Always At End!',
scrollDock: 'end'
}]
});
Note, a value of 'top' is equivalent to 'start' while 'bottom' is
equivalent to 'end'. The 'top' and 'bottom' values originated from the
List class.
This property is placed on the child items added to this container. The value placed on the child items determines the position of that item with respect to the data items.
Ext.Viewport.add({
xtype: 'dataview',
itemTpl: '{firstName}',
data: [
{ firstName: 'Peter'},
{ firstName: 'Raymond'},
{ firstName: 'Egon'},
{ firstName: 'Winston'}
],
items: [{
xtype: 'component',
html: 'Always At End!',
scrollDock: 'end'
}]
});
Note, a value of 'top' is equivalent to 'start' while 'bottom' is
equivalent to 'end'. The 'top' and 'bottom' values originated from the
List class.
Scroll the DataView to the top when the DataView is refreshed.
Defaults to:
true
Sets the value of scrollToTopOnRefresh
scrollToTopOnRefresh : Boolean
Scroll the DataView to the top when the DataView is refreshed.
Defaults to:
true
Sets the value of scrollToTopOnRefresh
scrollToTopOnRefresh : Boolean
A configuration object which allows passing of configuration options to create or reconfigure a Ext.dataview.selection.Model.
Defaults to:
true
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.
Sets the value of selectable
selectable : Object / Ext.dataview.selection.Model
A configuration object which allows passing of configuration options to create or reconfigure a Ext.dataview.selection.Model.
May contain the following options:
- mode `'single'`, '`simple'` or `'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 Configure as false to disallow deselecting down to zero selections.
Defaults to:
true
If provided this creates a new Session instance for this component. If this
is a Container, this will then be inherited by all child components.
To create a new session you can specify true:
Ext.create({
xtype: 'viewport',
session: true,
items: [{
...
}]
});
Alternatively, a config object can be provided:
Ext.create({
xtype: 'viewport',
session: {
...
},
items: [{
...
}]
});
Defaults to:
null
Sets the value of session
session : Boolean / Object / Ext.data.Session
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
Sets the value of showAnimation
showAnimation : String / Mixed
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
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
The unique id for this object to use for state management purposes.
Defaults to:
null
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
DOM tabIndex attribute for this component's focusEl.
Defaults to:
0
Return the actual tabIndex for this Focusable.
tabIndex attribute value
Set the tabIndex property for this Focusable. If the focusEl is available, set tabIndex attribute on it, too.
newTabIndex : Number
new tabIndex to set
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
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
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:
panXpanYpinchZoomdoubleTapZoomAll 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
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
Sets the value of tpl
tpl : String / String[] / Ext.Template / Ext.XTemplate[]
The Ext.(X)Template method to use when updating the content area of the Component.
Valid modes are:
Defaults to:
'overwrite'
Determines what type of touch event is recognized as a touch on the container.
Defaults to:
'tap'
Returns the value of triggerCtEvent
'tap' / 'singletap'
Sets the value of triggerCtEvent
triggerCtEvent : 'tap' / 'singletap'
Determines what type of touch event is recognized as a touch on the container.
Defaults to:
tap
Determines what type of touch event causes an item to be selected.
Defaults to:
'childtap'
Returns the value of triggerEvent
'childtap' / 'childsingletap' / 'childdoubletap' / 'childswipe' / 'childtaphold' / 'childlongpress'
Sets the value of triggerEvent
triggerEvent : 'childtap' / 'childsingletap' / 'childdoubletap' / 'childswipe' / 'childtaphold' / 'childlongpress'
Determines what type of touch event causes an item to be selected.
Defaults to:
"childtap"
This object holds a map of config properties that will update their binding
as they are modified. For example, value is a key added by form fields. The
form of this config is the same as publishes.
This config is defined so that updaters are not created and added for all bound properties since most cannot be modified by the end-user and hence are not appropriate for two-way binding.
Defaults to:
{
selection: 1
}
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
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
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
The ViewModel is a data provider for this component and its children. The
data contained in the ViewModel is typically used by adding bind configs
to the components that want present or edit this data.
When set, the ViewModel is created and links to any inherited viewModel
instance from an ancestor container as the "parent". The ViewModel hierarchy,
once established, only supports creation or destruction of children. The
parent of a ViewModel cannot be changed on the fly.
If this is a root-level ViewModel, the data model connection is made to this
component's associated Ext.data.Session. This is
determined by calling getInheritedSession.
Defaults to:
null
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
If set to true, then child items may be specified as a object,
with each property name specifying an itemId, and the property
value being the child item configuration object.
When using this scheme, each child item may contain a weight configuration value which affects its order in this container. Lower weights are towards the start, higher weights towards the end.
Defaults to:
false
The width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
By default, if this is not explicitly set, this Component's element will simply have its own natural size.
If set to auto, it will set the width to null meaning it will have its own natural size.
Defaults to:
null
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 like so:
Ext.define('PressMeButton', {
extend: 'Ext.button.Button',
xtype: '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.
Matches options property names within a listeners specification object - property names which are never used as event names.
Defaults to:
{
scope: 1,
delay: 1,
buffer: 1,
onFrame: 1,
single: 1,
args: 1,
destroyable: 1,
priority: 1,
order: 1
}
We don't want the base destructor to clear the prototype because our destroyObservable handler must be called the very last. It will take care of the prototype after completing Observable destruction sequence.
Defaults to:
true
The name of the Component property that holds a reference to the Element that serves as that Component's ARIA element. This property will be replaced with the actual Element reference after rendering.
Most of the simple Components will have their main element as ariaEl.
Defaults to:
'el'
Available since: 6.0.0
Instance specific ARIA attributes to render into Component's ariaEl. This object is only used during rendering, and is discarded afterwards.
ARIA role for this Component, defaults to no role. With no role, no other ARIA attributes are set.
true indicates an id was auto-generated rather than provided by configuration.
Defaults to:
false
Available since: 6.7.0
true if this currently focused element
is within this Component's or Container's hierarchy. This property is set separately
from hasFocus, and can be true when hasFocus is false.
Examples:
Text field with input element focused would be: focusable: true, hasFocus: true, containsFocus: true
Date field with drop-down picker currently focused would be: focusable: true, hasFocus: false, containsFocus: true
Form Panel with a child input field currently focused would be: focusable: false, hasFocus: false, containsFocus: true
See also hasFocus.
Defaults to:
false
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:
[]
This property is used to determine the property of a bind config that is just
the value. For example, if defaultBindProperty="value", then this shorthand
bind config:
bind: '{name}'
Is equivalent to this object form:
bind: {
value: '{name}'
}
The defaultBindProperty is set to "value" for form fields and to "store" for
grids and trees.
Defaults to:
'store'
Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.
Defaults to:
0
If this property is specified by the target class of this mixin its properties are
used to configure the created Ext.Factory.
true for keyboard interactive Components or Widgets, false otherwise.
For Containers, this property reflects interactiveness of the
Container itself, not its children. See isFocusable.
Note: It is not enough to set this property to true to make
a component keyboard interactive. You also need to make sure that
the component's focusEl is reachable via Tab key (tabbable).
See also tabIndex.
Defaults to:
true
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"
The element that will have the focusCls applied when component's focusEl is focused.
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'
true if this component's focusEl is focused.
See also containsFocus.
Defaults to:
false
This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class (via observe) or on the MVC EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.
The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:
if (this.hasListeners.foo) {
this.fireEvent('foo', this, arg1);
}
Template method to do any Focusable related initialization that does not involve event listeners creation.
Defaults to:
Ext.emptyFn
true in this class to identify an object as an instantiated Container, or subclass thereof.
Defaults to:
true
true in this class to identify an object this type, or subclass thereof.
Defaults to:
true
true to identify an object as an instantiated DataView, or subclass thereof.
Defaults to:
true
true in this class to identify an object as an instantiated Observable, or subclass
thereof.
Defaults to:
true
The last key event processed is cached on the component for use in subsequent event handlers.
Available since: 6.6.0
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.
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
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
The selection model type to create. Defaults to 'dataview' for DataViews and Lists.
Defaults to:
'dataview'
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'
}
Regular expression used for validating reference values.
Defaults to:
/^[a-z_][a-z0-9_]*$/i
Adds declarative listeners as nested arrays of listener objects.
listeners : Array
true if any listeners were added
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.
Returns the state id for this object.
The stateId or the configured id.
Creates a particular plugin type if defined in the plugins configuration.
Available since: 6.2.0
type : String
The type of the plugin.
The plugin that was created.
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
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.
The Component(s) that were added.
Adds a listeners with the "delegate" event option. Users should not invoke this method directly. Use the "delegate" event option of addListener instead.
eventName : Object
fn : Object
scope : Object
options : Object
order : Object
caller : Object
manager : 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}
});
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 set of arguments to pass to the handler function before the actual
fired event arguments. For example, if args is set to ['foo', 42],
the event handler function will be called with an arguments list like this:
handler('foo', 42, <actual event 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 -100Defaults to:
'current'
order : String (optional)
A shortcut for the order event option. Provided for backward compatibility.
Please use the priority event option instead.
Defaults to: 'current'
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();
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.SomeSharedMenu, '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.
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.
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes
all listeners added in this call. For example:
this.btnListeners = myButton.mon({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
Adds a plugin. For example:
list.addPlugin('pullrefresh');
Or:
list.addPlugin({
type: 'pullrefresh',
pullRefreshText: 'Pull to refresh...'
});
Available since: 6.2.0
plugin : Object/String/Ext.plugin.Abstract
The plugin or config object or alias to add.
component : Object
alignment : Object
options : Object
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.
activeItem : Object/Number
The item or item index to make active.
animation : Object/Ext.layout.card.fx.Abstract
Card animation configuration or instance.
activeItem : Object
currentActiveItem : Object
Available since: 5.0.0
binds : String/Object
currentBindings : Object
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.
item : Object/Ext.Component
The item to apply the defaults to.
The item that was passed in
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.
masked : Boolean/Object/String/Ext.Mask/Ext.LoadMask
Applier for the plugins config property.
plugins : String[]/Object[]/Ext.plugin.Abstract[]
The new plugins to use.
oldPlugins : Ext.plugin.Abstract[]
The existing plugins in use.
Transforms a Session config to a proper instance.
Available since: 5.0.0
session : Object
Transforms a ViewModel config to a proper instance.
Available since: 5.0.0
viewModel : String/Object/Ext.app.ViewModel
Sets up a component name reference.
component : Ext.Component
The component to reference.
Sets up a component reference.
component : Ext.Component
The component to reference.
Bubbles up the getRefOwner hierarchy, calling the specified function
with each component. The scope (this reference) of the function call will be the
scope provided or the current component. The arguments to the function will
be the args provided or the current component. If the function returns false at any
point, the bubble is stopped.
fn : Function
The function to call
scope : Object (optional)
The scope of the function. Defaults to current node.
args : Array (optional)
The args to call the function with. Defaults to passing the current component.
Center this floated or positioned Component in its parent.
this
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.
selector : String/Ext.Component (optional)
An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned.
The matching child Ext.Component (or null if no match was found).
Clears all listeners that were attached using the "delegate" event option. Users should not invoke this method directly. It is called automatically as part of normal clearListeners processing.
Creates new Component.
config : Object
The standard configuration object.
Converts the provided type or config object into a plugin instance.
config : String/Object/Ext.plugin.Abstract
The plugin type, config object or instance.
Creates an event handling function which re-fires the event from this object as the passed event name.
newName : String
The name under which to re-fire the passed parameters.
beginEnd : Array (optional)
The caller can specify on which indices to slice.
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
plugin : String/Ext.plugin.Abstract
The plugin or its id to remove.
plugin instance or null if not found.
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
Fires a delegated event. Users should not invoke this method directly. It is called automatically by the framework as needed (see the "delegate" event option of addListener for more details.
eventName : Object
args : Object
Continue to fire event.
eventName : String
args : Array
bubbles : Boolean
index : Number
item : Ext.Component
instanced : Boolean
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.
selector : String/Ext.Component (optional)
An Ext.ComponentQuery selector or Ext.Component. If no selector is specified, the first child will be returned.
The matching descendant Ext.Component (or null if no match
was found).
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');
}
}
});
eventNames : String/String[]
The event name to bubble, or an Array of event names.
Scrolls the specified record into view.
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.
Scrolls the specified record into view.
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.
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.
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.
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.
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.
The component to be added.
Finds an alternate Component to focus if this Component is disabled while focused, or focused while disabled, or otherwise unable to focus.
In both cases, focus must not be lost to document.body, but must move to an intuitively connectible Component, either a sibling, or uncle or nephew.
This is both for the convenience of keyboard users, and also for when focus is tracked within a Component tree such as for ComboBoxes and their dropdowns.
For example, a ComboBox with a PagingToolbar in is BoundList. If the "Next Page" button is hit, the LoadMask shows and focuses, the next page is the last page, so the "Next Page" button is disabled. When the LoadMask hides, it attempt to focus the last focused Component which is the disabled "Next Page" button. In this situation, focus should move to a sibling within the PagingToolbar.
A closely related focusable Component to which focus can move.
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
type : String
The Plugin's type as specified by the class's
alias configuration.
plugin instance or null if not found.
Fires the specified event with the passed parameters and executes a function (action).
By default, the action function will be executed after any "before" event handlers
(as specified using the order option of
addListener), but before any other
handlers are fired. This gives the "before" handlers an opportunity to
cancel the event by returning false, and prevent the action function from
being called.
The action can also be configured to run after normal handlers, but before any "after"
handlers (as specified using the order event option) by passing 'after'
as the order parameter. This configuration gives any event handlers except
for "after" handlers the opportunity to cancel the event and prevent the action
function from being called.
eventName : String
The name of the event to fire.
args : Array
Arguments to pass to handlers and to the action function.
fn : Function
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.
options : Object (optional)
Event options for the action function. Accepts any
of the options of addListener
order : String (optional)
The order to call the action function relative
too the event handlers ('before' or 'after'). Note that this option is
simply used to sort the action function relative to the event handlers by "priority".
An order of 'before' is equivalent to a priority of 99.5, while an order of
'after' is equivalent to a priority of -99.5. See the priority option
of addListener for more details.
Defaults to: 'before'
Deprecated since version 5.5
Use fireEventedAction instead.
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.
eventName : String
The name of the event to fire.
args : Object...
Variable number of parameters are passed to handlers.
returns false if any of the handlers return false otherwise it returns true.
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.
eventName : String
The name of the event to fire.
args : Object[]
An array of parameters which are passed to handlers.
returns false if any of the handlers return false otherwise it returns true.
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.
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.
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.
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.
true if focus target was found and focusing was attempted,
false if no focusing attempt was made.
Find component(s) that label or describe this component, and return the id(s) of their ariaEl elements.
reference : Function/String/String[] (optional)
Component reference, or array of component references, or a function that should return the proper attribute string. The function will be called in the context of the labelled component.
Element id string, or null
Returns the Component for a given index in the Container's items.
index : Number
The index of the Component to return.
The item at the specified index, if found.
Gets the bubbling parent for an Observable
The bubble parent. null is returned if no bubble target exists
Examines this container's items property
and gets a direct child component of this container.
component : String/Number
This parameter may be any of the following:
itemId
or id of the child component.items property.For additional information see Ext.util.MixedCollection#get.
The component (if found).
Finds a docked item of this container using a reference, idor an index of its location
in getDockedItems.
component : String/Number
The id or index of the component to find.
The docked component, if found.
Returns all the Ext.Component#docked items in this container.
The docked items of this container.
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.
Returns the element used to apply focus styling CSS class when Focusable's focusEl becomes focused. By default it is focusEl.
focusEl : Ext.dom.Element (optional)
Return focus styling element for the given focused element. This is used by Components implementing multiple focusable elements.
The focus styling element.
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.
the focus holding element.
Retrieves the id. This method Will auto-generate an id if one has not already
been configured.
id
This method returns an object containing the inherited properties for this instance.
Available since: 5.0.0
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
The inheritedState object containing inherited properties.
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
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
The value of the requested property.
Returns all inner items of this container. inner means that the item is
not docked or positioned.
The inner items of this container.
Returns an item at the specified view index. This may return items that do not
correspond to a Ext.data.Model in the store if such items have been
added to this container.
Negative numbers are treated as relative to the end such that -1 is the last
item, -2 is the next-to-last and so on.
The mapToItem method recommended over this method as it is more flexible and can
also handle a Ext.data.Model as the parameter. To handle store
index values, use mapToViewIndex:
item = view.mapToItem(view.mapToViewIndex(storeIndex));
index : Number
The index of the item in the view.
Returns an item at the specified view index. This may return items that do not
correspond to a Ext.data.Model in the store if such items have been
added to this container.
Negative numbers are treated as relative to the end such that -1 is the last
item, -2 is the next-to-last and so on.
The mapToItem method recommended over this method as it is more flexible and can
also handle a Ext.data.Model as the parameter. To handle store
index values, use mapToViewIndex:
item = view.mapToItem(view.mapToViewIndex(storeIndex));
index : Number
The index of the item in the view.
Returns the item (an element or widget) at the given page coordinates.
x : Number
y : Number
Returns the item (an element or widget) at the given client coordinates.
x : Number
y : Number
Returns the item's index in the store, or -1 if the item does not correspond to a Ext.data.Model.
Deprecated Historically this method has always returned the record's index in
the store. In most uses this was assumed to match the view index. But this is
not always the case, especially for the Ext.List subclass. To be clear about
which index is being requested, new code should instead call mapToViewIndex or
mapToRecordIndex.
item : HTMLElement/Ext.dom.Element/Ext.Component
The item to locate.
Index for the specified item.
Deprecated since version 6.5.0
Use mapToViewIndex or mapToRecordIndex instead.
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
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
An object with each named child. This will be null if this
container has no descendants with a name specified.
Returns the parent of this component, if it has one.
The parent of this component.
Retrieves a plugin by its id.
var list = Ext.create({
xtype: 'list',
itemTpl: '<div class="item">{title}</div>',
store: 'Items',
plugins: [{
type: 'pullrefresh',
id: 'foo'
}]
});
list.getPlugin('foo').setPullRefreshText('Pull to refresh...');
Note: See also findPlugin.
Available since: 6.2.0
id : String
The id of the plugin.
plugin instance or null if not found.
Similar to getRenderTarget but for positioned items.
Available since: 6.5.0
item : Ext.Component
The positioned item being added.
This method returns an object of all proxied config values for a given target. This is only useful during the class initialization phase to avoid passing in "wrong" initial config values for a child object and then proxying down all the configs from the parent.
This method is not typically called directly but rather mergeProxiedConfigs is
more likely.
Available since: 6.5.0
name : String
The proxy target config name (in the class example, this would be "childThing").
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
deep : Object
Used by Ext.ComponentQuery, and the up method to find the owning Component in the linkage hierarchy.
By default this returns the Container which contains this Component.
This may be overridden by Component authors who implement ownership hierarchies which are not based upon ownerCt, such as BoundLists being owned by Fields or Menus being owned by Buttons.
Returns 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
An object with each child reference. This will be null if this
container has no descendants with a reference
specified.
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 all the items that are docked at the ends of the items.
which : 'start'/'end'
The set of desired scrollDock items.
An array of the scrollDock items.
Returns all the items that are docked at the ends of the items.
which : 'start'/'end'
The set of desired scrollDock items.
An array of the scrollDock items.
This method is required by the Scroller to return the scrollable client region
The scrolling viewport region.
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.
cache : Boolean (optional)
Pass true to return a cached builder.
Defaults to: false
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 an array of the current items in the DataView. Depends on the useComponents configuration.
The items.
Returns an array of the current items in the DataView. Depends on the useComponents configuration.
The items.
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'
The xtype hierarchy string.
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.
eventName : String
The name of the event to check for
true if the event is being listened for or bubbles, else false
Returns true if this component has a parent.
true if this component has a parent.
Hides this Component optionally using an animation.
animation : Object/Boolean (optional)
You can specify an animation here or a bool to use the hideAnimation config.
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
modified : String[]
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
This method triggers the lazy configs and must be called when it is time to
fully boot up. The configs that must be initialized are: bind, publishes,
session, twoWayBindable and viewModel.
Available since: 5.0.0
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
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.
Sets up the focus listener on this Component's focusEl if it has one.
Form Components which must implicitly participate in tabbing order usually have
a naturally focusable element as their focusEl, and it is
the DOM event of that receiving focus which drives the Component's onFocus handling,
and the DOM event of it being blurred which drives the onBlur handling.
force : Object
Template method to do any event listener initialization for a Focusable. This generally happens after the focusEl is available.
force : Object
Called by getInherited to initialize the inheritedState the first time it is requested.
inheritedState : Object
This method should be called when the instance is ready to start listening for
keyboard events. This is called automatically for Ext.Component and derived
classes. This is done after the component is rendered.
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.
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'});
index : Number
The index to insert the Component at.
item : Object
The Component to insert.
This method marks the current inherited state as invalid. The next time a call is
made to getInherited the objects will be recreated and initialized.
Available since: 5.0.0
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.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
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.
possibleDescendant : Ext.Component
The Component to test for presence within this Component's subtree.
Determines if the passed property name is bound to ViewModel data.
Available since: 6.5.0
name : String (optional)
The property name to test. Defaults to the defaultBindProperty
true if the passed property receives data from a ViewModel.
Determines whether this component is the descendant of a passed component.
ancestor : Ext.Component
A Component which may contain this Component.
true if the component is the descendant of the passed component,
otherwise false.
Determines if this Component is inside a Component tree which is destroyed, or is being destroyed.
true if this Component, or any ancestor is destroyed, or
is being destroyed.
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.
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
True if component is focusable, false if not.
Checks if all events, or a specific event, is suspended.
event : String (optional)
The name of the specific event to check
true if events are suspended
Checks if a particular binding is synchronizing the value.
name : String
The name of the property being bound to.
true if the binding is syncing.
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).
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.
state : Ext.state.Builder
stateful : Object
The stateful properties as an object keyed by config name.
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
ref : String
The value of the reference to lookup.
The referenced component or null if it is not found.
Gets the controller that controls this view. May be a controller that belongs to a view higher in the hierarchy.
Available since: 5.0.1
skipThis : Boolean (optional)
true to not consider the controller directly attached
to this view (if it exists).
Defaults to: false
The controller. null if no controller is found.
Gets a reference to the component with the specified name property.
Available since: 6.5.0
name : String
The name of the descendant to lookup.
The component or null if it is not found.
Gets the Form or Component that is used as the name holder for this component.
Available since: 6.5.0
skipThis : Boolean (optional)
false to return this as the name holder if
this instance has set nameHolder. Unlike getInheritedConfig this method
defaults to true because it is possible that a name property set by the
owner of a component that is also a nameHolder itself. In this case, the
name connects not to this component but to the parent nameHolder.
Defaults to: true
The name holder.
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
ref : String
The name of the reference to lookup.
The referenced component or null if it is not found.
Gets the Controller or Component that is used as the reference holder for this view.
Available since: 5.0.0
skipThis : Boolean (optional)
false to return this as the reference holder if
this instance has set referenceHolder. Unlike getInheritedConfig this method
defaults to true because it is possible that a reference property set by the
owner of a component that is also a referenceHolder itself. In this case, the
reference connects not to this component but to the parent referenceHolder.
Defaults to: true
The reference holder.
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
ref : String
The name of the reference to lookup.
The referenced component or null if it is not found.
Returns the Ext.data.Session for this instance. This property may come
from this instance's session or be inherited from this object's parent.
Available since: 5.0.0
skipThis : Boolean (optional)
Pass true to ignore a session configured on
this instance and only consider an inherited session.
Defaults to: false
Returns the Ext.app.ViewModel for this instance. This property may come from this
this instance's viewModel or be inherited from this object's parent.
Available since: 5.0.0
skipThis : Boolean (optional)
Pass true to ignore a viewModel configured on
this instance and only consider an inherited view model.
Defaults to: false
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
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.
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
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.
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.
If item is a Ext.data.Model, it will be returned if it belongs to
this dataview's store. Otherwise, null will be 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
value : Ext.event.Event/Number/HTMLElement/Ext.dom.Element/Ext.Component/Ext.data.Model
The associated record or null if there is none.
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
value : Ext.event.Event/Number/HTMLElement/Ext.dom.Element/Ext.Component
The associated record or null if there is none.
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
value : Ext.event.Event/Number/HTMLElement/Ext.dom.Element/Ext.Component/Ext.data.Model
uncollapsed : Boolean (optional)
Pass true to return the record index in the
underlying (uncollapsed) store, bypassing collapsed groups. This applies only to
list and derived classes.
The record's index in the store or -1 if not found.
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
value : Ext.event.Event/Number/HTMLElement/Ext.dom.Element/Ext.Component/Ext.data.Model
The record's index in the store or -1 if not found.
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
value : Ext.event.Event/Number/HTMLElement/Ext.dom.Element/Ext.Component/Ext.data.Model
The view index or -1 if not found.
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
value : Ext.event.Event/Number/HTMLElement/Ext.dom.Element/Ext.Component/Ext.data.Model
The view index or -1 if not found.
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).
mask : Object
This method accepts the normal config object (itemConfig) for the child object
(name) and merges any proxied configs into a new config object. This is useful
during the class initialization phase to avoid passing in "wrong" initial config
values for a child object and then proxying down the rest of the configs.
This method is typically called during an "applier" method for a proxy target. If
called at any other time this method simply returns the given itemConfig. This
makes it safe to code such appliers as follows:
applyChildThing: function(config) {
config = this.mergeProxiedConfigs('childThing', config);
return new ChildThing(config);
}
Available since: 6.5.0
name : String
The proxy target config name (in the class example, this would be "childThing").
itemConfig : Mixed
The default configuration for the child item.
alwaysClone : Boolean (optional)
Pass true to ensure a new object is returned.
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.
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.
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();
Shorthand for removeManagedListener. Removes listeners that were added by the mon method.
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.
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.
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 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.
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 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.
selector : String (optional)
A Ext.ComponentQuery selector to filter the following nodes.
The next node (or the next node which matches the selector).
Returns null if there is no matching node.
Returns the next sibling of this Component.
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
selector : String (optional)
A Ext.ComponentQuery selector to filter the following items.
The next sibling (or the next sibling which matches the selector).
Returns null if there is no matching sibling.
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}
});
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 -100Defaults 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'
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();
Appends an after-event handler.
Same as addListener with order set
to 'after'.
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.
Appends a before-event handler. Returning false from the handler will stop the event.
Same as addListener with order set
to 'before'.
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.
Initialize layout and event listeners the very first time an item is added
item : Object
Called when focus enters this Component's hierarchy
e : Object
event : Ext.event.Event
The underlying DOM event.
target : HTMLElement
The element gaining focus.
: HTMLElement
The element losing focus.
toComponent : Ext.Component
The Component gaining focus.
fromComponent : Ext.Component
The Component losing focus.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Called when focus exits from this Component's hierarchy
e : Ext.event.Event
event : Ext.event.Event
The underlying DOM event.
target : HTMLElement
The element gaining focus.
: HTMLElement
The element losing focus.
toComponent : Ext.Component
The Component gaining focus.
fromComponent : Ext.Component
The Component losing focus.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Called when focus moves within this Component's hierarchy
info : Object
event : Ext.event.Event
The underlying Event object.
toElement : HTMLElement
The element gaining focus.
fromElement : HTMLElement
The element losing focus.
toComponent : Ext.Component
The Component gaining focus.
fromComponent : Ext.Component
The Component losing focus.
backwards : Boolean
true if the focus movement is backward in DOM order
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Called when this Inheritable is added to a parent
parent : Object
instanced : Boolean
Called when this inheritable is removed from a parent
destroying : Boolean
true if this item will be destroyed by it's container
item : Object
toIndex : Object
fromIndex : Object
item : Object
index : Object
destroying : Object
Called by Ext.GlobalEvents#setPressedComponent when the global mouseup event fires and there's a registered pressed component.
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:
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.
Invoked when a scroll operation is completed via this component's scroller.
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.
Invoked when this component is scrolled via its scroller.
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.
Invoked when a scroll is initiated on this component via its scroller.
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.
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.
Function which can be overridden to provide custom formatting for each Record that is used by this DataView's template to render each node.
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.
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'}))
Function which can be overridden to provide custom formatting for each Record that is used by this DataView's template to render each node.
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.
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'}))
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.
component : Object
alignment : Object
options : Object
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.
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 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.
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 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.
selector : String (optional)
A Ext.ComponentQuery selector to filter the preceding nodes.
The previous node (or the previous node which matches the selector).
Returns null if there is no matching node.
Returns the previous sibling of this Component.
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
selector : String (optional)
A Ext.ComponentQuery selector to filter the preceding items.
The previous sibling (or the previous sibling which matches
the selector). Returns null if there is no matching sibling.
An overrideable function which preprocesses all key events from within this
FocusableContainer. The base implementation vetoes processing of key events from input
fields by returning undefined. This may be overridden in subclasses with special
requirements.
e : Ext.util.Event
A keyboard event that is significant to the operation of a FocusableContainer.
The event if it is to be processed as a FocusableContainer
navigation keystroke, or undefined if it is to be ignore by the FocusableContainer
navigation machinery.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Publish this components state to the ViewModel. If no arguments are given (or if
this is the first call), the entire state is published. This state is determined by
the publishes property.
This method is called only by component authors.
Available since: 5.0.0
property : String (optional)
The name of the property to update.
value : Object (optional)
The value of property. Only needed if property is given.
Retrieves all descendant components which match the passed selector. Executes an Ext.ComponentQuery.query using this container as its root.
selector : String (optional)
Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned.
Components which matched the selector
Retrieves all descendant components which match the passed function. The function should return false for components that are to be excluded from the selection.
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.
Components matched by the passed function
Finds a component at any level under this container matching the id/itemId. This is a shorthand for calling ct.down('#' + id);
id : String
The id to find
The matching id, null if not found
Returns this instance's state object from the persistence store. This object should contain config properties.
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).
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'.
A Destroyable object. An object which implements the destroy method
which, when destroyed, removes all relayers. For example:
this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
Can be undone by calling
Ext.destroy(this.storeRelayers);
or this.store.relayers.destroy();
Removes an item from this Container, optionally destroying it.
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.
The Component that was removed.
Removes all items currently in the Container, optionally destroying them all.
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.
The removed components
Removes the Component at the specified index:
myContainer.removeAt(0); // removes the first item
index : Number
The index of the Component to remove.
destroy : Boolean (optional)
true to automatically call Component's
destroy method.
The removed Component
Removes delegated listeners for a given eventName, function, and scope. Users should not invoke this method directly. It is called automatically by the framework as part of removeListener processing.
eventName : Object
fn : Object
scope : Object
Removes an inner Component at the specified index:
myContainer.removeInnerAt(0); // removes the first item of the innerItems property
index : Number
The index of the Component to remove.
The removed Component
Removes an event handler.
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.
Removes listeners that were added by the mon method.
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.
Remove a single managed listener item
isClear : Boolean
True if this is being called during a clear
managedListener : Object
The managed listener item
item : Object
ename : String
fn : Function
scope : Object
See removeManagedListener for other args
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
plugin : String/Ext.plugin.Abstract
The plugin or its id to remove.
destroy : Boolean (optional)
Pass true to not call destroy() on the plugin.
plugin instance or null if not found.
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.
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.
Gets the default scope for firing late bound events (string names with no scope attached) at runtime.
defaultScope : Object (optional)
The default scope to return if none is found.
Defaults to: this
The default event scope
Returns the default listener scope for a "satellite" of this component. Used for resolving scope for observable objects that are not part of the normal Container/Component hierarchy (for example, plugins)
Available since: 5.1.1
satellite : Ext.mixin.Observable
defaultScope : Object (optional)
The listener scope
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.
eventName : String...
Multiple event names to resume.
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.
discardQueue : Boolean (optional)
true to prevent any previously queued events from firing
while we were suspended. See suspendEvents.
This field is on the recieving end of a call from revertFocus.
It is called when focus is being pushed back into this Component from a Component that is focused and is being hidden or disabled.
We must focus the passed element.
Subclasses may perform some extra processing to prepare for refocusing.
target : Object
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..
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.
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.
state : Ext.state.Builder
The state builder to which to save state.
stateful : Object
The stateful properties as an object keyed by config name.
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
x : Object
y : Object
animation : Object
Shows this component optionally using an animation.
animation : Object/Boolean (optional)
You can specify an animation here or a bool to use the showAnimation config.
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());
}
}
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.
this
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:
'l-r?',
'r-l?', 'b-t?' then 't-b?' in that order.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');
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.
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.
eventName : String...
Multiple event names to suspend.
Suspends the firing of all events. (see resumeEvents)
queueSuspended : Boolean
true to queue up suspended events to be fired
after the resumeEvents call instead of discarding all suspended events.
This method is called internally by initConfig to apply whatever changes are
needed from persistent storage.
instanceConfig : Object
The base config object
configurator : Ext.Configurator
The config object to use.
Shorthand for removeListener. Removes an event handler.
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'
});
Removes a before-event handler.
Same as removeListener with order set to 'after'.
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.
Removes a before-event handler.
Same as removeListener with order set to 'before'.
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.
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).
Walks up the ownership hierarchy looking for an ancestor Component which matches the passed simple selector.
Example:
var owningTabPanel = grid.up('tabpanel');
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.
The matching ancestor Container (or undefined if no match was found).
Updates the viewModel config.
viewModel : Ext.app.ViewModel
oldViewModel : Ext.app.ViewModel
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.
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 abort 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.
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.
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 abort 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.
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 visible and painted.
fn : String
The function to execute on this component.
args : Object[] (optional)
The arguments to pass.
true if the function was executed immediately.
Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
Direct use of this method should be rare. Use Ext.define instead:
Ext.define('My.CatOverride', {
override: 'My.Cat',
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).
members : Object
The properties to add to this class. This should be specified as an object literal containing one or more properties.
this class
Fires whenever item within the Container is activated.
newActiveItem : Object
The new active item within the container.
this : Ext.Container
The Container instance.
oldActiveItem : Object
The old active item within the container.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when activeItem changes.
sender : Ext.Container
The instance firing this event.
value : Ext.Component/Object/String/Number
The current value of activeItem.
oldValue : Ext.Component/Object/String/Number
The previous value of activeItem.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires after a Component had been added to a Container.
sender : Ext.Component
The component firing this event.
container : Ext.Container
Parent Container
index : Number
The index of the item within the Container.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when activeItem changes.
sender : Ext.Container
The instance firing this event.
value : Ext.Component/Object/String/Number
The current value of activeItem.
oldValue : Ext.Component/Object/String/Number
The previous value of activeItem.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when bottom changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of bottom.
oldValue : Number/String
The previous value of bottom.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when centered changes.
sender : Ext.Component
The instance firing this event.
value : Boolean
The current value of centered.
oldValue : Boolean
The previous value of centered.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when disabled changes.
sender : Ext.Widget
The instance firing this event.
value : Boolean
The current value of disabled.
oldValue : Boolean
The previous value of disabled.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when docked changes.
sender : Ext.Component
The instance firing this event.
value : String
The current value of docked.
oldValue : String
The previous value of docked.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when height changes.
sender : Ext.Widget
The instance firing this event.
value : Number/String
The current value of height.
oldValue : Number/String
The previous value of height.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
Fires before the Component is hidden. Hide may be vetoed by returning false from a handler.
sender : Ext.Component
The component firing this event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when left changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of left.
oldValue : Number/String
The previous value of left.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when maxHeight changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of maxHeight.
oldValue : Number/String
The previous value of maxHeight.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when maxWidth changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of maxWidth.
oldValue : Number/String
The previous value of maxWidth.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when minHeight changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of minHeight.
oldValue : Number/String
The previous value of minHeight.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when minWidth changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of minWidth.
oldValue : Number/String
The previous value of minWidth.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when right changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of right.
oldValue : Number/String
The previous value of right.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when scrollable changes.
sender : Ext.Component
The instance firing this event.
value : Boolean/String/Object
The current value of scrollable.
oldValue : Boolean/String/Object
The previous value of scrollable.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
Fires before the Component is shown. Show may be vetoed by returning false from a handler.
sender : Ext.Component
The component firing this event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when store changes.
sender : Ext.dataview.Abstract
The instance firing this event.
value : Ext.data.Store/Object
The current value of store.
oldValue : Ext.data.Store/Object
The previous value of store.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when top changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of top.
oldValue : Number/String
The previous value of top.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when width changes.
sender : Ext.Widget
The instance firing this event.
value : Number/String
The current value of width.
oldValue : Number/String
The previous value of width.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
Fires when this Component's focusEl loses focus.
this : Ext.Component
event : Ext.event.Event
The blur event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when bottom changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of bottom.
oldValue : Number/String
The previous value of bottom.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when centered changes.
sender : Ext.Component
The instance firing this event.
value : Boolean
The current value of centered.
oldValue : Boolean
The previous value of centered.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever item within the Container is deactivated.
oldActiveItem : Object
The old active item within the container.
this : Ext.Container
The Container instance.
newActiveItem : Object
The new active item within the container.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is deselected
this : Ext.dataview.DataView
records : Ext.data.Model[]
The records being deselected
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is deselected
this : Ext.dataview.DataView
records : Ext.data.Model[]
The records being deselected
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when disabled changes.
sender : Ext.Widget
The instance firing this event.
value : Boolean
The current value of disabled.
oldValue : Boolean
The previous value of disabled.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when docked changes.
sender : Ext.Component
The instance firing this event.
value : String
The current value of docked.
oldValue : String
The previous value of docked.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the component is no longer displayed in the DOM. Listening to this event will degrade performance not recommend for general use.
sender : Ext.Component
The component firing this event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever there is a change in the positioned status of a component
sender : Ext.Component
The component firing this event.
positioned : Boolean
The component's new positioned state. This becomes
true is a component is positioned using the cfg-top, cfg-right,
cfg-bottom or cfg-left configs.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Deprecated since version 6.2.0
Use positionedchange instead
Fires when this Component's focusEl receives focus.
this : Ext.Component/Ext.Widget
event : Ext.event.Event
The focus event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when focus enters this Component's hierarchy.
this : Ext.Component
event : Ext.event.Event
The focusenter event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when focus leaves this Component's hierarchy.
this : Ext.Component
event : Ext.event.Event
The focusleave event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever a Component with the fullscreen config is instantiated
sender : Ext.Component
The component firing this event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when height changes.
sender : Ext.Widget
The instance firing this event.
value : Number/String
The current value of height.
oldValue : Number/String
The previous value of height.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever the Component is hidden
sender : Ext.Component
The component firing this event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the component has been initialized
sender : Ext.Component
The component firing this event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is doubletapped
this : Ext.dataview.DataView
index : Number
The index of the item doubletapped
target : Ext.dom.Element/Ext.dataview.DataItem
The element or DataItem doubletapped
record : Ext.data.Model
The record associated to the item
e : Ext.event.Event
The event object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Deprecated since version 6.5.0
Use childdoubletap
Fires whenever an item's longpress event fires
this : Ext.dataview.DataView
index : Number
The index of the item touched
target : Ext.dom.Element/Ext.dataview.DataItem
The element or DataItem touched
record : Ext.data.Model
The record associated to the item
e : Ext.event.Event
The event object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Deprecated since version 6.5.0
Use childlongpress
Fires whenever the mouse pointer moves over an item
this : Ext.dataview.DataView
index : Number
The index of the item
target : Ext.dom.Element/Ext.dataview.DataItem
The element or DataItem
record : Ext.data.Model
The record associated to the item
e : Ext.event.Event
The event object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Deprecated since version 6.5.0
Use childmouseenter
Fires whenever the mouse pointer leaves an item
this : Ext.dataview.DataView
index : Number
The index of the item
target : Ext.dom.Element/Ext.dataview.DataItem
The element or DataItem
record : Ext.data.Model
The record associated to the item
e : Ext.event.Event
The event object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Deprecated since version 6.5.0
Use childmouseleave
Fires whenever an item is singletapped
this : Ext.dataview.DataView
index : Number
The index of the item singletapped
target : Ext.dom.Element/Ext.dataview.DataItem
The element or DataItem singletapped
record : Ext.data.Model
The record associated to the item
e : Ext.event.Event
The event object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Deprecated since version 6.5.0
Use childsingletap
Fires whenever an item is swiped
this : Ext.dataview.DataView
index : Number
The index of the item swiped
target : Ext.dom.Element/Ext.dataview.DataItem
The element or DataItem swiped
record : Ext.data.Model
The record associated to the item
e : Ext.event.Event
The event object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Deprecated since version 6.5.0
Use childswipe
Fires whenever an item is tapped. Add x-item-no-tap CSS class to a child of list
item to suppress itemtap events on that child. This can be useful when items
contain components such as Buttons.
this : Ext.dataview.DataView
index : Number
The index of the item tapped
target : Ext.dom.Element/Ext.dataview.DataItem
The element or DataItem tapped
record : Ext.data.Model
The record associated to the item
e : Ext.event.Event
The event object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Deprecated since version 6.5.0
Use childtap
Fires whenever an item's taphold event fires
this : Ext.dataview.DataView
index : Number
The index of the item touched
target : Ext.dom.Element/Ext.dataview.DataItem
The element or DataItem touched
record : Ext.data.Model
The record associated to the item
e : Ext.event.Event
The event object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Deprecated since version 6.5.0
Use childtaphold
Fires whenever an item touch is cancelled
this : Ext.dataview.DataView
index : Number
The index of the item touched
target : Ext.dom.Element/Ext.dataview.DataItem
The element or DataItem touched
record : Ext.data.Model
The record associated to the item
e : Ext.event.Event
The event object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Deprecated since version 6.5.0
Use childtouchcancel
Fires whenever an item is touched
this : Ext.dataview.DataView
index : Number
The index of the item touched
target : Ext.dom.Element/Ext.dataview.DataItem
The element or DataItem touched
record : Ext.data.Model
The record associated to the item
e : Ext.event.Event
The event object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Deprecated since version 6.5.0
Use childtouchend
Fires whenever an item is moved
this : Ext.dataview.DataView
index : Number
The index of the item moved
target : Ext.dom.Element/Ext.dataview.DataItem
The element or DataItem moved
record : Ext.data.Model
The record associated to the item
e : Ext.event.Event
The event object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Deprecated since version 6.5.0
Use childtouchmove
Fires whenever an item is touched
this : Ext.dataview.DataView
index : Number
The index of the item touched
target : Ext.dom.Element/Ext.dataview.DataItem
The element or DataItem touched
record : Ext.data.Model
The record associated to the item
e : Ext.event.Event
The event object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Deprecated since version 6.5.0
Use childtouchstart
This event fires when left changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of left.
oldValue : Number/String
The previous value of left.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when maxHeight changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of maxHeight.
oldValue : Number/String
The previous value of maxHeight.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when maxWidth changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of maxWidth.
oldValue : Number/String
The previous value of maxWidth.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when minHeight changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of minHeight.
oldValue : Number/String
The previous value of minHeight.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when minWidth changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of minWidth.
oldValue : Number/String
The previous value of minWidth.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a component si moved within its Container.
sender : Ext.Component
The component firing this event.
container : Ext.Container
Container which holds the component
toIndex : Number
The new index of the item.
fromIndex : Number
The old index of the item.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever this Element actually becomes visible (painted) on the screen. This is useful when you need to perform 'read' operations on the DOM element, i.e: calculating natural sizes and positioning.
Note: This event is not available to be used with event delegation. Instead painted only fires if you explicitly
add at least one listener to it, for performance reasons.
sender : Ext.Component
The component firing this event.
element : Ext.dom.Element
The component's outer element (this.element)
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever there is a change in the positioned status of a component
sender : Ext.Component
The component firing this event.
positioned : Boolean
The component's new positioned state. This becomes
true is a component is positioned using the cfg-top, cfg-right,
cfg-bottom or cfg-left configs.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever the DataView is refreshed
this : Ext.dataview.DataView
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This action following this event is preventable. When any of the listeners returns false, the action is cancelled.
Fires whenever the DataView is refreshed
this : Ext.dataview.DataView
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This action following this event is preventable. When any of the listeners returns false, the action is cancelled.
Fires when a component is removed from a Container
sender : Ext.Component
The component firing this event.
container : Ext.Container
Container which holds the component
index : Number
The index of the item that was removed.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is rendered into a container or derendered from a Container.
this : Ext.Container
The Container instance.
item : Object
The item in the Container.
rendered : Boolean
The current rendered status of the item.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Important note: For the best performance on mobile devices, use this only when you absolutely need to monitor a Element's size.
Note: This event is not available to be used with event delegation. Instead resize only fires if you explicitly
add at least one listener to it, for performance reasons.
element : Ext.dom.Element
The component's outer element (this.element).
info : Object
The component's new size parameters.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when right changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of right.
oldValue : Number/String
The previous value of right.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when scrollable changes.
sender : Ext.Component
The instance firing this event.
value : Boolean/String/Object
The current value of scrollable.
oldValue : Boolean/String/Object
The previous value of scrollable.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is selected
this : Ext.dataview.DataView
selected : Ext.data.Model/Ext.data.Model[]
The selected record(s). If selectable mode
is single, this will be a single Ext.data.Model. If
mode is simple or multi, this will be an array
of Ext.data.Model.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is selected
this : Ext.dataview.DataView
records : Ext.data.Model[]
The records being selected
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever the Component is shown
sender : Ext.Component
The component firing this event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when store changes.
sender : Ext.dataview.Abstract
The instance firing this event.
value : Ext.data.Store/Object
The current value of store.
oldValue : Ext.data.Store/Object
The previous value of store.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when top changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of top.
oldValue : Number/String
The previous value of top.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever the data of the component is updated
sender : Ext.Component
The component firing this event.
newData : Object
The new data
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when width changes.
sender : Ext.Widget
The instance firing this event.
value : Number/String
The current value of width.
oldValue : Number/String
The previous value of width.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
ExtReact | Terms of Use