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",
30 "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>",
31 "memberOf" : "Roo.util.Observable",
36 "name" : "hrefTarget",
38 "desc" : "target frame for the link",
39 "memberOf" : "Roo.tree.TreeNode",
46 "desc" : "The id for this node. If one is not specified, one is generated.",
47 "memberOf" : "Roo.data.Node",
54 "desc" : "The text for this node",
55 "memberOf" : "Roo.tree.TreeNode",
60 "name" : "uiProvider",
62 "desc" : "A UI <b>class</b> to use for this node (defaults to Roo.tree.TreeNodeUI)",
63 "memberOf" : "Roo.tree.TreeNode",
70 "desc" : "true to start the node expanded",
71 "memberOf" : "Roo.tree.TreeNode",
78 "desc" : "An Ext QuickTip config for the node (used instead of qtip)",
79 "memberOf" : "Roo.tree.TreeNode",
86 "desc" : "false if this node cannot be drop on",
87 "memberOf" : "Roo.tree.TreeNode",
94 "desc" : "true to start the node disabled",
95 "memberOf" : "Roo.tree.TreeNode",
102 "desc" : "A css class to be added to the node",
103 "memberOf" : "Roo.tree.TreeNode",
110 "desc" : "A css class to be added to the nodes icon element for applying css background images",
111 "memberOf" : "Roo.tree.TreeNode",
116 "name" : "allowDrag",
118 "desc" : "false to make this node undraggable if DD is on (defaults to true)",
119 "memberOf" : "Roo.tree.TreeNode",
126 "desc" : "The path to an icon for the node. The preferred way to do this",
127 "memberOf" : "Roo.tree.TreeNode",
132 "name" : "singleClickExpand",
134 "desc" : "True for single click expand on this node",
135 "memberOf" : "Roo.tree.TreeNode",
142 "desc" : "An Ext QuickTip for the node",
143 "memberOf" : "Roo.tree.TreeNode",
150 "desc" : "True to render a checked checkbox for this node, false to render an unchecked checkbox\n(defaults to undefined with no checkbox rendered)",
151 "memberOf" : "Roo.tree.TreeNode",
158 "desc" : "URL of the link used for the node (defaults to #)",
159 "memberOf" : "Roo.tree.TreeNode",
166 "desc" : "true if this node is a leaf and does not have children",
167 "memberOf" : "Roo.data.Node",
175 "desc" : "Triggers selection of this node",
177 "isConstructor" : false,
179 "memberOf" : "Roo.tree.TreeNode",
191 "desc" : "Enables this node",
193 "isConstructor" : false,
195 "memberOf" : "Roo.tree.TreeNode",
206 "name" : "collapseChildNodes",
207 "desc" : "Collapse all child nodes",
209 "isConstructor" : false,
211 "memberOf" : "Roo.tree.TreeNode",
220 "desc" : "(optional) true if the child nodes should also collapse their child nodes",
228 "name" : "ensureVisible",
229 "desc" : "Ensures all parent nodes are expanded",
231 "isConstructor" : false,
233 "memberOf" : "Roo.tree.TreeNode",
244 "name" : "isSelected",
245 "desc" : "Returns true if this node is selected",
247 "isConstructor" : false,
249 "memberOf" : "Roo.tree.TreeNode",
266 "desc" : "Disables this node",
268 "isConstructor" : false,
270 "memberOf" : "Roo.tree.TreeNode",
282 "desc" : "Returns the UI object for this node",
284 "isConstructor" : false,
286 "memberOf" : "Roo.tree.TreeNode",
296 "type" : "TreeNodeUI",
303 "desc" : "Sets the text for this node",
305 "isConstructor" : false,
307 "memberOf" : "Roo.tree.TreeNode",
325 "desc" : "Toggles expanded/collapsed state of the node",
327 "isConstructor" : false,
329 "memberOf" : "Roo.tree.TreeNode",
341 "desc" : "Triggers deselection of this node",
343 "isConstructor" : false,
345 "memberOf" : "Roo.tree.TreeNode",
356 "name" : "isExpanded",
357 "desc" : "Returns true if this node is expanded",
359 "isConstructor" : false,
361 "memberOf" : "Roo.tree.TreeNode",
377 "name" : "expandChildNodes",
378 "desc" : "Expand all child nodes",
380 "isConstructor" : false,
382 "memberOf" : "Roo.tree.TreeNode",
391 "desc" : "(optional) true if the child nodes should also expand their child nodes",
400 "desc" : "Expand this node.",
402 "isConstructor" : false,
404 "memberOf" : "Roo.tree.TreeNode",
413 "desc" : "(optional) True to expand all children as well",
419 "desc" : "(optional) false to cancel the default animation",
425 "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.",
434 "desc" : "Collapse this node.",
436 "isConstructor" : false,
438 "memberOf" : "Roo.tree.TreeNode",
447 "desc" : "(optional) True to collapse all children as well",
453 "desc" : "(optional) false to cancel the default animation",
462 "desc" : "Sorts this nodes children using the supplied sort function",
464 "isConstructor" : false,
466 "memberOf" : "Roo.data.Node",
481 "desc" : "(optional)",
489 "name" : "removeChild",
490 "desc" : "Removes a child node from this node.",
492 "isConstructor" : false,
494 "memberOf" : "Roo.data.Node",
503 "desc" : "The node to remove",
511 "desc" : "The removed node"
516 "name" : "isAncestor",
517 "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
519 "isConstructor" : false,
521 "memberOf" : "Roo.data.Node",
544 "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
546 "isConstructor" : false,
548 "memberOf" : "Roo.data.Node",
571 "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.",
573 "isConstructor" : false,
575 "memberOf" : "Roo.data.Node",
584 "desc" : "The function to call",
590 "desc" : "(optional) The scope of the function (defaults to current node)",
596 "desc" : "(optional) The args to call the function with (default to passing the current node)",
605 "desc" : "Returns depth of this node (the root node has a depth of 0)",
607 "isConstructor" : false,
609 "memberOf" : "Roo.data.Node",
626 "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.",
628 "isConstructor" : false,
630 "memberOf" : "Roo.data.Node",
639 "desc" : "(optional) The attr to use for the path (defaults to the node's id)",
653 "desc" : "Returns the index of a child node",
655 "isConstructor" : false,
657 "memberOf" : "Roo.data.Node",
674 "desc" : "The index of the node or -1 if it was not found"
680 "desc" : "Returns true if this node is the first child of its parent",
682 "isConstructor" : false,
684 "memberOf" : "Roo.data.Node",
701 "desc" : "Returns true if this node is the last child of its parent",
703 "isConstructor" : false,
705 "memberOf" : "Roo.data.Node",
722 "desc" : "Returns true if this node is a leaf",
724 "isConstructor" : false,
726 "memberOf" : "Roo.data.Node",
742 "name" : "insertBefore",
743 "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
745 "isConstructor" : false,
747 "memberOf" : "Roo.data.Node",
756 "desc" : "The node to insert",
762 "desc" : "The node to insert before (if null the node is appended)",
770 "desc" : "The inserted node"
776 "desc" : "Returns the child node at the specified index.",
778 "isConstructor" : false,
780 "memberOf" : "Roo.data.Node",
802 "name" : "getOwnerTree",
803 "desc" : "Returns the tree this node is in.",
805 "isConstructor" : false,
807 "memberOf" : "Roo.data.Node",
823 "name" : "appendChild",
824 "desc" : "Insert node(s) as the last child node of this node.",
826 "isConstructor" : false,
828 "memberOf" : "Roo.data.Node",
836 "type" : "Node/Array",
837 "desc" : "The node or Array of nodes to append",
845 "desc" : "The appended node if single append, or null if an array was passed"
850 "name" : "findChildBy",
851 "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.",
853 "isConstructor" : false,
855 "memberOf" : "Roo.data.Node",
870 "desc" : "(optional)",
878 "desc" : "The found child or null if none was found"
883 "name" : "replaceChild",
884 "desc" : "Replaces one child node in this node with another.",
886 "isConstructor" : false,
888 "memberOf" : "Roo.data.Node",
897 "desc" : "The replacement node",
903 "desc" : "The node to replace",
911 "desc" : "The replaced node"
917 "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.",
919 "isConstructor" : false,
921 "memberOf" : "Roo.data.Node",
930 "desc" : "The function to call",
936 "desc" : "(optional) The scope of the function (defaults to current node)",
942 "desc" : "(optional) The args to call the function with (default to passing the current node)",
950 "name" : "eachChild",
951 "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.",
953 "isConstructor" : false,
955 "memberOf" : "Roo.data.Node",
964 "desc" : "The function to call",
970 "desc" : "(optional) The scope of the function (defaults to current node)",
976 "desc" : "(optional) The args to call the function with (default to passing the current node)",
984 "name" : "findChild",
985 "desc" : "Finds the first child that has the attribute with the specified value.",
987 "isConstructor" : false,
989 "memberOf" : "Roo.data.Node",
996 "name" : "attribute",
998 "desc" : "The attribute name",
1004 "desc" : "The value to search for",
1005 "isOptional" : false
1012 "desc" : "The found child or null if none was found"
1017 "name" : "purgeListeners",
1018 "desc" : "Removes all listeners for this object",
1020 "isConstructor" : false,
1021 "isPrivate" : false,
1022 "memberOf" : "Roo.util.Observable",
1034 "desc" : "Appends an event handler to this element (shorthand for addListener)",
1036 "isConstructor" : false,
1037 "isPrivate" : false,
1038 "memberOf" : "Roo.util.Observable",
1045 "name" : "eventName",
1047 "desc" : "The type of event to listen for",
1048 "isOptional" : false
1052 "type" : "Function",
1053 "desc" : "The method the event invokes",
1054 "isOptional" : false
1059 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1060 "isOptional" : false
1065 "desc" : "(optional)",
1066 "isOptional" : false
1074 "desc" : "Removes a listener (shorthand for removeListener)",
1076 "isConstructor" : false,
1077 "isPrivate" : false,
1078 "memberOf" : "Roo.util.Observable",
1085 "name" : "eventName",
1087 "desc" : "The type of event to listen for",
1088 "isOptional" : false
1092 "type" : "Function",
1093 "desc" : "The handler to remove",
1094 "isOptional" : false
1099 "desc" : "(optional) The scope (this object) for the handler",
1100 "isOptional" : false
1107 "name" : "addEvents",
1108 "desc" : "Used to define events on this Observable",
1110 "isConstructor" : false,
1111 "isPrivate" : false,
1112 "memberOf" : "Roo.util.Observable",
1121 "desc" : "The object with the events defined",
1122 "isOptional" : false
1129 "name" : "releaseCapture",
1130 "desc" : "Removes <b>all</b> added captures from the Observable.",
1132 "isConstructor" : false,
1133 "isPrivate" : false,
1134 "memberOf" : "Roo.util.Observable",
1142 "type" : "Observable",
1143 "desc" : "The Observable to release",
1144 "isOptional" : false
1151 "name" : "removeListener",
1152 "desc" : "Removes a listener",
1154 "isConstructor" : false,
1155 "isPrivate" : false,
1156 "memberOf" : "Roo.util.Observable",
1163 "name" : "eventName",
1165 "desc" : "The type of event to listen for",
1166 "isOptional" : false
1170 "type" : "Function",
1171 "desc" : "The handler to remove",
1172 "isOptional" : false
1177 "desc" : "(optional) The scope (this object) for the handler",
1178 "isOptional" : false
1185 "name" : "fireEvent",
1186 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1188 "isConstructor" : false,
1189 "isPrivate" : false,
1190 "memberOf" : "Roo.util.Observable",
1197 "name" : "eventName",
1200 "isOptional" : false
1204 "type" : "Object...",
1205 "desc" : "Variable number of parameters are passed to handlers",
1206 "isOptional" : false
1213 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1218 "name" : "hasListener",
1219 "desc" : "Checks to see if this object has any listeners for a specified event",
1221 "isConstructor" : false,
1222 "isPrivate" : false,
1223 "memberOf" : "Roo.util.Observable",
1230 "name" : "eventName",
1232 "desc" : "The name of the event to check for",
1233 "isOptional" : false
1240 "desc" : "True if the event is being listened for, else false"
1246 "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.",
1248 "isConstructor" : false,
1249 "isPrivate" : false,
1250 "memberOf" : "Roo.util.Observable",
1258 "type" : "Observable",
1259 "desc" : "The Observable to capture",
1260 "isOptional" : false
1264 "type" : "Function",
1265 "desc" : "The function to call",
1266 "isOptional" : false
1271 "desc" : "(optional) The scope (this object) for the fn",
1272 "isOptional" : false
1279 "name" : "addListener",
1280 "desc" : "Appends an event handler to this component",
1282 "isConstructor" : false,
1283 "isPrivate" : false,
1284 "memberOf" : "Roo.util.Observable",
1291 "name" : "eventName",
1293 "desc" : "The type of event to listen for",
1294 "isOptional" : false
1298 "type" : "Function",
1299 "desc" : "The method the event invokes",
1300 "isOptional" : false
1305 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1306 "isOptional" : false
1311 "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>",
1312 "isOptional" : false
1321 "name" : "beforecollapse",
1322 "desc" : "Fires before this node is collapsed, return false to cancel.",
1323 "memberOf" : "Roo.tree.TreeNode",
1332 "desc" : "This node",
1333 "isOptional" : false
1339 "isOptional" : false
1345 "isOptional" : false
1352 "name" : "dblclick",
1353 "desc" : "Fires when this node is double clicked",
1354 "memberOf" : "Roo.tree.TreeNode",
1363 "desc" : "This node",
1364 "isOptional" : false
1368 "type" : "Roo.EventObject",
1369 "desc" : "The event object",
1370 "isOptional" : false
1377 "name" : "disabledchange",
1378 "desc" : "Fires when the disabled status of this node changes",
1379 "memberOf" : "Roo.tree.TreeNode",
1388 "desc" : "This node",
1389 "isOptional" : false
1392 "name" : "disabled",
1395 "isOptional" : false
1402 "name" : "beforechildrenrendered",
1403 "desc" : "Fires right before the child nodes for this node are rendered",
1404 "memberOf" : "Roo.tree.TreeNode",
1413 "desc" : "This node",
1414 "isOptional" : false
1421 "name" : "beforeclick",
1422 "desc" : "Fires before click processing. Return false to cancel the default action.",
1423 "memberOf" : "Roo.tree.TreeNode",
1432 "desc" : "This node",
1433 "isOptional" : false
1437 "type" : "Roo.EventObject",
1438 "desc" : "The event object",
1439 "isOptional" : false
1446 "name" : "checkchange",
1447 "desc" : "Fires when a node with a checkbox's checked property changes",
1448 "memberOf" : "Roo.tree.TreeNode",
1457 "desc" : "This node",
1458 "isOptional" : false
1464 "isOptional" : false
1471 "name" : "collapse",
1472 "desc" : "Fires when this node is collapsed",
1473 "memberOf" : "Roo.tree.TreeNode",
1482 "desc" : "This node",
1483 "isOptional" : false
1490 "name" : "textchange",
1491 "desc" : "Fires when the text for this node is changed",
1492 "memberOf" : "Roo.tree.TreeNode",
1501 "desc" : "This node",
1502 "isOptional" : false
1507 "desc" : "The new text",
1508 "isOptional" : false
1513 "desc" : "The old text",
1514 "isOptional" : false
1521 "name" : "beforeexpand",
1522 "desc" : "Fires before this node is expanded, return false to cancel.",
1523 "memberOf" : "Roo.tree.TreeNode",
1532 "desc" : "This node",
1533 "isOptional" : false
1539 "isOptional" : false
1545 "isOptional" : false
1553 "desc" : "Fires when this node is clicked",
1554 "memberOf" : "Roo.tree.TreeNode",
1563 "desc" : "This node",
1564 "isOptional" : false
1568 "type" : "Roo.EventObject",
1569 "desc" : "The event object",
1570 "isOptional" : false
1577 "name" : "contextmenu",
1578 "desc" : "Fires when this node is right clicked",
1579 "memberOf" : "Roo.tree.TreeNode",
1588 "desc" : "This node",
1589 "isOptional" : false
1593 "type" : "Roo.EventObject",
1594 "desc" : "The event object",
1595 "isOptional" : false
1603 "desc" : "Fires when this node is expanded",
1604 "memberOf" : "Roo.tree.TreeNode",
1613 "desc" : "This node",
1614 "isOptional" : false
1621 "name" : "beforeappend",
1622 "desc" : "Fires before a new child is appended, return false to cancel the append.",
1623 "memberOf" : "Roo.data.Node",
1632 "desc" : "The owner tree",
1633 "isOptional" : false
1638 "desc" : "This node",
1639 "isOptional" : false
1644 "desc" : "The child node to be appended",
1645 "isOptional" : false
1653 "desc" : "Fires when this node is moved to a new location in the tree",
1654 "memberOf" : "Roo.data.Node",
1663 "desc" : "The owner tree",
1664 "isOptional" : false
1669 "desc" : "This node",
1670 "isOptional" : false
1673 "name" : "oldParent",
1675 "desc" : "The old parent of this node",
1676 "isOptional" : false
1679 "name" : "newParent",
1681 "desc" : "The new parent of this node",
1682 "isOptional" : false
1687 "desc" : "The index it was moved to",
1688 "isOptional" : false
1696 "desc" : "Fires when a new child node is appended",
1697 "memberOf" : "Roo.data.Node",
1706 "desc" : "The owner tree",
1707 "isOptional" : false
1712 "desc" : "This node",
1713 "isOptional" : false
1718 "desc" : "The newly appended node",
1719 "isOptional" : false
1724 "desc" : "The index of the newly appended node",
1725 "isOptional" : false
1732 "name" : "beforeremove",
1733 "desc" : "Fires before a child is removed, return false to cancel the remove.",
1734 "memberOf" : "Roo.data.Node",
1743 "desc" : "The owner tree",
1744 "isOptional" : false
1749 "desc" : "This node",
1750 "isOptional" : false
1755 "desc" : "The child node to be removed",
1756 "isOptional" : false
1764 "desc" : "Fires when a child node is removed",
1765 "memberOf" : "Roo.data.Node",
1774 "desc" : "The owner tree",
1775 "isOptional" : false
1780 "desc" : "This node",
1781 "isOptional" : false
1786 "desc" : "The removed node",
1787 "isOptional" : false
1794 "name" : "beforeinsert",
1795 "desc" : "Fires before a new child is inserted, return false to cancel the insert.",
1796 "memberOf" : "Roo.data.Node",
1805 "desc" : "The owner tree",
1806 "isOptional" : false
1811 "desc" : "This node",
1812 "isOptional" : false
1817 "desc" : "The child node to be inserted",
1818 "isOptional" : false
1823 "desc" : "The child node the node is being inserted before",
1824 "isOptional" : false
1832 "desc" : "Fires when a new child node is inserted.",
1833 "memberOf" : "Roo.data.Node",
1842 "desc" : "The owner tree",
1843 "isOptional" : false
1848 "desc" : "This node",
1849 "isOptional" : false
1854 "desc" : "The child node inserted",
1855 "isOptional" : false
1860 "desc" : "The child node the node was inserted before",
1861 "isOptional" : false
1868 "name" : "beforemove",
1869 "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.",
1870 "memberOf" : "Roo.data.Node",
1879 "desc" : "The owner tree",
1880 "isOptional" : false
1885 "desc" : "This node",
1886 "isOptional" : false
1889 "name" : "oldParent",
1891 "desc" : "The parent of this node",
1892 "isOptional" : false
1895 "name" : "newParent",
1897 "desc" : "The new parent this node is moving to",
1898 "isOptional" : false
1903 "desc" : "The index it is being moved to",
1904 "isOptional" : false