],
"returns" : []
},
+ {
+ "name" : "setPressed",
+ "type" : "function",
+ "desc" : "Similar to toggle, but does not trigger event.",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "[required] Force a particular state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setText",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setPressed",
+ "type" : "function",
+ "desc" : "Similar to toggle, but does not trigger event.",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "Roo.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "[required] Force a particular state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setText",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setPressed",
+ "type" : "function",
+ "desc" : "Similar to toggle, but does not trigger event.",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "Roo.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "[required] Force a particular state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setText",
"type" : "function",
"returns" : []
},
{
- "name" : "setText",
+ "name" : "setPressed",
"type" : "function",
- "desc" : "Sets this button's text",
- "sig" : "(text)",
- "static" : false,
- "memberOf" : "Roo.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "text",
- "type" : "String",
- "desc" : "The button text",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function for boolean show/hide",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Shows this button",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "toggle",
- "type" : "function",
- "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
+ "desc" : "Similar to toggle, but does not trigger event.",
"sig" : "(state)",
"static" : false,
"memberOf" : "Roo.Button",
{
"name" : "state",
"type" : "Boolean",
- "desc" : "(optional) Force a particular state",
+ "desc" : "[required] Force a particular state",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "setText",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets this button's text",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "text",
"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" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.Toolbar.TextItem" : {
- "props" : [
- {
- "name" : "text",
- "type" : "string",
- "desc" : "",
- "memberOf" : "Roo.Toolbar",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires when the button is rendered",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Toolbar.Item",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Button",
- "desc" : "",
+ "desc" : "The button text",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Removes and destroys this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disables this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enables this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Get this item's HTML Element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hides this button",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
},
{
"name" : "setVisible",
"type" : "function",
- "desc" : "Convenience function for boolean show/hide.",
+ "desc" : "Convenience function for boolean show/hide",
"sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "visible",
"type" : "Boolean",
- "desc" : "true to show/false to hide",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Shows this button",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "toggle",
+ "type" : "function",
+ "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "Roo.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "(optional) Force a particular state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "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" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.Toolbar.TextItem" : {
+ "props" : [
+ {
+ "name" : "text",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : "Roo.Toolbar",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires when the button is rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Toolbar.Item",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Button",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Removes and destroys this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disables this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enables this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Get this item's HTML Element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hides this button",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function for boolean show/hide.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "true to show/false to hide",
"isOptional" : false
}
],
"isAbstract" : true,
"isBuilderTop" : false,
"implementations" : [
- "Roo.data.HttpProxy"
+ "Roo.data.HttpProxy",
+ "Roo.data.MemoryProxy"
],
"tree_children" : [],
"tree_parent" : []
],
"returns" : []
},
- {
- "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,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
- "isOptional" : false
- }
- ],
- "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,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "record",
- "type" : "Ext.data.Record",
- "desc" : "The Roo.data.Record object to remove from the cache.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "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,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
+ {
+ "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
+ "isOptional" : false
+ }
+ ],
+ "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "record",
+ "type" : "Ext.data.Record",
+ "desc" : "The Roo.data.Record object to remove from the cache.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "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" : "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
+ "isOptional" : false
+ },
+ {
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
+ "isOptional" : false
+ },
+ {
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "property",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "The record index to start at (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "The last record index to include (defaults to length - 1)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The sum"
+ }
+ ]
+ },
+ {
+ "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "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" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.MemoryProxy" : {
+ "props" : [
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "The data object which the Reader uses to construct a block of Roo.data.Records.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforeload",
+ "type" : "function",
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (This, params)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "The params parameter to the load function.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "load",
+ "type" : "function",
+ "desc" : "Fires before the load method's callback is called.",
+ "sig" : "function (This, o, arg)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "loadexception",
+ "type" : "function",
+ "desc" : "Fires if an Exception occurs during data retrieval.",
+ "sig" : "function (This, o, arg, e)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The Exception.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "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" : []
+ },
+ {
+ "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "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" : "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "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",
+ "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "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" : "load",
+ "type" : "function",
+ "desc" : "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
+ "sig" : "(params, reader, callback, scope, arg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "This parameter is not used by the MemoryProxy class.",
+ "isOptional" : false
+ },
+ {
+ "name" : "reader",
+ "type" : "Roo.data.DataReader",
+ "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "The function into which to pass the block of Roo.data.records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "The scope in which to call the callback",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "An optional argument which is passed to the callback as its second parameter.",
+ "isOptional" : false
+ }
+ ],
+ "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "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" : "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "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,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "removeListener",
"type" : "function",
],
"returns" : []
},
- {
- "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,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
- "isOptional" : false
- },
- {
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "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,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
- "isOptional" : false
- },
- {
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "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,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "property",
- "type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "The record index to start at (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "The last record index to include (defaults to length - 1)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The sum"
- }
- ]
- },
{
"name" : "un",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.MemoryProxy" : {
- "props" : [],
- "events" : [],
- "methods" : [
- {
- "name" : "load",
- "type" : "function",
- "desc" : "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
- "sig" : "(params, reader, callback, scope, arg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "params",
- "type" : "Object",
- "desc" : "This parameter is not used by the MemoryProxy class.",
- "isOptional" : false
- },
- {
- "name" : "reader",
- "type" : "Roo.data.DataReader",
- "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "The function into which to pass the block of Roo.data.records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "The scope in which to call the callback",
- "isOptional" : false
- },
- {
- "name" : "arg",
- "type" : "Object",
- "desc" : "An optional argument which is passed to the callback as its second parameter.",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
"Roo.data.Node" : {
"props" : [
{
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
"memberOf" : "Roo.form.Layout",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
"name" : "labelSeparator",
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
"memberOf" : "Roo.form.Layout",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
"name" : "labelSeparator",
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
"name" : "labelSeparator",
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
"memberOf" : "Roo.form.Layout",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
"name" : "labelSeparator",
"Roo.data.DataProxy",
"Roo.data.HttpProxy",
"Roo.data.JsonStore",
+ "Roo.data.MemoryProxy",
"Roo.data.Node",
"Roo.data.SimpleStore",
"Roo.data.Store",
projects / roojs1 / blobdiff