The documentation for the ExtReact product diverges somewhat from the
documentation of other Sencha products. The sections below describe
documentation for all products except where indicated as unique to
ExtReact.
Many classes have shortcut names used when creating (instantiating) a class with a
configuration object. The shortcut name is referred to as an alias (or xtype if the
class extends Ext.Component). The alias/xtype is listed next to the class name of
applicable classes for quick reference.
ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.
Framework classes or their members may be specified as private or protected. Else,
the class / member is public. Public, protected, and private are access
descriptors used to convey how and when the class or class member should be used.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
ExtReact component classes display
configuration options as props
ExtReact component classes do not list
properties as a dedicated member type, but rather as
read only props
static label next to the
method name. *See Static below.Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)Ext.Component in this case). This may be omitted for methods that do not
return anything other than undefined or may display as multiple possible values
separated by a forward slash / signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false if unsuccessful which would be displayed as
Ext.Component/Boolean).PROTECTED in
this example - see the Flags section below)Ext.container.Container in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.
All ExtReact props are bindable
unless decorated as immutable
Immutable ExtReact props may not be use as a configurable prop when instantiating a component
classInstance.method1().method2().etc();false is returned from
an event handler- Indicates a framework class
- A singleton framework class. *See the singleton flag for more information
- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)
- Indicates that the class, member, or guide is new in the currently viewed version
- Indicates a class member of type config
Or in the case of an ExtReact component class this
indicates a member of type prop
- Indicates a class member of type property
- Indicates a class member of type
method
- Indicates a class member of type event
- Indicates a class member of type
theme variable
- Indicates a class member of type
theme mixin
- Indicates that the class, member, or guide is new in the currently viewed version
Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.
Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.
ExtReact component classes do not hoist the getter /
setter methods into the prop. All methods will be described in the
Methods section
Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.
Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.
If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.
Both API docs and guides can be searched for using the search field at the top of the page.
On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.
The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.
Clicking on an empty search field will show your last 10 searches for quick navigation.
Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.
Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.
Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:
The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.
This is a specialized field which shows a Ext.picker.Date when tapped. If it has a predefined value, or a value is selected in the Ext.picker.Date, it will be displayed like a normal TextField (but not selectable/changeable).
Ext.field.DatePicker fields are very simple to implement, and have no required configurations.
It can be very useful to set a default value configuration on Ext.field.DatePicker fields. In this example, we set the value to be the current date. You can also use the setValue method to update the value at any time.
The template used to format the Array of error messages passed to setActiveErrors into a single HTML string. if the msgTarget is title, it defaults to a list separated by new lines. Otherwise, it renders each message as an item in an unordered list.
Defaults to:
undefined
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.
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.
True to set the field's DOM element auto=capitalize attribute to "on", false to set to "off".
Defaults to:
null
Sets the value of autoCapitalize
autoCapitalize : Boolean
True to set the field DOM element auto-correct attribute to "on", false to set to "off".
Defaults to:
null
Whether to adjust the component's body width to make room for error messages.
Defaults to:
null
If true, then, when showBy or alignTo fallback on
constraint violation only takes place along the major align axis.
That is, if alignment "l-r" is being used, and axisLock: true is used, then if constraints
fail, only fallback to "r-l" is considered.
Defaults to:
null
The error text to display if the allowBlank validation fails.
Defaults to:
'This field is required'
The horizontal alignment of this field's component within the body of the field
Defaults to:
'start'
Returns the value of bodyAlign
'start' / 'center' / 'end' / 'stretch'
Sets the value of bodyAlign
bodyAlign : 'start' / 'center' / 'end' / 'stretch'
Enables or disables bordering on this component. The following values are accepted:
null or `true (default): Do nothing and allow the border to be specified by the theme.false: suppress the default border provided by the theme.Please note that enabling bordering via this config will not add a border-color
or border-style CSS property to the component; you provide the border-color
and border-style via CSS rule or style configuration
(if not already provide by the theme).
Defaults to:
null
The absolute bottom position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
Explicitly setting this value will make this Component become 'positioned', which means it will no
longer participate in the layout of the Container that it resides in.
Defaults to:
null
Configure this as true to have this Component centered within its Container.
Setting this value to true will make this Component become 'positioned', which means it will no
longer participate in the layout of the Container that it resides in.
Defaults to:
null
The CSS class to add to this widget's element, in addition to the baseCls. In many cases, this property will be specified by the derived widget class. See userCls for adding additional CSS classes to widget instances (such as items in a Container).
Defaults to:
null
The configured element will automatically be added as the content of this component. When you pass a string, we expect it to be an element id. If the content element is hidden, we will automatically show it.
Defaults to:
null
Returns the value of contentEl
Ext.dom.Element / HTMLElement / String
Sets the value of contentEl
contentEl : Ext.dom.Element / HTMLElement / String
The initial set of data to apply to the tpl to
update the content area of the Component.
Defaults to:
null
The format to be used when displaying the date in this field. Accepts any valid date format. You can view formats over in the Ext.Date documentation.
Defaults to:
Ext.util.Format.defaultDateFormat
Whether or not to destroy the picker widget on hide. This save memory if it's not used frequently, but increase delay time on the next show due to re-instantiation.
Defaults to:
false
Sets the value of destroyPickerOnHide
destroyPickerOnHide : Boolean
true to disable the field.
Be aware that conformant with the HTML specification, disabled Fields will not be submitted.
Defaults to:
false
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
A configuration object, containing an cfg#xtype property which specifies the widget to
create if picker: 'edge' (or if it's 'auto' and the app is on a phone)
Defaults to:
null
Available since: 6.5.0
Configure as false to prevent the user from typing text directly into the field;
the field can only have its value set programmatically or via an action invoked by a trigger.
Contrast with readOnly which disables all mutation via the UI.
Defaults to:
true
A configuration object, containing an cfg#xtype property which specifies the widget to
create if picker: 'floated' (or if it's 'auto' and the app is not on a phone)
Defaults to:
null
Available since: 6.5.0
*Only valud when the floatedPicker is used. The showBy alignment string to use when showing the floated picker by the input field.
Defaults to:
tl-bl?
Sets the value of floatedPickerAlign
floatedPickerAlign : String
CSS class that will be added to focused component's focusClsEl, and removed when component blurs.
Defaults to:
'x-focused'
The height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
By default, if this is not explicitly set, this Component's element will simply have its own natural size.
If set to auto, it will set the width to null meaning it will have its own natural size.
Defaults to:
null
Animation effect to apply when the Component is being hidden. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'. For more animations, check the Ext.fx.Animation#type config.
Defaults to:
null
Sets the value of hideAnimation
hideAnimation : String / Mixed
When using a modal Component, setting this to true
will hide the modal mask and the Container when the mask is tapped on.
Defaults to:
null
Optional HTML content to render inside this Component, or a reference to an existing element on the page.
Defaults to:
null
Returns the value of html
String / Ext.dom.Element / HTMLElement
The type attribute for input fields -- e.g. text, password, date, url, email, etc.
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.
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'
When value is 'placeholder', the label text will be rendered as placeholder
text inside the empty input and will animated to "top" alignment when the input
is focused or contains text.
The position to render the label relative to the field input.
Defaults to:
'left'
Returns the value of labelAlign
'top' / 'left' / 'bottom' / 'right' / 'placeholder'
Sets the value of labelAlign
labelAlign : 'top' / 'left' / 'bottom' / 'right' / 'placeholder'
Text alignment of this field's label
Defaults to:
'left'
Returns the value of labelTextAlign
'top' / 'right' / 'bottom' / 'left'
Sets the value of labelTextAlign
labelTextAlign : 'top' / 'right' / 'bottom' / 'left'
true to allow the label to wrap. If set to false, the label will be truncated with
an ellipsis.
Defaults to:
false
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
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
*Only valid when the picker: 'floated' is used.
Whether the floatedPicker's width should be explicitly set to
match the width of the input element.
Defaults to:
true
Sets the value of matchFieldWidth
matchFieldWidth : Boolean
The maximum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
If set to auto, it will set the width to null meaning it will have its own natural size.
Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)
Defaults to:
null
The maximum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
If set to auto, it will set the width to null meaning it will have its own natural size.
Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)
Defaults to:
null
The minimum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
If set to auto, it will set the width to null meaning it will have its own natural size.
Defaults to:
null
The minimum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
If set to auto, it will set the width to null meaning it will have its own natural size.
Defaults to:
null
true to make this Component modal. This will create a mask underneath the Component
that covers its parent and does not allow the user to interact with any other Components until this
Component is dismissed.
Defaults to:
null
[msgTarget="qtip"]
The location where the error message text should display. Must be one of the following values:
The field's HTML name attribute.
Note: this property must be set if this field is to be automatically included with. form submit().
Defaults to:
null
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
The value for the HTML5 pattern attribute.
You can use this to change which keyboard layout will be used.
Even though it extends TextField, it will display the number keyboard.
Defaults to:
null
An object that is used when creating the internal Ext.picker.Date component or a direct instance of Ext.picker.Date.
Defaults to:
true
A string value displayed in the input when the control is empty.
Defaults to:
null
An object or array of objects that will provide custom functionality for this
component. If a string is provided or a string is one of the elements of the
array, that string is treated as the type alias. For example, "listpaging"
is the type alias for Ext.plugin.ListPaging. The full alias includes the
"plugin." prefix (i.e., 'plugin.listpaging').
Plugins should derive from Ext.plugin.Abstract but this is not required. The
only requirement for a valid plugin is that it contain an init() method that
accepts a reference to the owning component.
When a component is created, if any plugins are available, the component will
call the init method on each plugin,
passing a reference to itself. Each plugin can then call methods or respond to
events on the component as needed to provide its functionality.
A plugin by alias:
var list = Ext.create({
xtype: 'list',
itemTpl: '<div class="item">{title}</div>',
store: 'Items',
plugins: 'listpaging'
});
Multiple plugins by alias:
var list = Ext.create({
xtype: 'list',
itemTpl: '<div class="item">{title}</div>',
store: 'Items',
plugins: ['listpaging', 'pullrefresh']
});
Single plugin by class name with config options:
var list = Ext.create({
xtype: 'list',
itemTpl: '<div class="item">{title}</div>',
store: 'Items',
plugins: {
type: 'listpaging',
autoPaging: true
}
});
Multiple plugins by type and class name with config options:
var list = Ext.create({
xtype: 'list',
itemTpl: '<div class="item">{title}</div>',
store: 'Items',
plugins: [{
xclass: 'Ext.plugin.PullRefresh',
pullRefreshText: 'Pull to refresh...'
}, {
type: 'listpaging',
autoPaging: true
}]
});
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
Optional element to render this Component to. Not required if this component is an item of a Container of a Container.
Defaults to:
null
true to make this field required.
Note: this only causes a visual indication.
Doesn't prevent user from submitting the form.
Defaults to:
false
The absolute right position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
Explicitly setting this value will make this Component become 'positioned', which means it will no
longer participate in the layout of the Container that it resides in.
Defaults to:
null
Configuration options to make this Component scrollable. Acceptable values are:
true to enable auto scrolling.false (or null) to disable scrolling - this is the default.x or horizontal to enable horizontal scrolling onlyy or vertical to enable vertical scrolling onlyAlso accepts a configuration object for a Ext.scroll.Scroller if
if advanced configuration is needed.
The getter for this config returns the Ext.scroll.Scroller instance. You can use the Scroller API to read or manipulate the scroll position:
// scrolls the component to 5 on the x axis and 10 on the y axis
component.getScrollable().scrollTo(5, 10);
Defaults to:
null
Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'. For more animations, check the Ext.fx.Animation#type config.
Defaults to:
null
Sets the value of showAnimation
showAnimation : String / Mixed
The value that the Field had at the time it was last focused. This is the value that is passed to the Ext.field.Text#change event which is fired if the value has been changed when the Field is blurred.
This will be undefined until the Field has been visited. Compare originalValue.
Defaults to:
false
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
The tabIndex for this field. Note this only applies to fields that are rendered,
not those which are built via applyTo.
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
The text alignment of this field.
Defaults to:
null
Returns the value of textAlign
'left' / 'center' / 'right'
Sets the value of textAlign
textAlign : 'left' / 'center' / 'right'
The tooltip for this component - can be a string to be used as innerHTML (html tags are accepted) or ToolTip config object.
The default behavior is to use a shared tip instance. The tooltip configuration is registered with the Ext.tip.Manager. To enable this, your application can set the Ext.app.Application#quickTips config, or an instance of the Ext.tip.Manager may be created manually.
To force a unique tooltip instance to be created, specify autoCreate: true on this configuration.
Configuring this with autoHide: false implies autoCreate: true so that the desired persistent
behavior can be obtained with other targets still showing the singleton instance.
Defaults to:
null
The absolute top position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
Explicitly setting this value will make this Component become 'positioned', which means it will no
longer participate in the layout of the Container that it resides in.
Defaults to:
null
Emulates the behavior of the CSS touch-action property in a cross-browser compatible manner.
Keys in this object are touch action names, and values are false to disable
a touch action or true to enable it. Accepted keys are:
panXpanYpinchZoomdoubleTapZoomAll touch actions are enabled (true) by default, so it is usually only necessary
to specify which touch actions to disable. For example, the following disables
only horizontal scrolling and pinch-to-zoom on the component's main element:
touchAction: {
panX: false,
pinchZoom: false
}
Touch actions can be specified on reference elements using the reference element name, for example:
// disables horizontal scrolling on the main element, and double-tap-zoom
// on the child element named "body"
touchAction: {
panY: false
body: {
doubleTapZoom: false
}
}
The primary motivation for setting the touch-action of an element is to prevent the browser's default handling of a gesture such as pinch-to-zoom, or drag-to-scroll, so that the application can implement its own handling of that gesture on the element. Suppose, for example, a component has a custom drag handler on its element and wishes to prevent horizontal scrolling of its container while it is being dragged:
Ext.create('Ext.Widget', {
touchAction: {
panX: false
},
listeners: {
drag: function(e) {
// implement drag logic
}
}
});
Defaults to:
null
A string, array of strings, or a function that returns JSX.
tpl = data =>
Note The data configuration must be set for any content to be shown in the component when using this configuration.
Defaults to:
null
The Ext.(X)Template method to use when updating the content area of the Component.
Valid modes are:
Defaults to:
'overwrite'
Ext.field.trigger.Trigger to use in this field. The keys in this object are unique identifiers for the triggers. The values in this object are Ext.field.trigger.Trigger configuration objects.
The weight value may be a negative value in order to position custom triggers ahead of default triggers like that of a DatePicker field.
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
true to validate the field, even if it is disabled.
Defaults to:
false
Sets the value of validateDisabled
validateDisabled : Boolean
For HTML5 validation, regex, etc., this is the error message returned if field is invalid.
Defaults to:
'Is in the wrong format'
Sets the value of validationMessage
validationMessage : String
Default value for the field and the internal Ext.picker.Date component. Accepts an object of 'year', 'month' and 'day' values, all of which should be numbers, or a Date.
Example: {year: 1989, day: 1, month: 5} = 1st May 1989 or new Date()
Returns the Date value of this field. If you wanted a formatted date use the getFormattedValue method.
The date selected
This value controls this item's order in a weighted Container (see parent).
Lower values gravitate towards the start of the container - the top in vertical layouts, the locale start side in horizontal layouts.
Defaults to:
null
The width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.
By default, if this is not explicitly set, this Component's element will simply have its own natural size.
If set to auto, it will set the width to null meaning it will have its own natural size.
Defaults to:
null
The xtype configuration option can be used to optimize Component creation and rendering. It serves as a
shortcut to the full component name. For example, the component Ext.button.Button has an xtype of button.
You can define your own xtype on a custom Ext.Component by specifying the
alias config option with a prefix of widget. For example:
Ext.define('PressMeButton', {
extend: 'Ext.button.Button',
alias: 'widget.pressmebutton',
text: 'Press Me'
});
Any Component can be created implicitly as an object config with an xtype specified, allowing it to be declared and passed into the rendering pipeline without actually being instantiated as an object. Not only is rendering deferred, but the actual creation of the object itself is also deferred, saving memory and resources until they are actually needed. In complex, nested layouts containing many Components, this can make a noticeable improvement in performance.
// Explicit creation of contained Components:
var panel = new Ext.Panel({
// ...
items: [
Ext.create('Ext.button.Button', {
text: 'OK'
})
]
});
// Implicit creation using xtype:
var panel = new Ext.Panel({
// ...
items: [{
xtype: 'button',
text: 'OK'
}]
});
In the first example, the button will always be created immediately during the panel's initialization. With many added Components, this approach could potentially slow the rendering of the page. In the second example, the button will not be created or rendered until the panel is actually displayed in the browser. If the panel is never displayed (for example, if it is a tab that remains hidden) then the button will never be created and will never consume any resources whatsoever.
Defaults to:
"component"
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
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 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;
}
If this property is specified by the target class of this mixin its properties are
used to configure the created Ext.Factory.
true for keyboard interactive Components or Widgets, false otherwise.
For Containers, this property reflects interactiveness of the
Container itself, not its children. See isFocusable.
Note: It is not enough to set this property to true to make
a component keyboard interactive. You also need to make sure that
the component's focusEl is reachable via Tab key (tabbable).
See also tabIndex.
Defaults to:
false
The element that will have the focusCls applied when component's focusEl is focused.
The element that will be focused when focus method is called on this component. Usually this is the same element that receives focus via mouse clicks, taps, and pressing Tab key.
Defaults to:
'el'
true if this component's focusEl is focused.
See also containsFocus.
Defaults to:
false
This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class (via observe) or on the Ext.app.EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.
The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:
if (this.hasListeners.foo) {
this.fireEvent('foo', this, arg1);
}
This property is set to true during the call to initConfig.
Defaults to:
false
Available since: 5.0.0
Set to true on all Ext.field.Field subclasses. This is used by
Ext.form.Panel#getValues to determine which components inside a form are fields.
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
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'
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
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.
Determines how initial values will handle validation
Defaults to:
'auto'
Adds a CSS class (or classes) to this Component's rendered element.
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}
});
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
delay : Number
single : Boolean
buffer : Number
onFrame : Number
target : Ext.util.Observable
element : String
delegate : String (optional)
capture : Boolean (optional)
stopPropagation : Boolean (optional)
preventDefault : Boolean (optional)
stopEvent : Boolean (optional)
args : Array (optional)
destroyable : Boolean (optional)
Defaults to:
priority : Number (optional)
order : String (optional)
Defaults to:
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.
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.
Adds a trigger to this text field.
name : String
Unique name (within this field) for the trigger. Cannot be the same as the name of an existing trigger for this field.
trigger : Ext.field.trigger.Trigger / Object
The trigger instance or a prop object for a trigger to add
The trigger that was added
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 floated or positioned Component in its parent.
this
Called when focus leaves this input field. Used to post-process raw values and perform conversion and validation.
Creates new Component.
config : Object
The standard configuration object.
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.
Removes and destroys a plugin.
Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.
Available since: 6.2.0
plugin : String / Ext.plugin.Abstract
The plugin or its id to remove.
plugin instance or null if not found.
Perform the actual destruction sequence. This is the method to override in your subclasses to add steps specific to the destruction of custom Component.
If the Component is currently added to a Container it will first be removed from that Container. All Ext.Element references are also deleted and the Component is de-registered from Ext.ComponentManager.
As a rule of thumb, subclasses should destroy their child Components, Elements, and/or other objects before calling parent method. Any object references will be nulled after this method has finished, to prevent the possibility of memory leaks.
Available since: 6.2.0
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');
}
}
});
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
plugin instance or null if not found.
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.
scope : Object (optional)
The scope (this reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
Try to focus this component.
If this component is disabled or otherwise not focusable, a close relation will be targeted for focus instead to keep focus localized for keyboard users.
selectText : Boolean / Number[] (optional)
If applicable, true to also select all the text
in this component, or an array consisting of start and end (defaults to start)
position of selection.
true if focus target was found and focusing was attempted,
false if no focusing attempt was made.
Find the Widget or Component to which the given event/element belongs.
Available since: 6.5.0
el : Ext.event.Event / Ext.dom.Element / HTMLElement
The element or event from which to start to find an owning Component.
limit : Ext.dom.Element / HTMLElement (optional)
The element at which to stop upward searching for an owning Component, or the number of Components to traverse before giving up. Defaults to the document's HTML element.
selector : String (optional)
An optional Ext.ComponentQuery selector to filter the target.
Component, or null
Gets the active error message for this component, if any. This does not trigger validation on its own, it merely returns any message that the component may already hold.
The active error message on the component; if there is no error, an empty string is returned.
Gets the array of active errors for this component, if any.
The active error message(s) on the component.
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.
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
Returns the stack of floated components in which this Component resides. This Component and all siblings at this level are returned.
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 main focus holder element associated with this Focusable, i.e. the element that will be focused when Focusable's focus method is called. For the most Focusables this will be the focusEl.
Returns the value of the field formatted using the specified format. If it is not specified, it will default to dateFormat and then Ext.util.Format#defaultDateFormat.
format : String
The format to be returned.
The formatted date.
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 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: {
xclass: 'Ext.plugin.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.
Used by Ext.ComponentQuery, and the up method to find the owning Component in the linkage hierarchy.
By default this returns the Container which contains this Component.
This may be overridden by Component authors who implement ownership hierarchies which are not based upon ownerCt, such as BoundLists being owned by Fields or Menus being owned by Buttons.
Returns the height and width of the Component.
width : Number
height : Number
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.
Tells whether the field currently has an active error message. This does not trigger validation on its own, it merely looks for any message that the component may already hold.
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.
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
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.
Template method to do any Focusable related initialization that does not involve event listeners creation.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Template method to do any event listener initialization for a Focusable. This generally happens after the focusEl is available.
This method is called to initialize the inheritedState objects for this instance.
This amounts to typically copying certain properties from the instance to the given
object.
Available since: 5.0.0
inheritedState : Object
The state object for this instance.
inheritedStateInner : Object (optional)
This object is only provided for containers.
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. In Classic Toolkit, this is done after the component is rendered.
Allows addition of behavior to the rendering phase.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
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 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.
Returns true if the value of this Field has been changed from its originalValue.
Will return false if the field is disabled or has not been rendered yet.
true if this field has been changed from its original value (and
is not disabled), false otherwise.
Returns true if this Component is currently disabled.
true if currently disabled.
Returns whether two field values are logically equal. Field implementations may override this to provide custom comparison logic appropriate for the particular field's data type.
value1 : Object
The first value to compare
value2 : Object
The second value to compare
True if the values are equal, false if inequal.
Determine if this Focusable can receive focus at this time.
Note that Containers can be non-focusable themselves while delegating focus treatment to a child Component; see Container for more information.
deep : Boolean (optional)
Optionally determine if the container itself is focusable, or if container's focus is delegated to a child component and that child is focusable.
Defaults to: false
True if component is focusable, false if not.
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
Returns true if this Component is currently visible.
deep : Boolean (optional)
true to check if this component
is visible and all parents are also visible.
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.
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.
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.
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.
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}
});
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
delay : Number
single : Boolean
buffer : Number
onFrame : Number
target : Ext.util.Observable
element : String
delegate : String (optional)
capture : Boolean (optional)
stopPropagation : Boolean (optional)
preventDefault : Boolean (optional)
stopEvent : Boolean (optional)
args : Array (optional)
destroyable : Boolean (optional)
Defaults to:
priority : Number (optional)
order : String (optional)
Defaults to:
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'.
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'.
scope : Object (optional)
The scope for fn.
options : Object (optional)
An object containing handler configuration.
Called when focus enters this Component's hierarchy
e : Object
event : Ext.event.Event
target : HTMLElement
: HTMLElement
toComponent : Ext.Component
fromComponent : Ext.Component
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
target : HTMLElement
: HTMLElement
toComponent : Ext.Component
fromComponent : Ext.Component
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
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:
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 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.
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.
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 the given CSS class(es) from this Component's rendered element.
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.
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.
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.
Removes a trigger from this text field.
trigger : String / Ext.field.trigger.Trigger
The name of the trigger to remove, or a trigger reference.
destroy : Boolean (optional)
False to prevent the trigger from being destroyed on removal. Only use this option if you want to reuse the trigger instance.
Defaults to: true
The trigger that was removed
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.
Resets the current field value back to the original value on this field when it was created.
// Update the value
field.setValue('new value');
// Now you can reset it back to the `first value`
field.reset();
this
Resets the field's originalValue property so it matches the current value. This is called by FormPanel. setValues if the form's trackResetOnLoad property is set to true.
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.
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.
Attempts to forcefully select all the contents of the input field.
this
Store the activeError message string, fire the errorchange event accordingly, and
update the UI. If the error to be set is empty string, any validation UI is removed,
otherwise the proper validation UI is displayed, based upon msgTarget.
Set the active error message to an Array of error messages. The messages are formatted into a single message string using the activeErrorsTpl. Also see setActiveError which allows setting the entire error contents with a single string. You probably want to call markInvalid instead.
errors : String[]
The error messages
Sets a single/multiple configuration options.
value : Object (optional)
The value to set for the name parameter.
this
fromKeyboard : Boolean (optional)
Passed as true if the keyboard was used
to open the picker. This usually means that picker location should be set.
A function which may be implemented in subclasses which moves the focus to the value in the picker which matches this field's value.
For example, if you were writing a time picker, this method would be where you synced the picker's value with the field's value.
Defaults to: false
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
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());
}
}
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 Button
// 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 specific alignment.
options : Object (optional)
An object containing options for the Ext.util.Region#alignTo method.
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.
Add or removes a class based on if the class is already added to the Component.
className : String
The 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.
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'.
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'.
scope : Object (optional)
The scope originally specified for fn.
options : Object (optional)
Extra options object.
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).
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.
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
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()
The new method name, or an object to set multiple aliases. See flexSetter
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
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 the return key or go is pressed. FormPanel listeners for this event, and submits itself whenever it fires. Also note that this event bubbles up to parent containers.
this : TextField
This field
e : Mixed
The key event object
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This action following this event is preventable. When any of the listeners returns false, the action is cancelled.
Fires after a Component had been added to a Container.
this : Ext.Component
container : 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 bottom changes.
sender : Ext.Component
The instance firing this event.
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.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when disabled changes.
sender : Ext.Widget
The instance firing this event.
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.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when height changes.
sender : Ext.Widget
The instance firing this event.
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.
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.
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.
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.
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.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
This event fires when right changes.
sender : Ext.Component
The instance firing this event.
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.
This event fires when top changes.
sender : Ext.Component
The instance firing this event.
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.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false to cancel the change.
Fires when this field loses input focus
this : TextField
This field
e : Ext.event.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.
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.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a date is selected
this : Ext.field.DatePicker
newDate : Date
The new date
oldDate : Date
The old date
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the clear icon is tapped
this : TextField
This field
input : Ext.field.Input
The field's input component.
e : Ext.event.Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This action following this event is preventable. When any of the listeners returns false, the action is cancelled.
Fires whenever the input is clicked.
e : Ext.event.Event
The event object.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the field's picker is collapsed.
field : Ext.form.field.Picker
This field instance
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.
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.
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 field's picker is expanded.
field : Ext.form.field.Picker
This field instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when this field receives input focus
this : TextField
This field
e : Ext.event.Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when focus enters this Component's hierarchy.
this : Ext.Component
event : Ext.event.Event
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.
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.
Fires when a key is released on the input element
this : TextField
This field
e : Ext.event.Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This action following this event is preventable. When any of the listeners returns false, the action is cancelled.
This event fires when left changes.
sender : Ext.Component
The instance firing this event.
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.
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.
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.
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.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when this field receives a mousedown
this : TextField
This field
e : Ext.event.Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a component si moved within its Container.
this : Ext.Component
container : 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 when this field is pasted.
this : TextField
This field
e : Ext.event.Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever there is a change in the positioned status of a component
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 when a component is removed from a Container
this : Ext.Component
container : 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 asynchronously after a browser layout caused by a component resize. This may be triggered for any or several of the following reasons:
component : Ext.Component
This Component.
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.
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.
This event fires when top changes.
sender : Ext.Component
The instance firing this event.
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.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Field label background-color when disabled
Defaults to:
null
Field error icon when {#errorTarget} is 'side'
Defaults to:
$fa-var-exclamation-circle FontAwesome
Field error icon color when {#errorTarget} is 'side'
Defaults to:
$alert-color
Field error icon font-size when {#errorTarget} is 'side'
Defaults to:
null
Field error icon font-size when {#errorTarget} is 'side'
in the big sizing scheme
Defaults to:
null
Field error icon margin when {#errorTarget} is 'side'
Defaults to:
0 5px
Field error icon margin when {#errorTarget} is 'side'
in the big sizing scheme
Defaults to:
0 8px
Field error icon size when {#errorTarget} is 'side'
Defaults to:
16px
Field error icon size when {#errorTarget} is 'side'
in the big sizing scheme
Defaults to:
30px
Field error icon when {#errorTarget} is 'under'
Defaults to:
$fa-var-exclamation-circle FontAwesome
Field error icon color when {#errorTarget} is 'under'
Defaults to:
$alert-color
Field error icon font-size when {#errorTarget} is 'under'
Defaults to:
null
Field error icon font-size when {#errorTarget} is 'under'
in the big sizing scheme
Defaults to:
null
Field error icon margin when {#errorTarget} is 'under'
Defaults to:
0 5px 0 0
Field error icon margin when {#errorTarget} is 'under'
in the big sizing scheme
Defaults to:
0 8px 0 0
Field error icon size when {#errorTarget} is 'under'
Defaults to:
16px
Field error icon size when {#errorTarget} is 'under'
in the big sizing scheme
Defaults to:
30px
Field error message font-size in the big sizing scheme
Defaults to:
null
Field error message font-weight
Defaults to:
$font-weight
Field error message line-height in the big sizing scheme
Defaults to:
24px
Field error element margin when {#errorTarget} is 'under'
Defaults to:
2px 0
Field error element margin when {#errorTarget} is 'under'
in the big sizing scheme
Defaults to:
3px
Field label background-color when focused
Defaults to:
null
Field label background-color when invalid
Defaults to:
null
Field label font-size in the big sizing scheme
Defaults to:
$font-size-big
Field label line-height in the big sizing scheme
Defaults to:
20px
Field label min-width in the big sizing scheme
Defaults to:
null
Field label padding in the big sizing scheme
Defaults to:
6px 6px 6px 0
Field required indicator font-family
Defaults to:
null
Field required indicator font-weight
Defaults to:
null
Field required indicator line-height
Defaults to:
null
Field required indicator margin
Defaults to:
-3px null null 4px
Field required indicator margin in the big sizing scheme
Defaults to:
null
Vertical space in between form fields in the big sizing scheme
Defaults to:
8px
Parameters for the "alt" textfield UI.
Set to null to eliminate the UI from the CSS output.
The duration for the focus underline animation
Defaults to:
.45s
Text Field body width in the big sizing scheme
Defaults to:
200px
Parameters for the "celleditor" textfield UI.
Set to null to eliminate the UI from the CSS output.
Text Field input background-color when disabled
Defaults to:
null
Text Field input border color when disabled
Defaults to:
null
Parameters for the "faded" textfield UI.
Set to null to eliminate the UI from the CSS output.
Text Field input background-color when focused
Defaults to:
null
Text Field input border color when focused
Defaults to:
mix(#fff, #157fcc, 15%)
Text Field input border style when focused
Defaults to:
null
Text field input underline color when focused
Defaults to:
null
Text field input underline width when focused
Defaults to:
null
Text Field input background-color
Defaults to:
$background-color
Text Field input border color
Defaults to:
$neutral-color
Text Field input font-size in the big sizing scheme
Defaults to:
$font-size-big
Text Field input font-weight
Defaults to:
$font-weight-normal
Text Field input line-height in the big sizing scheme
Defaults to:
20px
Text Field input padding in the big sizing scheme
Defaults to:
5px 6px
Text Field input background-color when invalid
Defaults to:
null
Text Field input border color when invalid
Defaults to:
$alert-color
Text Field input border style when invalid
Defaults to:
null
Text field input underline color when invalid
Defaults to:
null
Text field input underline width when invalid
Defaults to:
null
Text Field placeholder color
Defaults to:
$neutral-medium-dark-color
Parameters for the "solo" textfield UI.
Set to null to eliminate the UI from the CSS output.
Creates a visual theme for a Field
$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: field
$background-color : color
Field background-color
$focused-background-color : color
Field background-color when focused
$invalid-background-color : color
Field background-color when invalid
$disabled-background-color : color
Field background-color when disabled
$label-color : color
Field label text color
$focused-label-color : color
Field label text color when focused
$invalid-label-color : color
Field label text color when invalid
$disabled-label-color : color
Field label text color when disabled
$label-background-color : color
Field label background-color
$focused-label-background-color : color
Field label background-color when focused
$invalid-label-background-color : color
Field label background-color when invalid
$disabled-label-background-color : color
Field label background-color when disabled
$label-padding : Number / list
Field label padding
$label-font-size : Number
Field label font-size
$label-line-height : Number
Field label line-height
$label-font-family : String
Field label font-family
$label-width : Number
Field label width
$label-min-width : Number
Field label min-width
$disabled-opacity : Number
Opacity of form fields when disabled
$error-icon-side : String
Field error icon when {#errorTarget} is 'side'
$error-icon-side-color : color
Field error icon color when {#errorTarget} is 'side'
$error-icon-side-size : Number
Field error icon size when {#errorTarget} is 'side'
$error-icon-side-size-big : Number
Field error icon size when {#errorTarget} is 'side'
in the big sizing scheme
$error-icon-side-font-size : Number
Field error icon font-size when {#errorTarget} is 'side'
$error-icon-side-font-size-big : Number
Field error icon font-size when {#errorTarget} is 'side'
in the big sizing scheme
$error-icon-side-margin : Number / list
Field error icon margin when {#errorTarget} is 'side'
$error-icon-side-margin-big : Number / list
Field error icon margin when {#errorTarget} is 'side'
in the big sizing scheme
$error-icon-under : String
Field error icon when {#errorTarget} is 'under'
$error-icon-under-color : color
Field error icon color when {#errorTarget} is 'under'
$error-icon-under-size : Number
Field error icon size when {#errorTarget} is 'under'
$error-icon-under-size-big : Number
Field error icon size when {#errorTarget} is 'under'
in the big sizing scheme
$error-icon-under-font-size : Number
Field error icon font-size when {#errorTarget} is 'under'
$error-icon-under-font-size-big : Number
Field error icon font-size when {#errorTarget} is 'under'
in the big sizing scheme
$error-icon-under-margin : Number / list
Field error icon margin when {#errorTarget} is 'under'
$error-icon-under-margin-big : Number / list
Field error icon margin when {#errorTarget} is 'under'
in the big sizing scheme
$error-under-margin : Number / list
Field error element margin when {#errorTarget} is 'under'
$error-under-margin-big : Number / list
Field error element margin when {#errorTarget} is 'under'
in the big sizing scheme
$error-message-color : color
Field error message color
$error-message-font-size : Number
Field error message font-size
$error-message-line-height : Number
Field error message line-height
$error-message-font-family : String
Field error message font-family
Creates a visual theme for a Text Field
$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: textfield
$background-color : color
Text Field input background color
$focused-background-color : color
Focused Text Field background color
$invalid-background-color : color
Invalid Text Field background color
$disabled-background-color : color
Disabled Text Field background color
$label-color : color
Text Field label color
$focused-label-color : color
Focused Text Field label color
$invalid-label-color : color
Invalid Text Field label color
$disabled-label-color : color
Disabled Text Field label color
$label-background-color : color
Text Field Label background color
$focused-label-background-color : color
Focused Text Field Label background color
$invalid-label-background-color : color
Invalid Text Field Label background color
$disabled-label-background-color : color
Disabled Text Field Label background color
$label-padding : Number
Text Field label padding
$label-font-weight : Number
Text Field label font weight
$label-font-size : Number
Text Field label font size
$label-line-height : Number
Text Field label line height
$label-font-family : String
Text Field label font family
$disabled-opacity : Number
Text Field disabled opacity
$required-indicator-font-weight : Number
Required indicator font weight
$required-indicator-font-size : Number
Required indicator font size
$required-indicator-line-height : Number
Required indicator line height
$required-indicator-font-family : String
Required indicator font family
$required-indicator-margin : String
Required indicator margin
$input-color : color
Text field input color
$focused-input-color : color
Text Field input color when focused
$invalid-input-color : color
Text Field input color when invalid
$disabled-input-color : color
Text Field input color when disabled
$input-border-width : Number / list
Text Field input border width
$input-border-style : String / list
Text Field input border style
$focused-input-border-style : String / list
Text Field input border style when focused
$invalid-input-border-style : String / list
Text Field input border style when invalid
$input-border-color : color / list
Text Field input border color
$focused-input-border-color : String / list
Text Field input border color when focused
$invalid-input-border-color : String / list
Text Field input border color when invalid
$disabled-input-border-color : String / list
Text Field input border color when disabled
$input-underline-width : Number
Text field input underline width
$focused-input-underline-width : Number
Text field input underline width when focused
$invalid-input-underline-width : Number
Text field input underline width when invalid
$input-underline-color : color
Text field input underline color
$focused-input-underline-color : color
Text field input underline color when focused
$invalid-input-underline-color : color
Text field input underline color when invalid
$input-background-color : color
Text Field input background-color
$focused-input-background-color : color
Text Field input background-color when focused
$invalid-input-background-color : color
Text Field input background-color when invalid
$disabled-input-background-color : color
Text Field input background-color when disabled
$input-padding : color
Text Field input padding
$input-padding-big : color
Text Field input padding in the big sizing scheme
$input-font-size : Number
Text Field input font-size
$input-line-height : Number
Text Field input line-height
$input-font-family : String
Text Field input font-family
$placeholder-color : color
Text Field placeholder color
$border-radius : Number
The border radius of the text field
$body-width : Number
Text Field body width
$animate-underline-duration : Number
The duration, in seconds, for the focus underline animation
ExtReact | Terms of Use