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.
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.
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.
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
- 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.
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.dataview.Pinnable
Ext.mixin.Accessible
Ext.mixin.Bindable
Ext.mixin.ComponentDelegation
Ext.mixin.Factoryable
Ext.mixin.Focusable
Ext.mixin.Identifiable
Ext.mixin.Inheritable
Ext.mixin.Keyboard
Ext.mixin.Observable
Ext.mixin.Pluggable
Ext.mixin.Toolable
A simple header component for grouped lists. List headers are created automatically by Ext.dataview.List and should not be directly instantiated.
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.
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
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).
Ext.Viewport.add({
centered: true,
width: 100,
height: 100,
style: 'border: 1px solid blue;'
// ...
});
Ext.Viewport.add({
centered: true,
width: 100,
height: 100,
cls: 'my-component'
// ...
});
And your CSS file:
.my-component {
border: 1px solid red;
}
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
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 Ext.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
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.
Sets the value of controller
controller : String / Object / Ext.app.ViewController
The initial set of data to apply to the tpl
to
update the content area of the Component.
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
The default weight
for tools in the header
.
Defaults to:
{ toggle: 10, gear: 20, prev: 30, next: 40, left: 50, right: 60, down: 70, up: 80, refresh: 90, disclosure: 100, // was originally defined in ListItem plus: 100, minus: 110, search: 120, save: 130, print: 140, expand: 150, collapse: 160, help: 170, pin: 180, unpin: 190, minimize: 200, maximize: 210, restore: 220, close: 230 }
Available since: 6.5.0
Sets the value of defaultToolWeights
defaultToolWeights : Object
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
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
Sets the value of enterAnimation
enterAnimation : String / Mixed
A map of event type to the corresponding handler method name. This is used internally by native event handling mechanism.
Defaults to:
{ focus: 'handleFocusEvent', blur: 'handleBlurEvent' }
Animation effect to apply when the Component is being hidden.
Defaults to:
null
Deprecated since version 2.0.0
Sets the value of exitAnimation
exitAnimation : String / Mixed
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 Ext.util.Collection of Ext.data.Model in the group.
Defaults to:
null
Available since: 6.5.0
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
A String which specifies how this component's DOM element will be hidden. The accepted values are any of these:
'clip'
: Hide using clip.'display'
: Hide using display.'offsets'
: Hide using positioning offsets.'opacity'
: Hide using opacity.'visibility'
: Hide using visibility.Hiding using display
results in having no dimensions as well as resetting
scroll positions to 0.
The other modes overcome this but may have different trade-offs in certain circumstances.
Defaults to:
'display'
Available since: 6.5.0
Returns the value of hideMode
'clip' / 'display' / 'offsets' / 'opacity' / 'visibility'
Sets the value of hideMode
hideMode : 'clip' / 'display' / 'offsets' / 'opacity' / 'visibility'
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
{String/String[]
An extra CSS class or classes to augment the classCls on an individual instance
Defaults to:
null
Available since: 6.5.0
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'
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 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
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
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
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'
});
It can also be an array of plugin aliases:
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
}]
});
A final, yet very useful form (new in version 6.5) is the keyed-object form:
var list = Ext.create({
xtype: 'list',
itemTpl: '<div class="item">{title}</div>',
store: 'Items',
plugins: {
pullrefresh: true,
listpaging: {
autoPaging: true,
weight: 10
}
}
});
In this last form, the keys are id
's as well as the default type alias. The
advantage of this form is that the value of the plugins
is merged by base
class to derived class and finally to the instance configuration. This allows
classes to define a set of plugins and allow derived classes or instantiators
to configure or disable these plugins. This merge behavior is a feature of the
config.
In the above examples, the string "listpaging" is the type alias for
Ext.dataview.plugin.ListPaging
. The full alias includes the "plugin." prefix
(i.e., 'plugin.listpaging').
Defaults to:
null
Returns the value of plugins
Sets the value of plugins
plugins : Array / Ext.enums.Plugin / Object / Ext.plugin.Abstract
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:
null
Available since: 5.0.0
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 Ext.app.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
Optional element to render this Component to. Not required if this component is an item of a Container of a Container.
Defaults to:
null
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
Set to truthy, Color or Object value for the ripple.
Defaults to:
null
Available since: 6.5.0
color : String
The background color of the ripple.
position : Array
Position for the ripple to start at [x,y]. Determines if a Ripple effect should happen whenever this element is pressed. For example: { ripple: true } Or: { ripple: { color: 'red' } } For complex components, individual elements can suppress ripples by adding the `x-no-ripple` class to disable rippling for a tree of elements.
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:
null
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
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:
null
Return the actual tabIndex for this Focusable.
Set the tabIndex property for this Focusable. If the focusEl is available, set tabIndex attribute on it, too.
newTabIndex : Number
The properties of this object are shallow copied (via applyIf()
as opposed to Ext.merge() to each tool declared in the tools
config.
Defaults to:
{ xtype: 'tool', zone: 'end' }
An array of Ext.Tool configs or an object keyed by itemId
.
Defaults to:
null
Returns the value of tools
Ext.Tool[] / Object / Object[]
The tooltip for this component - can be a string to be used as innerHTML (html tags are accepted) or Ext.tip.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:
panX
panY
pinchZoom
doubleTapZoom
All touch actions are enabled (true
) by default, so it is usually only necessary
to specify which touch actions to disable. For example, the following disables
only horizontal scrolling and pinch-to-zoom on the component's main element:
touchAction: {
panX: false,
pinchZoom: false
}
Touch actions can be specified on reference elements using the reference element name, for example:
// disables horizontal scrolling on the main element, and double-tap-zoom
// on the child element named "body"
touchAction: {
panY: false
body: {
doubleTapZoom: false
}
}
The primary motivation for setting the touch-action of an element is to prevent the browser's default handling of a gesture such as pinch-to-zoom, or drag-to-scroll, so that the application can implement its own handling of that gesture on the element. Suppose, for example, a component has a custom drag handler on its element and wishes to prevent horizontal scrolling of its container while it is being dragged:
Ext.create('Ext.Widget', {
touchAction: {
panX: false
},
listeners: {
drag: function(e) {
// implement drag logic
}
}
});
Defaults to:
null
This is the normal tpl config but in this context, this Ext.XTemplate has access to a specialized data object. The data object available to the template provides the following properties:
name
The grouping string of the groupField
for the group header. This string is the string produced by grouper's
groupFn.value
The value of the groupField
for the group header being rendered.columnName
The column header associated with the field being grouped
by if there is a column for the field, falls back to the groupField
.groupField
The field name being grouped by.html
The rendering of the value
as handled by the cell (for a grid,
otherwise the same as name
).children
An array containing the child records for the group. This is not
available if the store is a Ext.data.BufferedStore.Available since: 6.5.0
The Ext.(X)Template method to use when updating the content area of the Component. Valid modes are:
Defaults to:
'overwrite'
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:
null
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
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
Sets the value of viewModel
viewModel : String / Object / Ext.app.ViewModel
This value controls this item's order in a weighted Ext.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
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 by specifying the
alias config option with a prefix of widget
. For example:
Ext.define('PressMeButton', {
extend: 'Ext.button.Button',
alias: 'widget.pressmebutton',
text: 'Press Me'
});
Any Component can be created implicitly as an object config with an xtype specified, allowing it to be declared and passed into the rendering pipeline without actually being instantiated as an object. Not only is rendering deferred, but the actual creation of the object itself is also deferred, saving memory and resources until they are actually needed. In complex, nested layouts containing many Components, this can make a noticeable improvement in performance.
// Explicit creation of contained Components:
var panel = new Ext.Panel({
// ...
items: [
Ext.create('Ext.button.Button', {
text: 'OK'
})
]
});
// Implicit creation using xtype:
var panel = new Ext.Panel({
// ...
items: [{
xtype: 'button',
text: 'OK'
}]
});
In the first example, the button will always be created immediately during the panel's initialization. With many added Components, this approach could potentially slow the rendering of the page. In the second example, the button will not be created or rendered until the panel is actually displayed in the browser. If the panel is never displayed (for example, if it is a tab that remains hidden) then the button will never be created and will never consume any resources whatsoever.
The value true
causes config
values to be stored on instances using a
property name prefixed with an underscore ("_") character. A value of false
stores config
values as properties using their exact name (no prefix).
Defaults to:
true
Available since: 5.0.0
The value true
instructs the initConfig
method to only honor values for
properties declared in the config
block of a class. When false
, properties
that are not declared in a config
block will be placed on the instance.
Defaults to:
true
Available since: 5.0.0
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.
The base CSS class to apply to this widget's element.
Used as the prefix for ui-specific class names.
Defaults to the value of classCls or (x-
+ the xtype) of the widget
if classCls is null
Defaults to:
null
A CSS class to apply to the main element that will be inherited down the class hierarchy. Subclasses may override this property on their prototype to add their own CSS class in addition to the CSS classes inherited from ancestor classes via the prototype chain. For example
Ext.define('Foo', {
extend: 'Ext.Widget',
classCls: 'foo'
});
Ext.define('Bar', {
extend: 'Foo',
classCls: 'bar'
});
var bar = new Bar();
console.log(bar.element.className); // outputs 'foo bar'
Defaults to:
null
When set to true
during widget class definition, that class will be the "root" for
classCls inheritance. Derived classes may set this to true
to avoid
inheriting a classCls from their superclass.
Defaults to:
true
Setting this property to false
will prevent nulling object references
on a Class instance after destruction. Setting this to "async"
will delay
the clearing for approx 50ms.
Defaults to:
true
Available since: 6.2.0
Setting this property to true
will result in setting the object's
prototype to null
after the destruction sequence is fully completed.
After that, most attempts at calling methods on the object instance
will result in "method not defined" exception. This can be very helpful
with tracking down otherwise hard to find bugs like runaway Ajax requests,
timed functions not cleared on destruction, etc.
Note that this option can only work in browsers that support Object.setPrototypeOf
method, and is only available in debugging mode.
Defaults to:
false
Available since: 6.2.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
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:
'html'
This property is set to true
after the destroy
method is called.
Defaults to:
false
A configuration object for Ext.Element.create() that is used to create the Element template. Subclasses should avoid overriding this property and instead add elements using template.
Supports all the standard options of a Ext.Element.create() config and adds 3 additional options:
reference
- this option specifies a name for Element references. These
references names become properties of the Widget instance and refer to Ext.Element
instances that were created using the template:
element: {
reference: 'element',
children: [{
reference: 'innerElement'
}]
}
After construction of a widget the reference elements are accessible as follows:
var foo = new FooWidget(),
innerEl = foo.innerElement; // an Ext.Element that wraps the innerElement
The reference attribute is optional, but all Widgets must have a 'element'
reference on some element within the template (usually the outermost one).
listeners
- a standard listeners object as specified by Ext.mixin.Observable.
element: {
reference: 'element',
listeners: {
click: 'onClick'
},
children: [{
reference: 'innerElement',
listeners: {
click: 'onInnerClick'
}
}]
}
Since listeners cannot be attached without an Ext.Element reference the reference
property MUST be specified in order to use listeners
.
The Widget instance is used as the scope for all listeners specified in this way,
so it is invalid to use the scope
option in the listeners
config since it will
always be overwritten using this
.
uiCls
- a suffix to be appended to the ui-specific CSS class for each ui
for this widget. These ui classes are constructed by appending the ui
to each
classCls
or baseCls
for the widget. As such, uiCls
should
never be used on the main element
reference, as its uiCls
is computed automatically.For example, assume a widget is defined with a ui
of 'alt action'
and a
uiCls
of 'inner-el'
on its innerElement
reference element:
Ext.define('Doodad', {
extend: 'Ext.Widget',
xtype: 'doodad',
classCls: 'x-doodad',
ui: 'alt action',
element: {
reference: 'element',
children: [{
reference: 'innerElement',
cls: 'x-inner-el',
uiCls: 'inner-el'
}]
}
});
This would result in the following markup when rendered:
<div class="x-doodad x-doodad-alt x-doodad-action">
<div class="x-inner-el x-doodad-inner-el x-doodad-alt-inner-el x-doodad-action-inner-el"></div>
</div>
These additional classes can be used to style the reference element for a particular
ui; however, use of uiCls
is not typically necessary or recommended. Reference
elements should usually be styled using simple descendant selectors:
.x-doodad-alt .x-inner-el {
color: red;
}
When there is a possibility that widgets can be nested it is best to use direct child selectors to avoid the possibility of selecting all descendants instead of just the reference element for the intended widget:
.x-doodad-alt > .x-inner-el {
color: red;
}
Only use uiCls
when there is a possibility of nesting, AND there may be a variable
number of elements between the main element
and the reference element in question.
For example, Ext.Container with docked items has a different number of elements
in between its element
and its bodyElement
than a Container without docked items
because of the wrapping elements that are dynamically added to support docking.
To ensure it does not style all descendants it must use a uiCls
to style its
bodyElement
:
.x-container-alt-body-el {
background: #fff;
}
Note that when uiCls
is specified it also adds a class name that does not contain
the ui
using just the classCls
and/or baseCls
as the prefix. This class name
can be used for base-level styling that does not relate to any particular UI:
.x-container-body-el {
position: relative;
}
Defaults to:
{ reference: 'element' }
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:
false
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 Ext.app.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
This property is set to true
during the call to initConfig
.
Defaults to:
false
Available since: 5.0.0
This property is set to true
if this instance is the first of its class.
Defaults to:
false
Available since: 5.0.0
This value is true
and is used to identify plain objects from instances of
a defined class.
Defaults to:
true
true
in this class to identify an object as an instantiated Observable, or subclass thereof.
Defaults to:
true
The CSS class to add to this component should not have a border.
Defaults to:
Ext.baseCSSPrefix + 'noborder-trbl'
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.
Get the reference to the current class from which this object was instantiated. Unlike Ext.Base#statics,
this.self
is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base#statics
for a detailed comparison
Ext.define('My.Cat', {
statics: {
speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
},
constructor: function() {
alert(this.self.speciesName); // dependent on 'this'
},
clone: function() {
return new this.self();
}
});
Ext.define('My.SnowLeopard', {
extend: 'My.Cat',
statics: {
speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'
}
});
var cat = new My.Cat(); // alerts 'Cat'
var snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'
var clone = snowLeopard.clone();
alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'
Defaults to:
Base
An array of child elements to use as the children of the main element in the element template. Only used if "children" are not specified explicitly in the element template.
Defaults to:
[]
The name of the reference element to use as the "anchor" for the tool zones. The start zone is inserted just prior to the anchor element and the tail and end zones are inserted immediately after.
Not applicable for Ext.Container instances as they use docked items to create the tool zones
Defaults to:
'bodyElement'
A map that tracks all reference elements configured with a uiCls
.
Contains the element
reference by default since the element
always gets
non-suffixed ui-specific CSS class names added to it (see syncUiCls)
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
Creates a particular plugin type if defined in the plugins
configuration.
Available since: 6.2.0
type : String
Ensures that the given property (if it is a Config System config) has a proper "updater" method on this instance to sync changes to the config.
Available since: 5.0.0
property : String
Adds a CSS class (or classes) to this Component's rendered element.
cls : String/String[]
prefix : String (optional)
Defaults to: ""
suffix : String (optional)
Defaults to: ""
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
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated
config.
deprecations : Object
Adds an element reference to this Widget instance.
name : String
domNode : HTMLElement
Reduces instantiation time for a Widget by lazily instantiating Ext.Element references the first time they are used. This optimization only works for elements with no listeners specified.
name : String
domNode : HTMLElement
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
fn : Function/String (optional)
scope : Object (optional)
options : Object (optional)
scope : Object
The scope (this
reference) in which the handler function is executed. If omitted,
defaults to the object which fired the event.
delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
onFrame : Number
Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.
target : Ext.util.Observable
Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
element : String
This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.
This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.
For example, to add a click listener to a Panel's body:
var panel = new Ext.panel.Panel({
title: 'The title',
listeners: {
click: this.handlePanelClick,
element: 'body'
}
});
In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.
panel.body.un(...)
delegate : String (optional)
A simple selector to filter the event target or look for a descendant of the target.
The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).
See the delegate example below.
capture : Boolean (optional)
When set to true
, the listener is fired in the capture phase of the event propagation
sequence, instead of the default bubble phase.
The capture
option is only available on Ext.dom.Element instances (or
when attaching a listener to a Ext.dom.Element via a Component using the
element option).
stopPropagation : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true
to call stopPropagation on the event object
before firing the handler.
preventDefault : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true
to call preventDefault on the event object
before firing the handler.
stopEvent : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true
to call stopEvent on the event object
before firing the handler.
args : Array (optional)
Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.
destroyable : Boolean (optional)
When specified as true
, the function returns a destroyable
object. An object
which implements the destroy
method which removes all listeners added in this call.
This syntax can be a helpful shortcut to using un; particularly when
removing multiple listeners. NOTE - not compatible when using the element
option. See un for the proper syntax for removing listeners added using the
element config.
Defaults to:
false
priority : Number (optional)
An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.
order : String (optional)
A legacy option that is provided for backward compatibility.
It is recommended to use the priority
option instead. Available options are:
'before'
: equal to a priority of 100
'current'
: equal to a priority of 0
or default priority'after'
: equal to a priority of -100
Defaults to:
'current'
order : String (optional)
Defaults to: 'current'
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
ename : Object/String
fn : Function/String (optional)
scope : Object (optional)
options : Object (optional)
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
component : Object
alignment : Object
options : Object
Available since: 5.0.0
binds : String/Object
currentBindings : Object
Applier for the plugins
config property.
plugins : String[]/Object[]/Ext.plugin.Abstract[]
oldPlugins : Ext.plugin.Abstract[]
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
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
scope : Object (optional)
args : Array (optional)
Call the original method that was previously overridden with Ext.Base#override
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.callOverridden();
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
args : Array/Arguments
Deprecated since version 4.1.0
Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext#define).
Ext.define('My.Base', {
constructor: function (x) {
this.x = x;
},
statics: {
method: function (x) {
return x;
}
}
});
Ext.define('My.Derived', {
extend: 'My.Base',
constructor: function () {
this.callParent([21]);
}
});
var obj = new My.Derived();
alert(obj.x); // alerts 21
This can be used with an override as follows:
Ext.define('My.DerivedOverride', {
override: 'My.Derived',
constructor: function (x) {
this.callParent([x*2]); // calls original My.Derived constructor
}
});
var obj = new My.Derived();
alert(obj.x); // now alerts 42
This also works with static and private methods.
Ext.define('My.Derived2', {
extend: 'My.Base',
// privates: {
statics: {
method: function (x) {
return this.callParent([x*2]); // calls My.Base.method
}
}
});
alert(My.Base.method(10)); // alerts 10
alert(My.Derived2.method(10)); // alerts 20
Lastly, it also works with overridden static methods.
Ext.define('My.Derived2Override', {
override: 'My.Derived2',
// privates: {
statics: {
method: function (x) {
return this.callParent([x*2]); // calls My.Derived2.method
}
}
});
alert(My.Derived2.method(10); // now alerts 40
To override a method and replace it and also call the superclass method, use method-callSuper. This is often done to patch a method to fix a bug.
args : Array/Arguments
This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.
Consider:
Ext.define('Ext.some.Class', {
method: function () {
console.log('Good');
}
});
Ext.define('Ext.some.DerivedClass', {
extend: 'Ext.some.Class',
method: function () {
console.log('Bad');
// ... logic but with a bug ...
this.callParent();
}
});
To patch the bug in Ext.some.DerivedClass.method
, the typical solution is to create an
override:
Ext.define('App.patches.DerivedClass', {
override: 'Ext.some.DerivedClass',
method: function () {
console.log('Fixed');
// ... logic but with bug fixed ...
this.callSuper();
}
});
The patch method cannot use method-callParent to call the superclass
method
since that would call the overridden method containing the bug. In
other words, the above patch would only produce "Fixed" then "Good" in the
console log, whereas, using callParent
would produce "Fixed" then "Bad"
then "Good".
args : Array/Arguments
Center this floated or positioned Component in its parent.
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
Converts the provided type or config object into a plugin instance.
config : String/Object/Ext.plugin.Abstract
Creates an event handling function which re-fires the event from this object as the passed event name.
newName : String
beginEnd : Array (optional)
Destroys the Widget. This method should not be overridden in custom Widgets, because it sets the flags and does final cleanup that must go last. Instead, override doDestroy method to add functionality at destruction time.
Destroys member properties by name.
If a property name is the name of a config, the getter is not invoked, so if the config has not been initialized, nothing will be done.
The property will be destroyed, and the corrected name (if the property is a config
and config names are prefixed) will set to null
in this object's dictionary.
args : String...
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
name : Object
fn : Object
scope : Object
options : Object
order : Object
caller : Object
manager : Object
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
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[]
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.
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
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
args : Array
fn : Function
scope : Object (optional)
options : Object (optional)
order : String (optional)
Defaults to: 'before'
Deprecated since version 5.5
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
args : Object...
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
args : Object[]
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
args : Array
fn : Function/String
scope : Object (optional)
fnArgs : Array/Boolean (optional)
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)
Find component(s) that label or describe this component, and return the id(s) of their ariaEl elements.
reference : Function/String/String[] (optional)
Gets the bubbling parent for an Observable
Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.
name : String (optional)
peek : Boolean (optional)
Defaults to: false
ifInitialized : Boolean (optional)
Defaults to: false
A template method for modifying the element config before it is processed.
By default adds the result of this.getTemplate()
as the children
array of
element if children
were not specified in the original
element config. Typically this method should not need to be implemented
in subclasses. Instead the element property should be use to configure
the element template for a given Widget subclass.
This method is called once when the first instance of each Widget subclass is created. The element config object that is returned is cached and used as the template for all successive instances. The scope object for this method is the class prototype, not the instance.
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)
Returns the main focus holder element associated with this Focusable, i.e. the element that will be focused when Focusable's focus method is called. For most Focusables, this will be the focusEl.
Retrieves the id of this component. Will autogenerate an id if one has not already been set.
This method returns an object containing the inherited properties for this instance.
Available since: 5.0.0
inner : Boolean (optional)
Defaults to: false
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
skipThis : Boolean (optional)
Defaults to: false
Returns the initial configuration passed to the constructor when instantiating this class.
Given this example Ext.button.Button definition and instance:
Ext.define('MyApp.view.Button', {
extend: 'Ext.button.Button',
xtype: 'mybutton',
scale: 'large',
enableToggle: true
});
var btn = Ext.create({
xtype: 'mybutton',
renderTo: Ext.getBody(),
text: 'Test Button'
});
Calling btn.getInitialConfig()
would return an object including the config
options passed to the create
method:
xtype: 'mybutton',
renderTo: // The document body itself
text: 'Test Button'
Calling btn.getInitialConfig('text')
returns 'Test Button'.
name : String (optional)
Returns the top-most modal floated component (other then this one) that resides in the same float container.
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
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 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 the element that the "rootCls" (x-root
) should be applied to.
Should always return the component's main element.
Overridden by Ext.viewport.Default to return the page body element
This method is required by the Scroller to return the scrollable client region
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'
Checks if the specified CSS class exists on this element's DOM node.
className : 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
Hides this Component optionally using an animation.
animation : Object/Boolean (optional)
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
Initialize configuration for this class. a typical example:
Ext.define('My.awesome.Class', {
// The default config
config: {
name: 'Awesome',
isAwesome: true
},
constructor: function(config) {
this.initConfig(config);
}
});
var awesome = new My.awesome.Class({
name: 'Super Awesome'
});
alert(awesome.getName()); // 'Super Awesome'
instanceConfig : Object
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.
Initializes the Element for this Widget instance. If this is the first time a Widget of this type has been instantiated the element config will be processed to create an Element. This Element is then cached on the prototype (see afterCachedConfig) so that future instances can obtain their element by simply cloning the Element that was cached by the first instance.
Called for the first instance of this Widget to create an object that contains the listener configs for all of the element references keyed by reference name. The object is cached on the prototype and has the following shape:
_elementListeners: {
element: {
click: 'onClick',
scope: this
},
fooReference: {
tap: {
fn: someFunction,
delay: 100
}
}
}
The returned object is prototype chained to the _elementListeners object of its superclass, and each key in the object is prototype chained to object with the corresponding key in the superclass _elementListeners. This allows element listeners to be inherited and overridden when subclassing widgets.
This method is invoked with the prototype object as the scope
elementConfig : Object
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.
Initializes a "uiReference". Ui rerefences are reference elements that have classCls and ui info in their CSS class names. They can be used by setting uiCls in the template, or by invoking this method to setup the ui reference after element/template initialization (Toolable uses this for its dock wrapper)
referenceName : String
uiCls : String
isInstance : Boolean (optional)
Defaults to: false
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.
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
Tests whether this Widget matches a Ext.ComponentQuery selector string.
selector : String
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
Determines if the passed property name is bound to ViewModel data.
Available since: 6.5.0
name : String (optional)
Determines whether this component is the descendant of a passed component.
ancestor : Ext.Component
Determines if this Component is inside a Component tree which is destroyed, or is being destroyed.
Returns true
if this Component is currently disabled.
Returns true
if this Component is not currently disabled.
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 Ext.Container for more information.
deep : Boolean (optional)
Defaults to: false
Returns true
if this Component is currently hidden.
deep : Boolean/Ext.Widget (optional)
Defaults to: false
Checks if all events, or a specific event, is suspended.
event : String (optional)
Checks if a particular binding is synchronizing the value.
name : String
Returns true
if this Component is currently visible.
A Widget is visible if its element is not hidden, and has been rendered and has not been destroyed.
deep : Boolean (optional)
Defaults to: false
Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from the xtype (default) or whether it is directly of the xtype specified (shallow = true
).
**If using your own subclasses, be aware that a Component must register its own xtype
to participate in determination of inherited xtypes.__
For a list of all available xtypes, see the Ext.Component header.
Example usage:
var t = new Ext.field.Text();
var isText = t.isXType('textfield'); // true
var isBoxSubclass = t.isXType('field'); // true, descended from Ext.field.Field
var isBoxInstance = t.isXType('field', true); // false, not a direct Ext.field.Field instance
xtype : String
shallow : Boolean (optional)
Adds a "destroyable" object to an internal list of objects that will be destroyed
when this instance is destroyed (via destroy
).
name : String
value : Object
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)
Defaults to: false
Gets the Form or Component that is used as the name holder for this component.
Available since: 6.5.0
skipThis : Boolean (optional)
Defaults to: true
Gets the Controller or Component that is used as the reference holder for this view.
Available since: 5.0.0
skipThis : Boolean (optional)
Defaults to: true
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)
Defaults to: false
Gets a named template instance for this class. See Ext.XTemplate#getTpl.
Available since: 6.2.0
name : String
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)
Defaults to: false
Returns an update
method for the given Config that will call publishState
to ensure two-way bindings (via bind
) as well as any publishes
are updated.
This method is cached on the cfg
instance for re-use.
Available since: 5.0.0
cfg : Ext.Config
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
ename : Object/String
fn : Function/String (optional)
scope : Object (optional)
options : Object (optional)
Shorthand for removeManagedListener. Removes listeners that were added by the mon method.
item : Ext.util.Observable/Ext.dom.Element
ename : Object/String
fn : Function (optional)
scope : Object (optional)
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
fn : Function/String (optional)
scope : Object (optional)
options : Object (optional)
scope : Object
The scope (this
reference) in which the handler function is executed. If omitted,
defaults to the object which fired the event.
delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
onFrame : Number
Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.
target : Ext.util.Observable
Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
element : String
This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.
This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.
For example, to add a click listener to a Panel's body:
var panel = new Ext.panel.Panel({
title: 'The title',
listeners: {
click: this.handlePanelClick,
element: 'body'
}
});
In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.
panel.body.un(...)
delegate : String (optional)
A simple selector to filter the event target or look for a descendant of the target.
The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).
See the delegate example below.
capture : Boolean (optional)
When set to true
, the listener is fired in the capture phase of the event propagation
sequence, instead of the default bubble phase.
The capture
option is only available on Ext.dom.Element instances (or
when attaching a listener to a Ext.dom.Element via a Component using the
element option).
stopPropagation : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true
to call stopPropagation on the event object
before firing the handler.
preventDefault : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true
to call preventDefault on the event object
before firing the handler.
stopEvent : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true
to call stopEvent on the event object
before firing the handler.
args : Array (optional)
Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.
destroyable : Boolean (optional)
When specified as true
, the function returns a destroyable
object. An object
which implements the destroy
method which removes all listeners added in this call.
This syntax can be a helpful shortcut to using un; particularly when
removing multiple listeners. NOTE - not compatible when using the element
option. See un for the proper syntax for removing listeners added using the
element config.
Defaults to:
false
priority : Number (optional)
An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.
order : String (optional)
A legacy option that is provided for backward compatibility.
It is recommended to use the priority
option instead. Available options are:
'before'
: equal to a priority of 100
'current'
: equal to a priority of 0
or default priority'after'
: equal to a priority of -100
Defaults to:
'current'
order : String (optional)
Defaults to: 'current'
Appends an after-event handler.
Same as addListener with order
set
to 'after'
.
eventName : String/String[]/Object
fn : Function/String
scope : Object (optional)
options : Object (optional)
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
fn : Function/String
scope : Object (optional)
options : Object (optional)
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
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 this Inheritable is added to a parent
parent : Object
instanced : Boolean
Called when this inheritable is removed from a parent
destroying : Boolean
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
height : Number
oldWidth : Number
oldHeight : Number
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
y : Number
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
y : Number
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
y : Number
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
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
Recursively processes the element templates for this class and its superclasses, ascending the hierarchy until it reaches a superclass whose element template has already been processed. This method is invoked using the prototype as the scope.
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)
value : Object (optional)
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
events : String[]/Object
prefix : String (optional)
Removes the given CSS class(es) from this widget's primary element.
cls : String/String[]
prefix : String (optional)
Defaults to: ""
suffix : String (optional)
Defaults to: ""
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 event handler.
eventName : String
fn : Function
scope : Object (optional)
Removes listeners that were added by the mon method.
item : Ext.util.Observable/Ext.dom.Element
ename : Object/String
fn : Function (optional)
scope : Object (optional)
Remove a single managed listener item
isClear : Boolean
managedListener : Object
item : Object
ename : String
fn : Function
scope : Object
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
destroy : Boolean (optional)
Replaces specified classes with the newly specified classes. It uses the addCls and removeCls methods, so if the class(es) you are removing don't exist, it will still add the new classes.
oldCls : String/String[]
newCls : String/String[]
prefix : String (optional)
Defaults to: ""
suffix : String (optional)
Defaults to: ""
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
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)
Defaults to: this
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)
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...
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)
Sets a single/multiple configuration options.
name : String/Object
value : Object (optional)
Sets the size of the Component.
width : Number
height : Number
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)
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
y : Number (optional)
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
alignment : String (optional)
options : Object (optional)
Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base#self,
this.statics()
is scope-independent and it always returns the class from which it was called, regardless of what
this
points to during run-time
Ext.define('My.Cat', {
statics: {
totalCreated: 0,
speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
},
constructor: function() {
var statics = this.statics();
alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to
// equivalent to: My.Cat.speciesName
alert(this.self.speciesName); // dependent on 'this'
statics.totalCreated++;
},
clone: function() {
var cloned = new this.self(); // dependent on 'this'
cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName
return cloned;
}
});
Ext.define('My.SnowLeopard', {
extend: 'My.Cat',
statics: {
speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'
},
constructor: function() {
this.callParent();
}
});
var cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'
var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
var clone = snowLeopard.clone();
alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'
alert(clone.groupName); // alerts 'Cat'
alert(My.Cat.totalCreated); // alerts 3
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...
Suspends the firing of all events. (see resumeEvents)
queueSuspended : Boolean
Synchronizes an alignment cls on the tool dock wrapper when the alignment changes.
Only applicable for toolable components that have an align
config such as
grid cells and column headers
Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).
className : String
state : Boolean (optional)
Shorthand for removeListener. Removes an event handler.
eventName : String
fn : Function
scope : Object (optional)
Removes a before-event handler.
Same as removeListener with order
set to 'after'
.
eventName : String/String[]/Object
fn : Function/String
scope : Object (optional)
options : Object (optional)
Removes a before-event handler.
Same as removeListener with order
set to 'before'
.
eventName : String/String[]/Object
fn : Function/String
scope : Object (optional)
options : Object (optional)
Destroys a given set of linked
objects. This is only needed if
the linked object is being destroyed before this instance.
names : String[]
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)
limit : String/Number/Ext.Component (optional)
All cls methods directly report to the cls configuration, so anytime it changes, updateCls will be called
newCls : Object
oldCls : Object
Updates the viewModel config.
viewModel : Ext.app.ViewModel
oldViewModel : Ext.app.ViewModel
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
args : Object[] (optional)
Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.
config : Object
mixinClass : Ext.Class (optional)
Add methods / properties to the prototype of this class.
Ext.define('My.awesome.Cat', {
constructor: function() {
...
}
});
My.awesome.Cat.addMembers({
meow: function() {
alert('Meowww...');
}
});
var kitty = new My.awesome.Cat();
kitty.meow();
members : Object
isStatic : Boolean (optional)
Defaults to: false
privacy : Boolean (optional)
Defaults to: false
Add / override static properties of this class.
Ext.define('My.cool.Class', {
...
});
My.cool.Class.addStatics({
someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'
method1: function() { ... }, // My.cool.Class.method1 = function() { ... };
method2: function() { ... } // My.cool.Class.method2 = function() { ... };
});
members : Object
Borrow another class' members to the prototype of this class.
Ext.define('Bank', {
money: '$$$',
printMoney: function() {
alert('$$$$$$$');
}
});
Ext.define('Thief', {
...
});
Thief.borrow(Bank, ['money', 'printMoney']);
var steve = new Thief();
alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'
fromClass : Ext.Base
members : Array/String
Create a new instance of this Class.
Ext.define('My.cool.Class', {
...
});
My.cool.Class.create({
someConfig: true
});
All parameters are passed to the constructor of the class.
Create aliases for existing prototype methods. Example:
Ext.define('My.cool.Class', {
method1: function() { ... },
method2: function() { ... }
});
var test = new My.cool.Class();
My.cool.Class.createAlias({
method3: 'method1',
method4: 'method2'
});
test.method3(); // test.method1()
My.cool.Class.createAlias('method5', 'method3');
test.method5(); // test.method3() -> test.method1()
alias : String/Object
origin : String/Object
Returns the Ext.Configurator
for this class.
Get the current class' name in string format.
Ext.define('My.cool.Class', {
constructor: function() {
alert(this.self.getName()); // alerts 'My.cool.Class'
}
});
My.cool.Class.getName(); // 'My.cool.Class'
Used internally by the mixins pre-processor
name : Object
mixinClass : Object
Override members of this class. Overridden methods can be invoked via callParent.
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
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
Fires after a Component had been added to a Container.
this : Ext.Component
container : Ext.Container
index : Number
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when bottom
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when centered
changes.
sender : Ext.Component
value : Boolean
oldValue : Boolean
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when disabled
changes.
sender : Ext.Widget
value : Boolean
oldValue : Boolean
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when docked
changes.
sender : Ext.Component
value : String
oldValue : String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when height
changes.
sender : Ext.Widget
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before the Component is hidden. Hide may be vetoed by returning false
from a handler.
this : Ext.Component
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when left
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when maxHeight
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when maxWidth
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when minHeight
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when minWidth
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when right
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when scrollable
changes.
sender : Ext.Component
value : Boolean/String/Object
oldValue : Boolean/String/Object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before the Component is shown. Show may be vetoed by returning false
from a handler.
this : Ext.Component
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when top
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when width
changes.
sender : Ext.Widget
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when this Component's focusEl loses focus.
this : Ext.Component
event : Ext.event.Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when bottom
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when centered
changes.
sender : Ext.Component
value : Boolean
oldValue : Boolean
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when disabled
changes.
sender : Ext.Widget
value : Boolean
oldValue : Boolean
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when docked
changes.
sender : Ext.Component
value : String
oldValue : String
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.
this : Ext.Component
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever there is a change in the positioned status of a component
this : Ext.Component
positioned : Boolean
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Deprecated since version 6.2.0
Fires when this Component's focusEl receives focus.
this : Ext.Component/Ext.Widget
event : Ext.event.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
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
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever a Component with the fullscreen config is instantiated
this : Ext.Component
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when height
changes.
sender : Ext.Widget
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever the Component is hidden
this : Ext.Component
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the component has been initialized
this : Ext.Component
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when left
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when maxHeight
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when maxWidth
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when minHeight
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when minWidth
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a component si moved within its Container.
this : Ext.Component
container : Ext.Container
toIndex : Number
fromIndex : Number
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.
element : Ext.dom.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
this : Ext.Component
positioned : Boolean
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a component is removed from a Container
this : Ext.Component
container : Ext.Container
index : Number
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
info : Object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when right
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when scrollable
changes.
sender : Ext.Component
value : Boolean/String/Object
oldValue : Boolean/String/Object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever the Component is shown
this : Ext.Component
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when top
changes.
sender : Ext.Component
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever the data of the component is updated
this : Ext.Component
newData : Object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when width
changes.
sender : Ext.Widget
value : Number/String
oldValue : Number/String
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
List ItemHeader background-color
Defaults to:
$neutral-light-color
List ItemHeader border-color
Defaults to:
$neutral-medium-dark-color
List ItemHeader border-width
Defaults to:
$listitem-border-width
List ItemHeader outline-color when focused
Defaults to:
$listitem-focused-outline-color
List ItemHeader outline-offset when focused
Defaults to:
$listitem-focused-outline-offset
List ItemHeader outline-style when focused
Defaults to:
$listitem-focused-outline-style
List ItemHeader outline-width when focused
Defaults to:
$listitem-focused-outline-width
List ItemHeader font-size in the big sizing scheme
Defaults to:
$listitem-font-size-big
List ItemHeader font-weight
Defaults to:
$font-weight-bold
List ItemHeader line-height in the big sizing scheme
Defaults to:
$listitem-line-height-big
List ItemHeader padding in the big sizing scheme
Defaults to:
$listitem-padding-big
List ItemHeader background-color when pinned
Defaults to:
null
List ItemHeader box-shadow when pinned to the bottom
Defaults to:
$listitem-pinned-bottom-box-shadow
List ItemHeader box-shadow when pinned
Defaults to:
$listitem-pinned-box-shadow
Creates a visual theme for a List ItemHeader.
$ui : String
$xtype : String (optional)
Defaults to: itemheader
$color : color
$pinned-color : color
$background-color : color
$pinned-background-color : color
$border-width : Number/list
$border-style : String
$border-color : color
$pinned-border-color : color
$focused-outline-width : Number
$focused-outline-style : String
$focused-outline-color : color
$focused-outline-offset : Number
$box-shadow : list
$pinned-box-shadow : list
$pinned-bottom-box-shadow : list
$font-weight : String/Number
$font-size : Number
$font-size-big : Number
$line-height : Number
$line-height-big : Number
$font-family : String
$padding : Number/list
$padding-big : Number/list
Toolable components need special handling for their padding. When there are no tools (which usually means no dock wrapper) the padding on all sides is placed on the body-el, However, when the component has tools, the horizontal padding needs to be removed from the body-el and placed on the innermost dock wrapper so that the horizontal padding is between the outermost tools and the left/right edges of the component. In this configuration the space between the body and the tools is provided by the tools themselves via $tool-spacing.
The vertical padding remains on the body-el so that the height of the toolable component when auto-heighted is determined by the body-el's line-height + padding + the element borders. The tools gain an additional advantage from this arrangement because it means they can be taller than the component's line-height and not cause the component's height to increase since they are not "inside" of the vertical padding.
$ui : Object (optional)
Defaults to: null
$xtype : Object (optional)
Defaults to: null
$padding : Object (optional)
Defaults to: null
$padding-big : Object (optional)
Defaults to: null
$anchor : Object (optional)
Defaults to: body-el