The documentation for the ExtReact product diverges somewhat from the
documentation of other Sencha products. The sections below describe
documentation for all products except where indicated as unique to
ExtReact.
Many classes have shortcut names used when creating (instantiating) a class with a
configuration object. The shortcut name is referred to as an alias (or xtype if the
class extends Ext.Component). The alias/xtype is listed next to the class name of
applicable classes for quick reference.
ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.
Framework classes or their members may be specified as private or protected. Else,
the class / member is public. Public, protected, and private are access
descriptors used to convey how and when the class or class member should be used.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
ExtReact component classes display
configuration options as props
ExtReact component classes do not list
properties as a dedicated member type, but rather as
read only props
static label next to the
method name. *See Static below.Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)Ext.Component in this case). This may be omitted for methods that do not
return anything other than undefined or may display as multiple possible values
separated by a forward slash / signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false if unsuccessful which would be displayed as
Ext.Component/Boolean).PROTECTED in
this example - see the Flags section below)Ext.container.Container in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.
All ExtReact props are bindable
unless decorated as immutable
Immutable ExtReact props may not be use as a configurable prop when instantiating a component
classInstance.method1().method2().etc();false is returned from
an event handler- Indicates a framework class
- A singleton framework class. *See the singleton flag for more information
- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)
- Indicates that the class, member, or guide is new in the currently viewed version
- Indicates a class member of type config
Or in the case of an ExtReact component class this
indicates a member of type prop
- Indicates a class member of type property
- Indicates a class member of type
method
- Indicates a class member of type event
- Indicates a class member of type
theme variable
- Indicates a class member of type
theme mixin
- Indicates that the class, member, or guide is new in the currently viewed version
Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.
Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.
ExtReact component classes do not hoist the getter /
setter methods into the prop. All methods will be described in the
Methods section
Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.
Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.
If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.
Both API docs and guides can be searched for using the search field at the top of the page.
On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.
The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.
Clicking on an empty search field will show your last 10 searches for quick navigation.
Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.
Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.
Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:
The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.
true to maintain sorted order when items
are added regardless of requested insertion point, or when an item mutation
results in a new sort position.
This does not affect a filtered Collection's reaction to mutations of the source Collection. If sorters are present when the source Collection is mutated, this Collection's sort order will always be maintained.
Defaults to:
true
A function that can convert newly added items to a proper type before being added to this collection.
Defaults to:
null
The default sort direction to use if one is not specified.
Defaults to:
'ASC'
Sets the value of defaultSortDirection
defaultSortDirection : String
One or more Ext.util.CollectionKey configuration objects or key properties.
Each property of the given object is the name of the CollectionKey instance
that is stored on this collection. The value of each property configures the
CollectionKey instance.
var collection = new Ext.util.Collection({
extraKeys: {
byName: 'name' // based on "name" property of each item
}
});
Or equivalently:
var collection = new Ext.util.Collection({
extraKeys: {
byName: {
property: 'name'
}
}
});
To provide a custom key extraction function instead:
var collection = new Ext.util.Collection({
extraKeys: {
byName: {
keyFn: function (item) {
return item.name;
}
}
}
});
Or to call a key getter method from each item:
var collection = new Ext.util.Collection({
extraKeys: {
byName: {
keyFn: 'getName'
}
}
});
To use the above:
var item = collection.byName.get('somename');
NOTE Either a property or keyFn must be be specified to define each
key.
Defaults to:
null
Available since: 5.0.0
The collection of Ext.util.Filter for this collection. At the
time a collection is created filters can be specified as a unit. After that
time the normal setFilters method can also be given a set of replacement
filters for the collection.
Individual filters can be specified as an Ext.util.Filter instance, a config
object for Ext.util.Filter or simply a function that will be wrapped in a
instance with its filterFn set.
For fine grain control of the filters collection, call getFilters to return
the Ext.util.Collection instance that holds this collection's filters.
var collection = new Ext.util.Collection();
var filters = collection.getFilters(); // an Ext.util.FilterCollection
function legalAge (item) {
return item.age >= 21;
}
filters.add(legalAge);
//...
filters.remove(legalAge);
Any changes to the filters collection will cause this collection to adjust
its items accordingly (if autoFilter is true).
Defaults to:
null
Available since: 5.0.0
Returns the Ext.util.FilterCollection. Unless autoCreate is explicitly passed
as false this collection will be automatically created if it does not yet exist.
autoCreate : Object (optional)
Pass false to disable auto-creation of the collection.
Defaults to: true
The collection of filters.
Sets the value of filters
filters : Array / Ext.util.FilterCollection
A default configuration to be passed to any groups created by the Ext.util.GroupCollection. See groups.
Defaults to:
null
Available since: 6.5.0
A configuration object for this collection's Ext.util.Grouper.
For example, to group items by the first letter of the last name:
var collection = new Ext.util.Collection({
grouper: {
groupFn: function (item) {
return item.lastName.substring(0, 1);
}
}
});
Defaults to:
null
The collection of to hold each group container. This collection is created and
removed dynamically based on grouper. Application code should only need to
call getGroups to retrieve the collection and not setGroups.
Defaults to:
null
A function to retrieve the key of an item in the collection. If provided,
this replaces the default getKey method. The default getKey method handles
items that have either an "id" or "_id" property or failing that a getId
method to call.
Available since: 5.0.0
A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.
DOM events from Ext JS Ext.Component
While some Ext JS Component classes export selected DOM events (e.g. "click",
"mouseover" etc), this is usually only done when extra value can be added. For example
the DataView's itemclick
event passing the node clicked on. To access DOM events directly from a child element
of a Component, we need to specify the element option to identify the Component
property to add a DOM listener to:
new Ext.panel.Panel({
width: 400,
height: 200,
dockedItems: [{
xtype: 'toolbar'
}],
listeners: {
click: {
element: 'el', //bind to the underlying el property on the panel
fn: function(){ console.log('click el'); }
},
dblclick: {
element: 'body', //bind to the underlying body property on the panel
fn: function(){ console.log('dblclick body'); }
}
}
});
An alias for addListener. In versions prior to 5.1, listeners had a generated setter which could be called to add listeners. In 5.1 the listeners config is not processed using the config system and has no generated setter, so this method is provided for backward compatibility. The preferred way of adding listeners is to use the on method.
listeners : Object
The listeners
The maximum number of sorters which may be applied to this Sortable when using the "multi" insertion position when adding sorters.
New sorters added using the "multi" insertion position are inserted at the top of the sorters list becoming the new primary sort key.
If the sorters collection has grown to longer then multiSortLimit, then
the it is trimmed.
Defaults to:
3
Sets the value of multiSortLimit
multiSortLimit : Number
The root property to use for aggregation, filtering and sorting. By default
this is null but when containing things like Ext.data.Model
this config would likely be set to "data" so that property names are applied
to the fields of each record.
Defaults to:
null
Array of Ext.util.Sorter for this collection. At the time a
collection is created the sorters can be specified as a unit. After that time
the normal setSorters method can be also be given a set of replacement
sorters.
Individual sorters can be specified as an Ext.util.Sorter instance, a config
object for Ext.util.Sorter or simply the name of a property by which to sort.
An alternative way to extend the sorters is to call the sort method and pass
a property or sorter config to add to the sorters.
For fine grain control of the sorters collection, call getSorters to return
the Ext.util.Collection instance that holds this collection's sorters.
var collection = new Ext.util.Collection();
var sorters = collection.getSorters(); // an Ext.util.SorterCollection
sorters.add('name');
//...
sorters.remove('name');
Any changes to the sorters collection will cause this collection to adjust
its items accordingly (if autoSort is true).
Defaults to:
null
Available since: 5.0.0
Returns the Ext.util.SorterCollection. Unless autoCreate is explicitly passed
as false this collection will be automatically created if it does not yet exist.
autoCreate : Object (optional)
Pass false to disable auto-creation of the collection.
Defaults to: true
The collection of sorters.
Sets the value of sorters
sorters : Array / Ext.util.SorterCollection
The base Collection. This collection contains the items to which filters
are applied to populate this collection. In this configuration, only the
root source collection can have items truly added or removed.
Defaults to:
null
Available since: 5.0.0
Returns all unfiltered items in the Collection when the Collection has been
filtered. Returns null when the Collection is not filtered.
items All unfiltered items (or null when the
Collection is not filtered)
true to track individual groups in a Ext.util.GroupCollection
Defaults to:
true
Priority that is used for endupdate listeners on the filters and sorters. set to a very high priority so that our processing of these events takes place prior to user code - data must already be filtered/sorted when the user's handler runs
Defaults to:
1001
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
true indicates an id was auto-generated rather than provided by configuration.
Defaults to:
false
Available since: 6.7.0
Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.
Defaults to:
0
Mutation counter which is incremented when the collection changes.
Defaults to:
0
Available since: 5.0.0
This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class (via observe) or on the MVC EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.
The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:
if (this.hasListeners.foo) {
this.fireEvent('foo', this, arg1);
}
The number of times the indices have been rebuilt. This is for diagnostic use.
Defaults to:
0
Available since: 5.0.0
An object used as map to get the index of an item.
Defaults to:
null
Available since: 5.0.0
true in this class to identify an object as an instantiated Collection, or subclass
thereof.
Defaults to:
true
true in this class to identify an object as an instantiated Observable, or subclass
thereof.
Defaults to:
true
An object used as a map to find items based on their key.
Defaults to:
{}
Available since: 5.0.0
A read-only flag indicating if this object is sorted. This flag may not be correct
during an update of the sorter collection but will be correct before onSortChange
is called. This flag is true if grouped is true because the collection is at
least sorted by the grouper.
Defaults to:
false
A counter that is increased by beginUpdate and decreased by endUpdate. When
this transitions from 0 to 1 the beginupdate event is
fired. When it transitions back from 1 to 0 the endupdate
event is fired.
Defaults to:
0
Available since: 5.0.0
Adds declarative listeners as nested arrays of listener objects.
listeners : Array
true if any listeners were added
Adds an item to the collection. If the item already exists or an item with the same key exists, the old item will be removed and the new item will be added to the end.
This method also accepts an array of items or simply multiple items as individual arguments. The following 3 code sequences have the same end result:
// Call add() once per item (not optimal - best avoided):
collection.add(itemA);
collection.add(itemB);
collection.add(itemC);
collection.add(itemD);
// Call add() with each item as an argument:
collection.add(itemA, itemB, itemC, itemD);
// Call add() with the items as an array:
collection.add([ itemA, itemB, itemC, itemD ]);
The first form should be avoided where possible because the collection and all parties "watching" it will be updated 4 times.
Available since: 5.0.0
item : Object/Object[]
The item or items to add.
The item or items added.
The on method is shorthand for addListener.
Appends an event handler to this object. For example:
myGridPanel.on("itemclick", this.onItemClick, this);
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
myGridPanel.on({
cellclick: this.onCellClick,
select: this.onSelect,
viewready: this.onViewReady,
scope: this // Important. Ensure "this" is correct during handler execution
});
One can also specify options for each event handler separately:
myGridPanel.on({
cellclick: {fn: this.onCellClick, scope: this, single: true},
viewready: {fn: panel.onViewReady, scope: panel}
});
Names of methods in a specified scope may also be used:
myGridPanel.on({
cellclick: {fn: 'onCellClick', scope: this, single: true},
viewready: {fn: 'onViewReady', scope: panel}
});
eventName : String/Object
The name of the event to listen for. May also be an object who's property names are event names.
fn : Function/String (optional)
The method the event invokes or the name of
the method within the specified scope. Will be called with arguments
given to Ext.util.Observable#fireEvent plus the options parameter described
below.
scope : Object (optional)
The scope (this reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
options : Object (optional)
An object containing handler configuration.
Note: The options object will also be passed as the last argument to every event handler.
This object may contain any of the following properties:
scope : Object
The scope (this reference) in which the handler function is executed. If omitted,
defaults to the object which fired the event.
delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
onFrame : Number
Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.
target : Ext.util.Observable
Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
element : String
This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.
This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.
For example, to add a click listener to a Panel's body:
var panel = new Ext.panel.Panel({
title: 'The title',
listeners: {
click: this.handlePanelClick,
element: 'body'
}
});
In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.
panel.body.un(...)
delegate : String (optional)
A simple selector to filter the event target or look for a descendant of the target.
The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).
See the delegate example below.
capture : Boolean (optional)
When set to true, the listener is fired in the capture phase of the event propagation
sequence, instead of the default bubble phase.
The capture option is only available on Ext.dom.Element instances (or
when attaching a listener to a Ext.dom.Element via a Component using the
element option).
stopPropagation : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopPropagation on the event
object before firing the handler.
preventDefault : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call preventDefault on the event
object before firing the handler.
stopEvent : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopEvent on the event object
before firing the handler.
args : Array (optional)
Optional set of arguments to pass to the handler function before the actual
fired event arguments. For example, if args is set to ['foo', 42],
the event handler function will be called with an arguments list like this:
handler('foo', 42, <actual event arguments>...);
destroyable : Boolean (optional)
When specified as true, the function returns a destroyable object. An object
which implements the destroy method which removes all listeners added in this call.
This syntax can be a helpful shortcut to using un; particularly when
removing multiple listeners. NOTE - not compatible when using the element
option. See un for the proper syntax for removing listeners added using the
element config.
Defaults to:
false
priority : Number (optional)
An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.
order : String (optional)
A legacy option that is provided for backward compatibility.
It is recommended to use the priority option instead. Available options are:
'before': equal to a priority of 100'current': equal to a priority of 0 or default priority'after': equal to a priority of -100Defaults to:
'current'
order : String (optional)
A shortcut for the order event option. Provided for backward compatibility.
Please use the priority event option instead.
Defaults to: 'current'
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes
all listeners added in this call. For example:
this.btnListeners = = myButton.on({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.
Example:
Ext.define('Foo', {
extend: 'Ext.Component',
initComponent: function () {
this.addManagedListener(MyApp.SomeSharedMenu, 'show', this.doSomething);
this.callParent();
}
});
As you can see, when an instance of Foo is destroyed, it ensures that the 'show'
listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.
As of version 5.1 it is no longer necessary to use this method in most cases because
listeners are automatically managed if the scope object provided to
addListener is an Observable instance.
However, if the observable instance and scope are not the same object you
still need to use mon or addManagedListener if you want the listener to be
managed.
item : Ext.util.Observable/Ext.dom.Element
The item to which to add a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function/String (optional)
If the ename parameter was an event
name, this is the handler function or the name of a method on the specified
scope.
scope : Object (optional)
If the ename parameter was an event name, this is
the scope (this reference) in which the handler function is executed.
options : Object (optional)
If the ename parameter was an event name, this is
the addListener options.
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes
all listeners added in this call. For example:
this.btnListeners = myButton.mon({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
Adds an observing object to this collection. Observers are given first view of all
events that we may fire. For any event an observer may implement a method whose
name starts with "onCollection" to receive the event. The add
event for example would be passed to "onCollectionAdd".
The only restriction to observers is that they are not allowed to add or remove observers from inside these methods.
Available since: 5.0.0
observer : Ext.util.Collection
The observer instance.
Returns the result of the specified aggregation operation against all items in this collection.
This method is not typically called directly because there are convenience methods
for each of the supported operation values. These are:
[min, max].undefined if empty.undefined if empty.For example:
result = collection.aggregate('age', 'sum');
result = collection.aggregate('age', 'sum', 2, 10); // the 8 items at index 2
To provide a custom operation function:
function averageAgeOfMinors (items, values) {
var sum = 0,
count = 0;
for (var i = 0; i < values.length; ++i) {
if (values[i] < 18) {
sum += values[i];
++count;
}
}
return count ? sum / count : 0;
}
result = collection.aggregate('age', averageAgeOfMinors);
property : String
The name of the property to aggregate from each item.
operation : String/Function
The operation to perform.
begin : Number (optional)
The index of the first item in items to include in the
aggregation.
end : Number (optional)
The index at which to stop aggregating items. The item at
this index will not be included in the aggregation.
scope : Object (optional)
The this pointer to use if operation is a function.
Defaults to this collection.
See aggregate. The functionality is the same, however the aggregates are provided per group. Assumes this collection has an active grouper.
property : String
The name of the property to aggregate from each item.
operation : String/Function
The operation to perform.
scope : Object (optional)
The this pointer to use if operation is a function.
Defaults to this collection.
Aggregates a set of groups.
groups : Ext.util.GroupCollection
The groups
property : String
The name of the property to aggregate from each item.
operation : String/Function
The operation to perform.
scope : Object (optional)
The this pointer to use if operation is a function.
Defaults to this collection.
Returns the result of the specified aggregation operation against the given items.
For details see aggregate.
items : Array
The items to aggregate.
property : String
The name of the property to aggregate from each item.
operation : String/Function
The operation to perform.
begin : Number (optional)
The index of the first item in items to include in the
aggregation.
end : Number (optional)
The index at which to stop aggregating items. The item at
this index will not be included in the aggregation.
scope : Object (optional)
The this pointer to use if operation is a function.
Defaults to this collection.
Averages property values from some or all of the items in this collection.
Available since: 5.0.0
property : String
The name of the property to average from each item.
begin : Number (optional)
The index of the first item to include in the average.
end : Number (optional)
The index at which to stop averaging items. The item at
this index will not be included in the average.
The result of averaging the specified property from the indicated items.
See average. The result is partitioned by group.
Available since: 5.0.0
property : String
The name of the property to average from each item.
The result of average, partitioned by group. See aggregateByGroup.
This method is called to indicate the start of multiple changes to the collection.
Application code should seldom need to call this method as it is called internally
when needed. If multiple collection changes are needed, consider wrapping them in
an update call rather than calling beginUpdate directly.
Internally this method increments a counter that is decremented by endUpdate. It
is important, therefore, that if you call beginUpdate directly you match that
call with a call to endUpdate or you will prevent the collection from updating
properly.
For example:
var collection = new Ext.util.Collection();
collection.beginUpdate();
collection.add(item);
// ...
collection.insert(index, otherItem);
//...
collection.endUpdate();
Available since: 5.0.0
Determines the minimum and maximum values for the specified property over some or all of the items in this collection.
Available since: 5.0.0
property : String
The name of the property from each item.
begin : Number (optional)
The index of the first item to include in the bounds.
end : Number (optional)
The index at which to stop in items. The item at this index
will not be included in the bounds.
An array [min, max] with the minimum and maximum of the specified
property.
See bounds. The result is partitioned by group.
Available since: 5.0.0
property : String
The name of the property from each item.
The result of bounds, partitioned by group. See aggregateByGroup.
Removes all items from the collection. This is similar to removeAll except that
removeAll fire events to inform listeners. This means that this method should be
called only when you are sure there are no listeners.
Available since: 5.0.0
Creates a shallow copy of this collection
Available since: 5.0.0
Collects unique values of a particular property in this Collection.
Available since: 5.0.0
property : String
The property to collect on
root : String (optional)
'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object
allowNull : Boolean (optional)
Pass true to include null, undefined or empty
string values.
The unique values
Returns true if the collection contains the passed Object as an item.
Available since: 5.0.0
item : Object
The item to look for in the collection.
true if the collection contains the item.
Returns true if the collection contains all the passed items. If the first argument is an array, then the items in that array are checked. Otherwise, all arguments passed to this method are checked.
Available since: 6.5.2
items : Object.../Object[]
The item(s) that must be in the collection.
true if the collection contains all the items.
Returns true if the collection contains the passed Object as a key.
Available since: 5.0.0
key : String
The key to look for in the collection.
True if the collection contains the Object as a key.
Determines the number of items in the collection.
Available since: 5.0.0
The number of items.
See count. The result is partitioned by group.
Available since: 5.0.0
The result of count, partitioned by group. See aggregateByGroup.
Creates a new collection that is a filtered subset of this collection. The filter
passed can be a function, a simple property name and value, an Ext.util.Filter
instance, an array of Ext.util.Filter instances.
If the passed filter is a function the second argument is its "scope" (or "this"
pointer). The function should return true given each item in the collection if
that item should be included in the filtered collection.
var people = new Ext.util.Collection();
people.add([
{ id: 1, age: 25, name: 'Ed' },
{ id: 2, age: 24, name: 'Tommy' },
{ id: 3, age: 24, name: 'Arne' },
{ id: 4, age: 26, name: 'Aaron' }
]);
// Create a collection of people who are older than 24:
var oldPeople = people.createFiltered(function (item) {
return item.age > 24;
});
If the passed filter is a Ext.util.Filter instance or array of Ext.util.Filter
instances the filter(s) are used to produce the filtered collection and there are
no further arguments.
If the passed filter is a string it is understood as the name of the property by
which to filter. The second argument is the "value" used to compare each item's
property value. This comparison can be further tuned with the anyMatch and
caseSensitive (optional) arguments.
// Create a new Collection containing only the items where age == 24
var middleAged = people.createFiltered('age', 24);
Alternatively you can apply filters to this Collection by calling setFilters
or modifying the filter collection returned by getFilters.
Available since: 5.0.0
property : Ext.util.Filter[]/String/Function
A property on your objects, an array of Ext.util.Filter objects or a filter function.
value : Object
If property is a function, this argument is the "scope"
(or "this" pointer) for the function. Otherwise this is either a RegExp to test
property values or the value with which to compare.
anyMatch : Boolean (optional)
True to match any part of the string, not just the beginning.
Defaults to: false
caseSensitive : Boolean (optional)
True for case sensitive comparison.
Defaults to: false
exactMatch : Boolean (optional)
true to force exact match (^ and $ characters
added to the regex).
Defaults to: false
The new, filtered collection.
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.
Returns the items array on which to operate. This is called to handle the two possible forms used by various methods that accept items:
collection.add(item1, item2, item3);
collection.add([ item1, item2, item3 ]);
Things get interesting when other arguments are involved:
collection.insert(index, item1, item2, item3);
collection.insert(index, [ item1, item2, item3 ]);
As well as below because we have to distinguish the one item from from the array:
collection.add(item);
collection.insert(index, item);
Available since: 5.0.0
args : Arguments
The arguments object from the caller.
index : Number
The index in args (the caller's arguments) of items.
The array of items on which to operate.
This method is an alias for decodeItems but is called when items are being
removed. If a decoder is provided it may be necessary to also override this
method to achieve symmetry between adding and removing items. This is the case
for Ext.util.FilterCollection' andExt.util.SorterCollection' for example.
Available since: 5.0.0
Destroys this collection. This is only necessary if this collection uses a source
collection as that relationship will keep a reference from the source to this
collection and potentially leak memory.
Available since: 5.0.0
Continue to fire event.
eventName : String
args : Array
bubbles : Boolean
Executes the specified function once for every item in the collection. If the value
returned by fn is false the iteration stops. In all cases, the last value that
fn returns is returned by this method.
Available since: 5.0.0
fn : Function
The function to execute for each item.
scope : Object (optional)
The scope (this reference) in which the function
is executed. Defaults to this collection.
Defaults to: this
Executes the specified function once for every key in the collection, passing each
key, and its associated item as the first two parameters. If the value returned by
fn is false the iteration stops. In all cases, the last value that fn returns
is returned by this method.
Available since: 5.0.0
fn : Function
The function to execute for each item.
scope : Object (optional)
The scope (this reference) in which the function
is executed. Defaults to this collection.
Defaults to: this
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.
This method is called after modifications are complete on a collection. For details
see beginUpdate.
Available since: 5.0.0
Finds the items with the minimum and maximum for the specified property over some or all of the items in this collection.
Available since: 5.0.0
property : String
The name of the property from each item.
begin : Number (optional)
The index of the first item to include.
end : Number (optional)
The index at which to stop in items. The item at this index
will not be included.
An array [minItem, maxItem] with the items that have the minimum
and maximum of the specified property.
See extremes. The result is partitioned by group.
Available since: 5.0.0
property : String
The name of the property from each item.
The result of extremes, partitioned by group. See aggregateByGroup.
Filter by a function. Returns a new collection that has been filtered. The passed function will be called with each object in the collection. If the function returns true, the value is included otherwise it is filtered.
fn : Function
The function to be called.
item : Mixed
The collection item.
key : String
The key of collection item.
scope : Object (optional)
The scope (this reference) in
which the function is executed. Defaults to this Collection.
The new filtered collection
Deprecated since version 5.0.0
This method is deprecated.
Finds the first matching object in this collection by a specific property/value.
Available since: 5.0.0
property : String
The name of a property on your objects.
value : String/RegExp
A string that the property values should start with or a RegExp to test against the property.
start : Number (optional)
The index to start searching at.
Defaults to: 0
startsWith : Boolean (optional)
Pass false to allow a match start anywhere in
the string. By default the value will match only at the start of the string.
Defaults to: true
endsWith : Boolean (optional)
Pass false to allow the match to end before the
end of the string. By default the value will match only at the end of the string.
Defaults to: true
ignoreCase : Boolean (optional)
Pass false to make the RegExp case
sensitive (removes the 'i' flag).
Defaults to: true
The first item in the collection which matches the criteria or
null if none was found.
Returns the first item in the collection which elicits a true return value from the passed selection function.
Available since: 5.0.0
fn : Function
The selection function to execute for each item.
scope : Object (optional)
The scope (this reference) in which the function
is executed. Defaults to this collection.
Defaults to: this
start : Number (optional)
The index at which to start searching.
Defaults to: 0
The first item in the collection which returned true from the selection function, or null if none was found.
Finds the index of the first matching object in this collection by a specific property/value.
Available since: 5.0.0
property : String
The name of a property on your objects.
value : String/RegExp
A string that the property values should start with or a RegExp to test against the property.
start : Number (optional)
The index to start searching at.
Defaults to: 0
startsWith : Boolean (optional)
Pass false to allow a match start anywhere in
the string. By default the value will match only at the start of the string.
Defaults to: true
endsWith : Boolean (optional)
Pass false to allow the match to end before the
end of the string. By default the value will match only at the end of the string.
Defaults to: true
ignoreCase : Boolean (optional)
Pass false to make the RegExp case
sensitive (removes the 'i' flag).
Defaults to: true
The matched index or -1 if not found.
Find the index of the first matching object in this collection by a function.
If the function returns true it is considered a match.
Available since: 5.0.0
fn : Function
The function to be called.
scope : Object (optional)
The scope (this reference) in which the function
is executed. Defaults to this collection.
Defaults to: this
start : Number (optional)
The index at which to start searching.
Defaults to: 0
The matched index or -1
Can be called to find the insertion index of a passed object in this collection. Or can be passed an items array to search in, and may be passed a comparator
item : Object
items : Object
comparatorFn : Object
index : Object
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.
Returns the first item in the collection.
Available since: 5.0.0
grouped : Boolean (optional)
true to extract the first item in each group. Only applies if
a grouper is active in the collection.
The first item in the collection. If the grouped parameter is passed, see aggregateByGroup for information on the return type.
Returns the item associated with the passed key.
Available since: 5.0.0
key : String/Number
The key of the item.
The item associated with the passed key.
Returns the item at the specified index.
Available since: 5.0.0
index : Number
The index of the item.
The item at the specified index.
Gets the bubbling parent for an Observable
The bubble parent. null is returned if no bubble target exists
Returns the item associated with the passed key.
Available since: 5.0.0
key : String/Number
The key of the item.
The item associated with the passed key.
Returns the number of items in the collection.
Available since: 5.0.0
the number of items in the collection.
Retrieves the id. This method Will auto-generate an id if one has not already
been configured.
id
Returns the map of key to index for all items in this collection. This method will lazily populate this map on request. This map is maintained when doing so does not involve too much overhead. When this threshold is cross, the index map is discarded and must be rebuilt by calling this method.
Available since: 5.0.0
A function which will be called, passing an object belonging to this collection. The function should return the key by which that object will be indexed. This key must be unique to this item as only one item with this key will be retained.
The default implementation looks basically like this (give or take special case handling of 0):
function getKey (item) {
return item.id || item._id || item.getId();
}
You can provide your own implementation by passing the keyFn config.
For example, to hold items that have a unique "name" property:
var elementCollection = new Ext.util.Collection({
keyFn: function (item) {
return item.name;
}
});
The collection can have extraKeys if items need to be quickly looked up by other
(potentially non-unique) properties.
Available since: 5.0.0
item : Object
The item.
The key for the passed item.
Returns a range of items in this collection
Available since: 5.0.0
begin : Number (optional)
The index of the first item to get.
Defaults to: 0
end : Number (optional)
The ending index. The item at this index is not included.
An array of items
Returns an array of values for the specified (sub) property.
For example, to get an array of "name" properties from a collection of records (of
Ext.data.Model objects):
var names = collection.getValues('name', 'data');
Available since: 5.0.0
property : String
The property to collect on
root : String (optional)
'root' property to extract the first argument from. This is used mainly when operating on fields in records, where the fields are all stored inside the 'data' object.
start : Number (optional)
The index of the first item to include.
Defaults to: 0
end : Number (optional)
The index at which to stop getting values. The value of this item is not included.
The array of values.
Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.
eventName : String
The name of the event to check for
true if the event is being listened for or bubbles, else false
Returns index within the collection of the passed Object.
Available since: 5.0.0
item : Object
The item to find.
The index of the item or -1 if not found.
Returns index within the collection of the passed key.
Available since: 5.0.0
key : Object
The key to find.
The index of the item or -1 if not found.
Inserts one or more items to the collection. The index value is the position at
which the first item will be placed. The items starting at that position will be
shifted to make room.
Available since: 5.0.0
index : Number
The index at which to insert the item(s).
item : Object/Object[]
The item or items to add.
The item or items added.
This method can be used to conveniently test whether an individual item would be removed due to the current filter.
item : Object
The item to test.
The value true if the item would be "removed" from the
collection due to filters or false otherwise.
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
This method should be called when an item in this collection has been modified. If
the collection is sorted or filtered the result of modifying an item needs to be
reflected in the collection. If the item's key is also being modified, it is best
to pass the oldKey to this same call rather than call updateKey separately.
Available since: 5.0.0
item : Object
The item that was modified.
modified : String[] (optional)
The names of the modified properties of the item.
oldKey : String/Number (optional)
Passed if the item's key was also modified.
Returns the last item in the collection.
Available since: 5.0.0
grouped : Boolean (optional)
true to extract the first item in each group. Only applies if
a grouper is active in the collection.
The last item in the collection. If the grouped parameter is passed, see aggregateByGroup for information on the return type.
Determines the maximum value for the specified property over some or all of the items in this collection.
Available since: 5.0.0
property : String
The name of the property from each item.
begin : Number (optional)
The index of the first item to include in the maximum.
end : Number (optional)
The index at which to stop in items. The item at this index
will not be included in the maximum.
The maximum of the specified property from the indicated items.
See max. The result is partitioned by group.
Available since: 5.0.0
property : String
The name of the property from each item.
The result of max, partitioned by group. See aggregateByGroup.
Finds the item with the maximum value for the specified property over some or all of the items in this collection.
Available since: 5.0.0
property : String
The name of the property from each item.
begin : Number (optional)
The index of the first item to include in the maximum.
end : Number (optional)
The index at which to stop in items. The item at this index
will not be included in the maximum.
The item with the maximum of the specified property from the indicated items.
See maxItem. The result is partitioned by group.
Available since: 5.0.0
property : String
The name of the property from each item.
The result of maxItem, partitioned by group. See aggregateByGroup.
Determines the minimum value for the specified property over some or all of the items in this collection.
Available since: 5.0.0
property : String
The name of the property from each item.
begin : Number (optional)
The index of the first item to include in the minimum.
end : Number (optional)
The index at which to stop in items. The item at this index
will not be included in the minimum.
The minimum of the specified property from the indicated items.
See min. The result is partitioned by group.
Available since: 5.0.0
property : String
The name of the property from each item.
The result of min, partitioned by group. See aggregateByGroup.
Finds the item with the minimum value for the specified property over some or all of the items in this collection.
Available since: 5.0.0
property : String
The name of the property from each item.
begin : Number (optional)
The index of the first item to include in the minimum.
end : Number (optional)
The index at which to stop in items. The item at this index
will not be included in the minimum.
The item with the minimum of the specified property from the indicated items.
See minItem. The result is partitioned by group.
Available since: 5.0.0
property : String
The name of the property from each item.
The result of minItem, partitioned by group. See aggregateByGroup.
Shorthand for addManagedListener. The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.
Example:
Ext.define('Foo', {
extend: 'Ext.Component',
initComponent: function () {
this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
this.callParent();
}
});
As you can see, when an instance of Foo is destroyed, it ensures that the 'show'
listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.
As of version 5.1 it is no longer necessary to use this method in most cases because
listeners are automatically managed if the scope object provided to
addListener is an Observable instance.
However, if the observable instance and scope are not the same object you
still need to use mon or addManagedListener if you want the listener to be
managed.
item : Ext.util.Observable/Ext.dom.Element
The item to which to add a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function/String (optional)
If the ename parameter was an event
name, this is the handler function or the name of a method on the specified
scope.
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)
in which the handler function is executed.
options : Object (optional)
If the ename parameter was an event name, this is the
addListener options.
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:
this.btnListeners = myButton.mon({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
Shorthand for removeManagedListener. Removes listeners that were added by the mon method.
item : Ext.util.Observable/Ext.dom.Element
The item from which to remove a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)
in which the handler function is executed.
This method wraps all fired events and gives observers first view of the change.
Available since: 5.0.0
eventName : String
The name of the event to fire.
args : Array (optional)
The event arguments. This collection instance is inserted at the front of this array if there is any receiver for the notification.
The on method is shorthand for addListener.
Appends an event handler to this object. For example:
myGridPanel.on("itemclick", this.onItemClick, this);
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
myGridPanel.on({
cellclick: this.onCellClick,
select: this.onSelect,
viewready: this.onViewReady,
scope: this // Important. Ensure "this" is correct during handler execution
});
One can also specify options for each event handler separately:
myGridPanel.on({
cellclick: {fn: this.onCellClick, scope: this, single: true},
viewready: {fn: panel.onViewReady, scope: panel}
});
Names of methods in a specified scope may also be used:
myGridPanel.on({
cellclick: {fn: 'onCellClick', scope: this, single: true},
viewready: {fn: 'onViewReady', scope: panel}
});
eventName : String/Object
The name of the event to listen for. May also be an object who's property names are event names.
fn : Function/String (optional)
The method the event invokes or the name of
the method within the specified scope. Will be called with arguments
given to Ext.util.Observable#fireEvent plus the options parameter described
below.
scope : Object (optional)
The scope (this reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
options : Object (optional)
An object containing handler configuration.
Note: The options object will also be passed as the last argument to every event handler.
This object may contain any of the following properties:
scope : Object
The scope (this reference) in which the handler function is executed. If omitted,
defaults to the object which fired the event.
delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
onFrame : Number
Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.
target : Ext.util.Observable
Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
element : String
This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.
This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.
For example, to add a click listener to a Panel's body:
var panel = new Ext.panel.Panel({
title: 'The title',
listeners: {
click: this.handlePanelClick,
element: 'body'
}
});
In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.
panel.body.un(...)
delegate : String (optional)
A simple selector to filter the event target or look for a descendant of the target.
The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).
See the delegate example below.
capture : Boolean (optional)
When set to true, the listener is fired in the capture phase of the event propagation
sequence, instead of the default bubble phase.
The capture option is only available on Ext.dom.Element instances (or
when attaching a listener to a Ext.dom.Element via a Component using the
element option).
stopPropagation : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopPropagation on the event object
before firing the handler.
preventDefault : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call preventDefault on the event object
before firing the handler.
stopEvent : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopEvent on the event object
before firing the handler.
args : Array (optional)
Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.
destroyable : Boolean (optional)
When specified as true, the function returns a destroyable object. An object
which implements the destroy method which removes all listeners added in this call.
This syntax can be a helpful shortcut to using un; particularly when
removing multiple listeners. NOTE - not compatible when using the element
option. See un for the proper syntax for removing listeners added using the
element config.
Defaults to:
false
priority : Number (optional)
An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.
order : String (optional)
A legacy option that is provided for backward compatibility.
It is recommended to use the priority option instead. Available options are:
'before': equal to a priority of 100'current': equal to a priority of 0 or default priority'after': equal to a priority of -100Defaults to:
'current'
order : String (optional)
A shortcut for the order event option. Provided for backward compatibility.
Please use the priority event option instead.
Combining Options
Using the options argument, it is possible to combine different types of listeners:
A delayed, one-time listener.
myPanel.on('hide', this.handleClick, this, {
single: true,
delay: 100
});
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.
grid.on({
itemclick: 'onItemClick',
itemcontextmenu: grid.onItemContextmenu,
destroy: {
fn: function () {
// function called within the 'altCmp' scope instead of grid
},
scope: altCmp // unique scope for the destroy handler
},
scope: grid // default scope - provided for example clarity
});
Delegate
This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:
var panel = Ext.create({
xtype: 'panel',
renderTo: document.body,
title: 'Delegate Handler Example',
frame: true,
height: 220,
width: 220,
html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});
// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
click: function (e) {
console.log(e.getTarget().innerHTML);
},
element: 'body',
delegate: 'h1.myTitle'
});
Defaults to: 'current'
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes
all listeners added in this call. For example:
this.btnListeners = = myButton.on({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
Appends an after-event handler.
Same as addListener with order set
to 'after'.
eventName : String/String[]/Object
The name of the event to listen for.
fn : Function/String
The method the event invokes.
scope : Object (optional)
The scope for fn.
options : Object (optional)
An object containing handler configuration.
Appends a before-event handler. Returning false from the handler will stop the event.
Same as addListener with order set
to 'before'.
eventName : String/String[]/Object
The name of the event to listen for.
fn : Function/String
The method the event invokes.
scope : Object (optional)
The scope for fn.
options : Object (optional)
An object containing handler configuration.
This method is called when items are added to the source collection. This is
equivalent to the add event but is called before the add
event is fired.
Available since: 5.0.0
source : Ext.util.Collection
The source collection.
details : Object
The details of the add event.
This method is called when an item is modified in the source collection. This is
equivalent to the beforeitemchange event but is
called before the beforeitemchange event is fired.
Available since: 5.0.0
source : Ext.util.Collection
The source collection.
details : Object
The details of the
beforeitemchange event.
This method is called when the source collection starts updating. This is
equivalent to the beginupdate event but is called
before the beginupdate event is fired.
Available since: 5.0.0
source : Ext.util.Collection
The source collection.
This method is called when the source collection finishes updating. This is
equivalent to the endupdate event but is called before
the endupdate event is fired.
Available since: 5.0.0
source : Ext.util.Collection
The source collection.
This method is called when an item is modified in the source collection. This is
equivalent to the itemchange event but is called before
the itemchange event is fired.
Available since: 5.0.0
source : Ext.util.Collection
The source collection.
details : Object
The details of the itemchange
event.
This method is called when the source collection refreshes. This is equivalent to
the refresh event but is called before the refresh event
is fired.
Available since: 5.0.0
source : Ext.util.Collection
The source collection.
This method is called when items are removed from the source collection. This is
equivalent to the remove event but is called before the
remove event is fired.
Available since: 5.0.0
source : Ext.util.Collection
The source collection.
details : Object
The details of the remove event.
This method is called when the source collection is sorted. This is equivalent to
the sort event but is called before the sort event is fired.
Available since: 5.0.0
source : Ext.util.Collection
The source collection.
This method is called when key changes in the source collection. This is
equivalent to the updatekey event but is called before the updatekey event is
fired.
Available since: 5.0.0
source : Ext.util.Collection
The source collection.
details : Object
The details of the updatekey event.
Called after a change of the filter is complete.
For example:
onFilterChange: function (filters) {
if (this.filtered) {
// process filters
} else {
// no filters present
}
}
filters : Ext.util.FilterCollection
The filters collection.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Called after a change of the sort is complete.
For example:
onSortChange: function (sorters) {
if (this.sorted) {
// process sorters
} else {
// no sorters present
}
}
sorters : Ext.util.SorterCollection
The sorters collection.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
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();
Remove an item from the collection.
Available since: 5.0.0
item : Object/Object[]
The item or items to remove.
The number of items removed.
Remove all items in the collection.
Available since: 5.0.0
This object.
Remove an item from a specified index in the collection.
Available since: 5.0.0
index : Number
The index within the collection of the item to remove.
count : Number (optional)
The number of items to remove.
Defaults to: 1
If count was 1 and the item was removed, that item is
returned. Otherwise the number of items removed is returned.
Removes the item associated with the passed key from the collection.
Available since: 5.0.0
key : String
The key of the item to remove.
Only returned if removing at a specified key. The item removed or
false if no item was removed.
Removes an event handler.
eventName : String
The type of event the handler was associated with.
fn : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.
Removes listeners that were added by the mon method.
item : Ext.util.Observable/Ext.dom.Element
The item from which to remove a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the ename parameter was an event name, this is
the handler function.
scope : Object (optional)
If the ename parameter was an event name, this is
the scope (this reference) in which the handler function is executed.
Remove a single managed listener item
isClear : Boolean
True if this is being called during a clear
managedListener : Object
The managed listener item
item : Object
ename : String
fn : Function
scope : Object
See removeManagedListener for other args
Removes an observing object to this collection. See addObserver for details.
Available since: 5.0.0
observer : Ext.util.Collection
The observer instance.
Replace an old entry with a new entry of the same key if the entry existed.
item : Object
The item to insert.
inserted The item inserted.
Adds an item to the collection while removing any existing items. Similar to method-add.
Available since: 5.0.0
item : Object/Object[]
The item or items to add.
The item or items added.
Gets the default scope for firing late bound events (string names with no scope attached) at runtime.
defaultScope : Object (optional)
The default scope to return if none is found.
Defaults to: this
The default event scope
Resumes firing of the named event(s).
After calling this method to resume events, the events will fire when requested to fire.
Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.
eventName : String...
Multiple event names to resume.
Resumes firing events (see suspendEvents).
If events were suspended using the queueSuspended parameter, then all events fired
during event suspension will be sent to any listeners now.
discardQueue : Boolean (optional)
true to prevent any previously queued events from firing
while we were suspended. See suspendEvents.
Updates the sorters collection and triggers sorting of this Sortable.
For example:
//sort by a single field
myStore.sort('myField', 'DESC');
//sorting by multiple fields
myStore.sort([{
property : 'age',
direction: 'ASC'
}, {
property : 'name',
direction: 'DESC'
}]);
When passing a single string argument to sort, the direction is maintained for
each field and is toggled automatically. So this code:
store.sort('myField');
store.sort('myField');
Is equivalent to the following:
store.sort('myField', 'ASC');
store.sort('myField', 'DESC');
property : String/Function/Ext.util.Sorter[] (optional)
Either the name of a property
(such as a field of a Ext.data.Model in a Store), an array of configurations
for Ext.util.Sorter instances or just a comparison function.
direction : String (optional)
The direction by which to sort the data. This parameter
is only valid when property is a String, otherwise the second parameter is the
mode.
mode : String (optional)
Where to put new sorters in the collection. This should be one the following values:
replace : The new sorter(s) become the sole sorter set for this Sortable.
This is the most useful call mode to programmatically sort by multiple fields.
prepend : The new sorters are inserted as the primary sorters. The sorter
collection length must be controlled by the developer.
multi : Similar to prepend the new sorters are inserted at the front
of the collection of sorters. Following the insertion, however, this mode trims
the sorter collection to enforce the multiSortLimit config. This is useful for
implementing intuitive "Sort by this" user interfaces.
append : The new sorters are added at the end of the collection.
Defaults to: "replace"
This instance.
Sorts the collection by a single sorter function
sortFn : Function
The function to sort by
Deprecated since version 6.5.0
This method is deprecated.
This method will sort an array based on the currently configured sorters.
data : Array
The array you want to have sorted.
The array you passed after it is sorted.
Sorts the items of the collection using the supplied function. This should only be
called for collections that have no sorters defined.
Available since: 5.0.0
sortFn : Function
The function by which to sort the items.
This method is basically the same as the JavaScript Array splice method.
Negative indexes are interpreted starting at the end of the collection. That is,
a value of -1 indicates the last item, or equivalent to length - 1.
Available since: 5.0.0
index : Number
The index at which to add or remove items.
toRemove : Number/Object[]
The number of items to remove or an array of the items to remove.
toAdd : Object[] (optional)
The items to insert at the given index.
This method is what you might find in the core of a merge sort. We have an items array that is sorted so we sort the newItems and merge the two sorted arrays. In the general case, newItems will be no larger than all items so sorting it will be faster than simply concatenating the arrays and calling sort on it.
We take advantage of the nature of this process to generate add events as ranges.
Available since: 5.0.0
newItems : Object[]
newKeys : Object[]
Sums property values from some or all of the items in this collection.
Available since: 5.0.0
property : String
The name of the property to sum from each item.
begin : Number (optional)
The index of the first item to include in the sum.
end : Number (optional)
The index at which to stop summing items. The item at this
index will not be included in the sum.
The result of summing the specified property from the indicated items.
See sum. The result is partitioned by group.
Available since: 5.0.0
property : String
The name of the property to sum from each item.
The result of sum, partitioned by group. See aggregateByGroup.
Suspends firing of the named event(s).
After calling this method to suspend events, the events will no longer fire when requested to fire.
Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.
eventName : String...
Multiple event names to suspend.
Suspends the firing of all events. (see resumeEvents)
queueSuspended : Boolean
true to queue up suspended events to be fired
after the resumeEvents call instead of discarding all suspended events.
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.
This method calls the supplied function fn between beginUpdate and endUpdate
calls.
collection.update(function () {
// Perform multiple collection updates...
collection.add(item);
// ...
collection.insert(index, otherItem);
//...
collection.remove(someItem);
});
Available since: 5.0.0
fn : Function
The function to call that will modify this collection.
collection : Ext.util.Collection
This collection.
scope : Object (optional)
The this pointer to use when calling fn.
Defaults to: this
Returns the value returned from fn (typically undefined).
Change the key for an existing item in the collection. If the old key does not
exist this call does nothing. Even so, it is highly recommended to avoid calling
this method for an item that is not a member of this collection.
Available since: 5.0.0
item : Object
The item whose key has changed. The item should be a member
of this collection.
oldKey : String
The old key for the item.
details : Object
Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
Direct use of this method should be rare. Use Ext.define instead:
Ext.define('My.CatOverride', {
override: 'My.Cat',
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).
members : Object
The properties to add to this class. This should be specified as an object literal containing one or more properties.
this class
Fires after items have been added to the collection.
All add and remove events occur between
beginupdate and endupdate
events so it is best to do only the minimal amount of work in response to these
events and move the more expensive side-effects to an endupdate listener.
Available since: 5.0.0
collection : Ext.util.Collection
The collection being modified.
details : Object
An object describing the addition.
at : Number
The index in the collection where the add occurred.
atItem : Object
The item after which the new items were inserted or
null if at the beginning of the collection.
items : Object[]
The items that are now added to the collection.
keys : Array (optional)
next : Object (optional)
If more add events are in queue
to be delivered this is a reference to the details instance for the next
add event. This will only be the case when the collection is
sorted as the new items often need to be inserted at multiple locations to maintain
the sort. In this case, all of the new items have already been added not just those
described by the first add event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires before an item change is reflected in the collection. This event
is always followed by an itemchange event and, depending on the change, possibly
an add, remove and/or updatekey event.
Available since: 5.0.0
collection : Ext.util.Collection
The collection being modified.
details : Object
An object describing the change.
item : Object
The item that has changed.
key : String
The key of the item that has changed.
filterChanged : Boolean
This is true if the filter status of the
item has changed. That is, the item was previously filtered out and is no longer
or the opposite.
group : Ext.util.Group
The group containing the item. (since 6.5.1)
groupChanged : Boolean
This is true if the item is moving between
groups. See also the group and oldGroup properties. (since 6.5.1)
keyChanged : Boolean
This is true if the item has changed keys. If
so, check oldKey for the old key. An updatekey event will follow.
indexChanged : Boolean
This is true if the item needs to move to
a new index in the collection due to sorting. The index can be seen in index.
The old index is in oldIndex.
modified : String[] (optional)
If known this property holds the array of names of the modified properties of the item.
filtered : Boolean (optional)
This value is true if the item will be filtered
out of the collection.
index : Number (optional)
The new index in the collection for the item if
the item is being moved (see indexChanged). If the item is being removed due to
filtering, this will be -1.
oldGroup : Ext.util.Group
The group that previously contained the
item. (since 6.5.1)
oldIndex : Number (optional)
The old index in the collection for the item if
the item is being moved (see indexChanged). If the item was being removed due to
filtering, this will be -1.
oldKey : Object (optional)
The old key for the item if the item's key has
changed (see keyChanged).
wasFiltered : Boolean (optional)
This value is true if the item was filtered
out of the collection.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires before the contents of the collection have been sorted.
collection : Ext.util.Collection
The collection being sorted.
sorters : Ext.util.Sorter[]
Array of sorters applied to the Collection.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired before changes are made to the collection. This event fires when the
beginUpdate method is called and the counter it manages transitions from 0 to 1.
All add and remove events occur between
beginupdate and endupdate
events so it is best to do only the minimal amount of work in response to these
events and move the more expensive side-effects to an endupdate listener.
Available since: 5.0.0
collection : Ext.util.Collection
The collection being modified.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired after changes are made to the collection. This event fires when the endUpdate
method is called and the counter it manages transitions from 1 to 0.
All add and remove events occur between
beginupdate and endupdate
events so it is best to do only the minimal amount of work in response to these
events and move the more expensive side-effects to an endupdate listener.
Available since: 5.0.0
collection : Ext.util.Collection
The collection being modified.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires after an item change is reflected in the collection. This event
always follows a beforeitemchange event and its corresponding add, remove
and/or updatekey events.
Available since: 5.0.0
collection : Ext.util.Collection
The collection being modified.
details : Object
An object describing the change.
item : Object
The item that has changed.
key : String
The key of the item that has changed.
filterChanged : Boolean
This is true if the filter status of the
item has changed. That is, the item was previously filtered out and is no longer
or the opposite.
group : Ext.util.Group
The group containing the item. (since 6.5.1)
groupChanged : Boolean
This is true if the item is moving between
groups. See also the group and oldGroup properties. (since 6.5.1)
keyChanged : Object
This is true if the item has changed keys. If
so, check oldKey for the old key. An updatekey event will have been sent.
indexChanged : Boolean
This is true if the item was moved to a
new index in the collection due to sorting. The index can be seen in index.
The old index is in oldIndex.
modified : String[] (optional)
If known this property holds the array of names of the modified properties of the item.
filtered : Boolean (optional)
This value is true if the item is filtered
out of the collection.
index : Number (optional)
The new index in the collection for the item if
the item has been moved (see indexChanged). If the item is removed due to
filtering, this will be -1.
oldGroup : Ext.util.Group
The group that previously contained the
item. (since 6.5.1)
oldIndex : Number (optional)
The old index in the collection for the item if
the item has been moved (see indexChanged). If the item was being removed due to
filtering, this will be -1.
oldKey : Object (optional)
The old key for the item if the item's key has
changed (see keyChanged).
wasFiltered : Boolean (optional)
This value is true if the item was filtered
out of the collection.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires when the collection has changed entirely. This event is fired in cases where the collection's filter is updated or the items are sorted. While the items previously in the collection may remain the same, the order at a minimum has changed in ways that cannot be simply translated to other events.
collection : Ext.util.Collection
The collection being modified.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires after items have been removed from the collection. Some properties of this object may not be present if calculating them is deemed too expensive. These are marked as "optional".
All add and remove events occur between
beginupdate and endupdate
events so it is best to do only the minimal amount of work in response to these
events and move the more expensive side-effects to an endupdate listener.
Available since: 5.0.0
collection : Ext.util.Collection
The collection being modified.
details : Object
An object describing the removal.
at : Number
The index in the collection where the removal occurred.
items : Object[]
The items that are now removed from the collection.
keys : Array (optional)
map : Object (optional)
If available this is a map keyed by the key of each
item in the items array. This will often contain all of the items being removed
and not just the items in the range described by this event. The value held in this
map is the item.
next : Object (optional)
If more remove events are in
queue to be delivered this is a reference to the details instance for the next
remove event.
replacement : Object (optional)
If this removal has a corresponding
add taking place this reference holds the details object for
that add event. If the collection is sorted, the new items are pre-sorted but the
at property for the replacement will not be correct. The new items will be
added in one or more chunks at their proper index.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
This event fires after the contents of the collection have been sorted.
collection : Ext.util.Collection
The collection being sorted.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires after the key for an item has changed.
Available since: 5.0.0
collection : Ext.util.Collection
The collection being modified.
details : Object
An object describing the update.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
ExtReact | Terms of Use