Many classes have shortcut names used when creating (instantiating) a class with a
configuration object. The shortcut name is referred to as an alias
(or xtype
if the
class extends Ext.Component). The alias/xtype is listed next to the class name of
applicable classes for quick reference.
Framework classes or their members may be specified as private
or protected
. Else,
the class / member is public
. Public
, protected
, and private
are access
descriptors used to convey how and when the class or class member should be used.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public
members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
static
label next to the
method name. *See Static below.Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).
Let's look at each part of the member row:
lookupComponent
in this example)( item )
in this example)Ext.Component
in this case). This may be omitted for methods that do not
return anything other than undefined
or may display as multiple possible values
separated by a forward slash /
signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false
if unsuccessful which would be displayed as
Ext.Component/Boolean
).PROTECTED
in
this example - see the Flags section below)Ext.container.Container
in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source
in the example)item : Object
in the example).undefined
a "Returns" section
will note the type of class or object returned and a description (Ext.Component
in the
example)Available since 3.4.0
- not pictured in
the example) just after the member descriptionDefaults to: false
)The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.
classInstance.method1().method2().etc();
false
is returned from
an event handler- Indicates a framework class
- A singleton framework class. *See the singleton flag for more information
- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)
- Indicates that the class, member, or guide is new in the currently viewed version
- Indicates a class member of type config
- Indicates a class member of type property
- Indicates a class member of type
method
- Indicates a class member of type event
- Indicates a class member of type
theme variable
- Indicates a class member of type
theme mixin
- Indicates that the class, member, or guide is new in the currently viewed version
Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.
Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.
Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.
Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.
If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.
Both API docs and guides can be searched for using the search field at the top of the page.
On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level and inheritance. 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.
For an overview of calendar views see Ext.calendar.view.Base
The Week view displays the week containing the current date (or the date set on the value config). The number of days configured on the visibleDays config (defaults to 7) are displayed starting with the value set on the firstDayOfWeek.
By default the first day is Sunday. If you want to create a "work week" type view where the weekend days are omitted you can modify the visibleDays and firstDayOfWeek to show only Monday - Friday.
Ext.create({
xtype: 'calendar-weekview',
renderTo: Ext.getBody(),
height: 400,
width: 400,
firstDayOfWeek: 1, // starts the view on Monday
visibleDays: 5, // and displays it and the 4 days after
store: {
autoLoad: true,
proxy: {
type: 'ajax',
url: 'calendars.php'
},
eventStoreDefaults: {
proxy: {
type: 'ajax',
url: 'events.php'
}
}
}
});
The movePrevious and moveNext methods modify the displayed date range by moving the range forward or backward one week.
i.e. view.moveNext();
called on a 7-day view 1 week. Note that a view
configured with 5 visibleDays would not advance 5 days, but rather will show the
next full week with only 5 visible days.
If your view requires a header showing the dates displayed consider using Ext.calendar.panel.Week instead. To display fewer days consider using the Ext.calendar.view.Day or Ext.calendar.view.Days view.
The configuration for the Ext.calendar.form.Add to be used
when an event is to be created. Use null
to disable creation.
Defaults to: { xtype: 'calendar-form-add' }
true
to allow selection in the UI to create events. This includes being able
to drag-select a range in the all day area, as well as click/tap in the day
area (the dedicated space just above the start time's row) to create an event.
See showAddForm for adding an event when selection is disabled.
Defaults to: true
Sets the value of allowSelection
allowSelection : Boolean
An object containing ARIA attributes to be set
on this Component's ARIA element. Use this to set the attributes that cannot be
determined by the Component's state, such as aria-live
, aria-flowto
, etc.
Note that this config is only meaningful at the Component rendering time, and setting it after that will do nothing.
Defaults to: null
Sets the value of ariaAttributes
ariaAttributes : Object
DOM selector for a child element that is to be used
as description for this Component, set in aria-describedby
attribute.
The selector works the same way as ariaLabelledBy.
ARIA label for this Component. It is best to use
ariaLabelledBy option instead, because screen readers prefer
aria-labelledby
attribute to aria-label
. ariaLabel and
ariaLabelledBy config options are mutually exclusive.
DOM selector for a child element that is to be used
as label for this Component, set in aria-labelledby
attribute.
If the selector is by #id
, the label element can be any existing element,
not necessarily a child of the main Component element.
ariaLabelledBy and ariaLabel config options are mutually exclusive, and ariaLabelledBy has the higher precedence.
Setting this config option adds or removes data bindings for other configs.
For example, to bind the title
config:
var panel = Ext.create({
xtype: 'panel',
bind: {
title: 'Hello {user.name}'
}
});
To dynamically add bindings:
panel.setBind({
title: 'Greetings {user.name}!'
});
To remove bindings:
panel.setBind({
title: null
});
The bind expressions are presented to Ext.app.ViewModel#bind. The
ViewModel
instance is determined by lookupViewModel.
Note: If bind is passed as a string, it will use the Ext.Component#defaultBindProperty for the binding.
Defaults to: null
Enables or disables bordering on this component. The following values are accepted:
null
or `true (default): Do nothing and allow the border to be specified by the theme.false
: suppress the default border provided by the theme.Please note that enabling bordering via this config will not add a border-color
or border-style
CSS property to the component; you provide the border-color
and border-style
via CSS rule or style configuration
(if not already provide by the theme).
Ext.Viewport.add({
centered: true,
width: 100,
height: 100,
style: 'border: 1px solid blue;'
// ...
});
Ext.Viewport.add({
centered: true,
width: 100,
height: 100,
cls: 'my-component'
// ...
});
And your CSS file:
.my-component {
border: 1px solid red;
}
Defaults to: null
The CSS class to add to this widget's element, in addition to the baseCls. In many cases, this property will be specified by the derived widget class. See userCls for adding additional CSS classes to widget instances (such as items in a Ext.Container).
Defaults to: null
true
to display this view in compact mode, typically used
for smaller form factors. Setting to true
applies any configured
compactOptions.
Defaults to: false
Defaults to: { displayOverlap: false, showNowMarker: false, timeFormat: 'g', timeRenderer: function(hour, formatted, firstInGroup) { var D = Ext.Date, suffix = '', d, cls; if (firstInGroup) { cls = Ext.baseCSSPrefix + 'calendar-days-time-ampm'; d = D.clone(this.baseDate); d.setHours(hour); suffix = '<div class="' + cls + '">' + Ext.Date.format(d, 'a') + '</div>'; } return formatted + suffix; } }
Sets the value of compactOptions
compactOptions : Object
A string alias, a configuration object or an instance of a ViewController
for
this container. Sample usage:
Ext.define('MyApp.UserController', {
alias: 'controller.user'
});
Ext.define('UserContainer', {
extend: 'Ext.container.container',
controller: 'user'
});
// Or
Ext.define('UserContainer', {
extend: 'Ext.container.container',
controller: {
type: 'user',
someConfig: true
}
});
// Can also instance at runtime
var ctrl = new MyApp.UserController();
var view = new UserContainer({
controller: ctrl
});
Defaults to: null
Returns the Ext.app.ViewController instance associated with this component via the controller config or setController method.
Returns this component's ViewController or null if one was not configured
Sets the value of controller
controller : String / Object / Ext.app.ViewController
true
to allow this view to set the date range on event stores
in reaction to the value changing. The need to disable this surfaces
when using multiple views together and allowing one view (the one with
the largest range) to be the in control of loading the stores.
Defaults to: true
Sets the value of controlStoreRange
controlStoreRange : Boolean
If true
, this component will be the default scope (this pointer) for events
specified with string names so that the scope can be dynamically resolved. The
component will automatically become the defaultListenerScope if a
controller is specified.
See the introductory docs for Ext.container.Container for some sample usages.
NOTE: This value can only be reliably set at construction time. Setting it after that time may not correctly rewire all of the potentially effected listeners.
Defaults to: false
Sets the value of defaultListenerScope
defaultListenerScope : Boolean
When displaying events, allow events that intersect to horizontally overlap to save on horizontal space.
Defaults to: true
Sets the value of displayOverlap
displayOverlap : Boolean
The configuration for the Ext.calendar.form.Edit to be used
when an event is to be modified. Use null
to disable editing.
Defaults to: { xtype: 'calendar-form-edit' }
The hour number to end this view. Should be a value between 1
and 24
.
Defaults to: 20
The default configuration for Ext.calendar.Event widgets
Defaults to: { xtype: 'calendar-event' }
A map of event type to the corresponding handler method name. This is used internally by native event handling mechanism.
Defaults to: { focus: 'handleFocusEvent', blur: 'handleBlurEvent' }
The day on which the calendar week begins. 0
(Sunday) through 6
(Saturday).
Defaults to Ext.Date#firstDayOfWeek
Sets the value of firstDayOfWeek
firstDayOfWeek : Number
CSS class that will be added to focused component's focusClsEl, and removed when component blurs.
Defaults to: 'x-focused'
A Ext.calendar.header.Base object to link to this view
Defaults to: null
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
An object containing handlers for keyboard events. The property names of this object are the key name and any modifiers. The values of the properties are the descriptors of how to handle each event.
The handler descriptor can be simply the handler function (either the literal function or the method name), or it can be an object with these properties:
handler
: The function or its name to call to handle the event.scope
: The this pointer context (can be "this" or "controller").event
: An optional override of the key event to which to listen.Important: Calls to setKeyMap
do not replace the entire keyMap but
instead update the provided mappings. That is, unless null
is passed as the
value of the keyMap which will clear the keyMap of all entries.
Defaults to: null
scope : String
The default scope to apply to key handlers
which do not specify a scope. This is processed the same way as the scope of
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'
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 Ext.view.Views 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
Set to true
for this component's name
property to be tracked by its containing
nameHolder
.
Defaults to: false
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
}]
});
Defaults to: null
One or more names of config properties that this component should publish to its ViewModel. Generally speaking, only properties defined in a class config block (including ancestor config blocks and mixins) are eligible for publishing to the viewModel. Some components override this and publish their most useful configs by default.
Note: We'll discuss publishing properties not found in the config block below.
Values determined to be invalid by component (often form fields and model validations) will not be published to the ViewModel.
This config uses the reference to determine the name of the data
object to place in the ViewModel
. If reference is not set then this config
is ignored.
By using this config and reference you can bind configs between components. For example:
...
items: [{
xtype: 'textfield',
reference: 'somefield', // component's name in the ViewModel
publishes: 'value' // value is not published by default
},{
...
},{
xtype: 'displayfield',
bind: 'You have entered "{somefield.value}"'
}]
...
Classes must provide this config as an Object:
Ext.define('App.foo.Bar', {
publishes: {
foo: true,
bar: true
}
});
This is required for the config system to properly merge values from derived classes.
For instances this value can be specified as a value as show above or an array or object as follows:
{
xtype: 'textfield',
reference: 'somefield',
publishes: [
'value',
'rawValue',
'dirty'
]
}
// This achieves the same result as the above array form.
{
xtype: 'textfield',
reference: 'somefield',
publishes: {
value: true,
rawValue: true,
dirty: true
}
}
In some cases, users may want to publish a property to the viewModel that is not found in a class config block. In these situations, you may utilize publishState if the property has a setter method. Let's use setFieldLabel as an example:
setFieldLabel: function(fieldLabel) {
this.callParent(arguments);
this.publishState('fieldLabel', fieldLabel);
}
With the above chunk of code, fieldLabel may now be published to the viewModel.
Defaults to: null
Available since: 5.0.0
Returns the value of publishes
String / String[] / Object
Sets the value of publishes
publishes : String / String[] / Object
Specifies a name for this component inside its component hierarchy. This name must be unique within its view or its Ext.app.ViewController. See the documentation in Ext.container.Container for more information about references.
Note: Valid identifiers start with a letter or underscore and are followed by zero or more additional letters, underscores or digits. References are case sensitive.
Defaults to: null
Optional element to render this Component to. Not required if this component is an item of a Container of a Container.
Defaults to: null
If provided this creates a new Session
instance for this component. If this
is a Container
, this will then be inherited by all child components.
To create a new session you can specify true
:
Ext.create({
xtype: 'viewport',
session: true,
items: [{
...
}]
});
Alternatively, a config object can be provided:
Ext.create({
xtype: 'viewport',
session: {
...
},
items: [{
...
}]
});
Defaults to: null
Returns the value of session
Boolean / Object / Ext.data.Session
Sets the value of session
session : Boolean / Object / Ext.data.Session
true
to show a marker on the view that equates to the current local time.
Defaults to: true
The hour number to start this view. Should be a value between 0
and 23
.
Defaults to: 8
A Ext.calendar.store.Calendars instance or configuration
Defaults to: null
Returns the value of store
Object / Ext.calendar.store.Calendars
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 format to display the time values in the time gutter.
Refer to the class description of Ext.Date for formatting options.
Example format for displaying a 12-hour time with an am/pm suffix:
timeFormat: 'h:ia' // displays 14:00 hours as 2:00pm
Defaults to: 'H:i'
A formatting function for more complex displays of time values in the time gutter.
Defaults to: null
hour : Number
The hour being shown.
formatted : String
The formatted value as specified by the timeFormat.
firstInGroup : Boolean
true
if this hour is the first hour in the specified time
range to be in the morning (< 12) or in the afternoon > 12.
The timezone offset to display this calendar in. The value should be specified in the same way as the native Date offset. That is, the number of minutes between UTC and local time. For example the offset for UTC+10 would be -600 (10 hours * 60 minutes ahead).
Defaults to the current browser offset.
Sets the value of timezoneOffset
timezoneOffset : Number
Emulates the behavior of the CSS touch-action property in a cross-browser compatible manner.
Keys in this object are touch action names, and values are false
to disable
a touch action or true
to enable it. Accepted keys are:
panX
panY
pinchZoom
doubleTapZoom
All touch actions are enabled (true
) by default, so it is usually only necessary
to specify which touch actions to disable. For example, the following disables
only horizontal scrolling and pinch-to-zoom on the component's main element:
touchAction: {
panX: false,
pinchZoom: false
}
Touch actions can be specified on reference elements using the reference element name, for example:
// disables horizontal scrolling on the main element, and double-tap-zoom
// on the child element named "body"
touchAction: {
panY: false
body: {
doubleTapZoom: false
}
}
The primary motivation for setting the touch-action of an element is to prevent the browser's default handling of a gesture such as pinch-to-zoom, or drag-to-scroll, so that the application can implement its own handling of that gesture on the element. Suppose, for example, a component has a custom drag handler on its element and wishes to prevent horizontal scrolling of its container while it is being dragged:
Ext.create('Ext.Widget', {
touchAction: {
panX: false
},
listeners: {
drag: function(e) {
// implement drag logic
}
}
});
Defaults to: null
This object holds a map of config
properties that will update their binding
as they are modified. For example, value
is a key added by form fields. The
form of this config is the same as publishes.
This config is defined so that updaters are not created and added for all bound properties since most cannot be modified by the end-user and hence are not appropriate for two-way binding.
Defaults to: null
Returns the value of twoWayBindable
String / String[] / Object
Sets the value of twoWayBindable
twoWayBindable : String / String[] / Object
The ui or uis to be used on this Component
When a ui is configured, CSS class names are added to the element, created by appending the ui name(s) to each classCls and/or baseCls.
Defaults to: null
One or more CSS classes to add to the component's primary element. This config is intended solely for use by the component instantiator (the "user"), not by derived classes.
For example:
items: [{
xtype: 'button',
userCls: 'my-button'
...
}]
Defaults to: null
The start of the date range to show. The visible range of the view will begin at the firstDayOfWeek immediately preceding this value, or the value if it is the firstDayOfWeek. For example, using the following configuration:
{
firstDayOfWeek: 0, // Sunday
value: new Date(2010, 2, 3) // Wed, 3 March 2010
}
The visible range would begin on Sun 28th Feb.
Defaults to: new Date()
The ViewModel
is a data provider for this component and its children. The
data contained in the ViewModel
is typically used by adding bind configs
to the components that want present or edit this data.
When set, the ViewModel
is created and links to any inherited viewModel
instance from an ancestor container as the "parent". The ViewModel
hierarchy,
once established, only supports creation or destruction of children. The
parent of a ViewModel
cannot be changed on the fly.
If this is a root-level ViewModel
, the data model connection is made to this
component's associated Ext.data.Session. This is
determined by calling getInheritedSession
.
Defaults to: null
Returns the value of viewModel
String / Object / Ext.app.ViewModel
Sets the value of viewModel
viewModel : String / Object / Ext.app.ViewModel
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 value true
causes config
values to be stored on instances using a
property name prefixed with an underscore ("_") character. A value of false
stores config
values as properties using their exact name (no prefix).
Defaults to: true
Available since: 5.0.0
The value true
instructs the initConfig method to only honor values for
properties declared in the config
block of a class. When false
, properties
that are not declared in a config
block will be placed on the instance.
Defaults to: true
Available since: 5.0.0
Matches options property names within a listeners specification object - property names which are never used as event names.
Defaults to: { scope: 1, delay: 1, buffer: 1, onFrame: 1, single: 1, args: 1, destroyable: 1, priority: 1, order: 1 }
We don't want the base destructor to clear the prototype because our destroyObservable handler must be called the very last. It will take care of the prototype after completing Observable destruction sequence.
Defaults to: true
The name of the Component property that holds a reference to the Element that serves as that Component's ARIA element. This property will be replaced with the actual Element reference after rendering.
Most of the simple Components will have their main element as ariaEl.
Defaults to: 'el'
Available since: 6.0.0
Instance specific ARIA attributes to render into Component's ariaEl. This object is only used during rendering, and is discarded afterwards.
ARIA role for this Component, defaults to no role. With no role, no other ARIA attributes are set.
The base CSS class to apply to this widget's element.
Used as the prefix for ui-specific class names.
Defaults to the value of classCls or (x-
+ the xtype) of the widget
if classCls is null
Defaults to: null
A CSS class to apply to the main element that will be inherited down the class hierarchy. Subclasses may override this property on their prototype to add their own CSS class in addition to the CSS classes inherited from ancestor classes via the prototype chain. For example
Ext.define('Foo', {
extend: 'Ext.Widget',
classCls: 'foo'
});
Ext.define('Bar', {
extend: 'Foo',
classCls: 'bar'
});
var bar = new Bar();
console.log(bar.element.className); // outputs 'foo bar'
Defaults to: null
When set to true
during widget class definition, that class will be the "root" for
classCls inheritance. Derived classes may set this to true
to avoid
inheriting a classCls from their superclass.
Defaults to: true
Setting this property to false
will prevent nulling object references
on a Class instance after destruction. Setting this to "async"
will delay
the clearing for approx 50ms.
Defaults to: true
Available since: 6.2.0
Setting this property to true
will result in setting the object's
prototype to null
after the destruction sequence is fully completed.
After that, most attempts at calling methods on the object instance
will result in "method not defined" exception. This can be very helpful
with tracking down otherwise hard to find bugs like runaway Ajax requests,
timed functions not cleared on destruction, etc.
Note that this option can only work in browsers that support Object.setPrototypeOf
method, and is only available in debugging mode.
Defaults to: false
Available since: 6.2.0
true
if this currently focused element
is within this Component's or Container's hierarchy. This property is set separately
from hasFocus, and can be true
when hasFocus is false
.
Examples:
Text field with input element focused would be: focusable: true, hasFocus: true, containsFocus: true
Date field with drop-down picker currently focused would be: focusable: true, hasFocus: false, containsFocus: true
Form Panel with a child input field currently focused would be: focusable: false, hasFocus: false, containsFocus: true
See also hasFocus.
Defaults to: false
This property is used to determine the property of a bind config that is just
the value. For example, if defaultBindProperty="value"
, then this shorthand
bind config:
bind: '{name}'
Is equivalent to this object form:
bind: {
value: '{name}'
}
The defaultBindProperty is set to "value" for form fields and to "store" for grids and trees.
Defaults to: null
This property is set to true
after the destroy method is called.
Defaults to: false
A configuration object for Ext.Element.create() that is used to create the Element template. Subclasses should avoid overriding this property and instead add elements using template.
Supports all the standard options of a Ext.Element.create() config and adds 3 additional options:
reference - this option specifies a name for Element references. These references names become properties of the Widget instance and refer to Ext.Element instances that were created using the template:
element: {
reference: 'element',
children: [{
reference: 'innerElement'
}]
}
After construction of a widget the reference elements are accessible as follows:
var foo = new FooWidget(),
innerEl = foo.innerElement; // an Ext.Element that wraps the innerElement
The reference attribute is optional, but all Widgets must have a 'element'
reference on some element within the template (usually the outermost one).
listeners - a standard listeners object as specified by Ext.mixin.Observable.
element: {
reference: 'element',
listeners: {
click: 'onClick'
},
children: [{
reference: 'innerElement',
listeners: {
click: 'onInnerClick'
}
}]
}
Since listeners cannot be attached without an Ext.Element reference the reference property MUST be specified in order to use listeners.
The Widget instance is used as the scope for all listeners specified in this way,
so it is invalid to use the scope
option in the listeners config since it will
always be overwritten using this
.
uiCls
- a suffix to be appended to the ui-specific CSS class for each ui
for this widget. These ui classes are constructed by appending the ui to each
classCls or baseCls for the widget. As such, uiCls
should
never be used on the main element reference, as its uiCls
is computed automatically.For example, assume a widget is defined with a cfg!ui ui of 'alt action'
and a
uiCls
of 'inner-el'
on its innerElement
reference element:
Ext.define('Doodad', {
extend: 'Ext.Widget',
xtype: 'doodad',
classCls: 'x-doodad',
ui: 'alt action',
element: {
reference: 'element',
children: [{
reference: 'innerElement',
cls: 'x-inner-el',
uiCls: 'inner-el'
}]
}
});
This would result in the following markup when rendered:
<div class="x-doodad x-doodad-alt x-doodad-action">
<div class="x-inner-el x-doodad-inner-el x-doodad-alt-inner-el x-doodad-action-inner-el"></div>
</div>
These additional classes can be used to style the reference element for a particular
ui; however, use of uiCls
is not typically necessary or recommended. Reference
elements should usually be styled using simple descendant selectors:
.x-doodad-alt .x-inner-el {
color: red;
}
When there is a possibility that widgets can be nested it is best to use direct child selectors to avoid the possibility of selecting all descendants instead of just the reference element for the intended widget:
.x-doodad-alt > .x-inner-el {
color: red;
}
Only use uiCls
when there is a possibility of nesting, AND there may be a variable
number of elements between the main element and the reference element in question.
For example, Ext.Container with docked items has a different number of elements
in between its element and its bodyElement
than a Container without docked items
because of the wrapping elements that are dynamically added to support docking.
To ensure it does not style all descendants it must use a uiCls
to style its
bodyElement
:
.x-container-alt-body-el {
background: #fff;
}
Note that when uiCls
is specified it also adds a class name that does not contain
the ui using just the classCls and/or baseCls as the prefix. This class name
can be used for base-level styling that does not relate to any particular UI:
.x-container-body-el {
position: relative;
}
Defaults to: { reference: 'element' }
Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.
Defaults to: 0
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'
Get the period to move when using moveNext and movePrevious.
Defaults to: Ext.privateFn
The period to move
unit : String
The units to move, see Ext.Date.
amount : Number
The number of units to move.
true
if this component's focusEl is focused.
See also containsFocus.
Defaults to: false
This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class (via observe) or on the Ext.app.EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.
The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:
if (this.hasListeners.foo) {
this.fireEvent('foo', this, arg1);
}
Template method to do any Focusable related initialization that does not involve event listeners creation.
Defaults to: Ext.emptyFn
This property is set to true
during the call to initConfig.
Defaults to: false
Available since: 5.0.0
This property is set to true
if this instance is the first of its class.
Defaults to: false
Available since: 5.0.0
This value is true
and is used to identify plain objects from instances of
a defined class.
Defaults to: true
true
in this class to identify an object as an instantiated Observable, or subclass thereof.
Defaults to: true
The CSS class to add to this component should not have a border.
Defaults to: Ext.baseCSSPrefix + 'noborder-trbl'
Get the reference to the current class from which this object was instantiated. Unlike Ext.Base#statics,
this.self
is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base#statics
for a detailed comparison
Ext.define('My.Cat', {
statics: {
speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
},
constructor: function() {
alert(this.self.speciesName); // dependent on 'this'
},
clone: function() {
return new this.self();
}
});
Ext.define('My.SnowLeopard', {
extend: 'My.Cat',
statics: {
speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'
}
});
var cat = new My.Cat(); // alerts 'Cat'
var snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'
var clone = snowLeopard.clone();
alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'
Defaults to: Base
An array of child elements to use as the children of the main element in the element template. Only used if "children" are not specified explicitly in the element template.
Defaults to: []
A map that tracks all reference elements configured with a uiCls
.
Contains the element reference by default since the element always gets
non-suffixed ui-specific CSS class names added to it (see syncUiCls)
Defaults to: { element: '' }
Regular expression used for validating reference values.
Defaults to: /^[a-z_][a-z0-9_]*$/i
Adds declarative listeners as nested arrays of listener objects.
listeners : Array
true
if any listeners were added
Creates a particular plugin type if defined in the plugins configuration.
Available since: 6.2.0
type : String
The type
of the plugin.
The plugin that was created.
Ensures that the given property (if it is a Config System config) has a proper "updater" method on this instance to sync changes to the config.
Available since: 5.0.0
property : String
The name of the config property.
Adds a listeners with the "delegate" event option. Users should not invoke this method directly. Use the "delegate" event option of addListener instead.
eventName : Object
fn : Object
scope : Object
options : Object
order : Object
caller : Object
manager : Object
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated
config.
deprecations : Object
Adds an element reference to this Widget instance.
name : String
The name of the reference
domNode : HTMLElement
Reduces instantiation time for a Widget by lazily instantiating Ext.Element references the first time they are used. This optimization only works for elements with no listeners specified.
name : String
The name of the reference
domNode : HTMLElement
The on method is shorthand for addListener.
Appends an event handler to this object. For example:
myGridPanel.on("itemclick", this.onItemClick, this);
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
myGridPanel.on({
cellclick: this.onCellClick,
select: this.onSelect,
viewready: this.onViewReady,
scope: this // Important. Ensure "this" is correct during handler execution
});
One can also specify options for each event handler separately:
myGridPanel.on({
cellclick: {fn: this.onCellClick, scope: this, single: true},
viewready: {fn: panel.onViewReady, scope: panel}
});
Names of methods in a specified scope may also be used:
myGridPanel.on({
cellclick: {fn: 'onCellClick', scope: this, single: true},
viewready: {fn: 'onViewReady', scope: panel}
});
eventName : String / Object
The name of the event to listen for. May also be an object who's property names are event names.
fn : Function / String (optional)
The method the event invokes or the name of
the method within the specified scope
. Will be called with arguments
given to Ext.util.Observable#fireEvent plus the options
parameter described
below.
scope : Object (optional)
The scope (this
reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
options : Object (optional)
An object containing handler configuration.
Note: The options object will also be passed as the last argument to every event handler.
This object may contain any of the following properties:
scope : Object
The scope (this
reference) in which the handler function is executed. If omitted,
defaults to the object which fired the event.
delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
onFrame : Number
Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.
target : Ext.util.Observable
Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
element : String
This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.
This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.
For example, to add a click listener to a Panel's body:
var panel = new Ext.panel.Panel({
title: 'The title',
listeners: {
click: this.handlePanelClick,
element: 'body'
}
});
In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.
panel.body.un(...)
delegate : String (optional)
A simple selector to filter the event target or look for a descendant of the target.
The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).
See the delegate example below.
capture : Boolean (optional)
When set to true
, the listener is fired in the capture phase of the event propagation
sequence, instead of the default bubble phase.
The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).
stopPropagation : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true
to call stopPropagation on the event object
before firing the handler.
preventDefault : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true
to call preventDefault on the event object
before firing the handler.
stopEvent : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true
to call stopEvent on the event object
before firing the handler.
args : Array (optional)
Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.
destroyable : Boolean (optional)
When specified as true
, the function returns a destroyable
object. An object
which implements the destroy method which removes all listeners added in this call.
This syntax can be a helpful shortcut to using un; particularly when
removing multiple listeners. NOTE - not compatible when using the element
option. See un for the proper syntax for removing listeners added using the
element config.
Defaults to: false
priority : Number (optional)
An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.
order : String (optional)
A legacy option that is provided for backward compatibility.
It is recommended to use the priority
option instead. Available options are:
'before'
: equal to a priority of 100
'current'
: equal to a priority of 0
or default priority'after'
: equal to a priority of -100
Defaults to: 'current'
order : String (optional)
A shortcut for the order
event option. Provided for backward compatibility.
Please use the priority
event option instead.
Combining Options
Using the options argument, it is possible to combine different types of listeners:
A delayed, one-time listener.
myPanel.on('hide', this.handleClick, this, {
single: true,
delay: 100
});
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.
grid.on({
itemclick: 'onItemClick',
itemcontextmenu: grid.onItemContextmenu,
destroy: {
fn: function () {
// function called within the 'altCmp' scope instead of grid
},
scope: altCmp // unique scope for the destroy handler
},
scope: grid // default scope - provided for example clarity
});
Delegate
This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:
var panel = Ext.create({
xtype: 'panel',
renderTo: document.body,
title: 'Delegate Handler Example',
frame: true,
height: 220,
width: 220,
html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});
// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
click: function (e) {
console.log(e.getTarget().innerHTML);
},
element: 'body',
delegate: 'h1.myTitle'
});
Defaults to: 'current'
Only when the destroyable
option is specified.
A Destroyable
object. An object which implements the destroy method which removes
all listeners added in this call. For example:
this.btnListeners = = myButton.on({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.
Example:
Ext.define('Foo', {
extend: 'Ext.Component',
initComponent: function () {
this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
this.callParent();
}
});
As you can see, when an instance of Foo is destroyed, it ensures that the 'show'
listener on the menu (MyApp.SomeGlobalSharedMenu
) is also removed.
As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.
item : Ext.util.Observable / Ext.dom.Element
The item to which to add a listener/listeners.
ename : Object / String
The event name, or an object containing event name properties.
fn : Function / String (optional)
If the ename
parameter was an event
name, this is the handler function or the name of a method on the specified
scope
.
scope : Object (optional)
If the ename
parameter was an event name, this is the scope (this
reference)
in which the handler function is executed.
options : Object (optional)
If the ename
parameter was an event name, this is the
addListener options.
Only when the destroyable
option is specified.
A Destroyable
object. An object which implements the destroy method which removes all listeners added in this call. For example:
this.btnListeners = myButton.mon({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
Adds a plugin. For example:
list.addPlugin('pullrefresh');
Or:
list.addPlugin({
type: 'pullrefresh',
pullRefreshText: 'Pull to refresh...'
});
Available since: 6.2.0
plugin : Object / String / Ext.plugin.Abstract
The plugin or config object or alias to add.
method : Object
fn : Object
scope : Object
preventDefault : Object
extraArgs : Object
Available since: 5.0.0
binds : String / Object
currentBindings : Object
Applier for the plugins config property.
plugins : String[] / Object[] / Ext.plugin.Abstract[]
The new plugins to use.
oldPlugins : Ext.plugin.Abstract[]
The existing plugins in use.
Transforms a Session config to a proper instance.
Available since: 5.0.0
session : Object
touchAction : Object
oldTouchAction : Object
Transforms a ViewModel config to a proper instance.
Available since: 5.0.0
viewModel : String / Object / Ext.app.ViewModel
method : Object
fn : Object
scope : Object
preventDefault : Object
extraArgs : Object
Calculate the value to use for movePrevious
The new value.
Calculate the total number of half hour slots available given the current time range.
Call the original method that was previously overridden with Ext.Base#override
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
this.callOverridden();
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
args : Array / Arguments
The arguments, either an array or the arguments
object
from the current method, for example: this.callOverridden(arguments)
Returns the result of calling the overridden method
Deprecated since version 4.1.0
Use #callParent instead.
Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext#define).
Ext.define('My.Base', {
constructor: function (x) {
this.x = x;
},
statics: {
method: function (x) {
return x;
}
}
});
Ext.define('My.Derived', {
extend: 'My.Base',
constructor: function () {
this.callParent([21]);
}
});
var obj = new My.Derived();
alert(obj.x); // alerts 21
This can be used with an override as follows:
Ext.define('My.DerivedOverride', {
override: 'My.Derived',
constructor: function (x) {
this.callParent([x*2]); // calls original My.Derived constructor
}
});
var obj = new My.Derived();
alert(obj.x); // now alerts 42
This also works with static and private methods.
Ext.define('My.Derived2', {
extend: 'My.Base',
// privates: {
statics: {
method: function (x) {
return this.callParent([x*2]); // calls My.Base.method
}
}
});
alert(My.Base.method(10)); // alerts 10
alert(My.Derived2.method(10)); // alerts 20
Lastly, it also works with overridden static methods.
Ext.define('My.Derived2Override', {
override: 'My.Derived2',
// privates: {
statics: {
method: function (x) {
return this.callParent([x*2]); // calls My.Derived2.method
}
}
});
alert(My.Derived2.method(10); // now alerts 40
To override a method and replace it and also call the superclass method, use 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 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
skipVisibility : Object
includeFocusTarget : Object
Check for a position update of the now marker. This is contingent on the config to show the marker being enabled.
Clear a row element and populate it with child nodes.
row : Ext.dom.Element
The row
nodes : Object[]
The configuration for the new nodes to add.
clearAll : Boolean (optional)
true
to clear all nodes. false
to leave the last node (gutter).
Defaults to: false
Clears all listeners that were attached using the "delegate" event option. Users should not invoke this method directly. It is called automatically as part of normal clearListeners processing.
Removes all managed listeners for this object.
Construct all day events.
events : Ext.calendar.model.EventBase[]
The events.
Create the add form configuration. Can be hooked to provide any runtime customization.
A configuration for the form instance.
Create the edit form configuration. Can be hooked to provide any runtime customization.
event : Object
A configuration for the form instance.
Create an event widget.
event : Ext.calendar.model.EventBase
The event record.
cfg : Object (optional)
A config for the event.
dummy : Boolean (optional)
true
if this is a dummy event not backed by a record.
Defaults to: false
The event widget.
Create a number of event widgets.
events : Ext.calendar.model.EventBase[]
The events.
cfg : Object (optional)
A config for each event.
The event widgets.
Converts the provided type or config object into a plugin instance.
config : String / Object / Ext.plugin.Abstract
The plugin type, config object or instance.
Creates an event handling function which re-fires the event from this object as the passed event name.
newName : String
The name under which to re-fire the passed parameters.
beginEnd : Array (optional)
The caller can specify on which indices to slice.
Create the scroller.
The scroller.
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.
name : Object
fn : Object
scope : Object
options : Object
order : Object
caller : Object
manager : Object
Checks the position of the now marker, hides/shows it in the correct place as required. Does not check the existence of the config flag, assumes it's true at this point.
Fires a delegated event. Users should not invoke this method directly. It is called automatically by the framework as needed (see the "delegate" event option of addListener for more details.
eventName : Object
args : Object
eventName : Object
args : Object
bubbles : Object
Do range recalculation.
start : Date
The start to recalculate from. Defaults to the current value.
full : Ext.calendar.date.Range
The full date range (with times cleared).
visible : Ext.calendar.date.Range
start : Date
The start date.
end : Date
The end date.
Show a form for this calendar.
event : Ext.calendar.model.EventBase
The event.
type : Object
cfg : Object
The config for the form.
successFn : Function
A function to call if the edit is successful.
options : Object (optional)
Callback options for form creation.
onSave : Function (optional)
A save callback function.
onCancel : Function (optional)
A cancel callback function.
scope : Object (optional)
A scope for the callback functions.
Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget()
if
present. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component#getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.
Example:
Ext.define('Ext.overrides.form.field.Base', {
override: 'Ext.form.field.Base',
// Add functionality to Field's initComponent to enable the change event to bubble
initComponent: function () {
this.callParent();
this.enableBubble('change');
}
});
var myForm = Ext.create('Ext.form.Panel', {
title: 'User Details',
items: [{
...
}],
listeners: {
change: function() {
// Title goes red if form has been modified.
myForm.header.setStyle('color', 'red');
}
}
});
eventNames : String / String[]
The event name to bubble, or an Array of event names.
Finds an alternate Component to focus if this Component is disabled while focused, or focused while disabled, or otherwise unable to focus.
In both cases, focus must not be lost to document.body, but must move to an intuitively connectible Component, either a sibling, or uncle or nephew.
This is both for the convenience of keyboard users, and also for when focus is tracked within a Component tree such as for ComboBoxes and their dropdowns.
For example, a ComboBox with a PagingToolbar in is BoundList. If the "Next Page" button is hit, the LoadMask shows and focuses, the next page is the last page, so the "Next Page" button is disabled. When the LoadMask hides, it attempt to focus the last focused Component which is the disabled "Next Page" button. In this situation, focus should move to a sibling within the PagingToolbar.
A closely related focusable Component to which focus can move.
Retrieves plugin by its type
alias. For example:
var list = Ext.create({
xtype: 'list',
itemTpl: '<div class="item">{title}</div>',
store: 'Items',
plugins: ['listpaging', 'pullrefresh']
});
list.findPlugin('pullrefresh').setPullRefreshText('Pull to refresh...');
Note: See also getPlugin.
Available since: 6.2.0
type : String
The Plugin's type
as specified by the class's
alias configuration.
plugin instance or null
if not found.
Fires the specified event with the passed parameters and executes a function (action).
By default, the action function will be executed after any "before" event handlers
(as specified using the order
option of
addListener), but before any other
handlers are fired. This gives the "before" handlers an opportunity to
cancel the event by returning false
, and prevent the action function from
being called.
The action can also be configured to run after normal handlers, but before any "after"
handlers (as specified using the order
event option) by passing 'after'
as the order
parameter. This configuration gives any event handlers except
for "after" handlers the opportunity to cancel the event and prevent the action
function from being called.
eventName : String
The name of the event to fire.
args : Array
Arguments to pass to handlers and to the action function.
fn : Function
The action function.
scope : Object (optional)
The scope (this
reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
options : Object (optional)
Event options for the action function. Accepts any of the options of addListener
order : String (optional)
The order to call the action function relative
too the event handlers ('before'
or 'after'
). Note that this option is
simply used to sort the action function relative to the event handlers by "priority".
An order of 'before'
is equivalent to a priority of 99.5
, while an order of
'after'
is equivalent to a priority of -99.5
. See the priority
option
of addListener for more details.
Defaults to: 'before'
Deprecated since version 5.5
Use #fireEventedAction instead.
Fires the specified event with the passed parameters (minus the event name, plus the options
object passed
to addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.
eventName : String
The name of the event to fire.
args : Object...
Variable number of parameters are passed to handlers.
returns false if any of the handlers return false otherwise it returns true.
Fires the specified event with the passed parameter list.
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.
eventName : String
The name of the event to fire.
args : Object[]
An array of parameters which are passed to handlers.
returns false if any of the handlers return false otherwise it returns true.
Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow.
By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events.
eventName : String
The name of the event to fire.
args : Array
Arguments to pass to handlers and to the action function.
fn : Function / String
The action function.
scope : Object (optional)
The scope (this
reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
fnArgs : Array / Boolean (optional)
Optional arguments for the action fn
. If not
given, the normal args
will be used to call fn
. If false
is passed, the
args
are used but if the first argument is this instance it will be removed
from the args passed to the action function.
Try to focus this component.
If this component is disabled or otherwise not focusable, a close relation will be targeted for focus instead to keep focus localized for keyboard users.
selectText : Boolean / Number[] (optional)
If applicable, true
to also select all the text
in this component, or an array consisting of start and end (defaults to start)
position of selection.
true
if focus target was found and focusing was attempted,
false
if no focusing attempt was made.
Generate cells for the all day portion of the view.
cls : String (optional)
The class to add to the cells.
html : String (optional)
The markup to add to the cell.
The DOM configs for the cells.
Generate the column elements for the days.
The DOM configs for the column elements.
Generate the time elements for the gutter.
The DOM configs for the time elements.
Find component(s) that label or describe this component, and return the id(s) of their ariaEl elements.
reference : Function / String / String[] (optional)
Component reference, or array of component references, or a function that should return the proper attribute string. The function will be called in the context of the labelled component.
Element id string, or null
Get the body element of this view.
The body.
Gets the bubbling parent for an Observable
The bubble parent. null is returned if no bubble target exists
Get a calendar by id.
id : Object
The id of the calendar.
The calendar
Get a day column by index.
index : Number
The index of the column.
The column.
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
The config property value.
Get the number of days covered for a range. For example, 2010-01-01 22:00, 2010-01-02 01:00 is 2 days because it has boundaries within 2 days.
start : Date
The start of the range.
end : Date
The end of the range.
allDay : Boolean
true
if the time range should be considered as an all
day event.
The number of days spanned.
The the default range when creating a event.
The range.
Get the default color palette for this view. Defaults to the color of the first calendar, otherwise the first color in the palette.
The color palette.
Get all calendars that are editable.
The editable calendars.
Get an event record via element/DOM event.
el : Ext.dom.Element / HTMLElement / Ext.event.Event
The element target,
The event record.
Get the event container for a column by index.
index : Number
The index of the event container column.
The event container.
See getDaysSpanned.
event : Ext.calendar.model.EventBase
The event.
The number of days spanned.
Get the palette for an event record.
event : Ext.calendar.model.EventBase
The event record.
The palette.
Get the Ext.calendar.store.EventSource for this view.
The event source.
Get styles regarding events. Creates a fake event and measures pieces of the componentry.
Size info.
margin : Object
The margins for the event.
resizerWidth : Number
The width of the resizer element.
Find an event widget via record.
event : Ext.calendar.model.EventBase
The event record.
The event widget. null
if not found.
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.
Get the active editForm or addForm if it exists.
The active form. null
if not active.
Retrieves the id of this component. Will autogenerate an id if one has not already been set.
id
This method returns an object containing the inherited properties for this instance.
Available since: 5.0.0
inner : Boolean (optional)
Pass true
to return inheritedStateInner
instead
of the normal inheritedState
object. This is only needed internally and should
not be passed by user code.
Defaults to: false
The inheritedState
object containing inherited properties.
This method returns the value of a config property that may be inherited from some ancestor.
In some cases, a config may be explicitly set on a component with the intent of
only being presented to its children while that component should act upon the
inherited value (see referenceHolder
for example). In these cases the skipThis
parameter should be specified as true
.
Available since: 5.0.0
property : String
The name of the config property to return.
skipThis : Boolean (optional)
Pass true
if the property should be ignored if
found on this instance. In other words, true
means the property must be inherited
and not explicitly set on this instance.
Defaults to: false
The value of the requested property
.
Returns 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.
Get the value to use as the base for moving when using moveNext and movePrevious.
The value.
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
Precalculates the heights of slots for sizing events. Should be invalidated when the view height resizes.
The sizes.
hourHeight : Number
The height of 1 hour in px.
halfHeight : Number
The height of half an hour in px.
minSlotHeight : Number
The height of the smallest slot resolution for displayng events.
Get listeners to add to the event source.
A listeners config.
Get listeners to add to the calendar store..
A listeners config.
Return the actual tabIndex for this Focusable.
tabIndex attribute value
Needed for when widget is rendered into a grid cell. The class to add to the cell element.
Partner method to getTdCls.
Returns the base type for the component. Defaults to return this.xtype
, but
All derived classes of Ext.form.field.Text can return the type 'textfield',
and all derived classes of Ext.button.Button can return the type 'button'
Handle drop on the view.
type : Object
event : Ext.calendar.model.EventBase
The event.
newRange : Ext.calendar.date.Range
The new range.
callback : Function (optional)
A callback to execute.
Handle drag/resize start for an event.
type : String
The event type.
event : Ext.calendar.model.EventBase
The event.
false
to veto the event.
Handle taps on event widgets in the view.
e : Ext.event.Event
The event.
Checks if the store has editable calendars.
true
if any calendars are editable.
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
This method triggers the lazy configs and must be called when it is time to fully boot up. The configs that must be initialized are: bind, publishes, session, twoWayBindable and viewModel.
Available since: 5.0.0
Initialize configuration for this class. a typical example:
Ext.define('My.awesome.Class', {
// The default config
config: {
name: 'Awesome',
isAwesome: true
},
constructor: function(config) {
this.initConfig(config);
}
});
var awesome = new My.awesome.Class({
name: 'Super Awesome'
});
alert(awesome.getName()); // 'Super Awesome'
instanceConfig : Object
this
Initializes the Element for this Widget instance. If this is the first time a Widget of this type has been instantiated the element config will be processed to create an Element. This Element is then cached on the prototype (see afterCachedConfig) so that future instances can obtain their element by simply cloning the Element that was cached by the first instance.
Called for the first instance of this Widget to create an object that contains the listener configs for all of the element references keyed by reference name. The object is cached on the prototype and has the following shape:
_elementListeners: {
element: {
click: 'onClick',
scope: this
},
fooReference: {
tap: {
fn: someFunction,
delay: 100
}
}
}
The returned object is prototype chained to the _elementListeners object of its superclass, and each key in the object is prototype chained to object with the corresponding key in the superclass _elementListeners. This allows element listeners to be inherited and overridden when subclassing widgets.
This method is invoked with the prototype object as the scope
elementConfig : Object
Sets up the focus listener on this Component's focusEl if it has one.
Form Components which must implicitly participate in tabbing order usually have a naturally focusable element as their focusEl, and it is the DOM event of that receiving focus which drives the Component's onFocus handling, and the DOM event of it being blurred which drives the onBlur handling.
force : Object
Template method to do any event listener initialization for a Focusable. This generally happens after the focusEl is available.
force : Object
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.
This method marks the current inherited state as invalid. The next time a call is made to getInherited the objects will be recreated and initialized.
Available since: 5.0.0
Tests whether this Widget matches a Ext.ComponentQuery selector string.
selector : String
The selector string to test against.
true
if this Widget matches the selector.
Determines whether this Component is an ancestor of the passed Component.
This will return true
if the passed Component is anywhere within the subtree
beneath this Component.
possibleDescendant : Ext.Component
The Component to test for presence within this Component's subtree.
Determines if the passed property name is bound to ViewModel data.
Available since: 7.0.0
name : String (optional)
The property name to test. Defaults to the defaultBindProperty
true
if the passed property receives data from a ViewModel.
Determines whether this component is the descendant of a passed component.
ancestor : Ext.Component
A Component which may contain this Component.
true
if the component is the descendant of the passed component, otherwise false
.
Returns true
if this Component is currently disabled.
true
if currently disabled.
Checks if an event is hidden, by virtue of the calendar being hidden.
event : Ext.calendar.model.EventBase
The event.
true
if the event should be hidden.
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 defaultFocus for more information.
deep : Boolean (optional)
Optionally determine if the container itself is focusable, or if container's focus is delegated to a child component and that child is focusable.
Defaults to: false
True if component is focusable, false if not.
Returns true
if this Component is currently hidden.
deep : Boolean / Ext.Widget (optional)
true
to check if this component
is hidden because a parent container is hidden. Alternatively, a reference to the
top-most parent at which to stop climbing.
Defaults to: false
true
if currently hidden.
Checks if all events, or a specific event, is suspended.
event : String (optional)
The name of the specific event to check
true
if events are suspended
Checks if a particular binding is synchronizing the value.
name : String
The name of the property being bound to.
true
if the binding is syncing.
Returns true
if this Component is currently visible.
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.
Adds a "destroyable" object to an internal list of objects that will be destroyed when this instance is destroyed (via destroy).
name : String
value : Object
The value passed.
Gets the controller that controls this view. May be a controller that belongs to a view higher in the hierarchy.
Available since: 5.0.1
skipThis : Boolean (optional)
true
to not consider the controller directly attached
to this view (if it exists).
Defaults to: false
The controller. null
if no controller is found.
Gets the Form or Component that is used as the name holder for this component.
Available since: 7.0.0
skipThis : Boolean (optional)
false
to return this as the name holder if
this instance has set nameHolder
. Unlike getInheritedConfig this method
defaults to true
because it is possible that a name property set by the
owner of a component that is also a nameHolder
itself. In this case, the
name connects not to this component but to the parent nameHolder.
Defaults to: true
The name holder.
Gets the Controller or Component that is used as the reference holder for this view.
Available since: 5.0.0
skipThis : Boolean (optional)
false
to return this as the reference holder if
this instance has set referenceHolder
. Unlike getInheritedConfig this method
defaults to true
because it is possible that a reference property set by the
owner of a component that is also a referenceHolder
itself. In this case, the
reference connects not to this component but to the parent referenceHolder.
Defaults to: true
The reference holder.
Returns the Ext.data.Session for this instance. This property may come from this instance's session or be inherited from this object's parent.
Available since: 5.0.0
skipThis : Boolean (optional)
Pass true
to ignore a session configured on
this instance and only consider an inherited session.
Defaults to: false
Gets a named template instance for this class. See Ext.XTemplate#getTpl.
Available since: 6.2.0
name : String
The name of the property that holds the template.
The template, null
if not found.
Returns the Ext.app.ViewModel for this instance. This property may come from this this instance's viewModel or be inherited from this object's parent.
Available since: 5.0.0
skipThis : Boolean (optional)
Pass true
to ignore a viewModel configured on
this instance and only consider an inherited view model.
Defaults to: false
Returns an update
method for the given Config that will call publishState
to ensure two-way bindings (via bind) as well as any publishes are updated.
This method is cached on the cfg
instance for re-use.
Available since: 5.0.0
cfg : Ext.Config
The updater function.
Shorthand for addManagedListener. The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.
Example:
Ext.define('Foo', {
extend: 'Ext.Component',
initComponent: function () {
this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
this.callParent();
}
});
As you can see, when an instance of Foo is destroyed, it ensures that the 'show'
listener on the menu (MyApp.SomeGlobalSharedMenu
) is also removed.
As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.
item : Ext.util.Observable / Ext.dom.Element
The item to which to add a listener/listeners.
ename : Object / String
The event name, or an object containing event name properties.
fn : Function / String (optional)
If the ename
parameter was an event
name, this is the handler function or the name of a method on the specified
scope
.
scope : Object (optional)
If the ename
parameter was an event name, this is the scope (this
reference)
in which the handler function is executed.
options : Object (optional)
If the ename
parameter was an event name, this is the
addListener options.
Only when the destroyable
option is specified.
A Destroyable
object. An object which implements the destroy method which removes all listeners added in this call. For example:
this.btnListeners = myButton.mon({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
Move the view forward to view the "next" portion of the view based on the current value. This amount depends on the current view.
Move the view forward to view the "next" portion of the view based on the current value. This amount depends on the current view.
Shorthand for removeManagedListener. Removes listeners that were added by the mon method.
item : Ext.util.Observable / Ext.dom.Element
The item from which to remove a listener/listeners.
ename : Object / String
The event name, or an object containing event name properties.
fn : Function (optional)
If the ename
parameter was an event name, this is the handler function.
scope : Object (optional)
If the ename
parameter was an event name, this is the scope (this
reference)
in which the handler function is executed.
The on method is shorthand for addListener.
Appends an event handler to this object. For example:
myGridPanel.on("itemclick", this.onItemClick, this);
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
myGridPanel.on({
cellclick: this.onCellClick,
select: this.onSelect,
viewready: this.onViewReady,
scope: this // Important. Ensure "this" is correct during handler execution
});
One can also specify options for each event handler separately:
myGridPanel.on({
cellclick: {fn: this.onCellClick, scope: this, single: true},
viewready: {fn: panel.onViewReady, scope: panel}
});
Names of methods in a specified scope may also be used:
myGridPanel.on({
cellclick: {fn: 'onCellClick', scope: this, single: true},
viewready: {fn: 'onViewReady', scope: panel}
});
eventName : String / Object
The name of the event to listen for. May also be an object who's property names are event names.
fn : Function / String (optional)
The method the event invokes or the name of
the method within the specified scope
. Will be called with arguments
given to Ext.util.Observable#fireEvent plus the options
parameter described
below.
scope : Object (optional)
The scope (this
reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
options : Object (optional)
An object containing handler configuration.
Note: The options object will also be passed as the last argument to every event handler.
This object may contain any of the following properties:
scope : Object
The scope (this
reference) in which the handler function is executed. If omitted,
defaults to the object which fired the event.
delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
onFrame : Number
Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.
target : Ext.util.Observable
Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
element : String
This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.
This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.
For example, to add a click listener to a Panel's body:
var panel = new Ext.panel.Panel({
title: 'The title',
listeners: {
click: this.handlePanelClick,
element: 'body'
}
});
In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.
panel.body.un(...)
delegate : String (optional)
A simple selector to filter the event target or look for a descendant of the target.
The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).
See the delegate example below.
capture : Boolean (optional)
When set to true
, the listener is fired in the capture phase of the event propagation
sequence, instead of the default bubble phase.
The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).
stopPropagation : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true
to call stopPropagation on the event object
before firing the handler.
preventDefault : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true
to call preventDefault on the event object
before firing the handler.
stopEvent : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true
to call stopEvent on the event object
before firing the handler.
args : Array (optional)
Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.
destroyable : Boolean (optional)
When specified as true
, the function returns a destroyable
object. An object
which implements the destroy method which removes all listeners added in this call.
This syntax can be a helpful shortcut to using un; particularly when
removing multiple listeners. NOTE - not compatible when using the element
option. See un for the proper syntax for removing listeners added using the
element config.
Defaults to: false
priority : Number (optional)
An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.
order : String (optional)
A legacy option that is provided for backward compatibility.
It is recommended to use the priority
option instead. Available options are:
'before'
: equal to a priority of 100
'current'
: equal to a priority of 0
or default priority'after'
: equal to a priority of -100
Defaults to: 'current'
order : String (optional)
A shortcut for the order
event option. Provided for backward compatibility.
Please use the priority
event option instead.
Combining Options
Using the options argument, it is possible to combine different types of listeners:
A delayed, one-time listener.
myPanel.on('hide', this.handleClick, this, {
single: true,
delay: 100
});
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.
grid.on({
itemclick: 'onItemClick',
itemcontextmenu: grid.onItemContextmenu,
destroy: {
fn: function () {
// function called within the 'altCmp' scope instead of grid
},
scope: altCmp // unique scope for the destroy handler
},
scope: grid // default scope - provided for example clarity
});
Delegate
This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:
var panel = Ext.create({
xtype: 'panel',
renderTo: document.body,
title: 'Delegate Handler Example',
frame: true,
height: 220,
width: 220,
html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});
// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
click: function (e) {
console.log(e.getTarget().innerHTML);
},
element: 'body',
delegate: 'h1.myTitle'
});
Defaults to: 'current'
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();
container : Object
pos : Object
instanced : Object
Appends an after-event handler.
Same as addListener with order
set
to 'after'
.
eventName : String / String[] / Object
The name of the event to listen for.
fn : Function / String
The method the event invokes.
scope : Object (optional)
The scope for fn
.
options : Object (optional)
An object containing handler configuration.
Handle touchend on the all day portion of the view.
e : Ext.event.Event
The event.
Handle touchmove on the all day portion of the view.
e : Ext.event.Event
The event.
Handle touchstart on the all day portion of the view.
e : Ext.event.Event
The event.
Appends a before-event handler. Returning false
from the handler will stop the event.
Same as addListener with order
set
to 'before'
.
eventName : String / String[] / Object
The name of the event to listen for.
fn : Function / String
The method the event invokes.
scope : Object (optional)
The scope for fn
.
options : Object (optional)
An object containing handler configuration.
Handle touchend on the body day portion of the view.
e : Ext.event.Event
The event.
Handle touchmove on the body day portion of the view.
e : Ext.event.Event
The event.
Handle touchstart on the body day portion of the view.
e : Ext.event.Event
The event.
Handle a tap on an event model.
event : Ext.calendar.model.EventBase
The event model.
Handle the form being cancelled.
form : Ext.calendar.form.Base
The form.
Handle create form being saved.
form : Ext.calendar.form.Base
The form.
data : Object
The data from the form.
Handle edit form being saved.
form : Ext.calendar.form.Base
The form.
event : Ext.calendar.model.EventBase
The event being edited.
data : Object
The data from the form.
Called when this Inheritable is added to a parent
instanced : Boolean
Called when this inheritable is removed from a parent
destroying : Boolean
true
if this item will be destroyed by it's container
Handle dragend on an event resizer.
e : Ext.event.Event
The event.
Handle dragstart on an event resizer.
e : Ext.event.Event
The event.
Handle records being added to the source.
source : Ext.calendar.store.EventSource
The event source.
events : Ext.calendar.model.EventBase[]
The events.
Handles a source being refreshed.
source : Ext.calendar.store.EventSource
The source.
Handle records being removed from the source.
source : Ext.calendar.store.EventSource
The event source.
events : Ext.calendar.model.EventBase[]
The events.
Handles a record being updated in the source.
source : Ext.calendar.store.EventSource
The event source.
event : Ext.calendar.model.EventBase
The event.
Handles an update on the calendar store.
store : Ext.calendar.store.Calendars
The store.
calendar : Ext.calendar.model.CalendarBase
The calendar.
Position events for a day.
day : Ext.calendar.view.DaysRenderer
The day.
frag : DocumentFragment
A fragment to append events to.
Recursively processes the element templates for this class and its superclasses, ascending the hierarchy until it reaches a superclass whose element template has already been processed. This method is invoked using the prototype as the scope.
Publish this components state to the ViewModel
. If no arguments are given (or if
this is the first call), the entire state is published. This state is determined by
the publishes property.
This method is called only by component authors.
Available since: 5.0.0
property : String (optional)
The name of the property to update.
value : Object (optional)
The value of property
. Only needed if property
is given.
Recalculate the view bounds and communicate them to the event source.
Do a full refresh of the view if not in the middle of configuration.
Do a full event refresh if not configuring and event refresh is not suspended.
Relays selected events from the specified Observable as if the events were fired by this
.
For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:
this.relayEvents(this.getStore(), ['load']);
The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).
origin : Object
The Observable whose events this object is to relay.
events : String[] / Object
Array of event names to relay or an Object with key/value pairs translating to ActualEventName/NewEventName respectively. For example: this.relayEvents(this, {add:'push', remove:'pop'});
Would now redispatch the add event of this as a push event and the remove event as a pop event.
prefix : String (optional)
A common prefix to prepend to the event names. For example:
this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.
A Destroyable
object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:
this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
Can be undone by calling
Ext.destroy(this.storeRelayers);
or this.store.relayers.destroy();
Removes delegated listeners for a given eventName, function, and scope. Users should not invoke this method directly. It is called automatically by the framework as part of removeListener processing.
eventName : Object
fn : Object
scope : Object
Removes an event handler.
eventName : String
The type of event the handler was associated with.
fn : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.
Convenience Syntax
You can use the addListener
destroyable: true
config option in place of calling un(). For example:
var listeners = cmp.on({
scope: cmp,
afterrender: cmp.onAfterrender,
beforehide: cmp.onBeforeHide,
destroyable: true
});
// Remove listeners
listeners.destroy();
// or
cmp.un(
scope: cmp,
afterrender: cmp.onAfterrender,
beforehide: cmp.onBeforeHide
);
Exception - DOM event handlers using the element config option
You must go directly through the element to detach an event handler attached using the addListener element option.
panel.on({
element: 'body',
click: 'onBodyCLick'
});
panel.body.un({
click: 'onBodyCLick'
});
Removes listeners that were added by the mon method.
item : Ext.util.Observable / Ext.dom.Element
The item from which to remove a listener/listeners.
ename : Object / String
The event name, or an object containing event name properties.
fn : Function (optional)
If the ename
parameter was an event name, this is the handler function.
scope : Object (optional)
If the ename
parameter was an event name, this is the scope (this
reference)
in which the handler function is executed.
Remove a single managed listener item
isClear : Boolean
True if this is being called during a clear
managedListener : Object
The managed listener item See removeManagedListener for other args
Removes and (optionally) destroys a plugin.
Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.
Available since: 6.2.0
plugin : String / Ext.plugin.Abstract
The plugin or its id
to remove.
destroy : Boolean (optional)
Pass true
to not call destroy()
on the plugin.
plugin instance or null
if not found.
container : Object
insertBeforeElement : Object
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.
Resume the ability to refresh events on the view. The number of calls to resume must match suspendEventRefresh.
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.
Returns focus to the Component or element found in the cached focusEnterEvent.
Round a date to the nearest minimum slot.
d : Date
The date.
The rounded date.
Select a range in the all day view.
start : Number
The start index.
end : Number
The end index.
Sets a single/multiple configuration options.
name : String / Object
The name of the property to set, or a set of key value pairs to set.
value : Object (optional)
The value to set for the name parameter.
this
Sets the size of the Component.
width : Number
The new width for the Component.
height : Number
The new height for the Component.
Set the range on the event source if it exists.
range : Ext.calendar.date.Range
The range.
Set the tabIndex property for this Focusable. If the focusEl is available, set tabIndex attribute on it, too.
newTabIndex : Number
new tabIndex to set
Sets the startTime and endTime simultaneously.
start : Number
The start hour between 0 and 23.
end : Number
The end hour between 1 and 24.
Show the addForm for this calendar. Has no behavior if
addForm is null
.
event : Ext.calendar.model.EventBase (optional)
A new event record containing any data to be passed to the form. If not specified, default dates from this view will be chosen.
options : Object (optional)
Callback options for form creation.
onSave : Function (optional)
A save callback function.
onCancel : Function (optional)
A cancel callback function.
scope : Object (optional)
A scope for the callback functions.
Show the editForm for this calendar. Has no behavior if
editForm is null
.
event : Ext.calendar.model.EventBase
The event to be passed to the form.
options : Object (optional)
Callback options for form creation.
onSave : Function (optional)
A save callback function.
onCancel : Function (optional)
A cancel callback function.
scope : Object (optional)
A scope for the callback functions.
Get the nearest slot based on the page position.
pageY : Number
The y position on the page.
local : Boolean (optional)
true
to calculate as a local y instead of page y.
Defaults to: false
The slot.
Gets the local y position given a slot.
slot : Number
The slot.
The local y position.
Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base#self,
this.statics()
is scope-independent and it always returns the class from which it was called, regardless of what
this
points to during run-time
Ext.define('My.Cat', {
statics: {
totalCreated: 0,
speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
},
constructor: function() {
var statics = this.statics();
alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to
// equivalent to: My.Cat.speciesName
alert(this.self.speciesName); // dependent on 'this'
statics.totalCreated++;
},
clone: function() {
var cloned = new this.self(); // dependent on 'this'
cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName
return cloned;
}
});
Ext.define('My.SnowLeopard', {
extend: 'My.Cat',
statics: {
speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'
},
constructor: function() {
this.callParent();
}
});
var cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'
var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
var clone = snowLeopard.clone();
alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'
alert(clone.groupName); // alerts 'Cat'
alert(My.Cat.totalCreated); // alerts 3
Suspends firing of the named event(s).
After calling this method to suspend events, the events will no longer fire when requested to fire.
Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.
eventName : String...
Multiple event names to suspend.
Suspend the ability to refresh events on the view. The number of calls to suspend must match resumeEventRefresh.
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.
Ensure headers take into account a scrollbar on the view if necessary.
Creates a UTC date at the specified time, taking into account the timezone offset. For example if the timezone offset is +01:00GMT and the values are 2010-01-05:00:00, then the resulting value would be 2010-01-04:23:00.
date : Date
The date
The offset date
Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).
className : String
The CSS class to toggle.
state : Boolean (optional)
If specified as true
, causes the class to be added. If
specified as false
, causes the class to be removed.
Shorthand for removeListener. Removes an event handler.
eventName : String
The type of event the handler was associated with.
fn : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.
Convenience Syntax
You can use the addListener
destroyable: true
config option in place of calling un(). For example:
var listeners = cmp.on({
scope: cmp,
afterrender: cmp.onAfterrender,
beforehide: cmp.onBeforeHide,
destroyable: true
});
// Remove listeners
listeners.destroy();
// or
cmp.un(
scope: cmp,
afterrender: cmp.onAfterrender,
beforehide: cmp.onBeforeHide
);
Exception - DOM event handlers using the element config option
You must go directly through the element to detach an event handler attached using the addListener element option.
panel.on({
element: 'body',
click: 'onBodyCLick'
});
panel.body.un({
click: 'onBodyCLick'
});
Removes a before-event handler.
Same as removeListener with order
set to 'after'
.
eventName : String / String[] / Object
The name of the event the handler was associated with.
fn : Function / String
The handler to remove.
scope : Object (optional)
The scope originally specified for fn
.
options : Object (optional)
Extra options object.
Removes a before-event handler.
Same as removeListener with order
set to 'before'
.
eventName : String / String[] / Object
The name of the event the handler was associated with.
fn : Function / String
The handler to remove.
scope : Object (optional)
The scope originally specified for fn
.
options : Object (optional)
Extra options object.
Destroys a given set of linked objects. This is only needed if the linked object is being destroyed before this instance.
names : String[]
The names of the linked objects to destroy.
this
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).
All cls methods directly report to the cls configuration, so anytime it changes, updateCls will be called
newCls : Object
oldCls : Object
Updates the viewModel config.
viewModel : Ext.app.ViewModel
oldViewModel : Ext.app.ViewModel
Get a UTC date as a local date, taking into account the timezoneOffset.
For example, if the current date is:
Thu May 05 2016 10:00:00 GMT+1000
and the timezoneOffset is -60
, then the value will
be Thu May 05 2016 01:00:00 GMT+1000
.
d : Date
The date
The offset
Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.
config : Object
mixinClass : Ext.Class (optional)
The mixin class if the configs are from a mixin.
Add methods / properties to the prototype of this class.
Ext.define('My.awesome.Cat', {
constructor: function() {
...
}
});
My.awesome.Cat.addMembers({
meow: function() {
alert('Meowww...');
}
});
var kitty = new My.awesome.Cat();
kitty.meow();
members : Object
The members to add to this class.
isStatic : Boolean (optional)
Pass true
if the members are static.
Defaults to: false
privacy : Boolean (optional)
Pass true
if the members are private. This
only has meaning in debug mode and only for methods.
Defaults to: false
Add / override static properties of this class.
Ext.define('My.cool.Class', {
...
});
My.cool.Class.addStatics({
someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'
method1: function() { ... }, // My.cool.Class.method1 = function() { ... };
method2: function() { ... } // My.cool.Class.method2 = function() { ... };
});
members : Object
this
Borrow another class' members to the prototype of this class.
Ext.define('Bank', {
money: '$$$',
printMoney: function() {
alert('$$$$$$$');
}
});
Ext.define('Thief', {
...
});
Thief.borrow(Bank, ['money', 'printMoney']);
var steve = new Thief();
alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'
fromClass : Ext.Base
The class to borrow members from
members : Array / String
The names of the members to borrow
this
Create a new instance of this Class.
Ext.define('My.cool.Class', {
...
});
My.cool.Class.create({
someConfig: true
});
All parameters are passed to the constructor of the class.
the created instance.
Create aliases for existing prototype methods. Example:
Ext.define('My.cool.Class', {
method1: function() { ... },
method2: function() { ... }
});
var test = new My.cool.Class();
My.cool.Class.createAlias({
method3: 'method1',
method4: 'method2'
});
test.method3(); // test.method1()
My.cool.Class.createAlias('method5', 'method3');
test.method5(); // test.method3() -> test.method1()
alias : String / Object
The new method name, or an object to set multiple aliases. See flexSetter
origin : String / Object
The original method name
Returns the Ext.Configurator for this class.
Get the current class' name in string format.
Ext.define('My.cool.Class', {
constructor: function() {
alert(this.self.getName()); // alerts 'My.cool.Class'
}
});
My.cool.Class.getName(); // 'My.cool.Class'
className
Used internally by the mixins pre-processor
name : Object
mixinClass : Object
Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
Direct use of this method should be rare. Use Ext.define instead:
Ext.define('My.CatOverride', {
override: 'My.Cat',
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).
members : Object
The properties to add to this class. This should be specified as an object literal containing one or more properties.
this class
This event fires when disabled changes.
sender : Ext.Widget
The instance firing this event.
value : Boolean
The current value of disabled.
oldValue : Boolean
The previous value of disabled.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
Fired before an event addForm is shown.
this : Ext.calendar.view.Base
This view.
context : Object
The context.
event : Ext.calendar.model.EventBase
The new event to be added.
Return false
to cancel the form being shown.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired before an event drag begins. Depends on the draggable config.
this : Ext.calendar.view.Days
This view.
context : Object
The context.
event : Ext.calendar.model.EventBase
The event model.
Return false
to cancel the drag.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired before an event editForm is shown.
this : Ext.calendar.view.Base
This view.
context : Object
The context.
event : Ext.calendar.model.EventBase
The event to be edited.
Return false
to cancel the form being shown.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired before an event resize begins. Depends on the resizeEvents config.
this : Ext.calendar.view.Days
This view.
context : Object
The context.
event : Ext.calendar.model.EventBase
The event model.
Return false
to cancel the resize.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when height changes.
sender : Ext.Widget
The instance firing this event.
value : Number / String
The current value of height.
oldValue : Number / String
The previous value of height.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
This event fires when width changes.
sender : Ext.Widget
The instance firing this event.
value : Number / String
The current value of width.
oldValue : Number / String
The previous value of width.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
Fires when this Component's focusEl loses focus.
this : Ext.Component
event : Ext.event.Event
The blur event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when disabled changes.
sender : Ext.Widget
The instance firing this event.
value : Boolean
The current value of disabled.
oldValue : Boolean
The previous value of disabled.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired when an event has been added via the addForm.
this : Ext.calendar.view.Base
This view.
context : Object
The context.
event : Ext.calendar.model.EventBase
The newly added event with data.
data : Object
The data provided by the form.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired when an event drop is complete. Depends on the droppable config.
this : Ext.calendar.view.Days
The view.
context : Object
The context.
event : Ext.calendar.model.EventBase
The event model.
newRange : Ext.calendar.date.Range
The new date range.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired when an event has been edited via the editForm.
this : Ext.calendar.view.Base
This view.
context : Object
The context.
event : Ext.calendar.model.EventBase
The edited event with data.
data : Object
The data provided by the form.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired when an event resize is complete. Depends on the resizeEvents config.
this : Ext.calendar.view.Days
The view.
context : Object
The context.
event : Ext.calendar.model.EventBase
The event model.
newRange : Ext.calendar.date.Range
The new date range.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired when an event is tapped.
this : Ext.calendar.view.Base
This view.
context : Object
The context.
event : Ext.calendar.model.EventBase
The event model.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when this Component's focusEl receives focus.
this : Ext.Component / Ext.Widget
event : Ext.event.Event
The focus event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when focus enters this Component's hierarchy.
this : Ext.Component
event : Ext.event.Event
The focusenter event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when focus leaves this Component's hierarchy.
this : Ext.Component
event : Ext.event.Event
The focusleave event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when height changes.
sender : Ext.Widget
The instance firing this event.
value : Number / String
The current value of height.
oldValue : Number / String
The previous value of height.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired after the addForm has been completed, but before the event is added. Allows the add to be validated.
this : Ext.calendar.view.Base
This view.
context : Object
The context.
event : Ext.calendar.model.EventBase
The new event to be added, the data is not yet set on the event.
data : Object
The data provided by the form. This will be used to set the event data using Ext.calendar.model.EventBase#setData.
validate : Ext.Promise
A promise that allows validation to occur. The default behavior is for no validation to take place. To achieve asynchronous validation, the promise on the context object must be replaced:
{
listeners: {
validateeventadd: function(view, context) {
context.validate = context.then(function() {
return Ext.Ajax.request({
url: '/checkAdd'
}).then(function(response) {
return Promise.resolve(response.responseText === 'ok');
});
});
}
}
}
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired when an event is dropped on this view, allows the drop to be validated. Depends on the droppable config.
this : Ext.calendar.view.Days
The view.
context : Object
The context.
event : Ext.calendar.model.EventBase
The event model.
newRange : Ext.calendar.date.Range
The new date range.
validate : Ext.Promise
A promise that allows validation to occur. The default behavior is for no validation to take place. To achieve asynchronous validation, the promise on the context object must be replaced:
{
listeners: {
validateeventdrop: function(view, context) {
context.validate = context.then(function() {
return Ext.Ajax.request({
url: '/checkDrop'
}).then(function(response) {
return Promise.resolve(response.responseText === 'ok');
});
});
}
}
}
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired after the editForm has been completed, but before the event is saved. Allows the edit to be validated.
this : Ext.calendar.view.Base
This view.
context : Object
The context.
event : Ext.calendar.model.EventBase
The event to be edited, the data is not yet set on the event.
data : Object
The data provided by the form. This will be used to set the event data using Ext.calendar.model.EventBase#setData.
validate : Ext.Promise
A promise that allows validation to occur. The default behavior is for no validation to take place. To achieve asynchronous validation, the promise on the context object must be replaced:
{
listeners: {
validateeventedit: function(view, context) {
context.validate = context.then(function() {
return Ext.Ajax.request({
url: '/checkEdit'
}).then(function(response) {
return Promise.resolve(response.responseText === 'ok');
});
});
}
}
}
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired when an event is resized on this view, allows the resize to be validated. Depends on the resizeEvents config.
this : Ext.calendar.view.Days
The view.
context : Object
The context.
event : Ext.calendar.model.EventBase
The event model.
newRange : Ext.calendar.date.Range
The new date range.
validate : Ext.Promise
A promise that allows validation to occur. The default behavior is for no validation to take place. To achieve asynchronous validation, the promise on the context object must be replaced:
{
listeners: {
validateeventresize: function(view, context) {
context.validate = context.then(function() {
return Ext.Ajax.request({
url: '/checkResize'
}).then(function(response) {
return Promise.resolve(response.responseText === 'ok');
});
});
}
}
}
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired when the value changes.
this : Ext.calendar.view.Base
This view.
context : Object
The context.
value : Date
The new value.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when width changes.
sender : Ext.Widget
The instance firing this event.
value : Number / String
The current value of width.
oldValue : Number / String
The previous value of width.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
The height for the empty all day row to allow creation.
Defaults to: 10px
The background color.
Defaults to: $calendar-background-color
The width for the day gutter when in compact mode.
Defaults to: 0
The start margin for the day container when in compact mode.
Defaults to: 0
The font size for the time display when in compact mode.
Defaults to: $calendar-small-font-size
The padding for the time display when in compact mode.
Defaults to: 2px 2px 0 0
The width for the time display when in compact mode.
Defaults to: 2em
The border color for days.
Defaults to: $calendar-days-marker-border-color
The border style for days.
Defaults to: $calendar-days-marker-border-style
The border width for days.
Defaults to: $calendar-days-marker-border-width
The border color for half hour markers.
Defaults to: $calendar-border-color
The border style for half hour markers.
Defaults to: dotted
The border width for half hour markers.
Defaults to: 1px
The border color for hour markers.
Defaults to: $calendar-border-color
The color for the current time marker.
Defaults to: #a94442
The style for the current time marker.
Defaults to: solid
The height for the current time marker.
Defaults to: 2px 0 0 0
The margin for the current time marker.
Defaults to: 0 5px
The opacity for the current time marker.
Defaults to: 0.7
The background color for a selection.
Defaults to: $calendar-selection-color
The line height for the am/pm text when used in the time gutter.
Defaults to: 1em
The background color for the time display.
Defaults to: #F7F9FD
The font family for the time display.
Defaults to: $calendar-font-family
The font size for the time display.
Defaults to: $calendar-font-size
The padding for the time display.
Defaults to: 2px 2px 0 0
Creates a visual theme for the calendar days view.
$ui : String
The name of the UI being created. Can not included spaces or special punctuation (used in CSS class names).
$background-color : color (optional)
The background color.
$hour-height : Number (optional)
The height for a single hour in the view.
$day-gutter-width : Number (optional)
The width for the day gutter.
$day-start-margin : Number (optional)
The start margin for the day container.
$marker-border-width : Number (optional)
The border width for hour markers.
$marker-border-style : String (optional)
The border style for hour markers.
$marker-border-color : color (optional)
The border color for hour markers.
$marker-alt-border-width : Number (optional)
The border width for half hour markers.
$marker-alt-border-style : String (optional)
The border style for half hour markers.
$marker-alt-border-color : color (optional)
The border color for half hour markers.
$day-border-width : Number (optional)
The border width for days.
$day-border-style : String (optional)
The border style for days.
$day-border-color : color (optional)
The border color for days.
$now-marker-opacity : Number (optional)
The opacity for the current time marker.
$now-marker-margin : Number / list (optional)
The margin for the current time marker.
$now-marker-border-width : Number / list (optional)
The border width for the current time marker.
$now-marker-border-style : String (optional)
The border style for the current time marker.
$now-marker-border-color : color (optional)
The border color for the current time marker.
$time-width : Number (optional)
The width of the current time
$time-background-color : color (optional)
The background color for the current time
$time-color : color (optional)
The color for the current time
$time-font-family : String (optional)
The font family for the current time
$time-font-size : Number (optional)
The font size for the current time
$time-text-align : String (optional)
The font alignment for the current time
$time-padding : Number (optional)
The padding for the current time
$time-ampm-line-height : String (optional)
The line height for the current time
$allday-empty-height : Number (optional)
The height for the empty all day row to allow creation.
$selection-background-color : color (optional)
The background color for a selection.
$selection-opacity : Number (optional)
The background color for a selection.