2 "name" : "Roo.data.Node",
10 "Roo.tree.TreeNode" : [
11 "Roo.tree.AsyncTreeNode"
17 "isSingleton" : false,
21 "isBuilderTop" : false,
29 "name" : "attributes",
31 "desc" : "The attributes/config for the node",
42 "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>",
43 "memberOf" : "Roo.util.Observable",
50 "desc" : "The id for this node. If one is not specified, one is generated.",
58 "desc" : "true if this node is a leaf and does not have children",
68 "desc" : "Sorts this nodes children using the supplied sort function",
69 "sig" : "(fn, scope)",
73 "isConstructor" : false,
91 "desc" : "(optional)",
98 "name" : "removeChild",
100 "desc" : "Removes a child node from this node.",
105 "isConstructor" : false,
117 "desc" : "The node to remove",
125 "desc" : "The removed node"
130 "name" : "isAncestor",
132 "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
137 "isConstructor" : false,
164 "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
169 "isConstructor" : false,
196 "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.",
197 "sig" : "(fn, scope, args)",
201 "isConstructor" : false,
213 "desc" : "The function to call",
219 "desc" : "(optional) The scope of the function (defaults to current node)",
225 "desc" : "(optional) The args to call the function with (default to passing the current node)",
234 "desc" : "Returns depth of this node (the root node has a depth of 0)",
235 "sig" : "()\n{\n\n}",
239 "isConstructor" : false,
259 "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.",
264 "isConstructor" : false,
276 "desc" : "(optional) The attr to use for the path (defaults to the node's id)",
291 "desc" : "Returns the index of a child node",
296 "isConstructor" : false,
316 "desc" : "The index of the node or -1 if it was not found"
323 "desc" : "Returns true if this node is the first child of its parent",
324 "sig" : "()\n{\n\n}",
328 "isConstructor" : false,
348 "desc" : "Returns true if this node is the last child of its parent",
349 "sig" : "()\n{\n\n}",
353 "isConstructor" : false,
373 "desc" : "Returns true if this node is a leaf",
374 "sig" : "()\n{\n\n}",
378 "isConstructor" : false,
396 "name" : "insertBefore",
398 "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
399 "sig" : "(node, refNode)",
403 "isConstructor" : false,
415 "desc" : "The node to insert",
421 "desc" : "The node to insert before (if null the node is appended)",
429 "desc" : "The inserted node"
436 "desc" : "Returns the child node at the specified index.",
441 "isConstructor" : false,
466 "name" : "getOwnerTree",
468 "desc" : "Returns the tree this node is in.",
469 "sig" : "()\n{\n\n}",
473 "isConstructor" : false,
491 "name" : "appendChild",
493 "desc" : "Insert node(s) as the last child node of this node.",
498 "isConstructor" : false,
509 "type" : "Node/Array",
510 "desc" : "The node or Array of nodes to append",
518 "desc" : "The appended node if single append, or null if an array was passed"
523 "name" : "findChildBy",
525 "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.",
526 "sig" : "(fn, scope)",
530 "isConstructor" : false,
548 "desc" : "(optional)",
556 "desc" : "The found child or null if none was found"
561 "name" : "replaceChild",
563 "desc" : "Replaces one child node in this node with another.",
564 "sig" : "(newChild, oldChild)",
568 "isConstructor" : false,
580 "desc" : "The replacement node",
586 "desc" : "The node to replace",
594 "desc" : "The replaced node"
601 "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.",
602 "sig" : "(fn, scope, args)",
606 "isConstructor" : false,
618 "desc" : "The function to call",
624 "desc" : "(optional) The scope of the function (defaults to current node)",
630 "desc" : "(optional) The args to call the function with (default to passing the current node)",
637 "name" : "eachChild",
639 "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.",
640 "sig" : "(fn, scope, args)",
644 "isConstructor" : false,
656 "desc" : "The function to call",
662 "desc" : "(optional) The scope of the function (defaults to current node)",
668 "desc" : "(optional) The args to call the function with (default to passing the current node)",
675 "name" : "findChild",
677 "desc" : "Finds the first child that has the attribute with the specified value.",
678 "sig" : "(attribute, value)",
682 "isConstructor" : false,
692 "name" : "attribute",
694 "desc" : "The attribute name",
700 "desc" : "The value to search for",
708 "desc" : "The found child or null if none was found"
713 "name" : "purgeListeners",
715 "desc" : "Removes all listeners for this object",
716 "sig" : "()\n{\n\n}",
718 "memberOf" : "Roo.util.Observable",
720 "isConstructor" : false,
734 "desc" : "Appends an event handler to this element (shorthand for addListener)",
735 "sig" : "(eventName, handler, scope, options)",
737 "memberOf" : "Roo.util.Observable",
739 "isConstructor" : false,
749 "name" : "eventName",
751 "desc" : "The type of event to listen for",
757 "desc" : "The method the event invokes",
763 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
769 "desc" : "(optional)",
778 "desc" : "Removes a listener (shorthand for removeListener)",
779 "sig" : "(eventName, handler, scope)",
781 "memberOf" : "Roo.util.Observable",
783 "isConstructor" : false,
793 "name" : "eventName",
795 "desc" : "The type of event to listen for",
801 "desc" : "The handler to remove",
807 "desc" : "(optional) The scope (this object) for the handler",
814 "name" : "addEvents",
816 "desc" : "Used to define events on this Observable",
819 "memberOf" : "Roo.util.Observable",
821 "isConstructor" : false,
833 "desc" : "The object with the events defined",
840 "name" : "releaseCapture",
842 "desc" : "Removes <b>all</b> added captures from the Observable.",
845 "memberOf" : "Roo.util.Observable",
847 "isConstructor" : false,
858 "type" : "Observable",
859 "desc" : "The Observable to release",
866 "name" : "removeListener",
868 "desc" : "Removes a listener",
869 "sig" : "(eventName, handler, scope)",
871 "memberOf" : "Roo.util.Observable",
873 "isConstructor" : false,
883 "name" : "eventName",
885 "desc" : "The type of event to listen for",
891 "desc" : "The handler to remove",
897 "desc" : "(optional) The scope (this object) for the handler",
904 "name" : "fireEvent",
906 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
907 "sig" : "(eventName, args)",
909 "memberOf" : "Roo.util.Observable",
911 "isConstructor" : false,
921 "name" : "eventName",
928 "type" : "Object...",
929 "desc" : "Variable number of parameters are passed to handlers",
937 "desc" : "returns false if any of the handlers return false otherwise it returns true"
942 "name" : "hasListener",
944 "desc" : "Checks to see if this object has any listeners for a specified event",
945 "sig" : "(eventName)",
947 "memberOf" : "Roo.util.Observable",
949 "isConstructor" : false,
959 "name" : "eventName",
961 "desc" : "The name of the event to check for",
969 "desc" : "True if the event is being listened for, else false"
976 "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.",
977 "sig" : "(o, fn, scope)",
979 "memberOf" : "Roo.util.Observable",
981 "isConstructor" : false,
992 "type" : "Observable",
993 "desc" : "The Observable to capture",
999 "desc" : "The function to call",
1000 "isOptional" : false
1005 "desc" : "(optional) The scope (this object) for the fn",
1006 "isOptional" : false
1012 "name" : "addListener",
1013 "type" : "function",
1014 "desc" : "Appends an event handler to this component",
1015 "sig" : "(eventName, handler, scope, options)",
1017 "memberOf" : "Roo.util.Observable",
1019 "isConstructor" : false,
1020 "isPrivate" : false,
1029 "name" : "eventName",
1031 "desc" : "The type of event to listen for",
1032 "isOptional" : false
1036 "type" : "Function",
1037 "desc" : "The method the event invokes",
1038 "isOptional" : false
1043 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1044 "isOptional" : false
1049 "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>",
1050 "isOptional" : false
1058 "name" : "beforeappend",
1059 "type" : "function",
1060 "desc" : "Fires before a new child is appended, return false to cancel the append.",
1061 "sig" : "function (tree, _self, node)\n{\n\n}",
1071 "desc" : "The owner tree",
1072 "isOptional" : false
1077 "desc" : "This node",
1078 "isOptional" : false
1083 "desc" : "The child node to be appended",
1084 "isOptional" : false
1091 "type" : "function",
1092 "desc" : "Fires when this node is moved to a new location in the tree",
1093 "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
1103 "desc" : "The owner tree",
1104 "isOptional" : false
1109 "desc" : "This node",
1110 "isOptional" : false
1113 "name" : "oldParent",
1115 "desc" : "The old parent of this node",
1116 "isOptional" : false
1119 "name" : "newParent",
1121 "desc" : "The new parent of this node",
1122 "isOptional" : false
1127 "desc" : "The index it was moved to",
1128 "isOptional" : false
1135 "type" : "function",
1136 "desc" : "Fires when a new child node is appended",
1137 "sig" : "function (tree, _self, node, index)\n{\n\n}",
1147 "desc" : "The owner tree",
1148 "isOptional" : false
1153 "desc" : "This node",
1154 "isOptional" : false
1159 "desc" : "The newly appended node",
1160 "isOptional" : false
1165 "desc" : "The index of the newly appended node",
1166 "isOptional" : false
1172 "name" : "beforeremove",
1173 "type" : "function",
1174 "desc" : "Fires before a child is removed, return false to cancel the remove.",
1175 "sig" : "function (tree, _self, node)\n{\n\n}",
1185 "desc" : "The owner tree",
1186 "isOptional" : false
1191 "desc" : "This node",
1192 "isOptional" : false
1197 "desc" : "The child node to be removed",
1198 "isOptional" : false
1205 "type" : "function",
1206 "desc" : "Fires when a child node is removed",
1207 "sig" : "function (tree, _self, node)\n{\n\n}",
1217 "desc" : "The owner tree",
1218 "isOptional" : false
1223 "desc" : "This node",
1224 "isOptional" : false
1229 "desc" : "The removed node",
1230 "isOptional" : false
1236 "name" : "beforeinsert",
1237 "type" : "function",
1238 "desc" : "Fires before a new child is inserted, return false to cancel the insert.",
1239 "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
1249 "desc" : "The owner tree",
1250 "isOptional" : false
1255 "desc" : "This node",
1256 "isOptional" : false
1261 "desc" : "The child node to be inserted",
1262 "isOptional" : false
1267 "desc" : "The child node the node is being inserted before",
1268 "isOptional" : false
1275 "type" : "function",
1276 "desc" : "Fires when a new child node is inserted.",
1277 "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
1287 "desc" : "The owner tree",
1288 "isOptional" : false
1293 "desc" : "This node",
1294 "isOptional" : false
1299 "desc" : "The child node inserted",
1300 "isOptional" : false
1305 "desc" : "The child node the node was inserted before",
1306 "isOptional" : false
1312 "name" : "beforemove",
1313 "type" : "function",
1314 "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.",
1315 "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
1325 "desc" : "The owner tree",
1326 "isOptional" : false
1331 "desc" : "This node",
1332 "isOptional" : false
1335 "name" : "oldParent",
1337 "desc" : "The parent of this node",
1338 "isOptional" : false
1341 "name" : "newParent",
1343 "desc" : "The new parent this node is moving to",
1344 "isOptional" : false
1349 "desc" : "The index it is being moved to",
1350 "isOptional" : false