2 "name" : "Roo.tree.TreeNode",
7 "desc" : "is to use the cls or iconCls attributes and add the icon via a CSS background image.",
11 "memberOf" : "TreeNode",
18 "name" : "attributes",
19 "type" : "Object/String",
20 "desc" : "The attributes/config for the node or just a string with the text for the node",
29 "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>",
30 "memberOf" : "Roo.util.Observable",
34 "name" : "hrefTarget",
36 "desc" : "target frame for the link",
37 "memberOf" : "Roo.tree.TreeNode",
43 "desc" : "The id for this node. If one is not specified, one is generated.",
44 "memberOf" : "Roo.data.Node",
50 "desc" : "The text for this node",
51 "memberOf" : "Roo.tree.TreeNode",
55 "name" : "uiProvider",
57 "desc" : "A UI <b>class</b> to use for this node (defaults to Roo.tree.TreeNodeUI)",
58 "memberOf" : "Roo.tree.TreeNode",
64 "desc" : "true to start the node expanded",
65 "memberOf" : "Roo.tree.TreeNode",
71 "desc" : "An Ext QuickTip config for the node (used instead of qtip)",
72 "memberOf" : "Roo.tree.TreeNode",
78 "desc" : "false if this node cannot be drop on",
79 "memberOf" : "Roo.tree.TreeNode",
85 "desc" : "true to start the node disabled",
86 "memberOf" : "Roo.tree.TreeNode",
92 "desc" : "A css class to be added to the node",
93 "memberOf" : "Roo.tree.TreeNode",
99 "desc" : "A css class to be added to the nodes icon element for applying css background images",
100 "memberOf" : "Roo.tree.TreeNode",
104 "name" : "allowDrag",
106 "desc" : "false to make this node undraggable if DD is on (defaults to true)",
107 "memberOf" : "Roo.tree.TreeNode",
113 "desc" : "The path to an icon for the node. The preferred way to do this",
114 "memberOf" : "Roo.tree.TreeNode",
118 "name" : "singleClickExpand",
120 "desc" : "True for single click expand on this node",
121 "memberOf" : "Roo.tree.TreeNode",
127 "desc" : "An Ext QuickTip for the node",
128 "memberOf" : "Roo.tree.TreeNode",
134 "desc" : "True to render a checked checkbox for this node, false to render an unchecked checkbox\n(defaults to undefined with no checkbox rendered)",
135 "memberOf" : "Roo.tree.TreeNode",
141 "desc" : "URL of the link used for the node (defaults to #)",
142 "memberOf" : "Roo.tree.TreeNode",
148 "desc" : "true if this node is a leaf and does not have children",
149 "memberOf" : "Roo.data.Node",
156 "desc" : "Triggers selection of this node",
158 "isConstructor" : false,
160 "memberOf" : "Roo.tree.TreeNode",
170 "desc" : "Enables this node",
172 "isConstructor" : false,
174 "memberOf" : "Roo.tree.TreeNode",
183 "name" : "collapseChildNodes",
184 "desc" : "Collapse all child nodes",
186 "isConstructor" : false,
188 "memberOf" : "Roo.tree.TreeNode",
197 "desc" : "(optional) true if the child nodes should also collapse their child nodes",
204 "name" : "ensureVisible",
205 "desc" : "Ensures all parent nodes are expanded",
207 "isConstructor" : false,
209 "memberOf" : "Roo.tree.TreeNode",
218 "name" : "isSelected",
219 "desc" : "Returns true if this node is selected",
221 "isConstructor" : false,
223 "memberOf" : "Roo.tree.TreeNode",
239 "desc" : "Disables this node",
241 "isConstructor" : false,
243 "memberOf" : "Roo.tree.TreeNode",
253 "desc" : "Returns the UI object for this node",
255 "isConstructor" : false,
257 "memberOf" : "Roo.tree.TreeNode",
266 "type" : "TreeNodeUI",
273 "desc" : "Sets the text for this node",
275 "isConstructor" : false,
277 "memberOf" : "Roo.tree.TreeNode",
294 "desc" : "Toggles expanded/collapsed state of the node",
296 "isConstructor" : false,
298 "memberOf" : "Roo.tree.TreeNode",
308 "desc" : "Triggers deselection of this node",
310 "isConstructor" : false,
312 "memberOf" : "Roo.tree.TreeNode",
321 "name" : "isExpanded",
322 "desc" : "Returns true if this node is expanded",
324 "isConstructor" : false,
326 "memberOf" : "Roo.tree.TreeNode",
341 "name" : "expandChildNodes",
342 "desc" : "Expand all child nodes",
344 "isConstructor" : false,
346 "memberOf" : "Roo.tree.TreeNode",
355 "desc" : "(optional) true if the child nodes should also expand their child nodes",
363 "desc" : "Expand this node.",
365 "isConstructor" : false,
367 "memberOf" : "Roo.tree.TreeNode",
376 "desc" : "(optional) True to expand all children as well",
382 "desc" : "(optional) false to cancel the default animation",
388 "desc" : "(optional) A callback to be called when\nexpanding this node completes (does not wait for deep expand to complete).\nCalled with 1 parameter, this node.",
396 "desc" : "Collapse this node.",
398 "isConstructor" : false,
400 "memberOf" : "Roo.tree.TreeNode",
409 "desc" : "(optional) True to collapse all children as well",
415 "desc" : "(optional) false to cancel the default animation",
423 "desc" : "Sorts this nodes children using the supplied sort function",
425 "isConstructor" : false,
427 "memberOf" : "Roo.data.Node",
442 "desc" : "(optional)",
449 "name" : "removeChild",
450 "desc" : "Removes a child node from this node.",
452 "isConstructor" : false,
454 "memberOf" : "Roo.data.Node",
463 "desc" : "The node to remove",
471 "desc" : "The removed node"
476 "name" : "isAncestor",
477 "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
479 "isConstructor" : false,
481 "memberOf" : "Roo.data.Node",
504 "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
506 "isConstructor" : false,
508 "memberOf" : "Roo.data.Node",
531 "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.",
533 "isConstructor" : false,
535 "memberOf" : "Roo.data.Node",
544 "desc" : "The function to call",
550 "desc" : "(optional) The scope of the function (defaults to current node)",
556 "desc" : "(optional) The args to call the function with (default to passing the current node)",
564 "desc" : "Returns depth of this node (the root node has a depth of 0)",
566 "isConstructor" : false,
568 "memberOf" : "Roo.data.Node",
584 "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.",
586 "isConstructor" : false,
588 "memberOf" : "Roo.data.Node",
597 "desc" : "(optional) The attr to use for the path (defaults to the node's id)",
611 "desc" : "Returns the index of a child node",
613 "isConstructor" : false,
615 "memberOf" : "Roo.data.Node",
632 "desc" : "The index of the node or -1 if it was not found"
638 "desc" : "Returns true if this node is the first child of its parent",
640 "isConstructor" : false,
642 "memberOf" : "Roo.data.Node",
658 "desc" : "Returns true if this node is the last child of its parent",
660 "isConstructor" : false,
662 "memberOf" : "Roo.data.Node",
678 "desc" : "Returns true if this node is a leaf",
680 "isConstructor" : false,
682 "memberOf" : "Roo.data.Node",
697 "name" : "insertBefore",
698 "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
700 "isConstructor" : false,
702 "memberOf" : "Roo.data.Node",
711 "desc" : "The node to insert",
717 "desc" : "The node to insert before (if null the node is appended)",
725 "desc" : "The inserted node"
731 "desc" : "Returns the child node at the specified index.",
733 "isConstructor" : false,
735 "memberOf" : "Roo.data.Node",
757 "name" : "getOwnerTree",
758 "desc" : "Returns the tree this node is in.",
760 "isConstructor" : false,
762 "memberOf" : "Roo.data.Node",
777 "name" : "appendChild",
778 "desc" : "Insert node(s) as the last child node of this node.",
780 "isConstructor" : false,
782 "memberOf" : "Roo.data.Node",
790 "type" : "Node/Array",
791 "desc" : "The node or Array of nodes to append",
799 "desc" : "The appended node if single append, or null if an array was passed"
804 "name" : "findChildBy",
805 "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.",
807 "isConstructor" : false,
809 "memberOf" : "Roo.data.Node",
824 "desc" : "(optional)",
832 "desc" : "The found child or null if none was found"
837 "name" : "replaceChild",
838 "desc" : "Replaces one child node in this node with another.",
840 "isConstructor" : false,
842 "memberOf" : "Roo.data.Node",
851 "desc" : "The replacement node",
857 "desc" : "The node to replace",
865 "desc" : "The replaced node"
871 "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.",
873 "isConstructor" : false,
875 "memberOf" : "Roo.data.Node",
884 "desc" : "The function to call",
890 "desc" : "(optional) The scope of the function (defaults to current node)",
896 "desc" : "(optional) The args to call the function with (default to passing the current node)",
903 "name" : "eachChild",
904 "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.",
906 "isConstructor" : false,
908 "memberOf" : "Roo.data.Node",
917 "desc" : "The function to call",
923 "desc" : "(optional) The scope of the function (defaults to current node)",
929 "desc" : "(optional) The args to call the function with (default to passing the current node)",
936 "name" : "findChild",
937 "desc" : "Finds the first child that has the attribute with the specified value.",
939 "isConstructor" : false,
941 "memberOf" : "Roo.data.Node",
948 "name" : "attribute",
950 "desc" : "The attribute name",
956 "desc" : "The value to search for",
964 "desc" : "The found child or null if none was found"
969 "name" : "purgeListeners",
970 "desc" : "Removes all listeners for this object",
972 "isConstructor" : false,
974 "memberOf" : "Roo.util.Observable",
984 "desc" : "Appends an event handler to this element (shorthand for addListener)",
986 "isConstructor" : false,
988 "memberOf" : "Roo.util.Observable",
995 "name" : "eventName",
997 "desc" : "The type of event to listen for",
1002 "type" : "Function",
1003 "desc" : "The method the event invokes",
1004 "isOptional" : false
1009 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1010 "isOptional" : false
1015 "desc" : "(optional)",
1016 "isOptional" : false
1023 "desc" : "Removes a listener (shorthand for removeListener)",
1025 "isConstructor" : false,
1026 "isPrivate" : false,
1027 "memberOf" : "Roo.util.Observable",
1034 "name" : "eventName",
1036 "desc" : "The type of event to listen for",
1037 "isOptional" : false
1041 "type" : "Function",
1042 "desc" : "The handler to remove",
1043 "isOptional" : false
1048 "desc" : "(optional) The scope (this object) for the handler",
1049 "isOptional" : false
1055 "name" : "addEvents",
1056 "desc" : "Used to define events on this Observable",
1058 "isConstructor" : false,
1059 "isPrivate" : false,
1060 "memberOf" : "Roo.util.Observable",
1069 "desc" : "The object with the events defined",
1070 "isOptional" : false
1076 "name" : "releaseCapture",
1077 "desc" : "Removes <b>all</b> added captures from the Observable.",
1079 "isConstructor" : false,
1080 "isPrivate" : false,
1081 "memberOf" : "Roo.util.Observable",
1089 "type" : "Observable",
1090 "desc" : "The Observable to release",
1091 "isOptional" : false
1097 "name" : "removeListener",
1098 "desc" : "Removes a listener",
1100 "isConstructor" : false,
1101 "isPrivate" : false,
1102 "memberOf" : "Roo.util.Observable",
1109 "name" : "eventName",
1111 "desc" : "The type of event to listen for",
1112 "isOptional" : false
1116 "type" : "Function",
1117 "desc" : "The handler to remove",
1118 "isOptional" : false
1123 "desc" : "(optional) The scope (this object) for the handler",
1124 "isOptional" : false
1130 "name" : "fireEvent",
1131 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1133 "isConstructor" : false,
1134 "isPrivate" : false,
1135 "memberOf" : "Roo.util.Observable",
1142 "name" : "eventName",
1145 "isOptional" : false
1149 "type" : "Object...",
1150 "desc" : "Variable number of parameters are passed to handlers",
1151 "isOptional" : false
1158 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1163 "name" : "hasListener",
1164 "desc" : "Checks to see if this object has any listeners for a specified event",
1166 "isConstructor" : false,
1167 "isPrivate" : false,
1168 "memberOf" : "Roo.util.Observable",
1175 "name" : "eventName",
1177 "desc" : "The name of the event to check for",
1178 "isOptional" : false
1185 "desc" : "True if the event is being listened for, else false"
1191 "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.",
1193 "isConstructor" : false,
1194 "isPrivate" : false,
1195 "memberOf" : "Roo.util.Observable",
1203 "type" : "Observable",
1204 "desc" : "The Observable to capture",
1205 "isOptional" : false
1209 "type" : "Function",
1210 "desc" : "The function to call",
1211 "isOptional" : false
1216 "desc" : "(optional) The scope (this object) for the fn",
1217 "isOptional" : false
1223 "name" : "addListener",
1224 "desc" : "Appends an event handler to this component",
1226 "isConstructor" : false,
1227 "isPrivate" : false,
1228 "memberOf" : "Roo.util.Observable",
1235 "name" : "eventName",
1237 "desc" : "The type of event to listen for",
1238 "isOptional" : false
1242 "type" : "Function",
1243 "desc" : "The method the event invokes",
1244 "isOptional" : false
1249 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1250 "isOptional" : false
1255 "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>",
1256 "isOptional" : false
1264 "name" : "beforecollapse",
1265 "desc" : "Fires before this node is collapsed, return false to cancel.",
1266 "memberOf" : "Roo.tree.TreeNode",
1275 "desc" : "This node",
1276 "isOptional" : false
1282 "isOptional" : false
1288 "isOptional" : false
1294 "name" : "dblclick",
1295 "desc" : "Fires when this node is double clicked",
1296 "memberOf" : "Roo.tree.TreeNode",
1305 "desc" : "This node",
1306 "isOptional" : false
1310 "type" : "Roo.EventObject",
1311 "desc" : "The event object",
1312 "isOptional" : false
1318 "name" : "disabledchange",
1319 "desc" : "Fires when the disabled status of this node changes",
1320 "memberOf" : "Roo.tree.TreeNode",
1329 "desc" : "This node",
1330 "isOptional" : false
1333 "name" : "disabled",
1336 "isOptional" : false
1342 "name" : "beforechildrenrendered",
1343 "desc" : "Fires right before the child nodes for this node are rendered",
1344 "memberOf" : "Roo.tree.TreeNode",
1353 "desc" : "This node",
1354 "isOptional" : false
1360 "name" : "beforeclick",
1361 "desc" : "Fires before click processing. Return false to cancel the default action.",
1362 "memberOf" : "Roo.tree.TreeNode",
1371 "desc" : "This node",
1372 "isOptional" : false
1376 "type" : "Roo.EventObject",
1377 "desc" : "The event object",
1378 "isOptional" : false
1384 "name" : "checkchange",
1385 "desc" : "Fires when a node with a checkbox's checked property changes",
1386 "memberOf" : "Roo.tree.TreeNode",
1395 "desc" : "This node",
1396 "isOptional" : false
1402 "isOptional" : false
1408 "name" : "collapse",
1409 "desc" : "Fires when this node is collapsed",
1410 "memberOf" : "Roo.tree.TreeNode",
1419 "desc" : "This node",
1420 "isOptional" : false
1426 "name" : "textchange",
1427 "desc" : "Fires when the text for this node is changed",
1428 "memberOf" : "Roo.tree.TreeNode",
1437 "desc" : "This node",
1438 "isOptional" : false
1443 "desc" : "The new text",
1444 "isOptional" : false
1449 "desc" : "The old text",
1450 "isOptional" : false
1456 "name" : "beforeexpand",
1457 "desc" : "Fires before this node is expanded, return false to cancel.",
1458 "memberOf" : "Roo.tree.TreeNode",
1467 "desc" : "This node",
1468 "isOptional" : false
1474 "isOptional" : false
1480 "isOptional" : false
1487 "desc" : "Fires when this node is clicked",
1488 "memberOf" : "Roo.tree.TreeNode",
1497 "desc" : "This node",
1498 "isOptional" : false
1502 "type" : "Roo.EventObject",
1503 "desc" : "The event object",
1504 "isOptional" : false
1510 "name" : "contextmenu",
1511 "desc" : "Fires when this node is right clicked",
1512 "memberOf" : "Roo.tree.TreeNode",
1521 "desc" : "This node",
1522 "isOptional" : false
1526 "type" : "Roo.EventObject",
1527 "desc" : "The event object",
1528 "isOptional" : false
1535 "desc" : "Fires when this node is expanded",
1536 "memberOf" : "Roo.tree.TreeNode",
1545 "desc" : "This node",
1546 "isOptional" : false
1552 "name" : "beforeappend",
1553 "desc" : "Fires before a new child is appended, return false to cancel the append.",
1554 "memberOf" : "Roo.data.Node",
1563 "desc" : "The owner tree",
1564 "isOptional" : false
1569 "desc" : "This node",
1570 "isOptional" : false
1575 "desc" : "The child node to be appended",
1576 "isOptional" : false
1583 "desc" : "Fires when this node is moved to a new location in the tree",
1584 "memberOf" : "Roo.data.Node",
1593 "desc" : "The owner tree",
1594 "isOptional" : false
1599 "desc" : "This node",
1600 "isOptional" : false
1603 "name" : "oldParent",
1605 "desc" : "The old parent of this node",
1606 "isOptional" : false
1609 "name" : "newParent",
1611 "desc" : "The new parent of this node",
1612 "isOptional" : false
1617 "desc" : "The index it was moved to",
1618 "isOptional" : false
1625 "desc" : "Fires when a new child node is appended",
1626 "memberOf" : "Roo.data.Node",
1635 "desc" : "The owner tree",
1636 "isOptional" : false
1641 "desc" : "This node",
1642 "isOptional" : false
1647 "desc" : "The newly appended node",
1648 "isOptional" : false
1653 "desc" : "The index of the newly appended node",
1654 "isOptional" : false
1660 "name" : "beforeremove",
1661 "desc" : "Fires before a child is removed, return false to cancel the remove.",
1662 "memberOf" : "Roo.data.Node",
1671 "desc" : "The owner tree",
1672 "isOptional" : false
1677 "desc" : "This node",
1678 "isOptional" : false
1683 "desc" : "The child node to be removed",
1684 "isOptional" : false
1691 "desc" : "Fires when a child node is removed",
1692 "memberOf" : "Roo.data.Node",
1701 "desc" : "The owner tree",
1702 "isOptional" : false
1707 "desc" : "This node",
1708 "isOptional" : false
1713 "desc" : "The removed node",
1714 "isOptional" : false
1720 "name" : "beforeinsert",
1721 "desc" : "Fires before a new child is inserted, return false to cancel the insert.",
1722 "memberOf" : "Roo.data.Node",
1731 "desc" : "The owner tree",
1732 "isOptional" : false
1737 "desc" : "This node",
1738 "isOptional" : false
1743 "desc" : "The child node to be inserted",
1744 "isOptional" : false
1749 "desc" : "The child node the node is being inserted before",
1750 "isOptional" : false
1757 "desc" : "Fires when a new child node is inserted.",
1758 "memberOf" : "Roo.data.Node",
1767 "desc" : "The owner tree",
1768 "isOptional" : false
1773 "desc" : "This node",
1774 "isOptional" : false
1779 "desc" : "The child node inserted",
1780 "isOptional" : false
1785 "desc" : "The child node the node was inserted before",
1786 "isOptional" : false
1792 "name" : "beforemove",
1793 "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.",
1794 "memberOf" : "Roo.data.Node",
1803 "desc" : "The owner tree",
1804 "isOptional" : false
1809 "desc" : "This node",
1810 "isOptional" : false
1813 "name" : "oldParent",
1815 "desc" : "The parent of this node",
1816 "isOptional" : false
1819 "name" : "newParent",
1821 "desc" : "The new parent this node is moving to",
1822 "isOptional" : false
1827 "desc" : "The index it is being moved to",
1828 "isOptional" : false