--- /dev/null
+{
+ "name" : "Roo.util.MixedCollection",
+ "augments" : [
+ "Roo.util.Observable"
+ ],
+ "desc" : "A Collection class that maintains both numeric indexes and keys and exposes events.",
+ "isSingleton" : false,
+ "isStatic" : true,
+ "isBuiltin" : false,
+ "config" : [
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "values" : [
+ ]
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "remove",
+ "desc" : "Removed an item from the collection.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The item to remove.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "The item removed."
+ }
+ ]
+ },
+ {
+ "name" : "get",
+ "desc" : "Returns the item associated with the passed key or index.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "key",
+ "type" : "String/Number",
+ "desc" : "The key or index of the item.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "The item associated with the passed key."
+ }
+ ]
+ },
+ {
+ "name" : "itemAt",
+ "desc" : "Returns the item at the specified index.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the item.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "each",
+ "desc" : "Executes the specified function once for every item in the collection, passing each\nitem as the first and only parameter. returning false from the function will stop the iteration.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to execute for each item.",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the function.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "insert",
+ "desc" : "Inserts an item at the specified index in the collection.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index to insert the item at.",
+ "isOptional" : false
+ },
+ {
+ "name" : "key",
+ "type" : "String",
+ "desc" : "The key to associate with the new item, or the item itself.",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "(optional) If the second parameter was a key, the new item.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "The item inserted."
+ }
+ ]
+ },
+ {
+ "name" : "getCount",
+ "desc" : "Returns the number of items in the collection.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "the number of items in the collection."
+ }
+ ]
+ },
+ {
+ "name" : "clear",
+ "desc" : "Removes all items from the collection.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "keySort",
+ "desc" : "Sorts this collection by keys",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "direction",
+ "type" : "String",
+ "desc" : "(optional) \"ASC\" or \"DESC\"",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) a comparison function (defaults to case insensitive string)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "indexOf",
+ "desc" : "Returns index within the collection of the passed Object.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The item to find the index of.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "index of the item."
+ }
+ ]
+ },
+ {
+ "name" : "clone",
+ "desc" : "Creates a duplicate of this collection",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MixedCollection",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "containsKey",
+ "desc" : "Returns true if the collection contains the passed Object as a key.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "key",
+ "type" : "String",
+ "desc" : "The key to look for in the collection.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the collection contains the Object as a key."
+ }
+ ]
+ },
+ {
+ "name" : "getKey",
+ "desc" : "MixedCollection has a generic way to fetch keys if you implement getKey.\n<pre><code>\n// normal way\nvar mc = new Roo.util.MixedCollection();\nmc.add(someEl.dom.id, someEl);\nmc.add(otherEl.dom.id, otherEl);\n//and so on\n\n// using getKey\nvar mc = new Roo.util.MixedCollection();\nmc.getKey = function(el){\n return el.dom.id;\n};\nmc.add(someEl);\nmc.add(otherEl);\n\n// or via the constructor\nvar mc = new Roo.util.MixedCollection(false, function(el){\n return el.dom.id;\n});\nmc.add(someEl);\nmc.add(otherEl);\n</code></pre>",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "",
+ "desc" : "{Object} The item for which to find the key.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "The key for the passed item."
+ }
+ ]
+ },
+ {
+ "name" : "find",
+ "desc" : "Returns the first item in the collection which elicits a true return value from the\npassed selection function.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The selection function to execute for each item.",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the function.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "The first item in the collection which returned true from the selection function."
+ }
+ ]
+ },
+ {
+ "name" : "getRange",
+ "desc" : "Returns a range of items in this collection",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "startIndex",
+ "type" : "Number",
+ "desc" : "(optional) defaults to 0",
+ "isOptional" : false
+ },
+ {
+ "name" : "endIndex",
+ "type" : "Number",
+ "desc" : "(optional) default to the last item",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "An array of items"
+ }
+ ]
+ },
+ {
+ "name" : "eachKey",
+ "desc" : "Executes the specified function once for every key in the collection, passing each\nkey, and its associated item as the first two parameters.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to execute for each item.",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the function.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "indexOfKey",
+ "desc" : "Returns index within the collection of the passed key.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "key",
+ "type" : "String",
+ "desc" : "The key to find the index of.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "index of the key."
+ }
+ ]
+ },
+ {
+ "name" : "contains",
+ "desc" : "Returns true if the collection contains the passed Object as an item.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The Object to look for in the collection.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the collection contains the Object as an item."
+ }
+ ]
+ },
+ {
+ "name" : "addAll",
+ "desc" : "Adds all elements of an Array or an Object to the collection.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "objs",
+ "type" : "Object/Array",
+ "desc" : "An Object containing properties which will be added to the collection, or\nan Array of values, each of which are added to the collection.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "key",
+ "desc" : "Returns the item associated with the passed key.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "key",
+ "type" : "String/Number",
+ "desc" : "The key of the item.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "The item associated with the passed key."
+ }
+ ]
+ },
+ {
+ "name" : "item",
+ "desc" : "Returns the item associated with the passed key OR index. Key has priority over index.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "key",
+ "type" : "String/Number",
+ "desc" : "The key or index of the item.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "The item associated with the passed key."
+ }
+ ]
+ },
+ {
+ "name" : "filterBy",
+ "desc" : "Filter by a function. * Returns a new collection that has been filtered.\nThe passed function will be called with each \nobject in the collection. If the function returns true, the value is included \notherwise it is filtered.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to be called, it will receive the args o (the object), k (the key)",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to this)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MixedCollection",
+ "desc" : "The new filtered collection"
+ }
+ ]
+ },
+ {
+ "name" : "add",
+ "desc" : "Adds an item to the collection.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "key",
+ "type" : "String",
+ "desc" : "The key to associate with the item",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The item to add.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "The item added."
+ }
+ ]
+ },
+ {
+ "name" : "removeAt",
+ "desc" : "Remove an item from a specified index in the collection.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index within the collection of the item to remove.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "removeKey",
+ "desc" : "Removed an item associated with the passed key fom the collection.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "key",
+ "type" : "String",
+ "desc" : "The key of the item to remove.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "filter",
+ "desc" : "Filter the <i>objects</i> in this collection by a specific property. \nReturns a new collection that has been filtered.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "property",
+ "type" : "String",
+ "desc" : "A property on your objects",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either string that the property values \nshould start with or a RegExp to test against the property",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MixedCollection",
+ "desc" : "The new filtered collection"
+ }
+ ]
+ },
+ {
+ "name" : "last",
+ "desc" : "Returns the last item in the collection.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the last item in the collection.."
+ }
+ ]
+ },
+ {
+ "name" : "replace",
+ "desc" : "Replaces an item in the collection.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "key",
+ "type" : "String",
+ "desc" : "The key associated with the item to replace, or the item to replace.",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "",
+ "desc" : "{Object} o (optional) If the first parameter passed was a key, the item to associate with that key.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "The new item."
+ }
+ ]
+ },
+ {
+ "name" : "first",
+ "desc" : "Returns the first item in the collection.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the first item in the collection.."
+ }
+ ]
+ },
+ {
+ "name" : "sort",
+ "desc" : "Sorts this collection with the passed comparison function",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.MixedCollection",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "direction",
+ "type" : "String",
+ "desc" : "(optional) \"ASC\" or \"DESC\"",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) comparison function",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "purgeListeners",
+ "desc" : "Removes all listeners for this object",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.Observable",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "on",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.Observable",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "un",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.Observable",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "addEvents",
+ "desc" : "Used to define events on this Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.Observable",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "releaseCapture",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.Observable",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "removeListener",
+ "desc" : "Removes a listener",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.Observable",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "fireEvent",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.Observable",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.Observable",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
+ },
+ {
+ "name" : "capture",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.Observable",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "addListener",
+ "desc" : "Appends an event handler to this component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.util.Observable",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ }
+ ],
+ "events" : [
+ {
+ "name" : "remove",
+ "desc" : "Fires when an item is removed from the collection.",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The item being removed.",
+ "isOptional" : false
+ },
+ {
+ "name" : "key",
+ "type" : "String",
+ "desc" : "(optional) The key associated with the removed item.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "add",
+ "desc" : "Fires when an item is added to the collection.",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index at which the item was added.",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The item added.",
+ "isOptional" : false
+ },
+ {
+ "name" : "key",
+ "type" : "String",
+ "desc" : "The key associated with the added item.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "replace",
+ "desc" : "Fires when an item is replaced in the collection.",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "key",
+ "type" : "String",
+ "desc" : "he key associated with the new added.",
+ "isOptional" : false
+ },
+ {
+ "name" : "old",
+ "type" : "Object",
+ "desc" : "The item being replaced.",
+ "isOptional" : false
+ },
+ {
+ "name" : "new",
+ "type" : "Object",
+ "desc" : "The new item.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "clear",
+ "desc" : "Fires when the collection is cleared.",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ]
+ }
+ ]
+}
\ No newline at end of file
projects / roojs1 / blobdiff