Roo.util.Observable
Roo.util.MixedCollection

Class Roo.util.MixedCollection

Package:	Roo.util
Defined In:	Roo/util/MixedCollection.js.
Class:	MixedCollection
Extends:	Roo.util.Observable

A Collection class that maintains both numeric indexes and keys and exposes events.

Class Comments / Notes => [Add Your comment/notes about this class]

Config Options (Usually are also Properties)
Options		Defined By
	listeners : Object list of events and functions to call for this object, For example : `listeners : { 'click' : function(e) { .` `list of events and functions to call for this object, For example : listeners : { 'click' : function(e) { ..... } , .... }`	Roo.util.Observable

Public Methods
Method		Defined By
	new Roo.util.MixedCollection (Boolean *allowFunctions, Function keyFn) Create a new Roo.util.MixedCollection Create a new Roo.util.MixedCollection Parameters: Boolean allowFunctions* True if the addAll function should add function references to the collection (defaults to false) Function keyFn A function that can accept an item of the type(s) stored in this MixedCollection and return the key value for that item. This is used when available to look up the key on items that were passed without an explicit key parameter to a MixedCollection method. Passing this parameter is equivalent to providing an implementation for the {link getKey} method.
	add (String *key, Object o) : Object Adds an item to the collection. Adds an item to the collection. Parameters: String key* The key to associate with the item Object o The item to add. Returns: Object The item added.	Roo.util.MixedCollection
	addAll (Object/Array *objs) 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: Object/Array objs* An Object containing properties which will be added to the collection, or an Array of values, each of which are added to the collection.	Roo.util.MixedCollection
	addEvents (Object *object) Used to define events on this Observable Used to define events on this Observable Parameters: Object object* The object with the events defined	Roo.util.Observable
	addListener (String *eventName, Function handler, Object scope, Object options) Appends an event handler to this component Appends an event handler to this component Parameters: String eventName* The type of event to listen for Function handler The method the event invokes Object scope (optional) The scope in which to execute the handler function. The handler function's "this" context. Object options (optional) An object containing handler configuration properties. This may contain any of the following properties: scope {Object} The scope in which to execute the handler function. The handler function's "this" context. delay {Number} The number of milliseconds to delay the invocation of the handler after te 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 {link Roo.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. Combining Options Using the options argument, it is possible to combine different types of listeners: A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId) `el.on('click', this.onClick, this, { single: true, delay: 100, forumId: 4 });` 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. `el.on({ 'click': { fn: this.onClick, scope: this, delay: 100 }, 'mouseover': { fn: this.onMouseOver, scope: this }, 'mouseout': { fn: this.onMouseOut, scope: this } });` Or a shorthand syntax which passes the same scope object to all handlers: `el.on({ 'click': this.onClick, 'mouseover': this.onMouseOver, 'mouseout': this.onMouseOut, scope: this });`	Roo.util.Observable
	clear () Removes all items from the collection. Removes all items from the collection.	Roo.util.MixedCollection
	clone () : MixedCollection Creates a duplicate of this collection Creates a duplicate of this collection Returns: MixedCollection	Roo.util.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: Object o The Object to look for in the collection. Returns: Boolean True if the collection contains the Object as an item.	Roo.util.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: String key* The key to look for in the collection. Returns: Boolean True if the collection contains the Object as a key.	Roo.util.MixedCollection
	each (Function fn, Object *scope) Executes the specified function once for every item in the collection, passing each item as the first and only parameter. Executes the specified function once for every item in the collection, passing each item as the first and only parameter. returning false from the function will stop the iteration. Parameters: Function fn The function to execute for each item. Object scope* (optional) The scope in which to execute the function.	Roo.util.MixedCollection
	eachKey (Function fn, Object *scope) Executes the specified function once for every key in the collection, passing each key, and its associated item as the first two parameters. Executes the specified function once for every key in the collection, passing each key, and its associated item as the first two parameters. Parameters: Function fn The function to execute for each item. Object scope* (optional) The scope in which to execute the function.	Roo.util.MixedCollection
	filter (String *property, String/RegExp value) : MixedCollection Filter the objects* in this collection by a specific property. Filter the objects in this collection by a specific property. Returns a new collection that has been filtered. Parameters: String property A property on your objects String/RegExp value Either string that the property values should start with or a RegExp to test against the property Returns: MixedCollection The new filtered collection	Roo.util.MixedCollection
	filterBy (Function fn, Object *scope) : MixedCollection Filter by a function. 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: Function fn The function to be called, it will receive the args o (the object), k (the key) Object scope (optional) The scope of the function (defaults to this) Returns: MixedCollection The new filtered collection	Roo.util.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: Function fn The selection function to execute for each item. Object scope* (optional) The scope in which to execute the function. Returns: Object The first item in the collection which returned true from the selection function.	Roo.util.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: String eventName* Object... args Variable number of parameters are passed to handlers Returns: Boolean returns false if any of the handlers return false otherwise it returns true	Roo.util.Observable
	first () : Object Returns the first item in the collection. Returns the first item in the collection. Returns: Object the first item in the collection..	Roo.util.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: String/Number key* The key or index of the item. Returns: Object The item associated with the passed key.	Roo.util.MixedCollection
	getCount () : Number Returns the number of items in the collection. Returns the number of items in the collection. Returns: Number the number of items in the collection.	Roo.util.MixedCollection
	getKey (o) : Object MixedCollection has a generic way to fetch keys if you implement getKey. MixedCollection has a generic way to fetch keys if you implement getKey. `// normal way var mc = new Roo.util.MixedCollection(); mc.add(someEl.dom.id, someEl); mc.add(otherEl.dom.id, otherEl); //and so on // using getKey var mc = new Roo.util.MixedCollection(); mc.getKey = function(el){ return el.dom.id; }; mc.add(someEl); mc.add(otherEl); // or via the constructor var mc = new Roo.util.MixedCollection(false, function(el){ return el.dom.id; }); mc.add(someEl); mc.add(otherEl);` Parameters: o {Object} The item for which to find the key. Returns: Object The key for the passed item.	Roo.util.MixedCollection
	getRange (Number *startIndex, Number endIndex) : Array Returns a range of items in this collection Returns a range of items in this collection Parameters: Number startIndex* (optional) defaults to 0 Number endIndex (optional) default to the last item Returns: Array An array of items	Roo.util.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: String eventName* The name of the event to check for Returns: Boolean True if the event is being listened for, else false	Roo.util.Observable
	indexOf (Object o) : Number Returns index within the collection of the passed Object. Returns index within the collection of the passed Object. Parameters: Object o The item to find the index of. Returns: Number index of the item.	Roo.util.MixedCollection
	indexOfKey (String *key) : Number Returns index within the collection of the passed key. Returns index within the collection of the passed key. Parameters: String key* The key to find the index of. Returns: Number index of the key.	Roo.util.MixedCollection
	insert (Number *index, String key, Object o) : Object Inserts an item at the specified index in the collection. Inserts an item at the specified index in the collection. Parameters: Number index* The index to insert the item at. String key The key to associate with the new item, or the item itself. Object o (optional) If the second parameter was a key, the new item. Returns: Object The item inserted.	Roo.util.MixedCollection
	item (String/Number *key) : Object Returns the item associated with the passed key OR index. Returns the item associated with the passed key OR index. Key has priority over index. Parameters: String/Number key* The key or index of the item. Returns: Object The item associated with the passed key.	Roo.util.MixedCollection
	itemAt (Number *index) : Object Returns the item at the specified index. Returns the item at the specified index. Parameters: Number index* The index of the item. Returns: Object	Roo.util.MixedCollection
	key (String/Number *key) : Object Returns the item associated with the passed key. Returns the item associated with the passed key. Parameters: String/Number key* The key of the item. Returns: Object The item associated with the passed key.	Roo.util.MixedCollection
	keySort (String *direction, Function fn) Sorts this collection by keys Sorts this collection by keys Parameters: String direction* (optional) "ASC" or "DESC" Function fn (optional) a comparison function (defaults to case insensitive string)	Roo.util.MixedCollection
	last () : Object Returns the last item in the collection. Returns the last item in the collection. Returns: Object the last item in the collection..	Roo.util.MixedCollection
	on (String *eventName, Function handler, Object scope, Object options) Appends an event handler to this element (shorthand for addListener) Appends an event handler to this element (shorthand for addListener) Parameters: String eventName* The type of event to listen for Function handler The method the event invokes Object scope (optional) The scope in which to execute the handler function. The handler function's "this" context. Object options (optional)	Roo.util.Observable
	purgeListeners () Removes all listeners for this object Removes all listeners for this object	Roo.util.Observable
	remove (Object o) : Object Removed an item from the collection. Removed an item from the collection. Parameters: Object o The item to remove. Returns: Object The item removed.	Roo.util.MixedCollection
	removeAt (Number *index) Remove an item from a specified index in the collection. Remove an item from a specified index in the collection. Parameters: Number index* The index within the collection of the item to remove.	Roo.util.MixedCollection
	removeKey (String *key) Removed an item associated with the passed key fom the collection. Removed an item associated with the passed key fom the collection. Parameters: String key* The key of the item to remove.	Roo.util.MixedCollection
	removeListener (String *eventName, Function handler, Object scope) Removes a listener Removes a listener Parameters: String eventName* The type of event to listen for Function handler The handler to remove Object scope (optional) The scope (this object) for the handler	Roo.util.Observable
	replace (String *key, o) : Object Replaces an item in the collection. Replaces an item in the collection. Parameters: String key* The key associated with the item to replace, or the item to replace. o {Object} o (optional) If the first parameter passed was a key, the item to associate with that key. Returns: Object The new item.	Roo.util.MixedCollection
	sort (String *direction, Function fn) Sorts this collection with the passed comparison function Sorts this collection with the passed comparison function Parameters: String direction* (optional) "ASC" or "DESC" Function fn (optional) comparison function	Roo.util.MixedCollection
	un (String *eventName, Function handler, Object scope) Removes a listener (shorthand for removeListener) Removes a listener (shorthand for removeListener) Parameters: String eventName* The type of event to listen for Function handler The handler to remove Object scope (optional) The scope (this object) for the handler	Roo.util.Observable

Events
Event		Defined By
	add (Number *index, Object o, String key) Fires when an item is added to the collection. Fires when an item is added to the collection. Parameters: Number index* The index at which the item was added. Object o The item added. String key The key associated with the added item.	Roo.util.MixedCollection
	clear () Fires when the collection is cleared. Fires when the collection is cleared.	Roo.util.MixedCollection
	remove (Object o, String *key) Fires when an item is removed from the collection. Fires when an item is removed from the collection. Parameters: Object o The item being removed. String key* (optional) The key associated with the removed item.	Roo.util.MixedCollection
	replace (String *key, Object old, Object new) Fires when an item is replaced in the collection. Fires when an item is replaced in the collection. Parameters: String key* he key associated with the new added. Object old The item being replaced. Object new The new item.	Roo.util.MixedCollection

Documentation generated by Introspection Doc Generator on Fri Jul 13 2018 14:10:55 GMT+0800 (HKT) Based on JsDoc Toolkit