--- /dev/null
+{
+ "name" : "Roo.tree.TreeLoader",
+ "augments" : [
+ "Roo.util.Observable"
+ ],
+ "desc" : "A TreeLoader provides for lazy loading of an {@link Roo.tree.TreeNode}'s child\nnodes from a specified URL. The response must be a javascript Array definition\nwho's elements are node definition objects. eg:\n<pre><code>\n{ success : true,\n data : [\n \n { 'id': 1, 'text': 'A folder Node', 'leaf': false },\n { 'id': 2, 'text': 'A leaf Node', 'leaf': true }\n ]\n}\n\n\n</code></pre>\n<br><br>\nThe old style respose with just an array is still supported, but not recommended.\n<br><br>\n\nA server request is sent, and child nodes are loaded only when a node is expanded.\nThe loading node's id is passed to the server under the parameter name \"node\" to\nenable the server to produce the correct child nodes.\n<br><br>\nTo pass extra parameters, an event handler may be attached to the \"beforeload\"\nevent, and the parameters specified in the TreeLoader's baseParams property:\n<pre><code>\n myTreeLoader.on(\"beforeload\", function(treeLoader, node) {\n this.baseParams.category = node.attributes.category;\n }, this);\n</code></pre><\nThis would pass an HTTP parameter called \"category\" to the server containing\nthe value of the Node's \"category\" attribute.",
+ "isSingleton" : false,
+ "isStatic" : false,
+ "isBuiltin" : false,
+ "memberOf" : "TreeLoader",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "A config object containing config properties.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
+ "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" : [
+ ]
+ },
+ {
+ "name" : "clearOnLoad",
+ "type" : "Boolean",
+ "desc" : "(optional) Default to true. Remove previously existing\nchild nodes before loading.",
+ "memberOf" : "Roo.tree.TreeLoader",
+ "values" : [
+ ]
+ },
+ {
+ "name" : "dataUrl",
+ "type" : "String",
+ "desc" : "The URL from which to request a Json string which\nspecifies an array of node definition object representing the child nodes\nto be loaded.",
+ "memberOf" : "Roo.tree.TreeLoader",
+ "values" : [
+ ]
+ },
+ {
+ "name" : "root",
+ "type" : "String",
+ "desc" : "(optional) Default to false. Use this to read data from an object \nproperty on loading, rather than expecting an array. (eg. more compatible to a standard\nGrid query { data : [ .....] }",
+ "memberOf" : "Roo.tree.TreeLoader",
+ "values" : [
+ ]
+ },
+ {
+ "name" : "requestMethod",
+ "type" : "String",
+ "desc" : "either GET or POST\ndefaults to POST (due to BC)\nto be loaded.",
+ "memberOf" : "Roo.tree.TreeLoader",
+ "values" : [
+ ]
+ },
+ {
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "(optional) An object containing properties which\nspecify HTTP parameters to be passed to each request for child nodes.",
+ "memberOf" : "Roo.tree.TreeLoader",
+ "values" : [
+ ]
+ },
+ {
+ "name" : "baseAttrs",
+ "type" : "Object",
+ "desc" : "(optional) An object containing attributes to be added to all nodes\ncreated by this loader. If the attributes sent by the server have an attribute in this object,\nthey take priority.",
+ "memberOf" : "Roo.tree.TreeLoader",
+ "values" : [
+ ]
+ },
+ {
+ "name" : "uiProviders",
+ "type" : "Object",
+ "desc" : "(optional) An object containing properties which\n\nDEPRECATED - use 'create' event handler to modify attributes - which affect creation.\nspecify custom {@link Roo.tree.TreeNodeUI} implementations. If the optional\n<i>uiProvider</i> attribute of a returned child node is a string rather\nthan a reference to a TreeNodeUI implementation, this that string value\nis used as a property name in the uiProviders object. You can define the provider named\n'default' , and this will be used for all nodes (if no uiProvider is delivered by the node data)",
+ "memberOf" : "Roo.tree.TreeLoader",
+ "values" : [
+ ]
+ },
+ {
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "(optional) \nName of the query as it will be passed on the querystring (defaults to 'node')\neg. the request will be ?node=[id]",
+ "memberOf" : "Roo.tree.TreeLoader",
+ "values" : [
+ ]
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "load",
+ "desc" : "Load an {@link Roo.tree.TreeNode} from the URL specified in the constructor.\nThis is called automatically when a node is expanded, but may be used to reload\na node (or append new children if the {@link #clearOnLoad} option is false.)",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.tree.TreeLoader",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "Roo.tree.TreeNode",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "",
+ "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" : "create",
+ "desc" : "Fires before a node is created, enabling you to return custom Node types",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "TreeLoader object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "attr",
+ "type" : "Object",
+ "desc" : "- the data returned from the AJAX call (modify it to suit)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "beforeload",
+ "desc" : "Fires before a network request is made to retrieve the Json text which specifies a node's children.",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "TreeLoader object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Object",
+ "desc" : "The {@link Roo.tree.TreeNode} object being loaded.",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Object",
+ "desc" : "The callback function specified in the {@link #load} call.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "load",
+ "desc" : "Fires when the node has been successfuly loaded.",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "TreeLoader object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Object",
+ "desc" : "The {@link Roo.tree.TreeNode} object being loaded.",
+ "isOptional" : false
+ },
+ {
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The response object containing the data from the server.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "loadexception",
+ "desc" : "Fires if the network request failed.",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "TreeLoader object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Object",
+ "desc" : "The {@link Roo.tree.TreeNode} object being loaded.",
+ "isOptional" : false
+ },
+ {
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The response object containing the data from the server.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ }
+ ]
+}
\ No newline at end of file
projects / roojs1 / blobdiff