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.mixin.Accessible
Ext.mixin.Bindable
Ext.mixin.ComponentDelegation
Ext.mixin.Container
Ext.mixin.Factoryable
Ext.mixin.Focusable
Ext.mixin.FocusableContainer
Ext.mixin.Identifiable
Ext.mixin.Inheritable
Ext.mixin.Keyboard
Ext.mixin.Observable
Ext.mixin.Pluggable
Ext.mixin.Queryable
Ext.mixin.Toolable
Ext.mixin.Traversable
A 'Toast' is a simple modal message that is displayed on the screen and then automatically closed by a timeout or by a user tapping outside of the toast itself. Think about it like a text only alert box that will self destruct. A Toast should not be instantiated manually but creating by calling 'Ext.toast(message, timeout)'. This will create one reusable toast container and content will be swapped out as toast messages are queued or displayed.
DOM tabIndex attribute to set on the active Focusable child of this container when using the "Roaming tabindex" technique.
Defaults to:
0
The item from the cfg-items collection that will be active first. This is usually only meaningful in a Ext.layout.Card, where only one item can be active at a time. If passes a string, it will be assumed to be a Ext.ComponentQuery selector.
Defaults to:
0
Set this to true
to enable focusing disabled child items via keyboard.
Defaults to:
false
A flag indicating that this component should be above its floated siblings.
This may be a positive number to prioritize the ordering of multiple visible always on top components.
This may be set to a negative number to prioritize a component to the bottom of the z-index stack.
Defaults to:
false
Available since: 6.2.0
Configure true to show an anchor element pointing to the target component when this Panel is
shown by another component.
Defaults to:
false
Set the anchor position.
Defaults to:
null
Sets the value of anchorPosition
anchorPosition : String
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, child items will be destroyed as soon as they are removed
from this container.
Defaults to:
true
May be set to false for improved layout performance if auto-sizing is not required.
Some versions of Safari, both desktop and mobile, have very slow performance if the application has deeply nested containers due to the following WebKit bug: https://bugs.webkit.org/show_bug.cgi?id=150445
Applications that experience performance issues in the affected versions of
Safari may need to turn off autoSizing globally for all Ext.Container instances
by placing the following override in the application's "overrides" directory:
Ext.define('MyApp.overrides.Container', {
override: 'Ext.Container',
config: {
autoSize: false
}
});
Once auto-sizing support has turned off by default, it can be selectively
turned back on only on those container instances that explicitly need auto-sizing
behavior by setting autoSize to true.
This option can also be used to allow items to be sized in percentage units as a workaround for the following browser bug: https://bugs.webkit.org/show_bug.cgi?id=137730
To illustrate, the following example should render a 200px by 200px green box
(the container) with a yellow box inside of it (the child item). The child
item's height and width are both set to '50%' so the child should render
exactly 100px by 100px in size.
All browsers except for Safari render the previous example correctly, but
Safari does not assign a height to the component. To make percentage-sized
items work in Safari, simply set autoSize to false on the container.
Since the underlying implementation works by absolutely positioning the container's
body element, this option can only be used when the container is not
"shrink wrapping" the content in either direction. When autoSize is
set to false, shrink wrapped dimension(s) will collapse to 0.
Defaults to:
true
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
Convenience config. Short for 'Bottom Bar'.
is equivalent to
Defaults to:
null
Available since: 6.5.0
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
true to enable the border around the panel body (as defined by the theme)
Note that even when enabled, the bodyBorder is only visible when there are docked
items around the edges of the panel. Where the bodyBorder touches the panel's outer
border it is automatically collapsed into a single border.
false to disable the body border
null - use the value of border as the value for bodyBorder
Defaults to:
null
A shortcut for setting a padding style on the body element. The value can either be a number to be applied to all sides, or a normal CSS string describing padding.
Defaults to:
null
Custom CSS styles to be applied to the panel's body element, which can be supplied as a valid CSS style string or an object containing style property name/value pairs. For example, these two formats are interpreted to be equivalent:
bodyStyle: 'background:#ffc; padding:10px;'
bodyStyle: {
background: '#ffc',
padding: '10px'
}
Defaults to:
null
Available since: 6.5.0
Enables or disables bordering on this component. The following values are accepted:
null or `true (default): Do nothing and allow the border to be specified by the theme.false: suppress the default border provided by the theme.Please note that enabling bordering via this config will not add a border-color
or border-style CSS property to the component; you provide the border-color
and border-style via CSS rule or style configuration
(if not already provide by the theme).
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:
false
The absolute bottom position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
Explicitly setting this value will make this Component become 'positioned', which means it will no
longer participate in the layout of the Container that it resides in.
Defaults to:
null
Animation to be used during transitions of cards.
This method has been REMOVED since 2.0.0
Whether or not this component is absolutely centered inside its container.
Defaults to:
false
True to display the 'close' tool button and allow the user to close the panel, false to hide the button and disallow closing the window.
By default, when close is requested by clicking the close button in the header, the method-close method will be called. This will destroy the Panel and its content meaning that it may not be reused.
To make closing a Panel hide the Panel so that it may be reused, set closeAction to 'hide'.
Defaults to:
null
The action to take when the close header tool is clicked:
'method-destroy' :
remove the window from the DOM and destroy it and all descendant Components. The window will not be available to be redisplayed via the method-show method.
'method-hide' :
method-hide the window by setting visibility to hidden and applying negative offsets. The window will be available to be redisplayed via the method-show method.
Note: This behavior has changed! setting does affect the method-close method which will invoke the appropriate closeAction.
Defaults to:
'destroy'
Text to be announced by screen readers when the close Ext.Tool is focused. Will also be set as the close tool's tooltip text.
Note: Applicable when the panel is closable: true
Defaults to:
'Close panel'
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
A configuration for a Ext.panel.Collapser.
True to make the panel collapsible and have an expand/collapse toggle Tool added into the header tool button area.
You can also set top/right/bottom/left to directly specify the collapse direction.
Defaults to:
null
Available since: 6.5.0
Returns the value of collapsible
Sets the value of collapsible
collapsible : 'top' / 'right' / 'bottom' / 'left' / Boolean / Object
A specification of the constraint to apply when showBy or alignTo is called to align a floated or positioned component.
Defaults to the parent container for positioned components (components which have their top, right, bottom or left set to move them out of their container's layout flow).
Defaults to the viewport for floated components.
May be a Ext.ComponentQuery selector to find an ancestor component to constrain within.
May be false to specify that constraining is not applied.
You may also specify an element, or a Ext.util.Region
Defaults to:
null
Returns the value of constrainAlign
Sets the value of constrainAlign
constrainAlign : String / Ext.util.Region / Ext.dom.Element
The configured element will automatically be added as the content of this component. When you pass a string, we expect it to be an element id. If the content element is hidden, we will automatically show it.
Defaults to:
null
Returns the value of contentEl
Ext.dom.Element / HTMLElement / String
Sets the value of contentEl
contentEl : Ext.dom.Element / HTMLElement / String
Enables you to easily control Components inside this Container by listening to their events and taking some action. For example, if we had a container with a nested Disable button, and we wanted to hide the Container when the Disable button is tapped, we could do this:
We used a Ext.ComponentQuery selector to listen to the tap event on any
Ext.Button anywhere inside the Container that has the text 'Disable'.
Whenever a Component matching that selector fires the tap event our hideMe function is called. hideMe is
called with scope: this (e.g. this is the Container instance).
Defaults to:
null
A string alias, a configuration object or an instance of a ViewController for
this container. Sample usage:
Ext.define('MyApp.UserController', {
alias: 'controller.user'
});
Ext.define('UserContainer', {
extend: 'Ext.container.container',
controller: 'user'
});
// Or
Ext.define('UserContainer', {
extend: 'Ext.container.container',
controller: {
type: 'user',
someConfig: true
}
});
// Can also instance at runtime
var ctrl = new MyApp.UserController();
var view = new UserContainer({
controller: ctrl
});
Defaults to:
null
Returns the Ext.app.ViewController instance associated with this component via the controller config or setController method.
Returns this component's ViewController or null if one was not configured
Sets the value of controller
controller : String / Object / Ext.app.ViewController
Set to true to display the menu using cover style. The menu will be shown over the Viewport from the specified side. By default, the menu will be modal, displaying a mask over the rest of the Viewport, and the user may tap on the mask to dismiss the menu.
Defaults to:
null
The initial set of data to apply to the tpl to
update the content area of the Component.
Note: Data will be appended to any existing data.
Defaults to:
null
Specifies a child Component to receive focus when this Container's method-focus method is called. Should be a valid Ext.ComponentQuery selector.
Defaults to:
null
If true, this component will be the default scope (this pointer) for events
specified with string names so that the scope can be dynamically resolved. The
component will automatically become the defaultListenerScope if a
controller is specified.
See the introductory docs for Ext.container.Container for some sample usages.
NOTE: This value can only be reliably set at construction time. Setting it after that time may not correctly rewire all of the potentially effected listeners.
Defaults to:
false
Sets the value of defaultListenerScope
defaultListenerScope : Boolean
A set of default configurations to apply to all child Components in this Container. It's often useful to specify defaults when creating more than one items with similar configurations. For example here we can specify that each child is a panel and avoid repeating the xtype declaration for each one:
Defaults to:
null
The default 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,
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
The default Ext.Component of child Components to create in this Container when a child item is specified as a raw configuration object, rather than as an instantiated Component.
Defaults to:
null
Set to true to call show and false to call hide. Unlike the hidden
config, changing this config will potentially involve animations to show or
hide the component.
Defaults to:
null
Available since: 6.5.0
The dock position of this component in its container. Can be left, top, right or bottom.
Notes
You must use a HTML5 doctype for docked bottom to work. To do this, simply add the following code to the HTML file:
<!doctype html>
So your index.html file should look a little like this:
<!doctype html>
<html>
<head>
<title>MY application title</title>
...
Defaults to:
null
Set to true to allow this component to be dragged. This can also be the config
object for the Ext.drag.Source that will manage the drag.
Defaults to:
null
Sets the value of draggable
draggable : Boolean / Object / Ext.drag.Source
The viewport side used as the enter point when shown. Valid values are 'top', 'bottom', 'left', and 'right'. Applies to sliding animation effects only.
Defaults to:
'bottom'
Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'.
Defaults to:
null
Deprecated since version 2.0.0
Please use showAnimation instead.
Sets the value of enterAnimation
enterAnimation : String / Mixed
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'
}
The viewport side used as the exit point when hidden. Valid values are 'top', 'bottom', 'left', and 'right'. Applies to sliding animation effects only.
Defaults to:
'bottom'
Animation effect to apply when the Component is being hidden.
Defaults to:
null
Deprecated since version 2.0.0
Please use hideAnimation instead. Typically you want to use an
outbound animation type such as 'fadeOut' or 'slideOut'.
Sets the value of exitAnimation
exitAnimation : String / Mixed
The flex of this item if this item item is inside a Ext.layout.HBox or Ext.layout.VBox layout.
You can also update the flex of a component dynamically using the Ext.layout.FlexBox#setItemFlex method.
When supplied as a string or number this option supports the same syntax as CSS href="https://developer.mozilla.org/en-US/docs/Web/CSS/flex" class="external-link" target="_blank">https://developer.mozilla.org/en-US/docs/Web/CSS/flex flex. For example:
flex: '1 2 auto'
sets flex-grow property to 0, flex-shrink to 2 and flex-basis to
'auto'.
The default flex-shrink value for box layout items is set to 0 in the
stylesheet, which is different from the browser's default flex-shrink value
of 1. This accommodates the majority use case for applications since where
non-flexed components are typically not expected to shrink smaller than their
default size.
For convenience when only a single number is supplied it is used as the value
for both flex-grow and flex-shrink, for example flex: 3 is the same as
flex: '3 3'
An object form is also accepted:
flex: {
grow: 1,
shrink: 2,
basis: 'auto'
}
When the object form is supplied shrink always defaults to 0 regardless
of the value of grow.
Although 'auto' is the default value for flex-basis, flex-basis defaults to 0%
when flex is supplied as a single numeric or string value (e.g. flex: 1). If
this behavior is not desired either explicitly set flex-basis to 'auto' or use
the object form to set only grow and/or shrink:
flex: {
grow: 2
}
Defaults to:
null
A Component may be floated above all other components in the application. This means that the component is absolutely positioned, and will move to the front and occlude other sibling floated component if clicked.
A Floated component may have floated descendants. It will bring these decendants to the front with it when brought to the front of its sibling floated components.
By default, descendant floated components are all positioned using the viewport coordinate system. To make a floating
component a positioning parent for descendants, and have the ancestors positioned relatively, configure the parent
floated component with cfg-relative: true.
Defaults to:
false
Available since: 6.2.0
Enable or disable navigation with arrow keys for this FocusableContainer. This option may be useful with nested FocusableContainers, when only the root container should handle keyboard events.
Defaults to:
false
CSS class that will be added to focused component's focusClsEl, and removed when component blurs.
Defaults to:
'x-focused'
Force the component to take up 100% width and height available, by adding it to Ext.Viewport.
Pass as false to prevent a header from being created.
You may also assign a header with a config object (optionally containing an xtype)
to custom-configure your panel's header.
See Ext.panel.Header for all the options that may be specified here.
Defaults to:
null
The position of the header. Ignored if no cfg-header is created.
Defaults to:
'top'
Available since: 6.5.0
Returns the value of headerPosition
'top' / 'right' / 'bottom' / 'left'
Sets the value of headerPosition
headerPosition : 'top' / 'right' / 'bottom' / 'left'
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:
{
type: 'popOut',
duration: 250,
easing: 'ease-out'
}
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:
true
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
Path to an image to use as an icon.
For instructions on how you can use icon fonts including those distributed in the SDK see iconCls.
Defaults to:
null
The side of the title to render the icon.
Defaults to:
'left'
Returns the value of iconAlign
'top' / 'right' / 'bottom' / 'left'
Sets the value of iconAlign
iconAlign : 'top' / 'right' / 'bottom' / 'left'
One or more space separated CSS classes to be applied to the icon element. The CSS rule(s) applied should specify a background image to be used as the icon.
An example of specifying a custom icon class would be something like:
// specify the property in the config for the class:
iconCls: 'my-home-icon'
// css rule specifying the background image to be used as the icon image:
.my-home-icon {
background-image: url(../images/my-home-icon.gif) !important;
}
In addition to specifying your own classes, you can use the font icons provided in the SDK using the following syntax:
// using Font Awesome
iconCls: 'x-fa fa-home'
// using Pictos
iconCls: 'pictos pictos-home'
Depending on the theme you're using, you may need include the font icon packages in your application in order to use the icons included in the SDK. For more information see:
Defaults to:
null
The unique id of this component instance.
It should not be necessary to use this configuration except for singleton objects in your application. Components created with an id may be accessed globally using Ext.getCmp.
Instead of using assigned ids, use the itemId config, and Ext.ComponentQuery which provides selector-based searching for Sencha Components analogous to DOM querying. The Ext.Container class contains shortcut methods to query its descendant Components by selector.
Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent.
Note: to avoid complications imposed by a unique id also see itemId.
Defaults to an auto-assigned id.
Retrieves the id of this component. Will autogenerate an id if one has not already been set.
id
DOM tabIndex attribute to set on inactive Focusable children of this container when using the "Roaming tabindex" technique. This value rarely needs to be changed from its default.
Defaults to:
-1
A string to add to the immediate parent element of the inner items of this
container. That is, items that are not docked, positioned or floated. In
some containers, positioned items may be in this same element.
Defaults to:
null
Available since: 6.5.0
{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 itemId can be used as an alternative way to get a reference to a component when no object reference is
available. Instead of using an id with Ext#getCmp, use itemId with
Ext.Container#getComponent which will retrieve itemId's or id's. Since itemId's are an
index to the container's internal MixedCollection, the itemId is scoped locally to the container - avoiding
potential conflicts with Ext.ComponentManager which requires a unique id.
Also see id, Ext.Container#query, Ext.Container#down and Ext.Container#child.
Defaults to:
undefined
The child items to add to this Container. This is usually an array of Component configurations or instances, for example:
This may also be specified as an object, the property names of which are itemIds, and the property values
are child Component config objects, for example:
Defaults to:
null
An object containing handlers for keyboard events. The property names of this object are the key name and any modifiers. The values of the properties are the descriptors of how to handle each event.
The handler descriptor can be simply the handler function (either the literal function or the method name), or it can be an object with these properties:
handler: The function or its name to call to handle the event.scope: The this pointer context (can be "this" or "controller").event: An optional override of the key event to which to listen.Important: Calls to setKeyMap do not replace the entire keyMap but
instead update the provided mappings. That is, unless null is passed as the
value of the keyMap which will clear the keyMap of all entries.
Defaults to:
null
scope : String
The default scope to apply to key handlers
which do not specify a scope. This is processed the same way as the scope of
cfg-listeners. It defaults to the "controller", but using 'this'
means that an instance method will be used.
Enables or disables processing keys in the keyMap. This value starts as
null and if it is null when initKeyMap is called, it will automatically
be set to true. Since initKeyMap is called by Ext.Component at the
proper time, this is not something application code normally handles.
Defaults to:
null
The name of the member that should be used to listen for keydown/keypress events. This is intended to be controlled at the class level not per instance.
Defaults to:
'el'
Configuration for this Container's layout. Example:
Defaults to:
{
type: 'vbox',
pack: 'center'
}
Convenience config. Short for 'Left Bar' (left-docked, vertical toolbar).
is equivalent to
Defaults to:
null
Available since: 6.5.0
The absolute left position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
Explicitly setting this value will make this Component become 'positioned', which means it will no
longer participate in the layout of the Container that it resides in.
Defaults to:
null
A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.
DOM events from Ext JS Ext.Component
While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually
only done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a
child element of a Component, we need to specify the element option to identify the Component property to add a
DOM listener to:
new Ext.panel.Panel({
width: 400,
height: 200,
dockedItems: [{
xtype: 'toolbar'
}],
listeners: {
click: {
element: 'el', //bind to the underlying el property on the panel
fn: function(){ console.log('click el'); }
},
dblclick: {
element: 'body', //bind to the underlying body property on the panel
fn: function(){ console.log('dblclick body'); }
}
}
});
An alias for addListener. In versions prior to 5.1, listeners had a generated setter which could be called to add listeners. In 5.1 the listeners config is not processed using the config system and has no generated setter, so this method is provided for backward compatibility. The preferred way of adding listeners is to use the on method.
listeners : Object
The listeners
true to enable border management of docked items. When enabled, borders of docked
items will collapse where they meet to avoid duplicated borders.
Defaults to:
false
The margin to use on this Component. Can be specified as a number (in which case all edges get the same margin) or a CSS string like '5 10 10 10'
Defaults to:
null
A configuration to allow you to mask this container.
You can optionally pass an object block with and xtype of loadmask, and an optional message value to
display a loading mask. Please refer to the Ext.LoadMask component to see other configurations.
Alternatively, you can just call the setter at any time with true/false to show/hide the mask:
setMasked(true); //show the mask
setMasked(false); //hides the mask
There are also two convenient methods, method-mask and unmask, to allow you to mask and unmask this container at any time.
Remember, the Ext.Viewport is always a container, so if you want to mask your whole application at anytime, can call:
Ext.Viewport.setMasked({
xtype: 'loadmask',
message: 'Hello'
});
Defaults to:
null
Returns the value of masked
Boolean / Object / Ext.Mask / Ext.LoadMask
Sets the value of masked
masked : Boolean / Object / Ext.Mask / Ext.LoadMask
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 animation that should be used between toast messages when they are queued up
Defaults to:
true
Minimum width of all buttonToolbar buttons in pixels. If set, this will be used
as the default value for the Ext.Button#minWidth config of each Button
added to the `buttonToolbar via the buttons toolbar.
It will be ignored for buttons that have a minWidth configured some other way, e.g. in their own config object or via the defaults of their parent container.
Defaults to:
75
Available since: 6.5.0
Sets the value of minButtonWidth
minButtonWidth : Number
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
This config enables binding to your Ext.data.Model#validators. This
is only processed by form fields (e.g., Ext.field.*) at present, however, this
setting is inherited and so can be set on a parent container.
When set to true by a component (or by an ancestor container), the validators
of for any {@Ext.data.Model record} fields will be used wherever the value is
bound to such data fields.
While this config can be set arbitrarily high in the component hierarchy, doing
so can create a lot overhead if most of your form fields do not actually rely on
validators in your data model.
Using this setting for a form that is bound to an Ext.data.Model might look
like this:
{
xtype: 'panel',
modelValidation: true,
items: [{
xtype: 'textfield',
bind: '{theUser.firstName}'
},{
xtype: 'textfield',
bind: '{theUser.lastName}'
},{
xtype: 'textfield',
bind: '{theUser.phoneNumber}'
},{
xtype: 'textfield',
bind: '{theUser.email}'
}]
}
Defaults to:
null
Available since: 6.5.0
Set to true for this component's name property to be tracked by its containing
nameHolder.
Defaults to:
false
When true child components are tracked by their name property and can be
retrieved using the lookupName method.
Defaults to:
false
The padding to use on this Component. Can be specified as a number (in which case all edges get the same padding) or a CSS string like '5 10 10 10'
Defaults to:
null
This config describes one or more plugin config objects used to create plugin instances for this component.
Plugins are a way to bundle and reuse custom functionality. Plugins should extend
Ext.plugin.Abstract but technically the only requirement for a valid plugin
is that it contain an init method that accepts a reference to its owner. Once
a plugin is created, the owner will call the init method, passing a reference
to itself. Each plugin can then call methods or respond to events on its owner
as needed to provide its functionality.
This config's value can take several different forms.
The value can be a single string with the plugin's Ext.enums.Plugin:
var list = Ext.create({
xtype: 'list',
itemTpl: '<div class="item">{title}</div>',
store: 'Items',
plugins: 'listpaging'
});
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
Convenience config. Short for 'Right Bar' (right-docked, vertical toolbar).
is equivalent to
Defaults to:
null
Available since: 6.5.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
If true, this container will be marked as being a point in the hierarchy where
references to items with a specified reference config will be held. The container
will automatically become a referenceHolder if a controller is specified.
See the introductory docs for Ext.container.Container for more information about references & reference holders.
Defaults to:
false
Only valid when a component is cfg-floated
Configure this as true if you require descendant floated components to be positioned relative to this
component's coordinate space, not the viewport's coordinate space.
Note: The coordinate space is this Component's encapsulating element's area. Not that of the inner element in which static child items are rendered by the layout.
Defaults to:
false
Available since: 6.2.0
Optional element to render this Component to. Not required if this component is an item of a Container of a Container.
Defaults to:
null
When true, FocusableContainer
will reset last focused position whenever focus leaves the container.
Subsequent tabbing into the container will always focus the first eligible
child item.
When false, subsequent tabbing into the container will focus the child
item that was last focused before.
Defaults to:
false
A configuration for a Ext.panel.Resizer.
Defaults to:
null
Available since: 6.5.0
Set to true to display the menu using reveal style. The Viewport will slide up/down/left/right to make room for the menu to be seen.
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
Configure as true for the component to have a drop shadow. 'false' will suppress any default shadow.
By default the theme will determine the presence of a shadow.
Defaults to:
null
Available since: 6.2.0
Only valid when a component is cfg-floated
Configure as true for the component to use an <iframe> as an underlay to ensure certain non-standard
browser plugins are occluded by this component.
Defaults to:
false
Available since: 6.2.0
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:
{
type: 'popIn',
duration: 250,
easing: 'ease-out'
}
Sets the value of showAnimation
showAnimation : String / Mixed
The side of the viewport where the menu will be positioned.
Defaults to:
null
Returns the value of side
"left" / "right" / "top" / "bottom"
This object contains config objects for the standard buttons (such as OK
and Cancel). This object is keyed by the itemId for the button and contains
the text and a default weight for weighted
containers to use. These default weights vary by OS to provide the user with
a button order that is consistent for their platform. In particular, Windows
and Linux (or rather all platforms other then Mac OS and iOS) present the OK
button followed by Cancel while Mac OS and iOS present them in reverse order
of 'Cancelfollowed byOK`.
The standard buttons, in weight order, are as follows:
okabortretryignoreyesnocancelapplysavesubmithelpcloseOn Mac OS and iOS this order is reversed with the exception of help which
is the first button. The buttons are assigned weights from 10 to 200.
Defaults to:
{
ok: {
text: 'OK',
weight: mac ? 120 : 10
},
abort: {
text: 'Abort',
weight: mac ? 110 : 20
},
retry: {
text: 'Retry',
weight: mac ? 100 : 30
},
ignore: {
text: 'Ignore',
weight: mac ? 90 : 40
},
yes: {
text: 'Yes',
weight: mac ? 80 : 50
},
no: {
text: 'No',
weight: mac ? 70 : 60
},
cancel: {
text: 'Cancel',
weight: mac ? 60 : 70
},
apply: {
text: 'Apply',
weight: mac ? 50 : 80
},
save: {
text: 'Save',
weight: mac ? 40 : 90
},
submit: {
text: 'Submit',
weight: mac ? 30 : 100
},
help: {
text: 'Help',
weight: mac ? 10 : 110
},
close: {
text: 'Close',
weight: mac ? 20 : 120
}
}
Available since: 6.5.0
Sets the value of standardButtons
standardButtons : Object
Additional CSS styles that will be rendered into an inline style attribute when the widget is rendered.
You can pass either a string syntax:
style: 'background:red'
Or by using an object:
style: {
background: 'red'
}
When using the object syntax, you can define CSS Properties by using a string:
style: {
'border-left': '1px solid red'
}
Although the object syntax is much easier to read, we suggest you to use the string syntax for better performance.
Defaults to:
null
DOM tabIndex attribute for this component's focusEl.
Defaults to:
null
Return the actual tabIndex for this Focusable.
tabIndex attribute value
Set the tabIndex property for this Focusable. If the focusEl is available, set tabIndex attribute on it, too.
newTabIndex : Number
new tabIndex to set
Convenience config. Short for 'Top Bar'.
is equivalent to
Defaults to:
null
Available since: 6.5.0
The amount of time in milliseconds to wait before destroying the toast automatically
Defaults to:
1000
The title text or config object for the Ext.panel.Title component.
Defaults to:
null
The alignment of the title text within the available space between the icon and the tools.
Defaults to:
'left'
Returns the value of titleAlign
'left' / 'center' / 'right'
Sets the value of titleAlign
titleAlign : 'left' / 'center' / 'right'
True to automatically call toFront when a cfg-floated Component is shown.
Defaults to:
true
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:
panXpanYpinchZoomdoubleTapZoomAll touch actions are enabled (true) by default, so it is usually only necessary
to specify which touch actions to disable. For example, the following disables
only horizontal scrolling and pinch-to-zoom on the component's main element:
touchAction: {
panX: false,
pinchZoom: false
}
Touch actions can be specified on reference elements using the reference element name, for example:
// disables horizontal scrolling on the main element, and double-tap-zoom
// on the child element named "body"
touchAction: {
panY: false
body: {
doubleTapZoom: false
}
}
The primary motivation for setting the touch-action of an element is to prevent the browser's default handling of a gesture such as pinch-to-zoom, or drag-to-scroll, so that the application can implement its own handling of that gesture on the element. Suppose, for example, a component has a custom drag handler on its element and wishes to prevent horizontal scrolling of its container while it is being dragged:
Ext.create('Ext.Widget', {
touchAction: {
panX: false
},
listeners: {
drag: function(e) {
// implement drag logic
}
}
});
Defaults to:
null
A String, Ext.Template, Ext.XTemplate or an Array of strings to form an Ext.XTemplate. Used in conjunction with the data and tplWriteMode configurations.
Note The data configuration must be set for any content to be shown in the component when using this configuration.
Defaults to:
null
Sets the value of tpl
tpl : String / String[] / Ext.Template / Ext.XTemplate[]
The Ext.(X)Template method to use when updating the content area of the Component. Valid modes are:
Defaults to:
'overwrite'
This config is the default translatable type to use for this type of component.
This is not normally set on instances because it is more appropriate to just set
translatable:
items: [{
translatable: {
type: 'csstransform',
}
...
This config is more useful for a class to set the default translatable type that
will be used for any components that are translatable.
Available since: 6.5.0
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
If set to true, then child items may be specified as a object,
with each property name specifying an itemId, and the property
value being the child item configuration object.
When using this scheme, each child item may contain a weight configuration value which affects its order in this container. Lower weights are towards the start, higher weights towards the end.
Defaults to:
false
The width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
By default, if this is not explicitly set, this Component's element will simply have its own natural size.
If set to auto, it will set the width to null meaning it will have its own natural size.
Defaults to:
null
Only valid when a component is cfg-floated
The x position at which to position this component. This is usually viewport-relative. But if there is a
relative: true ancestor, it will be relative to that.
Defaults to:
0
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.
Only valid when a component is cfg-floated
The x position at which to position this component. This is usually viewport-relative. But if there is a
relative: true ancestor, it will be relative to that.
Defaults to:
0
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 cfg!ui 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.
The CSS class to add to this component when it is floated at the viewport level.
Defaults to:
"x-floated"
The CSS class to add to this component's floatWrap when it's created.
Defaults to:
"x-float-wrap"
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 name of the element that FocusableContainer should bind its keyboard handler to. Similar to ariaEl, this name is resolved to the Ext.dom.Element instance after rendering.
Defaults to:
"el"
The element that will have the focusCls applied when component's focusEl is focused.
The element that will be focused when focus method is called on this component. Usually this is the same element that receives focus via mouse clicks, taps, and pressing Tab key.
Defaults to:
'el'
true if this panel has the collapsible override added.
Defaults to:
true
Available since: 6.5.0
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);
}
true if this panel has the resizable override added.
Defaults to:
true
Available since: 6.5.0
Set to true on widgets that should inherit ui from their parent container.
This property is typically set on the class body, but can be set on an instance as long
as it is set prior to the instance being added to its container. This property is
inspected at the moment a widget is added to a container, and any UIs on the container
are added to the widget at that time. Inherited UIs are in addition to the widget's
own ui, and are updated when the container's UI changes.
Defaults to:
false
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
true in this class to identify an object as an instantiated Container, or subclass thereof.
Defaults to:
true
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'
Called when focus moves within this Component's hierarchy
Defaults to:
Ext.emptyFn
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 method is called the first time a component is inserted into the DOM. If this
component Ext.Container other components, the onRender method
for child components is called after the parent's onRender.
Implementations of this method should avoid modifying the DOM but are free to read from and measure elements as needed. To adjust the DOM, consider implementing afterRender instead.
If this method is overridden, be sure to use callParent to call the base class
version.
onRender: function () {
this.callParent();
// custom actions
}
This method is not generally needed because components always have their own DOM element and these are maintained by config property updaters prior to insertion in the DOM. In general, it is always best to interrogate the component's elements outside the DOM where there is no associated reflow or layout cost. This method is useful for situations where the component's elements must be in the DOM. For example to be measured correctly.
Defaults to:
Ext.emptyFn
Available since: 6.5.0
The rendered flag is set when a widget is inserted into the document for the first time.
Note that this is a one-way operation. The first time a widget is inserted into the document, this flag is set, and it is never unset.
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
The CSS class to add to this component when it has a shadow.
Defaults to:
Ext.baseCSSPrefix + 'shadow'
The CSS class to add to this component's shim element if enabled.
Defaults to:
"x-shim"
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
true if any listeners were added
Creates a particular plugin type if defined in the plugins configuration.
Available since: 6.2.0
type : String
The type of the plugin.
The plugin that was created.
Adds one or more Components to this Container. Example:
var myPanel = Ext.create({
xtype: 'panel',
html : 'This will be added to a Container'
});
var items = myContainer.add([myPanel]); // Array returned
var item = myContainer.add(myPanel); // One item is returned
newItems : Object/Object[]/Ext.Component/Ext.Component[]
The new item(s) to add to the Container. Note that if an array of items to add was passed in, an array of added items will be returned as well even if there was only one item.
The Component(s) that were added.
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
The name of the config property.
Adds a CSS class to the body element. If not rendered, the class will be added when the panel is rendered.
cls : String
The class to add
this
Adds a CSS class (or classes) to this Component's rendered element.
cls : String/String[]
The CSS class(es) to add.
prefix : String (optional)
Optional prefix to add to each class.
Defaults to: ""
suffix : String (optional)
Optional suffix to add to each class.
Defaults to: ""
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
The name of the reference
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
The name of the reference
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
The name of the event to listen for. May also be an object who's property names are event names.
fn : Function/String (optional)
The method the event invokes or the name of
the method within the specified scope. Will be called with arguments
given to Ext.util.Observable#fireEvent plus the options parameter described
below.
scope : Object (optional)
The scope (this reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
options : Object (optional)
An object containing handler configuration.
Note: The options object will also be passed as the last argument to every event handler.
This object may contain any of the following properties:
scope : Object
The scope (this reference) in which the handler function is executed. If omitted,
defaults to the object which fired the event.
delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
onFrame : Number
Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.
target : Ext.util.Observable
Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
element : String
This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.
This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.
For example, to add a click listener to a Panel's body:
var panel = new Ext.panel.Panel({
title: 'The title',
listeners: {
click: this.handlePanelClick,
element: 'body'
}
});
In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.
panel.body.un(...)
delegate : String (optional)
A simple selector to filter the event target or look for a descendant of the target.
The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).
See the delegate example below.
capture : Boolean (optional)
When set to true, the listener is fired in the capture phase of the event propagation
sequence, instead of the default bubble phase.
The capture option is only available on Ext.dom.Element instances (or
when attaching a listener to a Ext.dom.Element via a Component using the
element option).
stopPropagation : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopPropagation on the event object
before firing the handler.
preventDefault : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call preventDefault on the event object
before firing the handler.
stopEvent : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopEvent on the event object
before firing the handler.
args : Array (optional)
Optional set of arguments to pass to the handler function before the actual
fired event arguments. For example, if args is set to ['foo', 42],
the event handler function will be called with an arguments list like this:
handler('foo', 42, <actual event arguments>...);
destroyable : Boolean (optional)
When specified as true, the function returns a destroyable object. An object
which implements the destroy method which removes all listeners added in this call.
This syntax can be a helpful shortcut to using un; particularly when
removing multiple listeners. NOTE - not compatible when using the element
option. See un for the proper syntax for removing listeners added using the
element config.
Defaults to:
false
priority : Number (optional)
An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.
order : String (optional)
A legacy option that is provided for backward compatibility.
It is recommended to use the priority option instead. Available options are:
'before': equal to a priority of 100'current': equal to a priority of 0 or default priority'after': equal to a priority of -100Defaults to:
'current'
order : String (optional)
A shortcut for the order event option. Provided for backward compatibility.
Please use the priority event option instead.
Combining Options
Using the options argument, it is possible to combine different types of listeners:
A delayed, one-time listener.
myPanel.on('hide', this.handleClick, this, {
single: true,
delay: 100
});
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.
grid.on({
itemclick: 'onItemClick',
itemcontextmenu: grid.onItemContextmenu,
destroy: {
fn: function () {
// function called within the 'altCmp' scope instead of grid
},
scope: altCmp // unique scope for the destroy handler
},
scope: grid // default scope - provided for example clarity
});
Delegate
This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:
var panel = Ext.create({
xtype: 'panel',
renderTo: document.body,
title: 'Delegate Handler Example',
frame: true,
height: 220,
width: 220,
html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});
// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
click: function (e) {
console.log(e.getTarget().innerHTML);
},
element: 'body',
delegate: 'h1.myTitle'
});
Defaults to: 'current'
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes
all listeners added in this call. For example:
this.btnListeners = = myButton.on({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.
Example:
Ext.define('Foo', {
extend: 'Ext.Component',
initComponent: function () {
this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
this.callParent();
}
});
As you can see, when an instance of Foo is destroyed, it ensures that the 'show'
listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.
As of version 5.1 it is no longer necessary to use this method in most cases because
listeners are automatically managed if the scope object provided to
addListener is an Observable instance.
However, if the observable instance and scope are not the same object you
still need to use mon or addManagedListener if you want the listener to be
managed.
item : Ext.util.Observable/Ext.dom.Element
The item to which to add a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function/String (optional)
If the ename parameter was an event
name, this is the handler function or the name of a method on the specified
scope.
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)
in which the handler function is executed.
options : Object (optional)
If the ename parameter was an event name, this is the
addListener options.
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:
this.btnListeners = myButton.mon({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
Adds a plugin. For example:
list.addPlugin('pullrefresh');
Or:
list.addPlugin({
type: 'pullrefresh',
pullRefreshText: 'Pull to refresh...'
});
Available since: 6.2.0
plugin : Object/String/Ext.plugin.Abstract
The plugin or config object or alias to add.
This method is called after the component is initially added to the DOM. If this
component Ext.Container other components, the afterRender method
for child components is called before the parent's afterRender.
Implementations of this method should avoid reading from the DOM but are free to write to the DOM as needed. To read the DOM, consider implementing onRender instead.
This method is not generally needed because components always have their own DOM element and these are maintained by config property updaters prior to insertion in the DOM. In general, it is always best to manipulate the component's elements outside the DOM where there is no associated reflow or layout cost. This method is useful for situations where the component's elements must be in the DOM in order to be manipulated correctly.
Available since: 6.5.0
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
component : Object
alignment : Object
options : Object
Animates to the supplied activeItem with a specified animation. Currently this only works
with a Card layout. This passed animation will override any default animations on the
container, for a single card switch. The animation will be destroyed when complete.
activeItem : Object/Number
The item or item index to make active.
animation : Object/Ext.layout.card.fx.Abstract
Card animation configuration or instance.
activeItem : Object
currentActiveItem : Object
Available since: 5.0.0
binds : String/Object
currentBindings : Object
Applies the container's defaults onto a child item. The item can be a config object or an instance but has to be an inner item.
item : Object/Ext.Component
The item to apply the defaults to.
The item that was passed in
Changes the masked configuration when its setter is called, which will convert the value into a proper object/instance of Ext.Mask/Ext.LoadMask. If a mask already exists, it will use that instead.
masked : Boolean/Object/Ext.Mask/Ext.LoadMask
Applier for the plugins config property.
plugins : String[]/Object[]/Ext.plugin.Abstract[]
The new plugins to use.
oldPlugins : Ext.plugin.Abstract[]
The existing plugins in use.
Transforms a Session config to a proper instance.
Available since: 5.0.0
session : Object
Transforms a ViewModel config to a proper instance.
Available since: 5.0.0
viewModel : String/Object/Ext.app.ViewModel
Sets up a component name reference.
component : Ext.Component
The component to reference.
Sets up a component reference.
component : Ext.Component
The component to reference.
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
The arguments, either an array or the arguments object
from the current method, for example: this.callOverridden(arguments)
Returns the result of calling the overridden method
Deprecated since version 4.1.0
Use method-callParent instead.
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
The arguments, either an array or the arguments object
from the current method, for example: this.callParent(arguments)
Returns the result of calling the parent method
This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.
Consider:
Ext.define('Ext.some.Class', {
method: function () {
console.log('Good');
}
});
Ext.define('Ext.some.DerivedClass', {
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
The arguments, either an array or the arguments object
from the current method, for example: this.callSuper(arguments)
Returns the result of calling the superclass method
Center this cfg-floated or positioned Component in its parent.
this
Retrieves the first direct child of this container which matches the passed selector or component. The passed in selector must comply with an Ext.ComponentQuery selector, or it can be an actual Ext.Component.
selector : String/Ext.Component (optional)
An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned.
The matching child Ext.Component (or null if no match was found).
Clears all listeners that were attached using the "delegate" event option. Users should not invoke this method directly. It is called automatically as part of normal clearListeners processing.
Collapses the panel body so that the body becomes hidden. Fires the Ext.Panel#beforecollapse event which will cancel the collapse action if it returns false.
It also fires the Ext.Panel#collapse event after the panel body is collapsed.
animation : Boolean/Object
The animation to execute. This setting overrides any animation configuration. Do not pass a value to use the values configured on the class.
A promise that resolves when the collapse completes.
Creates new Component.
config : Object
The standard configuration object.
Converts the provided type or config object into a plugin instance.
config : String/Object/Ext.plugin.Abstract
The plugin type, config object or instance.
Creates an event handling function which re-fires the event from this object as the passed event name.
newName : String
The name under which to re-fire the passed parameters.
beginEnd : Array (optional)
The caller can specify on which indices to slice.
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...
One or more names of the properties to destroy and remove from the object.
Removes and destroys a plugin.
Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.
Available since: 6.2.0
plugin : String/Ext.plugin.Abstract
The plugin or its id to remove.
plugin instance or null if not found.
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
index : Number
item : Ext.Component
instanced : Boolean
Retrieves the first descendant of this container which matches the passed selector. The passed in selector must comply with an Ext.ComponentQuery selector, or it can be an actual Ext.Component.
selector : String/Ext.Component (optional)
An Ext.ComponentQuery selector or Ext.Component. If no selector is specified, the first child will be returned.
The matching descendant Ext.Component (or null if no match was found).
Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if
present. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component#getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.
Example:
Ext.define('Ext.overrides.form.field.Base', {
override: 'Ext.form.field.Base',
// Add functionality to Field's initComponent to enable the change event to bubble
initComponent: function () {
this.callParent();
this.enableBubble('change');
}
});
var myForm = Ext.create('Ext.form.Panel', {
title: 'User Details',
items: [{
...
}],
listeners: {
change: function() {
// Title goes red if form has been modified.
myForm.header.setStyle('color', 'red');
}
}
});
eventNames : String/String[]
The event name to bubble, or an Array of event names.
Expands the panel body so that it becomes visible. Fires the Ext.Panel#beforeexpand event which will cancel the expand action if it returns false.
It also fires the Ext.Panel#expand event after the panel is expanded.
animation : Boolean/Object
The animation to execute. This setting overrides any animation configuration. Do not pass a value to use the values configured on the class.
A promise that resolves when the expand completes.
Called when an item is added to this container either during initialization of the cfg-items config, or when new items are added), or {@link #method-insert inserted.
If the passed object is not an instanced component, it converts the passed object into an instanced child component.
It applies cfg-defaults applied for contained child items - that is items which are not positiond using left, top, bottom, right, centered or docked.
Derived classes can override this method to process context appropriate short-hands such as Ext.Toolbar and "->" to insert a spacer.
item : Mixed
The item being added. May be a raw config object or an instanced Component or some other short-hand understood by the container.
The component to be added.
The method finds this floated component's floatParent. That means a DOM positioning container which acts as a root element for sibling floated components, and allows allows floated components to be absolutely positioned, and their encapsulating elements to be reordered to produce a visual stacking effect.
This component's element is appended to its floatParent.
There is a global floatParent element, created on demand when the first top level floated component
is shown. This may be an item child of a container configured with cfg-floated: true,
or a free floated component which is programatically shown.
Child items of components inside a floated component may also be configured floated. These
are give a floatParent which is created on demand wrapping the nearest floated ancestor.
This means that when that ancestor's element is brought to the top of the stack (by moving its
element to the end of its own floatParent), the descendant elements will automatically remain above.
Finds an alternate Component to focus if this Component is disabled while focused, or focused while disabled, or otherwise unable to focus.
In both cases, focus must not be lost to document.body, but must move to an intuitively connectible Component, either a sibling, or uncle or nephew.
This is both for the convenience of keyboard users, and also for when focus is tracked within a Component tree such as for ComboBoxes and their dropdowns.
For example, a ComboBox with a PagingToolbar in is BoundList. If the "Next Page" button is hit, the LoadMask shows and focuses, the next page is the last page, so the "Next Page" button is disabled. When the LoadMask hides, it attempt to focus the last focused Component which is the disabled "Next Page" button. In this situation, focus should move to a sibling within the PagingToolbar.
A closely related focusable Component to which focus can move.
Retrieves plugin by its type alias. For example:
var list = Ext.create({
xtype: 'list',
itemTpl: '<div class="item">{title}</div>',
store: 'Items',
plugins: ['listpaging', 'pullrefresh']
});
list.findPlugin('pullrefresh').setPullRefreshText('Pull to refresh...');
Note: See also getPlugin.
Available since: 6.2.0
type : String
The Plugin's type as specified by the class's
alias configuration.
plugin instance or null if not found.
Fires the specified event with the passed parameters and executes a function (action).
By default, the action function will be executed after any "before" event handlers
(as specified using the order option of
addListener), but before any other
handlers are fired. This gives the "before" handlers an opportunity to
cancel the event by returning false, and prevent the action function from
being called.
The action can also be configured to run after normal handlers, but before any "after"
handlers (as specified using the order event option) by passing 'after'
as the order parameter. This configuration gives any event handlers except
for "after" handlers the opportunity to cancel the event and prevent the action
function from being called.
eventName : String
The name of the event to fire.
args : Array
Arguments to pass to handlers and to the action function.
fn : Function
The action function.
scope : Object (optional)
The scope (this reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
options : Object (optional)
Event options for the action function. Accepts any
of the options of addListener
order : String (optional)
The order to call the action function relative
too the event handlers ('before' or 'after'). Note that this option is
simply used to sort the action function relative to the event handlers by "priority".
An order of 'before' is equivalent to a priority of 99.5, while an order of
'after' is equivalent to a priority of -99.5. See the priority option
of addListener for more details.
Defaults to: 'before'
Deprecated since version 5.5
Use fireEventedAction instead.
Fires the specified event with the passed parameters (minus the event name, plus the options object passed
to addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.
eventName : String
The name of the event to fire.
args : Object...
Variable number of parameters are passed to handlers.
returns false if any of the handlers return false otherwise it returns true.
Fires the specified event with the passed parameter list.
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.
eventName : String
The name of the event to fire.
args : Object[]
An array of parameters which are passed to handlers.
returns false if any of the handlers return false otherwise it returns true.
Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow.
By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events.
eventName : String
The name of the event to fire.
args : Array
Arguments to pass to handlers and to the action function.
fn : Function/String
The action function.
scope : Object (optional)
The scope (this reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
fnArgs : Array/Boolean (optional)
Optional arguments for the action fn. If not
given, the normal args will be used to call fn. If false is passed, the
args are used but if the first argument is this instance it will be removed
from the args passed to the action function.
Try to focus this component.
If this component is disabled or otherwise not focusable, a close relation will be targeted for focus instead to keep focus localized for keyboard users.
selectText : Boolean/Number[] (optional)
If applicable, true to also select all the text
in this component, or an array consisting of start and end (defaults to start)
position of selection.
true if focus target was found and focusing was attempted,
false if no focusing attempt was made.
component : Object
alignment : Object
options : Object
Prepares information on aligning this to component using alignment. Also checks to see if this is already aligned to component according to alignment.
component : Object
alignment : Object
Find component(s) that label or describe this component, and return the id(s) of their ariaEl elements.
reference : Function/String/String[] (optional)
Component reference, or array of component references, or a function that should return the proper attribute string. The function will be called in the context of the labelled component.
Element id string, or null
Returns the Component for a given index in the Container's items.
index : Number
The index of the Component to return.
The item at the specified index, if found.
Gets the bubbling parent for an Observable
The bubble parent. null is returned if no bubble target exists
Examines this container's items property
and gets a direct child component of this container.
component : String/Number
This parameter may be any of the following:
itemId
or id of the child component.items property.For additional information see Ext.util.MixedCollection#get.
The component (if found).
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)
The name of the config property to get.
peek : Boolean (optional)
true to peek at the raw value without calling the getter.
Defaults to: false
ifInitialized : Boolean (optional)
true to only return the initialized property value,
not the raw config value, and not to trigger initialization. Returns undefined if the
property has not yet been initialized.
Defaults to: false
The config property value.
Finds a docked item of this container using a reference, idor an index of its location
in getDockedItems.
component : String/Number
The id or index of the component to find.
The docked component, if found.
Returns all the Ext.Component#docked items in this container.
The docked items of this container.
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.
the element config object
This method is in place on the instance during construction to ensure that any lookup or getReferences calls have the items initialized prior to the lookup.
For cfg-floated components only.
Finds the owning cfg-floated component (if any) responsible for the base z-index stack position of this compoonent, and, if that component is cfg-relative, for the coordinate system in which this component is positioned.
If this is a top level floated component, this method will return null
The owning floated component or null if this
component is top level floated.
This method returns, or creates on demand the floatWrap element which wraps the passed floated component. It enables that floated component to act as a host for descendant floated components.
The passed component's floatWrap element.
Returns the stack of floated components in which this Component resides. This Component and all siblings at this level are returned.
selector : String/Function
A ComponentQuery selector, or
a selection function which returns true to select a component.
Returns the element used to apply focus styling CSS class when Focusable's focusEl becomes focused. By default it is focusEl.
focusEl : Ext.dom.Element (optional)
Return focus styling element for the given focused element. This is used by Components implementing multiple focusable elements.
The focus styling element.
Returns the focus holder element associated with this Container. By default, this is the Container's focusEl element; however if defaultFocus is defined, the child component referenced by that property will be found and returned instead.
the focus holding element.
This method returns an object containing the inherited properties for this instance.
Available since: 5.0.0
inner : Boolean (optional)
Pass true to return inheritedStateInner instead
of the normal inheritedState object. This is only needed internally and should
not be passed by user code.
Defaults to: false
The inheritedState object containing inherited properties.
This method returns the value of a config property that may be inherited from some ancestor.
In some cases, a config may be explicitly set on a component with the intent of
only being presented to its children while that component should act upon the
inherited value (see referenceHolder for example). In these cases the skipThis
parameter should be specified as true.
Available since: 5.0.0
property : String
The name of the config property to return.
skipThis : Boolean (optional)
Pass true if the property should be ignored if
found on this instance. In other words, true means the property must be inherited
and not explicitly set on this instance.
Defaults to: false
The value of the requested property.
Returns 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)
Name of the config option to return.
The full config object or a single config value
when name parameter specified.
Returns all inner items of this container. inner means that the item is not docked or
positioned.
The inner items of this container.
In IE11 vertically flexed elements (such as container body-el or panel body-wrap-el) are not flexed properly when the container has a max-height, but no height. We can workaround the issue by wrapping the vertical box in a horizontal box. See EXTJS-24498
Returns an object holding the descendants of this container keyed by their
name. This object should not be held past the scope of the function calling this
method. It will not be valid if items are added or removed from this or any
sub-container.
The intended usage is shown here (assume there are 3 components with names of "foo", "bar" and "baz" at some level below this container):
onClick: function () {
var items = this.getNamedItems();
// using "items" we can access any descendant by its "name"
items.foo.getValue() + items.bar.getValue() + items.baz.getValue();
}
If this component has a name assigned to it, it is not included in this
object. That name is understood to belong to the ancestor container configured
as the nameHolder.
Available since: 6.5.0
An object with each named child. This will be null if this
container has no descendants with a name specified.
Returns the parent of this component, if it has one.
The parent of this component.
Retrieves a plugin by its id.
var list = Ext.create({
xtype: 'list',
itemTpl: '<div class="item">{title}</div>',
store: 'Items',
plugins: [{
type: 'pullrefresh',
id: 'foo'
}]
});
list.getPlugin('foo').setPullRefreshText('Pull to refresh...');
Note: See also findPlugin.
Available since: 6.2.0
id : String
The id of the plugin.
plugin instance or null if not found.
Similar to getRenderTarget but for positioned items.
Available since: 6.5.0
item : Ext.Component
The positioned item being added.
Used by ComponentQuery to retrieve all of the items
which can potentially be considered a child of this Container.
This should be overridden by components which have child items
that are not contained in items. For example dockedItems, menu, etc
deep : Object
Used by Ext.ComponentQuery, and the up method to find the owning Component in the linkage hierarchy.
By default this returns the Container which contains this Component.
This may be overridden by Component authors who implement ownership hierarchies which are not based upon ownerCt, such as BoundLists being owned by Fields or Menus being owned by Buttons.
Returns an object holding the descendants of this view keyed by their
reference. This object should not be held
past the scope of the function calling this method. It will not be valid if items
are added or removed from this or any sub-container.
The intended usage is shown here (assume there are 3 components with reference values of "foo", "bar" and "baz" at some level below this container):
onClick: function () {
var refs = this.getReferences();
// using "refs" we can access any descendant by its "reference"
refs.foo.getValue() + refs.bar.getValue() + refs.baz.getValue();
}
If this component has a reference assigned
to it, that is not included in this object. That reference is understood to
belong to the ancestor container configured as the referenceHolder.
Available since: 5.0.0
An object with each child reference. This will be null if this
container has no descendants with a reference
specified.
Returns the element into which the html content and items should be rendered.
This defaults to the bodyElement but derived classes can override this method
to use a different element.
For containers his only applies to inner items, not docked items. The
positioned items are rendered to the element returned by the
{@link Ext.Container#getPositionedItemTarget method.
Available since: 6.5.0
Returns 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
The scrolling viewport 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'
The xtype hierarchy string.
Checks if the specified CSS class exists on this element's DOM node.
className : String
The CSS class to check for.
true if the class exists, else false.
Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.
eventName : String
The name of the event to check for
true if the event is being listened for or bubbles, else false
Returns true if this component has a parent.
true if this component has a parent.
Hides this Component optionally using an animation.
animation : Object/Boolean (optional)
You can specify an animation here or a bool to use the hideAnimation config.
This method 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
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)
pass false if this is not an instance-level
reference
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.
Adds a child Component at the given index. For example, here's how we can add a new item, making it the first child Component of this Container:
myContainer.insert(0, {xtype: 'panel', html: 'new item'});
index : Number
The index to insert the Component at.
item : Object
The Component to insert.
This method marks the current inherited state as invalid. The next time a call is
made to getInherited the objects will be recreated and initialized.
Available since: 5.0.0
Tests whether this Widget matches a Ext.ComponentQuery selector string.
selector : String
The selector string to test against.
true if this Widget matches the selector.
Determines whether this Component is an ancestor of the passed Component.
This will return true if the passed Component is anywhere within the subtree
beneath this Component.
possibleDescendant : Ext.Component
The Component to test for presence within this Component's subtree.
Determines if the passed property name is bound to ViewModel data.
Available since: 6.5.0
name : String (optional)
The property name to test. Defaults to the defaultBindProperty
true if the passed property receives data from a ViewModel.
Determines whether this component is the descendant of a passed component.
ancestor : Ext.Component
A Component which may contain this Component.
true if the component is the descendant of the passed component, otherwise false.
Determines if this Component is inside a Component tree which is destroyed, or is being destroyed.
true if this Component, or any ancestor is destroyed, or
is being destroyed.
Returns true if this Component is currently disabled.
true if currently disabled.
Returns true if this Component is not currently disabled.
true if 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)
Optionally determine if the container itself is focusable, or if container's focus is delegated to a child component and that child is focusable.
Defaults to: false
True if component is focusable, false if not.
Returns true if this Component is currently hidden.
deep : Boolean/Ext.Widget (optional)
true to check if this component
is hidden because a parent container is hidden. Alternatively, a reference to the
top-most parent at which to stop climbing.
Defaults to: false
true if currently hidden.
Checks if all events, or a specific event, is suspended.
event : String (optional)
The name of the specific event to check
true if events are suspended
Checks if a particular binding is synchronizing the value.
name : String
The name of the property being bound to.
true if the binding is syncing.
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)
true to check if this component
is visible and all parents are also visible.
Contrast this with the isHidden method which just checks the hidden state of the component.
Defaults to: false
true if currently visible.
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
The xtype to check for this Component.
shallow : Boolean (optional)
false to check whether this Component is descended from the xtype (this is
the default), or true to check whether this Component is directly of the specified xtype.
true if this component descends from the specified xtype, false otherwise.
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
The value passed.
Gets a reference to the component with the specified reference value.
The method is a short-hand for the lookupReference method.
Available since: 6.0.1
ref : String
The value of the reference to lookup.
The referenced component or null if it is not found.
Gets the controller that controls this view. May be a controller that belongs to a view higher in the hierarchy.
Available since: 5.0.1
skipThis : Boolean (optional)
true to not consider the controller directly attached
to this view (if it exists).
Defaults to: false
The controller. null if no controller is found.
Gets a reference to the component with the specified name property.
Available since: 6.5.0
name : String
The name of the descendant to lookup.
The component or null if it is not found.
Gets the Form or Component that is used as the name holder for this component.
Available since: 6.5.0
skipThis : Boolean (optional)
false to return this as the name holder if
this instance has set nameHolder. Unlike getInheritedConfig this method
defaults to true because it is possible that a name property set by the
owner of a component that is also a nameHolder itself. In this case, the
name connects not to this component but to the parent nameHolder.
Defaults to: true
The name holder.
Gets a reference to the component with the specified reference value.
The lookup method is a short-hand version of this method.
Available since: 5.0
ref : String
The name of the reference to lookup.
The referenced component or null if it is not found.
Gets the Controller or Component that is used as the reference holder for this view.
Available since: 5.0.0
skipThis : Boolean (optional)
false to return this as the reference holder if
this instance has set referenceHolder. Unlike getInheritedConfig this method
defaults to true because it is possible that a reference property set by the
owner of a component that is also a referenceHolder itself. In this case, the
reference connects not to this component but to the parent referenceHolder.
Defaults to: true
The reference holder.
Returns the Ext.data.Session for this instance. This property may come
from this instance's session or be inherited from this object's parent.
Available since: 5.0.0
skipThis : Boolean (optional)
Pass true to ignore a session configured on
this instance and only consider an inherited session.
Defaults to: false
Gets a named template instance for this class. See Ext.XTemplate#getTpl.
Available since: 6.2.0
name : String
The name of the property that holds the template.
The template, null if not found.
Returns the Ext.app.ViewModel for this instance. This property may come from this
this instance's viewModel or be inherited from this object's parent.
Available since: 5.0.0
skipThis : Boolean (optional)
Pass true to ignore a viewModel configured on
this instance and only consider an inherited view model.
Defaults to: false
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
The updater function.
Convenience method which calls setMasked with a value of true (to show the mask). For additional
functionality, call the setMasked function direction (See the masked configuration documentation
for more information).
mask : Object
Shorthand for addManagedListener. The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.
Example:
Ext.define('Foo', {
extend: 'Ext.Component',
initComponent: function () {
this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
this.callParent();
}
});
As you can see, when an instance of Foo is destroyed, it ensures that the 'show'
listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.
As of version 5.1 it is no longer necessary to use this method in most cases because
listeners are automatically managed if the scope object provided to
addListener is an Observable instance.
However, if the observable instance and scope are not the same object you
still need to use mon or addManagedListener if you want the listener to be
managed.
item : Ext.util.Observable/Ext.dom.Element
The item to which to add a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function/String (optional)
If the ename parameter was an event
name, this is the handler function or the name of a method on the specified
scope.
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)
in which the handler function is executed.
options : Object (optional)
If the ename parameter was an event name, this is the
addListener options.
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:
this.btnListeners = myButton.mon({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
Shorthand for removeManagedListener. Removes listeners that were added by the mon method.
item : Ext.util.Observable/Ext.dom.Element
The item from which to remove a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)
in which the handler function is executed.
Returns the next node in the Component tree in tree traversal order.
Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree to attempt to find a match. Contrast with nextSibling.
selector : String (optional)
A Ext.ComponentQuery selector to filter the following nodes.
The next node (or the next node which matches the selector).
Returns null if there is no matching node.
Returns the next sibling of this Component.
Optionally selects the next sibling which matches the passed Ext.ComponentQuery selector.
May also be referred to as next()
Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with
nextNode
selector : String (optional)
A Ext.ComponentQuery selector to filter the following items.
The next sibling (or the next sibling which matches the selector).
Returns null if there is no matching sibling.
The on method is shorthand for addListener.
Appends an event handler to this object. For example:
myGridPanel.on("itemclick", this.onItemClick, this);
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
myGridPanel.on({
cellclick: this.onCellClick,
select: this.onSelect,
viewready: this.onViewReady,
scope: this // Important. Ensure "this" is correct during handler execution
});
One can also specify options for each event handler separately:
myGridPanel.on({
cellclick: {fn: this.onCellClick, scope: this, single: true},
viewready: {fn: panel.onViewReady, scope: panel}
});
Names of methods in a specified scope may also be used:
myGridPanel.on({
cellclick: {fn: 'onCellClick', scope: this, single: true},
viewready: {fn: 'onViewReady', scope: panel}
});
eventName : String/Object
The name of the event to listen for. May also be an object who's property names are event names.
fn : Function/String (optional)
The method the event invokes or the name of
the method within the specified scope. Will be called with arguments
given to Ext.util.Observable#fireEvent plus the options parameter described
below.
scope : Object (optional)
The scope (this reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
options : Object (optional)
An object containing handler configuration.
Note: The options object will also be passed as the last argument to every event handler.
This object may contain any of the following properties:
scope : Object
The scope (this reference) in which the handler function is executed. If omitted,
defaults to the object which fired the event.
delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
onFrame : Number
Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.
target : Ext.util.Observable
Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
element : String
This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.
This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.
For example, to add a click listener to a Panel's body:
var panel = new Ext.panel.Panel({
title: 'The title',
listeners: {
click: this.handlePanelClick,
element: 'body'
}
});
In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.
panel.body.un(...)
delegate : String (optional)
A simple selector to filter the event target or look for a descendant of the target.
The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).
See the delegate example below.
capture : Boolean (optional)
When set to true, the listener is fired in the capture phase of the event propagation
sequence, instead of the default bubble phase.
The capture option is only available on Ext.dom.Element instances (or
when attaching a listener to a Ext.dom.Element via a Component using the
element option).
stopPropagation : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopPropagation on the event object
before firing the handler.
preventDefault : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call preventDefault on the event object
before firing the handler.
stopEvent : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopEvent on the event object
before firing the handler.
args : Array (optional)
Optional set of arguments to pass to the handler function before the actual
fired event arguments. For example, if args is set to ['foo', 42],
the event handler function will be called with an arguments list like this:
handler('foo', 42, <actual event arguments>...);
destroyable : Boolean (optional)
When specified as true, the function returns a destroyable object. An object
which implements the destroy method which removes all listeners added in this call.
This syntax can be a helpful shortcut to using un; particularly when
removing multiple listeners. NOTE - not compatible when using the element
option. See un for the proper syntax for removing listeners added using the
element config.
Defaults to:
false
priority : Number (optional)
An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.
order : String (optional)
A legacy option that is provided for backward compatibility.
It is recommended to use the priority option instead. Available options are:
'before': equal to a priority of 100'current': equal to a priority of 0 or default priority'after': equal to a priority of -100Defaults to:
'current'
order : String (optional)
A shortcut for the order event option. Provided for backward compatibility.
Please use the priority event option instead.
Combining Options
Using the options argument, it is possible to combine different types of listeners:
A delayed, one-time listener.
myPanel.on('hide', this.handleClick, this, {
single: true,
delay: 100
});
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.
grid.on({
itemclick: 'onItemClick',
itemcontextmenu: grid.onItemContextmenu,
destroy: {
fn: function () {
// function called within the 'altCmp' scope instead of grid
},
scope: altCmp // unique scope for the destroy handler
},
scope: grid // default scope - provided for example clarity
});
Delegate
This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:
var panel = Ext.create({
xtype: 'panel',
renderTo: document.body,
title: 'Delegate Handler Example',
frame: true,
height: 220,
width: 220,
html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});
// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
click: function (e) {
console.log(e.getTarget().innerHTML);
},
element: 'body',
delegate: 'h1.myTitle'
});
Defaults to: 'current'
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes
all listeners added in this call. For example:
this.btnListeners = = myButton.on({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
Appends an after-event handler.
Same as addListener with order set
to 'after'.
eventName : String/String[]/Object
The name of the event to listen for.
fn : Function/String
The method the event invokes.
scope : Object (optional)
The scope for fn.
options : Object (optional)
An object containing handler configuration.
Appends a before-event handler. Returning false from the handler will stop the event.
Same as addListener with order set
to 'before'.
eventName : String/String[]/Object
The name of the event to listen for.
fn : Function/String
The method the event invokes.
scope : Object (optional)
The scope for fn.
options : Object (optional)
An object containing handler configuration.
Initialize layout and event listeners the very first time an item is added
item : Object
Called when focus enters this Component's hierarchy
e : Object
event : Ext.event.Event
The underlying DOM event.
target : HTMLElement
The element gaining focus.
: HTMLElement
The element losing focus.
toComponent : Ext.Component
The Component gaining focus.
fromComponent : Ext.Component
The Component losing focus.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Called when focus exits from this Component's hierarchy
e : Ext.event.Event
event : Ext.event.Event
The underlying DOM event.
target : HTMLElement
The element gaining focus.
: HTMLElement
The element losing focus.
toComponent : Ext.Component
The Component gaining focus.
fromComponent : Ext.Component
The Component losing focus.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Called when this Inheritable is added to a parent
instanced : Boolean
Called when this inheritable is removed from a parent
destroying : Boolean
true if this item will be destroyed by it's container
item : Object
toIndex : Object
fromIndex : Object
item : Object
index : Object
destroying : Object
Optional template method. If implemented, this is called asynchronously after a browser layout caused by a component resize. This may be triggered for any or several of the following reasons:
width : Number
The new width.
height : Number
The new height.
oldWidth : Number
The previous width.
oldHeight : Number
The previous height.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Invoked when a scroll operation is completed via this component's scroller.
x : Number
The current x position
y : Number
The current y position
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Invoked when this component is scrolled via its scroller.
x : Number
The current x position
y : Number
The current y position
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Invoked when a scroll is initiated on this component via its scroller.
x : Number
The current x position
y : Number
The current y position
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Returns true if the passed element is within the container tree of this component.
For example if a menu's submenu contains an Ext.form.field.Date, that top level menu owns the elements of the date picker. Using this method, you can tell if an event took place within a certain component tree.
element : Object
This is the private method to ensure everything is set up for showing. This is called by both show and showBy to set a component up. the user-facing method is beforeShow, this setup must have happened by the time that is called.
component : Object
alignment : Object
options : Object
Returns the previous node in the Component tree in tree traversal order.
Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree in reverse order to attempt to find a match. Contrast with previousSibling.
selector : String (optional)
A Ext.ComponentQuery selector to filter the preceding nodes.
The previous node (or the previous node which matches the selector).
Returns null if there is no matching node.
Returns the previous sibling of this Component.
Optionally selects the previous sibling which matches the passed Ext.ComponentQuery selector.
May also be referred to as prev()
Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with
previousNode
selector : String (optional)
A Ext.ComponentQuery selector to filter the preceding items.
The previous sibling (or the previous sibling which matches the selector).
Returns null if there is no matching sibling.
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.
An overrideable function which preprocesses all key events from within this FocusableContainer.
The base implementation vetoes processing of key events from input fields by returning undefined.
This may be overridden in subclasses with special requirements.
e : Ext.util.Event
A keyboard event that is significant to the operation of a FocusableContainer.
The event if it is to be processed as a FocusableContainer navigation keystroke,
or undefined if it is to be ignore by the FocusableContainer navigation machinery.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Publish this components state to the ViewModel. If no arguments are given (or if
this is the first call), the entire state is published. This state is determined by
the publishes property.
This method is called only by component authors.
Available since: 5.0.0
property : String (optional)
The name of the property to update.
value : Object (optional)
The value of property. Only needed if property is given.
Retrieves all descendant components which match the passed selector. Executes an Ext.ComponentQuery.query using this container as its root.
selector : String (optional)
Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned.
Components which matched the selector
Retrieves all descendant components which match the passed function. The function should return false for components that are to be excluded from the selection.
fn : Function
The matcher function. It will be called with a single argument, the component being tested.
scope : Object (optional)
The scope in which to run the function. If not specified, it will default to the active component.
Components matched by the passed function
Finds a component at any level under this container matching the id/itemId. This is a shorthand for calling ct.down('#' + id);
id : String
The id to find
The matching id, null if not found
component : Object
alignment : Object
options : Object
Relays selected events from the specified Observable as if the events were fired by this.
For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:
this.relayEvents(this.getStore(), ['load']);
The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).
origin : Object
The Observable whose events this object is to relay.
events : String[]/Object
Array of event names to relay or an Object with key/value pairs translating to ActualEventName/NewEventName respectively. For example: this.relayEvents(this, {add:'push', remove:'pop'});
Would now redispatch the add event of this as a push event and the remove event as a pop event.
prefix : String (optional)
A common prefix to prepend to the event names. For example:
this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.
A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:
this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
Can be undone by calling
Ext.destroy(this.storeRelayers);
or this.store.relayers.destroy();
Removes an item from this Container, optionally destroying it.
which : Ext.Component/String/Number/Array
The component instance, id or index to remove or an array of these.
destroy : Boolean (optional)
true to automatically call Component's
destroy method.
The Component that was removed.
Removes all items currently in the Container, optionally destroying them all.
destroy : Boolean
If true, destroys
each removed Component.
everything : Boolean
If true, completely remove all items including
docked / centered and positioned items.
Array of the removed Components
Removes the Component at the specified index:
myContainer.removeAt(0); // removes the first item
index : Number
The index of the Component to remove.
The removed Component
Removes a CSS class from the body element.
cls : String
The class to remove
this
Removes the given CSS class(es) from this widget's primary element.
cls : String/String[]
The class(es) to remove.
prefix : String (optional)
Optional prefix to prepend before each class.
Defaults to: ""
suffix : String (optional)
Optional suffix to append to each class.
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 inner Component at the specified index:
myContainer.removeInnerAt(0); // removes the first item of the innerItems property
index : Number
The index of the Component to remove.
The removed Component
Removes an event handler.
eventName : String
The type of event the handler was associated with.
fn : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.
Convenience Syntax
You can use the addListener
destroyable: true config option in place of calling un(). For example:
var listeners = cmp.on({
scope: cmp,
afterrender: cmp.onAfterrender,
beforehide: cmp.onBeforeHide,
destroyable: true
});
// Remove listeners
listeners.destroy();
// or
cmp.un(
scope: cmp,
afterrender: cmp.onAfterrender,
beforehide: cmp.onBeforeHide
);
Exception - DOM event handlers using the element config option
You must go directly through the element to detach an event handler attached using the addListener element option.
panel.on({
element: 'body',
click: 'onBodyCLick'
});
panel.body.un({
click: 'onBodyCLick'
});
Removes listeners that were added by the mon method.
item : Ext.util.Observable/Ext.dom.Element
The item from which to remove a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)
in which the handler function is executed.
Remove a single managed listener item
isClear : Boolean
True if this is being called during a clear
managedListener : Object
The managed listener item See removeManagedListener for other args
Removes and (optionally) destroys a plugin.
Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.
Available since: 6.2.0
plugin : String/Ext.plugin.Abstract
The plugin or its id to remove.
destroy : Boolean (optional)
Pass true to not call destroy() on the plugin.
plugin instance or null if not found.
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[]
The class(es) to remove.
newCls : String/String[]
The class(es) to add.
prefix : String (optional)
Optional prefix to prepend before each class.
Defaults to: ""
suffix : String (optional)
Optional suffix to append to each class.
Defaults to: ""
Resets top, right, bottom and left configurations to null, which
will cause this component to stop being 'positioned' and to take its place in its owning container's
layout.
Deprecated since version 6.2
Use resetPositioned instead.
Resets top, right, bottom and left configurations to null, which
will cause this component to stop being 'positioned' and to take its place in its owning container's
layout.
Gets the default scope for firing late bound events (string names with no scope attached) at runtime.
defaultScope : Object (optional)
The default scope to return if none is found.
Defaults to: this
The default event scope
Returns the default listener scope for a "satellite" of this component. Used for resolving scope for observable objects that are not part of the normal Container/Component hierarchy (for example, plugins)
Available since: 5.1.1
satellite : Ext.mixin.Observable
defaultScope : Object (optional)
The listener scope
Resumes firing of the named event(s).
After calling this method to resume events, the events will fire when requested to fire.
Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.
eventName : String...
Multiple event names to resume.
Resumes firing events (see suspendEvents).
If events were suspended using the queueSuspended parameter, then all events fired
during event suspension will be sent to any listeners now.
discardQueue : Boolean (optional)
true to prevent any previously queued events from firing
while we were suspended. See suspendEvents.
Sets a single/multiple configuration options.
name : String/Object
The name of the property to set, or a set of key value pairs to set.
value : Object (optional)
The value to set for the name parameter.
this
Sets the current Alignment information, called by alignTo
alignmentInfo : Object
All Components need a potentially recursive setRendered because some are pseudo containers, such as grid Ext.grid.Row, and some mix in Ext.mixin.Toolable.
rendered : Boolean
root : Boolean (optional)
Sets the size of the Component.
width : Number
The new width for the Component.
height : Number
The new height for the Component.
This method has the same arguments as element's setXY
method, but is used to maintain the x and y configs (for floated components)
or the left and top config for positioned components.
Available since: 6.5.0
x : Object
y : Object
animation : Object
Shows this component optionally using an animation.
animation : Object/Boolean (optional)
You can specify an animation here or a bool to use the showAnimation config.
Displays component at specific xy position. A floating component (like a menu) is positioned relative to its ownerCt if any. Useful for popping up a context menu:
listeners: {
itemcontextmenu: function(view, record, item, index, event, options) {
Ext.create('Ext.menu.Menu', {
width: 100,
height: 100,
margin: '0 0 10 0',
items: [{
text: 'regular item 1'
},{
text: 'regular item 2'
},{
text: 'regular item 3'
}]
}).showAt(event.getXY());
}
}
x : Number/Number[]/Object
The new x position or array of [x,y], or an object {x:10, y:10}.
y : Number (optional)
The new y position.
animate : Boolean/Object (optional)
True to animate the Component into its new position. You may also pass an animation configuration.
this
Shows this component by another component. If you specify no alignment, it will automatically position this component relative to the reference component.
For example, say we are aligning a Panel next to a Button, the alignment string would look like this:
[panel-vertical (t/b/c)][panel-horizontal (l/r/c)]-[button-vertical (t/b/c)][button-horizontal (l/r/c)]
where t = top, b = bottom, c = center, l = left, r = right.
tl-tr means top-left corner of the Panel to the top-right corner of the Buttontc-bc means top-center of the Panel to the bottom-center of the ButtonYou can put a '?' at the end of the alignment string to constrain the positioned element to the Ext.Viewport
// show `panel` by `button` using the default positioning (auto fit)
panel.showBy(button);
// align the top left corner of `panel` with the top right corner of `button` (constrained to viewport)
panel.showBy(button, "tl-tr?");
// align the bottom right corner of `panel` with the center left edge of `button` (not constrained by viewport)
panel.showBy(button, "br-cl");
component : Ext.Component
The target component to show this component by.
alignment : String (optional)
The alignment string, eg: 'tl-bl'.
options : Object (optional)
An object containing options for the Ext.util.Region#alignTo method.
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...
Multiple event names to suspend.
Suspends the firing of all events. (see resumeEvents)
queueSuspended : Boolean
true to queue up suspended events to be fired
after the resumeEvents call instead of discarding all suspended events.
Fixes up the alwaysOnTop order of this floated widget within its siblings.
fromMousedown : Object
true if this was the topmost widget among its siblings.
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
Brings a cfg-floated Component to the front of any other visible, floated Components.
TODO: If this Component is modal, inserts the modal mask just below this Component.
fromMousedown : Object
this
Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).
className : String
The CSS class to toggle.
state : Boolean (optional)
If specified as true, causes the class to be added. If
specified as false, causes the class to be removed.
Set the collapsed state of the panel.
collapsed : Boolean
The collapsed state.
animation : Object
A promise that resolves when the collapse/expand completes.
Shorthand for removeListener. Removes an event handler.
eventName : String
The type of event the handler was associated with.
fn : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.
Convenience Syntax
You can use the addListener
destroyable: true config option in place of calling un(). For example:
var listeners = cmp.on({
scope: cmp,
afterrender: cmp.onAfterrender,
beforehide: cmp.onBeforeHide,
destroyable: true
});
// Remove listeners
listeners.destroy();
// or
cmp.un(
scope: cmp,
afterrender: cmp.onAfterrender,
beforehide: cmp.onBeforeHide
);
Exception - DOM event handlers using the element config option
You must go directly through the element to detach an event handler attached using the addListener element option.
panel.on({
element: 'body',
click: 'onBodyCLick'
});
panel.body.un({
click: 'onBodyCLick'
});
Removes a before-event handler.
Same as removeListener with order set to 'after'.
eventName : String/String[]/Object
The name of the event the handler was associated with.
fn : Function/String
The handler to remove.
scope : Object (optional)
The scope originally specified for fn.
options : Object (optional)
Extra options object.
Removes a before-event handler.
Same as removeListener with order set to 'before'.
eventName : String/String[]/Object
The name of the event the handler was associated with.
fn : Function/String
The handler to remove.
scope : Object (optional)
The scope originally specified for fn.
options : Object (optional)
Extra options object.
Destroys a given set of linked objects. This is only needed if
the linked object is being destroyed before this instance.
names : String[]
The names of the linked objects to destroy.
this
Convenience method which calls setMasked with a value of false (to hide the mask). For additional functionality, call the setMasked function direction (See the masked configuration documentation for more information).
Walks up the ownership hierarchy looking for an ancestor Component which matches the passed simple selector.
Example:
var owningTabPanel = grid.up('tabpanel');
selector : String (optional)
The simple selector to test.
limit : String/Number/Ext.Component (optional)
This may be a selector upon which to stop the upward scan, or a limit of the number of steps, or Component reference to stop on.
The matching ancestor Container (or undefined if no match was found).
newActiveItem : Object
oldActiveItem : Object
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
Traverses the tree rooted at this node in post-order mode, calling the passed function on the nodes at each level. That is the function is called upon each node after being called on its children).
This method is used at each level down the cascade. Currently Ext.Components and Ext.data.TreeModels are queryable.
If you have tree-structured data, you can make your nodes queryable, and use ComponentQuery on them.
selector : Object
A ComponentQuery selector used to filter candidate nodes before calling the function. An empty string matches any node.
fn : Function
The function to call. Return false to aborl the traverse.
node : Object
The node being visited.
scope : Object (optional)
The context (this reference) in which the function is executed.
extraArgs : Array (optional)
A set of arguments to be appended to the function's argument list to pass down extra data known to the caller after the node being visited.
Traverses the tree rooted at this node in pre-order mode, calling the passed function on the nodes at each level. That is the function is called upon each node before being called on its children).
This method is used at each level down the cascade. Currently Ext.Components and Ext.data.TreeModels are queryable.
If you have tree-structured data, you can make your nodes queryable, and use ComponentQuery on them.
selector : Object
A ComponentQuery selector used to filter candidate nodes before calling the function. An empty string matches any node.
fn : Function
The function to call. Return false to aborl the traverse.
node : Object
The node being visited.
scope : Object (optional)
The context (this reference) in which the function is executed.
extraArgs : Array (optional)
A set of arguments to be appended to the function's argument list to pass down extra data known to the caller after the node being visited.
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)
The mixin class if the configs are from a mixin.
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
The members to add to this class.
isStatic : Boolean (optional)
Pass true if the members are static.
Defaults to: false
privacy : Boolean (optional)
Pass true if the members are private. This
only has meaning in debug mode and only for methods.
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
this
Borrow another class' members to the prototype of this class.
Ext.define('Bank', {
money: '$$$',
printMoney: function() {
alert('$$$$$$$');
}
});
Ext.define('Thief', {
...
});
Thief.borrow(Bank, ['money', 'printMoney']);
var steve = new Thief();
alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'
fromClass : Ext.Base
The class to borrow members from
members : Array/String
The names of the members to borrow
this
Create a new instance of this Class.
Ext.define('My.cool.Class', {
...
});
My.cool.Class.create({
someConfig: true
});
All parameters are passed to the constructor of the class.
the created instance.
Create aliases for existing prototype methods. Example:
Ext.define('My.cool.Class', {
method1: function() { ... },
method2: function() { ... }
});
var test = new My.cool.Class();
My.cool.Class.createAlias({
method3: 'method1',
method4: 'method2'
});
test.method3(); // test.method1()
My.cool.Class.createAlias('method5', 'method3');
test.method5(); // test.method3() -> test.method1()
alias : String/Object
The new method name, or an object to set multiple aliases. See flexSetter
origin : String/Object
The original method name
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'
className
Used internally by the mixins pre-processor
name : Object
mixinClass : Object
Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
Direct use of this method should be rare. Use Ext.define instead:
Ext.define('My.CatOverride', {
override: 'My.Cat',
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).
members : Object
The properties to add to this class. This should be specified as an object literal containing one or more properties.
this class
Fires whenever item within the Container is activated.
newActiveItem : Object
The new active item within the container.
this : Ext.Container
The Container instance.
oldActiveItem : Object
The old active item within the container.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when activeItem changes.
sender : Ext.Container
The instance firing this event.
value : Object/String/Number
The current value of activeItem.
oldValue : Object/String/Number
The previous value of activeItem.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever item added to the Container.
this : Ext.Container
The Container instance.
item : Object
The item added to the Container.
index : Number
The index of the item within the Container.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires after a Component had been added to a Container.
this : Ext.Component
container : Ext.Container
Parent Container
index : Number
The index of the item within the Container.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when activeItem changes.
sender : Ext.Container
The instance firing this event.
value : Object/String/Number
The current value of activeItem.
oldValue : Object/String/Number
The previous value of activeItem.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when bottom changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of bottom.
oldValue : Number/String
The previous value of bottom.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when centered changes.
sender : Ext.Component
The instance firing this event.
value : Boolean
The current value of centered.
oldValue : Boolean
The previous value of centered.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
Fires before collapse starts. Return false to cancel collapse.
Available since: 6.5.0
this : Ext.Panel
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when disabled changes.
sender : Ext.Widget
The instance firing this event.
value : Boolean
The current value of disabled.
oldValue : Boolean
The previous value of disabled.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when docked changes.
sender : Ext.Component
The instance firing this event.
value : String
The current value of docked.
oldValue : String
The previous value of docked.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
Fires before expand starts. Return false to cancel expand.
Available since: 6.5.0
this : Ext.Panel
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when height changes.
sender : Ext.Widget
The instance firing this event.
value : Number/String
The current value of height.
oldValue : Number/String
The previous value of height.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
Fires before the Component is hidden. Hide may be vetoed by returning false from a handler.
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when left changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of left.
oldValue : Number/String
The previous value of left.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when maxHeight changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of maxHeight.
oldValue : Number/String
The previous value of maxHeight.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when maxWidth changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of maxWidth.
oldValue : Number/String
The previous value of maxWidth.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when minHeight changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of minHeight.
oldValue : Number/String
The previous value of minHeight.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when minWidth changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of minWidth.
oldValue : Number/String
The previous value of minWidth.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
Fires before resize starts. Return false to cancel dragging.
Available since: 6.5.0
this : Ext.Panel
context : Object
edge : String
The edge being resized.
event : Ext.event.Event
The event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when right changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of right.
oldValue : Number/String
The previous value of right.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when scrollable changes.
sender : Ext.Component
The instance firing this event.
value : Boolean/String/Object
The current value of scrollable.
oldValue : Boolean/String/Object
The previous value of scrollable.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
Fires before the Component is shown. Show may be vetoed by returning false from a handler.
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before a cfg-floated component is brought to the front of the visual stack.
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when top changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of top.
oldValue : Number/String
The previous value of top.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when width changes.
sender : Ext.Widget
The instance firing this event.
value : Number/String
The current value of width.
oldValue : Number/String
The previous value of width.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
Fires when this Component's focusEl loses focus.
this : Ext.Component
event : Ext.event.Event
The blur event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when bottom changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of bottom.
oldValue : Number/String
The previous value of bottom.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when centered changes.
sender : Ext.Component
The instance firing this event.
value : Boolean
The current value of centered.
oldValue : Boolean
The previous value of centered.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the collapse starts.
Available since: 6.5.0
this : Ext.Panel
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever item within the Container is deactivated.
oldActiveItem : Object
The old active item within the container.
this : Ext.Container
The Container instance.
newActiveItem : Object
The new active item within the container.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when disabled changes.
sender : Ext.Widget
The instance firing this event.
value : Boolean
The current value of disabled.
oldValue : Boolean
The previous value of disabled.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when docked changes.
sender : Ext.Component
The instance firing this event.
value : String
The current value of docked.
oldValue : String
The previous value of docked.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires then the drawer hides.
Available since: 6.5.0
this : Ext.Panel
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires then the drawer shows.
Available since: 6.5.0
this : Ext.Panel
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
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the expand starts.
Available since: 6.5.0
this : Ext.Panel
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
The component instance
positioned : Boolean
The component's new positioned state. This becomes
true is a component is positioned using the cfg-top, cfg-right,
cfg-bottom or cfg-left configs.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Deprecated since version 6.2.0
Use positionedchange instead
Fires when this Component's focusEl receives focus.
this : Ext.Component/Ext.Widget
event : Ext.event.Event
The focus event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when focus enters this Component's hierarchy.
this : Ext.Component
event : Ext.event.Event
The focusenter event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when focus leaves this Component's hierarchy.
this : Ext.Component
event : Ext.event.Event
The focusleave event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever a Component with the fullscreen config is instantiated
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when height changes.
sender : Ext.Widget
The instance firing this event.
value : Number/String
The current value of height.
oldValue : Number/String
The previous value of height.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever the Component is hidden
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the component has been initialized
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when left changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of left.
oldValue : Number/String
The previous value of left.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when maxHeight changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of maxHeight.
oldValue : Number/String
The previous value of maxHeight.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when maxWidth changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of maxWidth.
oldValue : Number/String
The previous value of maxWidth.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when minHeight changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of minHeight.
oldValue : Number/String
The previous value of minHeight.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when minWidth changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of minWidth.
oldValue : Number/String
The previous value of minWidth.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever item moved within the Container.
this : Ext.Container
The Container instance.
item : Object
The item moved within the Container.
toIndex : Number
The new index of the item.
fromIndex : Number
The old index of the item.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a component si moved within its Container.
this : Ext.Component
container : Ext.Container
Container which holds the component
toIndex : Number
The new index of the item.
fromIndex : Number
The old index of the item.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever this Element actually becomes visible (painted) on the screen. This is useful when you need to perform 'read' operations on the DOM element, i.e: calculating natural sizes and positioning.
Note: This event is not available to be used with event delegation. Instead painted only fires if you explicitly
add at least one listener to it, for performance reasons.
element : Ext.dom.Element
The component's outer element (this.element)
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever there is a change in the positioned status of a component
this : Ext.Component
The component instance
positioned : Boolean
The component's new positioned state. This becomes
true is a component is positioned using the cfg-top, cfg-right,
cfg-bottom or cfg-left configs.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever item removed from the Container.
this : Ext.Container
The Container instance.
item : Object
The item removed from the Container.
index : Number
The index of the item that was removed.
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
Container which holds the component
index : Number
The index of the item that was removed.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever an item is rendered into a container or derendered from a Container.
this : Ext.Container
The Container instance.
item : Object
The item in the Container.
rendered : Boolean
The current rendered status of the item.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Important note: For the best performance on mobile devices, use this only when you absolutely need to monitor a Element's size.
Note: This event is not available to be used with event delegation. Instead resize only fires if you explicitly
add at least one listener to it, for performance reasons.
element : Ext.dom.Element
The component's outer element (this.element).
info : Object
The component's new size parameters.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires for each tick while a drag is active.
Available since: 6.5.0
this : Ext.Panel
context : Object
edge : String
The edge being resized.
event : Ext.event.Event
The event.
width : Number
The current resized width in pixels.
height : Number
The current resized height in pixels.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the drag resize is cancelled.
Available since: 6.5.0
this : Ext.Panel
context : Object
edge : String
The edge being resized.
event : Ext.event.Event
The event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the drag resize is complete.
Available since: 6.5.0
this : Ext.Panel
context : Object
edge : String
The edge being resized.
event : Ext.event.Event
The event.
width : Number
The final resized width in pixels.
height : Number
The final resized height in pixels.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the resize starts.
Available since: 6.5.0
this : Ext.Panel
context : Object
edge : String
The edge being resized.
event : Ext.event.Event
The event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when right changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of right.
oldValue : Number/String
The previous value of right.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when scrollable changes.
sender : Ext.Component
The instance firing this event.
value : Boolean/String/Object
The current value of scrollable.
oldValue : Boolean/String/Object
The previous value of scrollable.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever the Component is shown
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a cfg-floated component has been brought to the front of the visual stack.
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when top changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of top.
oldValue : Number/String
The previous value of top.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever the data of the component is updated
this : Ext.Component
The component instance
newData : Object
The new data
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when width changes.
sender : Ext.Widget
The instance firing this event.
value : Number/String
The current value of width.
oldValue : Number/String
The previous value of width.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Panel anchor background-color
Defaults to:
$panel-body-background-color
The height (in all orientations) of the anchor arrow
Defaults to:
10px
The extra spacing beyond the tip of the anchor arrow to prevent the pointer touching the target;
Defaults to:
1px
Panel body font-size in the big sizing scheme
Defaults to:
$font-size-big
Panel body line-height in the big sizing scheme
Defaults to:
$panel-body-line-height
Panel body padding in the big sizing scheme
Defaults to:
null
Panel border-radius in the big sizing scheme
Defaults to:
$panel-border-radius
Panel Header background-gradient. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.
Defaults to:
null
Panel Header border-color
Defaults to:
$panel-border-color
Panel Header border-width
Defaults to:
$panel-border-width
Panel Header font-size in the big sizing scheme
Defaults to:
$font-size-big
Panel Header icon color.
Defaults to:
rgba($panel-header-color, .5)
Panel Header icon font-size. Used for configuring the size of font icons
Defaults to:
null
Panel Header icon font-size in the big sizing scheme
Defaults to:
null
The space between the Panel Header icon and text when the icon is horizontally aligned
Defaults to:
6px
The space between the Panel Header icon and text when the icon is horizontally aligned in the big sizing scheme
Defaults to:
8px
Panel Header icon size in the big sizing scheme
Defaults to:
$panel-header-line-height-big
The space between the Panel Header icon and text when the icon is vertically aligned
Defaults to:
2px
The space between the Panel Header icon and text when the icon is vertically aligned in the big sizing scheme
Defaults to:
2px
Panel Header line-height in the big sizing scheme
Defaults to:
24px
Panel Header min-height in the big sizing scheme
Defaults to:
44px
Panel Header padding in the big sizing scheme
Defaults to:
0 15px
Panel Header Title padding in the big sizing scheme
Defaults to:
9px 0
Z-Index for the Panel Header, should be used with shadows to raise header above content
Defaults to:
null
Parameters for the "light" panel UI.
Set to null to eliminate the UI from the CSS output.
Panel Tool border radius in the big sizing scheme
Defaults to:
null
Panel Tool background-color when disabled
Defaults to:
null
Panel Tool outline color when focused
Defaults to:
$panel-header-color
Panel Tool outline offset when focused
Defaults to:
null
Panel Tool font-size in the big sizing scheme
Defaults to:
$panel-tool-size-big
Panel Tool background-color when hovered
Defaults to:
null
Panel Tool background-color when pressed
Defaults to:
null
The space between Panel Tools in the big sizing scheme
Defaults to:
null
Creates a visual theme for a Panel.
$ui : String
The name of the UI being created. Can not included spaces or special punctuation (used in CSS class names).
$xtype : String (optional)
The Ext.Class#xtype to use in CSS selectors. For use by UI mixins of derived classes.
Defaults to: panel
$header-xtype : String (optional)
The Ext.Class#xtype to use in CSS selectors for the header component. For use by UI mixins of derived classes.
Defaults to: panelheader
$title-xtype : String (optional)
The Ext.Class#xtype to use in CSS selectors for the title component. For use by UI mixins of derived classes.
Defaults to: paneltitle
$tool-xtype : String (optional)
The Ext.Class#xtype to use in CSS selectors for tools. For use by UI mixins of derived classes.
Defaults to: paneltool
$background-color : color
Panel background-color
$border-color : color/list
Panel border-color
$border-width : Number/list
Panel border-width
$border-style : String/list
Panel border-style
$border-radius : Number/list
Panel border-radius
$border-radius-big : Number/list
Panel border-radius in the big sizing scheme
$body-background-color : color
Panel body background-color
$body-color : color
Panel body text color
$body-border-color : color
Panel body border-color
$body-border-width : Number/list
Panel body border-width
$body-border-style : Number/list
Panel body border-style
$body-font-weight : String/Number
Panel body font-weight
$body-font-size : Number
Panel body font-size
$body-font-size-big : Number
Panel body font-size in the big sizing scheme
$body-line-height : Number
Panel body line-height
$body-line-height-big : Number
Panel body line-height in the big sizing scheme
$body-font-family : String
Panel body font-family
$body-padding : Number/list
Panel body padding
$body-padding-big : Number/list
Panel body padding in the big sizing scheme
$header-background-color : color
Panel Header background-color
$header-background-gradient : String/list
Panel Header background-gradient. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.
$header-color : color
Panel Header text color
$header-border-color : color/list
Panel Header border-color
$header-border-width : Number/list
Panel Header border-width
$header-border-style : String/list
Panel Header border-style
$header-font-weight : String/Number
Panel Header font-weight
$header-font-size : Number
Panel Header font-size
$header-font-size-big : Number
Panel Header font-size in the big sizing scheme
$header-line-height : Number
Panel Header line-height
$header-line-height-big : Number
Panel Header line-height in the big sizing scheme
$header-font-family : String
Panel Header font-family
$header-padding : Number/list
Panel Header padding
$header-padding-big : Number/list
Panel Header padding in the big sizing scheme
$header-title-padding : Number/list
Panel Header Title padding
$header-title-padding-big : Number/list
Panel Header Title padding in the big sizing scheme
$header-shadow : shadow
Panel Header Shadow
$header-z-index : Number
Z-Index for the Panel Header, should be used with shadows to raise header above content
$header-min-height : Number
Panel Header min-height
$header-min-height-big : Number
Panel Header min-height in the big sizing scheme
$header-icon-color : color
Panel Header icon color.
$header-icon-size : Number
Panel Header icon size
$header-icon-size-big : Number
Panel Header icon size in the big sizing scheme
$header-icon-font-size : Number
Panel Header icon font-size. Used for configuring the size of font icons
$header-icon-font-size-big : Number
Panel Header icon font-size in the big sizing scheme
$header-icon-horizontal-spacing : Number
The space between the Panel Header icon and text when the icon is horizontally aligned
$header-icon-horizontal-spacing-big : Number
The space between the Panel Header icon and text when the icon is horizontally aligned in the big sizing scheme
$header-icon-vertical-spacing : Number
The space between the Panel Header icon and text when the icon is vertically aligned
$header-icon-vertical-spacing-big : Number
The space between the Panel Header icon and text when the icon is vertically aligned in the big sizing scheme
$header-icon-opacity : Number
Panel Header icon opacity
$tool-color : color
Panel Tool color
$tool-hovered-color : Number
Panel Tool color when hovered
$tool-pressed-color : Number
Panel Tool color when pressed
$tool-disabled-color : Number
Panel Tool color when disabled
$tool-background-color : color
Panel Tool background-color
$tool-hovered-background-color : Number
Panel Tool background-color when hovered
$tool-pressed-background-color : Number
Panel Tool background-color when pressed
$tool-disabled-background-color : Number
Panel Tool background-color when disabled
$tool-opacity : Number
Panel Tool opacity
$tool-hovered-opacity : Number
Panel Tool opacity when hovered
$tool-pressed-opacity : Number
Panel Tool opacity when pressed
$tool-disabled-opacity : Number
Panel Tool opacity when disabled
$tool-border-radius : Number
Panel Tool border radius
$tool-border-radius-big : Number
Panel Tool border radius in the big sizing scheme
$tool-size : Number
Panel Tool size
$tool-size-big : Number
Panel Tool size in the big sizing scheme
$tool-font-size : Number
Panel Tool font-size
$tool-font-size-big : Number
Panel Tool font-size in the big sizing scheme
$tool-spacing : Number
The space between Panel Tools
$tool-spacing-big : Number
The space between Panel Tools in the big sizing scheme
$tool-cursor : String
Panel Tool cursor
$tool-disabled-cursor : String
Panel Tool cursor when disabled
$tool-focused-outline-width : Number
Panel Tool outline width when focused
$tool-focused-outline-style : String
Panel Tool outline style when focused
$tool-focused-outline-color : color
Panel Tool outline color when focused
$tool-focused-outline-offset : Number
Panel Tool outline offset when focused
$anchor-border-color : color
Panel anchor border-color
$anchor-background-color : color
Panel anchor background-color
$anchor-height : Number
The height (in all orientations) of the anchor arrow
$anchor-width : Number
The width (in all orientations) of the anchor arrow.
$anchor-margin : Number
The extra spacing beyond the tip of the anchor arrow to prevent the pointer touching the target;
$manage-borders : String
true to include border management rules
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
Ext JS | Terms of Use