Observable MixedCollection
Package: | Ext.util |
Defined In: | MixedCollection.js |
Class: | MixedCollection |
Subclasses: | StoreMgr |
Extends: | Observable |
Config Options | Defined By | |
---|---|---|
listeners : Object A config object containing one or more event handlers to be added to this object during initialization. This should b...
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.
|
Observable |
Method | Defined By | |
---|---|---|
MixedCollection( Boolean allowFunctions , Function keyFn )
Parameters:
|
MixedCollection | |
add( String key , Object o ) : Object
|
MixedCollection | |
addAll( Object/Array objs ) : void Adds all elements of an Array or an Object to the collection.
Adds all elements of an Array or an Object to the collection.
Parameters:
|
MixedCollection | |
addEvents( Object object ) : void Used to define events on this Observable
Used to define events on this Observable
Parameters:
|
Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this component
Appends an event handler to this component
Parameters:
|
Observable | |
clear() : void | MixedCollection | |
clone() : MixedCollection Creates a duplicate of this collection
Creates a duplicate of this collection
Parameters:
|
MixedCollection | |
contains( Object o ) : Boolean Returns true if the collection contains the passed Object as an item.
Returns true if the collection contains the passed Object as an item.
Parameters:
|
MixedCollection | |
containsKey( String key ) : Boolean Returns true if the collection contains the passed Object as a key.
Returns true if the collection contains the passed Object as a key.
Parameters:
|
MixedCollection | |
each( Function fn , [Object scope ] ) : void Executes the specified function once for every item in the collection, passing the following arguments:
item : Mixed...
Executes the specified function once for every item in the collection, passing the following arguments:
Parameters:
|
MixedCollection | |
eachKey( Function fn , [Object scope ] ) : void Executes the specified function once for every key in the collection, passing each
key, and its associated item as th...
Executes the specified function once for every key in the collection, passing each
key, and its associated item as the first two parameters.
Parameters:
|
MixedCollection | |
filter( String property , String/RegExp value , [Boolean anyMatch ], [Boolean caseSensitive ] ) : MixedCollection Filter the objects in this collection by a specific property.
Returns a new collection that has been filtered.
Filter the objects in this collection by a specific property.
Returns a new collection that has been filtered.
Parameters:
|
MixedCollection | |
filterBy( Function fn , [Object scope ] ) : MixedCollection Filter by a function. Returns a new collection that has been filtered.
The passed function will be called with each o...
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.
Parameters:
|
MixedCollection | |
find( Function fn , [Object scope ] ) : Object Returns the first item in the collection which elicits a true return value from the
passed selection function.
Returns the first item in the collection which elicits a true return value from the
passed selection function.
Parameters:
|
MixedCollection | |
findIndex( String property , String/RegExp value , [Number start ], [Boolean anyMatch ], [Boolean caseSensitive ] ) : Number Finds the index of the first matching object in this collection by a specific property/value.
Returns a new collectio...
Finds the index of the first matching object in this collection by a specific property/value.
Returns a new collection that has been filtered.
Parameters:
|
MixedCollection | |
findIndexBy( Function fn , [Object scope ], [Number start ] ) : Number Find the index of the first matching object in this collection by a function.
If the function returns true it is cons...
Find the index of the first matching object in this collection by a function.
If the function returns true it is considered a match.
Parameters:
|
MixedCollection | |
fireEvent( String eventName , Object... args ) : Boolean Fires the specified event with the passed parameters (minus the event name).
Fires the specified event with the passed parameters (minus the event name).
Parameters:
|
Observable | |
first() : Object Returns the first item in the collection.
Returns the first item in the collection.
Parameters:
|
MixedCollection | |
get( String/Number key ) : Object Returns the item associated with the passed key or index.
Returns the item associated with the passed key or index.
Parameters:
|
MixedCollection | |
getCount() : Number Returns the number of items in the collection.
Returns the number of items in the collection.
Parameters:
|
MixedCollection | |
getKey( Object item ) : Object MixedCollection has a generic way to fetch keys if you implement getKey. The default implementation
simply returns i...
MixedCollection has a generic way to fetch keys if you implement getKey. The default implementation
simply returns item.id but you can provide your own implementation
to return a different value as in the following examples:
Parameters:
|
MixedCollection | |
getRange( [Number startIndex ], [Number endIndex ] ) : Array Returns a range of items in this collection
Returns a range of items in this collection
Parameters:
|
MixedCollection | |
hasListener( String eventName ) : Boolean Checks to see if this object has any listeners for a specified event
Checks to see if this object has any listeners for a specified event
Parameters:
|
Observable | |
indexOf( Object o ) : Number Returns index within the collection of the passed Object.
Returns index within the collection of the passed Object.
Parameters:
|
MixedCollection | |
indexOfKey( String key ) : Number Returns index within the collection of the passed key.
Returns index within the collection of the passed key.
Parameters:
|
MixedCollection | |
insert( Number index , String key , [Object o ] ) : Object Inserts an item at the specified index in the collection. Fires the add event when complete.
Inserts an item at the specified index in the collection. Fires the add event when complete.
Parameters:
|
MixedCollection | |
item( String/Number key ) : Object Returns the item associated with the passed key OR index. Key has priority over index. This is the equivalent
of cal...
|
MixedCollection | |
itemAt( Number index ) : Object Returns the item at the specified index.
Returns the item at the specified index.
Parameters:
|
MixedCollection | |
key( String/Number key ) : Object Returns the item associated with the passed key.
Returns the item associated with the passed key.
Parameters:
|
MixedCollection | |
keySort( [String direction ], [Function fn ] ) : void Sorts this collection by keys
Sorts this collection by keys
Parameters:
|
MixedCollection | |
last() : Object Returns the last item in the collection.
Returns the last item in the collection.
Parameters:
|
MixedCollection | |
on( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this element (shorthand for addListener)
Appends an event handler to this element (shorthand for addListener)
Parameters:
|
Observable | |
purgeListeners() : void Removes all listeners for this object
Removes all listeners for this object
Parameters:
|
Observable | |
remove( Object o ) : Object Removed an item from the collection.
Removed an item from the collection.
Parameters:
|
MixedCollection | |
removeAt( Number index ) : Object Remove an item from a specified index in the collection. Fires the remove event when complete.
Remove an item from a specified index in the collection. Fires the remove event when complete.
Parameters:
|
MixedCollection | |
removeKey( String key ) : Object Removed an item associated with the passed key fom the collection.
Removed an item associated with the passed key fom the collection.
Parameters:
|
MixedCollection | |
removeListener( String eventName , Function handler , [Object scope ] ) : void Removes a listener
Removes a listener
Parameters:
|
Observable | |
replace( String key , [o {Object} ] ) : Object Replaces an item in the collection. Fires the replace event when complete.
Replaces an item in the collection. Fires the replace event when complete.
Parameters:
|
MixedCollection | |
resumeEvents() : void Resume firing events. (see suspendEvents)
Resume firing events. (see suspendEvents)
Parameters:
|
Observable | |
sort( [String direction ], [Function fn ] ) : void Sorts this collection with the passed comparison function
Sorts this collection with the passed comparison function
Parameters:
|
MixedCollection | |
suspendEvents() : void Suspend the firing of all events. (see resumeEvents)
Suspend the firing of all events. (see resumeEvents)
Parameters:
|
Observable | |
un( String eventName , Function handler , [Object scope ] ) : void Removes a listener (shorthand for removeListener)
Removes a listener (shorthand for removeListener)
Parameters:
|
Observable |