"Roo.data.Store",
"Roo.util.Observable"
],
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : [],
"desc" : "Small helper class to make creating Stores from Array data easier.",
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : false,
+ "isAbstract" : false,
+ "isBuilderTop" : false,
"memberOf" : "SimpleStore",
"example" : "",
"deprecated" : "",
}
],
"returns" : [],
+ "throws" : "",
+ "requires" : "",
"config" : [
{
"name" : "an",
"type" : "Object",
"desc" : "existing reader (eg. copied from another store)",
- "memberOf" : "Roo.data.SimpleStore",
- "optvals" : []
+ "memberOf" : "Roo.data.SimpleStore"
},
{
"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",
- "optvals" : []
+ "memberOf" : "Roo.util.Observable"
},
{
"name" : "id",
"type" : "Number",
"desc" : "The array index of the record id. Leave blank to auto generate ids.",
- "memberOf" : "Roo.data.SimpleStore",
- "optvals" : []
+ "memberOf" : "Roo.data.SimpleStore"
},
{
"name" : "fields",
"type" : "Array",
"desc" : "An array of field definition objects, or field name strings.",
- "memberOf" : "Roo.data.SimpleStore",
- "optvals" : []
+ "memberOf" : "Roo.data.SimpleStore"
},
{
"name" : "proxy",
"type" : "Roo.data.DataProxy",
- "desc" : "The Proxy object which provides access to a data object.",
- "memberOf" : "Roo.data.Store",
- "optvals" : []
+ "desc" : "[not-required]",
+ "memberOf" : "Roo.data.SimpleStore"
},
{
"name" : "multiSort",
"type" : "Boolean",
"desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf" : "Roo.data.Store",
- "optvals" : []
+ "memberOf" : "Roo.data.Store"
},
{
"name" : "pruneModifiedRecords",
"type" : "boolean",
"desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf" : "Roo.data.Store",
- "optvals" : []
+ "memberOf" : "Roo.data.Store"
},
{
"name" : "remoteSort",
"type" : "boolean",
"desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
- "memberOf" : "Roo.data.Store",
- "optvals" : []
+ "memberOf" : "Roo.data.Store"
},
{
"name" : "data",
"type" : "Array",
"desc" : "The multi-dimensional array of data",
- "memberOf" : "Roo.data.SimpleStore",
- "optvals" : []
+ "memberOf" : "Roo.data.SimpleStore"
},
{
"name" : "sortInfo",
"type" : "Object",
"desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : "Roo.data.Store",
- "optvals" : []
+ "memberOf" : "Roo.data.Store"
},
{
"name" : "baseParams",
"type" : "Object",
"desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : "Roo.data.Store",
- "optvals" : []
+ "memberOf" : "Roo.data.Store"
},
{
"name" : "reader",
"type" : "Roo.data.Reader",
- "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
- "memberOf" : "Roo.data.Store",
- "optvals" : []
+ "desc" : "[not-required]",
+ "memberOf" : "Roo.data.SimpleStore"
},
{
"name" : "isLocal",
"type" : "boolean",
"desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
- "memberOf" : "Roo.data.Store",
- "optvals" : []
+ "memberOf" : "Roo.data.Store"
}
],
"methods" : [
{
"name" : "reload",
+ "type" : "function",
"desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
+ "sig" : "(options)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "options",
},
{
"name" : "removeAll",
+ "type" : "function",
"desc" : "Remove all Records from the Store and fires the clear event.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "query",
+ "type" : "function",
"desc" : "Query the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "field",
},
{
"name" : "sum",
+ "type" : "function",
"desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
+ "sig" : "(property, start, end)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "property",
},
{
"name" : "getById",
+ "type" : "function",
"desc" : "Get the Record with the specified id.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "id",
},
{
"name" : "commitChanges",
+ "type" : "function",
"desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "getCount",
+ "type" : "function",
"desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "indexOf",
+ "type" : "function",
"desc" : "Get the index within the cache of the passed Record.",
+ "sig" : "(record)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "record",
},
{
"name" : "add",
+ "type" : "function",
"desc" : "Add Records to the Store and fires the add event.",
+ "sig" : "(records)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "records",
},
{
"name" : "indexOfId",
+ "type" : "function",
"desc" : "Get the index within the cache of the Record with the passed id.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "id",
},
{
"name" : "filter",
+ "type" : "function",
"desc" : "Filter the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "field",
},
{
"name" : "sort",
+ "type" : "function",
"desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
+ "sig" : "(fieldName, dir)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "fieldName",
},
{
"name" : "getRange",
+ "type" : "function",
"desc" : "Returns a range of Records between specified indices.",
+ "sig" : "(startIndex, endIndex)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "startIndex",
},
{
"name" : "queryBy",
+ "type" : "function",
"desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "fn",
},
{
"name" : "loadDataFromChildren",
+ "type" : "function",
"desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
+ "sig" : "(rec)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "rec",
},
{
"name" : "clearFilter",
+ "type" : "function",
"desc" : "Revert to a view of the Record cache with no filtering applied.",
+ "sig" : "(suppressEvent)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "suppressEvent",
},
{
"name" : "each",
+ "type" : "function",
"desc" : "Calls the specified function for each of the Records in the cache.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "fn",
},
{
"name" : "rejectChanges",
+ "type" : "function",
"desc" : "Cancel outstanding changes on all changed records.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "getAt",
+ "type" : "function",
"desc" : "Get the Record at the specified index.",
+ "sig" : "(index)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "index",
},
{
"name" : "getTotalCount",
+ "type" : "function",
"desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "filterBy",
+ "type" : "function",
"desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "fn",
},
{
"name" : "collect",
+ "type" : "function",
"desc" : "Collects unique values for a particular dataIndex from this store.",
+ "sig" : "(dataIndex, allowNull, bypassFilter)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "dataIndex",
},
{
"name" : "getModifiedRecords",
+ "type" : "function",
"desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"name" : "remove",
+ "type" : "function",
"desc" : "Remove a Record from the Store and fires the remove event.",
+ "sig" : "(record)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "record",
},
{
"name" : "loadData",
+ "type" : "function",
"desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
+ "sig" : "(data, append)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "data",
},
{
"name" : "load",
+ "type" : "function",
"desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
+ "sig" : "(options)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "options",
},
{
"name" : "setDefaultSort",
+ "type" : "function",
"desc" : "Sets the default sort column and order to be used by the next load operation.",
+ "sig" : "(fieldName, dir)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "fieldName",
},
{
"name" : "insert",
+ "type" : "function",
"desc" : "Inserts Records to the Store at the given index and fires the add event.",
+ "sig" : "(index, records)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "index",
},
{
"name" : "getSortState",
+ "type" : "function",
"desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "purgeListeners",
+ "type" : "function",
"desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "on",
+ "type" : "function",
"desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"name" : "un",
+ "type" : "function",
"desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"name" : "addEvents",
+ "type" : "function",
"desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "object",
},
{
"name" : "releaseCapture",
+ "type" : "function",
"desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "o",
},
{
"name" : "removeListener",
+ "type" : "function",
"desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"name" : "fireEvent",
+ "type" : "function",
"desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"name" : "hasListener",
+ "type" : "function",
"desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"name" : "capture",
+ "type" : "function",
"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.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "o",
},
{
"name" : "addListener",
+ "type" : "function",
"desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
"events" : [
{
"name" : "beforeloadadd",
+ "type" : "function",
"desc" : "Fires after a new set of Records has been loaded.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
"memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
},
{
"name" : "loadexception",
+ "type" : "function",
"desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
+ "sig" : "function (, return, load, jsonData)\n{\n\n}",
"memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
},
{
"name" : "load",
+ "type" : "function",
"desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
"memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
},
{
"name" : "add",
+ "type" : "function",
"desc" : "Fires when Records have been added to the Store",
+ "sig" : "function (_self, records, index)\n{\n\n}",
"memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
},
{
"name" : "metachange",
+ "type" : "function",
"desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
+ "sig" : "function (_self, meta)\n{\n\n}",
"memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
},
{
"name" : "clear",
+ "type" : "function",
"desc" : "Fires when the data cache has been cleared.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
},
{
"name" : "remove",
+ "type" : "function",
"desc" : "Fires when a Record has been removed from the Store",
+ "sig" : "function (_self, record, index)\n{\n\n}",
"memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
},
{
"name" : "update",
+ "type" : "function",
"desc" : "Fires when a Record has been updated",
+ "sig" : "function (_self, record, operation)\n{\n\n}",
"memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
},
{
"name" : "beforeload",
+ "type" : "function",
"desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
+ "sig" : "function (_self, options)\n{\n\n}",
"memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
},
{
"name" : "datachanged",
+ "type" : "function",
"desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
projects / roojs1 / blobdiff