2 "name" : "Roo.tree.TreePanel",
8 "Roo.tree.TreePanel" : [
15 "isSingleton" : false,
19 "isBuilderTop" : false,
20 "memberOf" : "TreePanel",
28 "type" : "String/HTMLElement/Element",
29 "desc" : "The container element",
45 "type" : "Roo.tree.TreeEditor",
46 "desc" : "The TreeEditor to display when clicked.",
54 "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>",
55 "memberOf" : "Roo.util.Observable",
60 "name" : "singleExpand",
62 "desc" : "true if only 1 node per branch may be expanded",
69 "type" : "Roo.tree.TreeNode",
70 "desc" : "The root node",
76 "name" : "ddAppendOnly",
78 "desc" : "True if the tree should only allow append drops (use for trees which are sorted)",
84 "name" : "dragConfig",
86 "desc" : "Custom config to pass to the {@link Roo.tree.TreeDragZone} instance",
92 "name" : "enableDrop",
94 "desc" : "true to enable just drop",
102 "desc" : "The color of the node highlight (defaults to C3DAF9)",
104 "isOptional" : false,
108 "name" : "rendererTip",
110 "desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul>",
112 "isOptional" : false,
118 "desc" : "true to enable drag and drop",
120 "isOptional" : false,
126 "desc" : "false to disable node highlight on drop (defaults to the value of Roo.enableFx)",
128 "isOptional" : false,
134 "desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes. to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul>",
136 "isOptional" : false,
140 "name" : "rootVisible",
142 "desc" : "false to hide the root node (defaults to true)",
144 "isOptional" : false,
148 "name" : "enableDrag",
150 "desc" : "true to enable just drag",
152 "isOptional" : false,
158 "desc" : "The DD group this TreePanel belongs to",
160 "isOptional" : false,
166 "desc" : "false to disable tree lines (defaults to true)",
168 "isOptional" : false,
172 "name" : "dropConfig",
174 "desc" : "Custom config to pass to the {@link Roo.tree.TreeDropZone} instance",
176 "isOptional" : false,
182 "desc" : "A tree selection model to use with this TreePanel (defaults to a {@link Roo.tree.DefaultSelectionModel})",
184 "isOptional" : false,
189 "type" : "Roo.tree.TreeLoader",
190 "desc" : "A TreeLoader for use with this TreePanel",
192 "isOptional" : false,
196 "name" : "containerScroll",
198 "desc" : "true to register this container with ScrollManager",
200 "isOptional" : false,
206 "desc" : "true to enable YUI body scrolling",
208 "isOptional" : false,
214 "desc" : "true to enable animated expand/collapse (defaults to the value of Roo.enableFx)",
216 "isOptional" : false,
220 "name" : "pathSeparator",
222 "desc" : "The token used to separate sub-paths in path strings (defaults to '/')",
224 "isOptional" : false,
230 "name" : "getLoader",
232 "desc" : "Returns the default TreeLoader for this TreePanel",
233 "sig" : "()\n{\n\n}",
237 "isConstructor" : false,
251 "desc" : "Trigger rendering of this TreePanel",
252 "sig" : "()\n{\n\n}",
256 "isConstructor" : false,
268 "name" : "getSelectionModel",
270 "desc" : "Returns the selection model used by this TreePanel",
271 "sig" : "()\n{\n\n}",
275 "isConstructor" : false,
287 "name" : "expandPath",
289 "desc" : "Expands a specified path in this TreePanel. A path can be retrieved from a node with {@link Roo.data.Node#getPath}",
290 "sig" : "(path, attr, callback)",
294 "isConstructor" : false,
312 "desc" : "(optional) The attribute used in the path (see {@link Roo.data.Node#getPath} for more info)",
318 "desc" : "(optional) The callback to call when the expand is complete. The callback will be called with\n(bSuccess, oLastNode) where bSuccess is if the expand was successful and oLastNode is the last node that was expanded.",
325 "name" : "expandAll",
327 "desc" : "Expand all nodes",
328 "sig" : "()\n{\n\n}",
332 "isConstructor" : false,
344 "name" : "getChecked",
346 "desc" : "Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. \"id\")",
347 "sig" : "(attribute, startNode)",
351 "isConstructor" : false,
361 "name" : "attribute",
363 "desc" : "(optional) Defaults to null (return the actual nodes)",
367 "name" : "startNode",
369 "desc" : "(optional) The node to start from, defaults to the root",
382 "name" : "selectPath",
384 "desc" : "Selects the node in this tree at the specified path. A path can be retrieved from a node with {@link Roo.data.Node#getPath}",
385 "sig" : "(path, attr, callback)",
389 "isConstructor" : false,
407 "desc" : "(optional) The attribute used in the path (see {@link Roo.data.Node#getPath} for more info)",
413 "desc" : "(optional) The callback to call when the selection is complete. The callback will be called with\n(bSuccess, oSelNode) where bSuccess is if the selection was successful and oSelNode is the selected node.",
422 "desc" : "Returns the container element for this TreePanel",
423 "sig" : "()\n{\n\n}",
427 "isConstructor" : false,
439 "name" : "collapseAll",
441 "desc" : "Collapse all nodes",
442 "sig" : "()\n{\n\n}",
446 "isConstructor" : false,
458 "name" : "setRootNode",
460 "desc" : "Sets the root node for this tree.",
463 "memberOf" : "Roo.data.Tree",
465 "isConstructor" : false,
490 "name" : "getRootNode",
492 "desc" : "Returns the root node for this tree.",
493 "sig" : "()\n{\n\n}",
495 "memberOf" : "Roo.data.Tree",
497 "isConstructor" : false,
515 "name" : "getNodeById",
517 "desc" : "Gets a node in this tree by its id.",
520 "memberOf" : "Roo.data.Tree",
522 "isConstructor" : false,
547 "name" : "purgeListeners",
549 "desc" : "Removes all listeners for this object",
550 "sig" : "()\n{\n\n}",
552 "memberOf" : "Roo.util.Observable",
554 "isConstructor" : false,
568 "desc" : "Appends an event handler to this element (shorthand for addListener)",
569 "sig" : "(eventName, handler, scope, options)",
571 "memberOf" : "Roo.util.Observable",
573 "isConstructor" : false,
583 "name" : "eventName",
585 "desc" : "The type of event to listen for",
591 "desc" : "The method the event invokes",
597 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
603 "desc" : "(optional)",
612 "desc" : "Removes a listener (shorthand for removeListener)",
613 "sig" : "(eventName, handler, scope)",
615 "memberOf" : "Roo.util.Observable",
617 "isConstructor" : false,
627 "name" : "eventName",
629 "desc" : "The type of event to listen for",
635 "desc" : "The handler to remove",
641 "desc" : "(optional) The scope (this object) for the handler",
648 "name" : "addEvents",
650 "desc" : "Used to define events on this Observable",
653 "memberOf" : "Roo.util.Observable",
655 "isConstructor" : false,
667 "desc" : "The object with the events defined",
674 "name" : "releaseCapture",
676 "desc" : "Removes <b>all</b> added captures from the Observable.",
679 "memberOf" : "Roo.util.Observable",
681 "isConstructor" : false,
692 "type" : "Observable",
693 "desc" : "The Observable to release",
700 "name" : "removeListener",
702 "desc" : "Removes a listener",
703 "sig" : "(eventName, handler, scope)",
705 "memberOf" : "Roo.util.Observable",
707 "isConstructor" : false,
717 "name" : "eventName",
719 "desc" : "The type of event to listen for",
725 "desc" : "The handler to remove",
731 "desc" : "(optional) The scope (this object) for the handler",
738 "name" : "fireEvent",
740 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
741 "sig" : "(eventName, args)",
743 "memberOf" : "Roo.util.Observable",
745 "isConstructor" : false,
755 "name" : "eventName",
762 "type" : "Object...",
763 "desc" : "Variable number of parameters are passed to handlers",
771 "desc" : "returns false if any of the handlers return false otherwise it returns true"
776 "name" : "hasListener",
778 "desc" : "Checks to see if this object has any listeners for a specified event",
779 "sig" : "(eventName)",
781 "memberOf" : "Roo.util.Observable",
783 "isConstructor" : false,
793 "name" : "eventName",
795 "desc" : "The name of the event to check for",
803 "desc" : "True if the event is being listened for, else false"
810 "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.",
811 "sig" : "(o, fn, scope)",
813 "memberOf" : "Roo.util.Observable",
815 "isConstructor" : false,
826 "type" : "Observable",
827 "desc" : "The Observable to capture",
833 "desc" : "The function to call",
839 "desc" : "(optional) The scope (this object) for the fn",
846 "name" : "addListener",
848 "desc" : "Appends an event handler to this component",
849 "sig" : "(eventName, handler, scope, options)",
851 "memberOf" : "Roo.util.Observable",
853 "isConstructor" : false,
863 "name" : "eventName",
865 "desc" : "The type of event to listen for",
871 "desc" : "The method the event invokes",
877 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
883 "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>",
894 "desc" : "Fires when a node is double clicked",
895 "sig" : "function (node, e)\n{\n\n}",
910 "type" : "Roo.EventObject",
911 "desc" : "The event object",
918 "name" : "contextmenu",
920 "desc" : "Fires when a node is right clicked",
921 "sig" : "function (node, e)\n{\n\n}",
936 "type" : "Roo.EventObject",
937 "desc" : "The event object",
944 "name" : "beforeclick",
946 "desc" : "Fires before click processing on a node. Return false to cancel the default action.",
947 "sig" : "function (node, e)\n{\n\n}",
962 "type" : "Roo.EventObject",
963 "desc" : "The event object",
970 "name" : "checkchange",
972 "desc" : "Fires when a node with a checkbox's checked property changes",
973 "sig" : "function (_self, checked)\n{\n\n}",
983 "desc" : "This node",
996 "name" : "nodedragover",
998 "desc" : "Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent\npassed to handlers has the following properties:<br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>tree - The TreePanel</li>\n<li>target - The node being targeted for the drop</li>\n<li>data - The drag data from the drag source</li>\n<li>point - The point of the drop - append, above or below</li>\n<li>source - The drag source</li>\n<li>rawEvent - Raw mouse event</li>\n<li>dropNode - Drop node(s) provided by the source.</li>\n<li>cancel - Set this to true to signal drop not allowed.</li>\n</ul>",
999 "sig" : "function (dragOverEvent)\n{\n\n}",
1007 "name" : "dragOverEvent",
1010 "isOptional" : false
1016 "name" : "beforeexpand",
1017 "type" : "function",
1018 "desc" : "Fires before a node is expanded, return false to cancel.",
1019 "sig" : "function (node, deep, anim)\n{\n\n}",
1029 "desc" : "The node",
1030 "isOptional" : false
1036 "isOptional" : false
1042 "isOptional" : false
1048 "name" : "collapse",
1049 "type" : "function",
1050 "desc" : "Fires when a node is collapsed",
1051 "sig" : "function (node)\n{\n\n}",
1061 "desc" : "The node",
1062 "isOptional" : false
1068 "name" : "beforenodedrop",
1069 "type" : "function",
1070 "desc" : "Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent\npassed to handlers has the following properties:<br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>tree - The TreePanel</li>\n<li>target - The node being targeted for the drop</li>\n<li>data - The drag data from the drag source</li>\n<li>point - The point of the drop - append, above or below</li>\n<li>source - The drag source</li>\n<li>rawEvent - Raw mouse event</li>\n<li>dropNode - Drop node(s) provided by the source <b>OR</b> you can supply node(s)\nto be inserted by setting them on this object.</li>\n<li>cancel - Set this to true to cancel the drop.</li>\n</ul>",
1071 "sig" : "function (dropEvent)\n{\n\n}",
1079 "name" : "dropEvent",
1082 "isOptional" : false
1088 "name" : "beforechildrenrendered",
1089 "type" : "function",
1090 "desc" : "Fires right before the child nodes for a node are rendered",
1091 "sig" : "function (node)\n{\n\n}",
1101 "desc" : "The node",
1102 "isOptional" : false
1108 "name" : "textchange",
1109 "type" : "function",
1110 "desc" : "Fires when the text for a node is changed",
1111 "sig" : "function (node, text, oldText)\n{\n\n}",
1121 "desc" : "The node",
1122 "isOptional" : false
1127 "desc" : "The new text",
1128 "isOptional" : false
1133 "desc" : "The old text",
1134 "isOptional" : false
1141 "type" : "function",
1142 "desc" : "Fires when a node is loaded",
1143 "sig" : "function (node)\n{\n\n}",
1153 "desc" : "The node that was loaded",
1154 "isOptional" : false
1160 "name" : "appendnode",
1161 "type" : "function",
1162 "desc" : "Fires when append node to the tree",
1163 "sig" : "function (_self, node, index)\n{\n\n}",
1172 "type" : "Roo.tree.TreePanel",
1174 "isOptional" : false
1178 "type" : "Roo.tree.TreeNode",
1180 "isOptional" : false
1185 "desc" : "The index of the newly appended node",
1186 "isOptional" : false
1192 "name" : "startdrag",
1193 "type" : "function",
1194 "desc" : "Fires when a node starts being dragged",
1195 "sig" : "function (_self, node, e)\n{\n\n}",
1204 "type" : "Roo.tree.TreePanel",
1206 "isOptional" : false
1210 "type" : "Roo.tree.TreeNode",
1212 "isOptional" : false
1217 "desc" : "The raw browser event",
1218 "isOptional" : false
1225 "type" : "function",
1226 "desc" : "Fires when a node is clicked",
1227 "sig" : "function (node, e)\n{\n\n}",
1237 "desc" : "The node",
1238 "isOptional" : false
1242 "type" : "Roo.EventObject",
1243 "desc" : "The event object",
1244 "isOptional" : false
1251 "type" : "function",
1252 "desc" : "Fires when a node is expanded",
1253 "sig" : "function (node)\n{\n\n}",
1263 "desc" : "The node",
1264 "isOptional" : false
1271 "type" : "function",
1272 "desc" : "Fires when a drag operation is complete",
1273 "sig" : "function (_self, node, e)\n{\n\n}",
1282 "type" : "Roo.tree.TreePanel",
1284 "isOptional" : false
1288 "type" : "Roo.tree.TreeNode",
1290 "isOptional" : false
1295 "desc" : "The raw browser event",
1296 "isOptional" : false
1302 "name" : "nodedrop",
1303 "type" : "function",
1304 "desc" : "Fires after a DD object is dropped on a node in this tree. The dropEvent\npassed to handlers has the following properties:<br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>tree - The TreePanel</li>\n<li>target - The node being targeted for the drop</li>\n<li>data - The drag data from the drag source</li>\n<li>point - The point of the drop - append, above or below</li>\n<li>source - The drag source</li>\n<li>rawEvent - Raw mouse event</li>\n<li>dropNode - Dropped node(s).</li>\n</ul>",
1305 "sig" : "function (dropEvent)\n{\n\n}",
1313 "name" : "dropEvent",
1316 "isOptional" : false
1322 "name" : "dragdrop",
1323 "type" : "function",
1324 "desc" : "Fires when a dragged node is dropped on a valid DD target",
1325 "sig" : "function (_self, node, dd, e)\n{\n\n}",
1334 "type" : "Roo.tree.TreePanel",
1336 "isOptional" : false
1340 "type" : "Roo.tree.TreeNode",
1342 "isOptional" : false
1347 "desc" : "The dd it was dropped on",
1348 "isOptional" : false
1353 "desc" : "The raw browser event",
1354 "isOptional" : false
1360 "name" : "beforecollapse",
1361 "type" : "function",
1362 "desc" : "Fires before a node is collapsed, return false to cancel.",
1363 "sig" : "function (node, deep, anim)\n{\n\n}",
1373 "desc" : "The node",
1374 "isOptional" : false
1380 "isOptional" : false
1386 "isOptional" : false
1392 "name" : "disabledchange",
1393 "type" : "function",
1394 "desc" : "Fires when the disabled status of a node changes",
1395 "sig" : "function (node, disabled)\n{\n\n}",
1405 "desc" : "The node",
1406 "isOptional" : false
1409 "name" : "disabled",
1412 "isOptional" : false
1418 "name" : "beforeload",
1419 "type" : "function",
1420 "desc" : "Fires before a node is loaded, return false to cancel",
1421 "sig" : "function (node)\n{\n\n}",
1431 "desc" : "The node being loaded",
1432 "isOptional" : false
1439 "type" : "function",
1440 "desc" : "Fires when a new child node is appended to a node in this tree.",
1441 "sig" : "function (tree, parent, node, index)\n{\n\n}",
1442 "memberOf" : "Roo.data.Tree",
1451 "desc" : "The owner tree",
1452 "isOptional" : false
1457 "desc" : "The parent node",
1458 "isOptional" : false
1463 "desc" : "The newly appended node",
1464 "isOptional" : false
1469 "desc" : "The index of the newly appended node",
1470 "isOptional" : false
1476 "name" : "beforemove",
1477 "type" : "function",
1478 "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.",
1479 "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
1480 "memberOf" : "Roo.data.Tree",
1489 "desc" : "The owner tree",
1490 "isOptional" : false
1495 "desc" : "The node being moved",
1496 "isOptional" : false
1499 "name" : "oldParent",
1501 "desc" : "The parent of the node",
1502 "isOptional" : false
1505 "name" : "newParent",
1507 "desc" : "The new parent the node is moving to",
1508 "isOptional" : false
1513 "desc" : "The index it is being moved to",
1514 "isOptional" : false
1521 "type" : "function",
1522 "desc" : "Fires when a new child node is inserted in a node in this tree.",
1523 "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
1524 "memberOf" : "Roo.data.Tree",
1533 "desc" : "The owner tree",
1534 "isOptional" : false
1539 "desc" : "The parent node",
1540 "isOptional" : false
1545 "desc" : "The child node inserted",
1546 "isOptional" : false
1551 "desc" : "The child node the node was inserted before",
1552 "isOptional" : false
1558 "name" : "beforeappend",
1559 "type" : "function",
1560 "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.",
1561 "sig" : "function (tree, parent, node)\n{\n\n}",
1562 "memberOf" : "Roo.data.Tree",
1571 "desc" : "The owner tree",
1572 "isOptional" : false
1577 "desc" : "The parent node",
1578 "isOptional" : false
1583 "desc" : "The child node to be appended",
1584 "isOptional" : false
1591 "type" : "function",
1592 "desc" : "Fires when a node is moved to a new location in the tree",
1593 "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
1594 "memberOf" : "Roo.data.Tree",
1603 "desc" : "The owner tree",
1604 "isOptional" : false
1609 "desc" : "The node moved",
1610 "isOptional" : false
1613 "name" : "oldParent",
1615 "desc" : "The old parent of this node",
1616 "isOptional" : false
1619 "name" : "newParent",
1621 "desc" : "The new parent of this node",
1622 "isOptional" : false
1627 "desc" : "The index it was moved to",
1628 "isOptional" : false
1634 "name" : "beforeremove",
1635 "type" : "function",
1636 "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.",
1637 "sig" : "function (tree, parent, node)\n{\n\n}",
1638 "memberOf" : "Roo.data.Tree",
1647 "desc" : "The owner tree",
1648 "isOptional" : false
1653 "desc" : "The parent node",
1654 "isOptional" : false
1659 "desc" : "The child node to be removed",
1660 "isOptional" : false
1667 "type" : "function",
1668 "desc" : "Fires when a child node is removed from a node in this tree.",
1669 "sig" : "function (tree, parent, node)\n{\n\n}",
1670 "memberOf" : "Roo.data.Tree",
1679 "desc" : "The owner tree",
1680 "isOptional" : false
1685 "desc" : "The parent node",
1686 "isOptional" : false
1691 "desc" : "The child node removed",
1692 "isOptional" : false
1698 "name" : "beforeinsert",
1699 "type" : "function",
1700 "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.",
1701 "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
1702 "memberOf" : "Roo.data.Tree",
1711 "desc" : "The owner tree",
1712 "isOptional" : false
1717 "desc" : "The parent node",
1718 "isOptional" : false
1723 "desc" : "The child node to be inserted",
1724 "isOptional" : false
1729 "desc" : "The child node the node is being inserted before",
1730 "isOptional" : false