2 "name" : "Roo.tree.TreeLoader",
9 "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 \n</code></pre>\n\nThis would pass an HTTP parameter called \"category\" to the server containing\nthe value of the Node's \"category\" attribute.",
10 "isSingleton" : false,
14 "isBuilderTop" : false,
15 "memberOf" : "TreeLoader",
24 "desc" : "A config object containing config properties.",
35 "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>",
36 "memberOf" : "Roo.util.Observable"
39 "name" : "clearOnLoad",
41 "desc" : "(optional) Default to true. Remove previously existing\nchild nodes before loading.",
42 "memberOf" : "Roo.tree.TreeLoader"
47 "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.",
48 "memberOf" : "Roo.tree.TreeLoader"
53 "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 : [ .....] }",
54 "memberOf" : "Roo.tree.TreeLoader"
57 "name" : "requestMethod",
59 "desc" : "either GET or POST\ndefaults to POST (due to BC)\nto be loaded.",
60 "memberOf" : "Roo.tree.TreeLoader"
63 "name" : "baseParams",
65 "desc" : "(optional) An object containing properties which\nspecify HTTP parameters to be passed to each request for child nodes.",
66 "memberOf" : "Roo.tree.TreeLoader"
71 "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.",
72 "memberOf" : "Roo.tree.TreeLoader"
75 "name" : "uiProviders",
77 "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)",
78 "memberOf" : "Roo.tree.TreeLoader"
81 "name" : "queryParam",
83 "desc" : "(optional) \nName of the query as it will be passed on the querystring (defaults to 'node')\neg. the request will be ?node=[id]",
84 "memberOf" : "Roo.tree.TreeLoader"
91 "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.)",
92 "sig" : "(node, callback)",
96 "isConstructor" : false,
107 "type" : "Roo.tree.TreeNode",
121 "name" : "purgeListeners",
123 "desc" : "Removes all listeners for this object",
124 "sig" : "()\n{\n\n}",
126 "memberOf" : "Roo.util.Observable",
128 "isConstructor" : false,
142 "desc" : "Appends an event handler to this element (shorthand for addListener)",
143 "sig" : "(eventName, handler, scope, options)",
145 "memberOf" : "Roo.util.Observable",
147 "isConstructor" : false,
157 "name" : "eventName",
159 "desc" : "The type of event to listen for",
165 "desc" : "The method the event invokes",
171 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
177 "desc" : "(optional)",
186 "desc" : "Removes a listener (shorthand for removeListener)",
187 "sig" : "(eventName, handler, scope)",
189 "memberOf" : "Roo.util.Observable",
191 "isConstructor" : false,
201 "name" : "eventName",
203 "desc" : "The type of event to listen for",
209 "desc" : "The handler to remove",
215 "desc" : "(optional) The scope (this object) for the handler",
222 "name" : "addEvents",
224 "desc" : "Used to define events on this Observable",
227 "memberOf" : "Roo.util.Observable",
229 "isConstructor" : false,
241 "desc" : "The object with the events defined",
248 "name" : "releaseCapture",
250 "desc" : "Removes <b>all</b> added captures from the Observable.",
253 "memberOf" : "Roo.util.Observable",
255 "isConstructor" : false,
266 "type" : "Observable",
267 "desc" : "The Observable to release",
274 "name" : "removeListener",
276 "desc" : "Removes a listener",
277 "sig" : "(eventName, handler, scope)",
279 "memberOf" : "Roo.util.Observable",
281 "isConstructor" : false,
291 "name" : "eventName",
293 "desc" : "The type of event to listen for",
299 "desc" : "The handler to remove",
305 "desc" : "(optional) The scope (this object) for the handler",
312 "name" : "fireEvent",
314 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
315 "sig" : "(eventName, args)",
317 "memberOf" : "Roo.util.Observable",
319 "isConstructor" : false,
329 "name" : "eventName",
336 "type" : "Object...",
337 "desc" : "Variable number of parameters are passed to handlers",
345 "desc" : "returns false if any of the handlers return false otherwise it returns true"
350 "name" : "hasListener",
352 "desc" : "Checks to see if this object has any listeners for a specified event",
353 "sig" : "(eventName)",
355 "memberOf" : "Roo.util.Observable",
357 "isConstructor" : false,
367 "name" : "eventName",
369 "desc" : "The name of the event to check for",
377 "desc" : "True if the event is being listened for, else false"
384 "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.",
385 "sig" : "(o, fn, scope)",
387 "memberOf" : "Roo.util.Observable",
389 "isConstructor" : false,
400 "type" : "Observable",
401 "desc" : "The Observable to capture",
407 "desc" : "The function to call",
413 "desc" : "(optional) The scope (this object) for the fn",
420 "name" : "addListener",
422 "desc" : "Appends an event handler to this component",
423 "sig" : "(eventName, handler, scope, options)",
425 "memberOf" : "Roo.util.Observable",
427 "isConstructor" : false,
437 "name" : "eventName",
439 "desc" : "The type of event to listen for",
445 "desc" : "The method the event invokes",
451 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
457 "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>",
468 "desc" : "Fires before a node is created, enabling you to return custom Node types",
469 "sig" : "function (This, attr)\n{\n\n}",
479 "desc" : "TreeLoader object.",
485 "desc" : "- the data returned from the AJAX call (modify it to suit)",
492 "name" : "beforeload",
494 "desc" : "Fires before a network request is made to retrieve the Json text which specifies a node's children.",
495 "sig" : "function (This, node, callback)\n{\n\n}",
505 "desc" : "TreeLoader object.",
511 "desc" : "The {@link Roo.tree.TreeNode} object being loaded.",
517 "desc" : "The callback function specified in the {@link #load} call.",
526 "desc" : "Fires when the node has been successfuly loaded.",
527 "sig" : "function (This, node, response)\n{\n\n}",
537 "desc" : "TreeLoader object.",
543 "desc" : "The {@link Roo.tree.TreeNode} object being loaded.",
549 "desc" : "The response object containing the data from the server.",
556 "name" : "loadexception",
558 "desc" : "Fires if the network request failed.",
559 "sig" : "function (This, node, response)\n{\n\n}",
569 "desc" : "TreeLoader object.",
575 "desc" : "The {@link Roo.tree.TreeNode} object being loaded.",
581 "desc" : "The response object containing the data from the server.",