2 "name" : "Roo.tree.TreePanel",
14 "type" : "Object|Roo.tree.TreeEditor",
15 "desc" : "The TreeEditor or xtype data to display when clicked.",
16 "memberOf" : "Roo.tree.TreePanel",
23 "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>",
24 "memberOf" : "Roo.util.Observable",
29 "name" : "singleExpand",
31 "desc" : "true if only 1 node per branch may be expanded",
32 "memberOf" : "Roo.tree.TreePanel",
37 "name" : "ddAppendOnly",
39 "desc" : "True if the tree should only allow append drops (use for trees which are sorted)",
40 "memberOf" : "Roo.tree.TreePanel",
45 "name" : "dragConfig",
47 "desc" : "Custom config to pass to the {@link Roo.tree.TreeDragZone} instance",
48 "memberOf" : "Roo.tree.TreePanel",
53 "name" : "enableDrop",
55 "desc" : "true to enable just drop",
56 "memberOf" : "Roo.tree.TreePanel",
63 "desc" : "The color of the node highlight (defaults to C3DAF9)",
64 "memberOf" : "Roo.tree.TreePanel",
69 "name" : "rendererTip",
71 "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>",
72 "memberOf" : "Roo.tree.TreePanel",
79 "desc" : "true to enable drag and drop",
80 "memberOf" : "Roo.tree.TreePanel",
87 "desc" : "false to disable node highlight on drop (defaults to the value of Roo.enableFx)",
88 "memberOf" : "Roo.tree.TreePanel",
95 "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>",
96 "memberOf" : "Roo.tree.TreePanel",
101 "name" : "rootVisible",
103 "desc" : "false to hide the root node (defaults to true)",
104 "memberOf" : "Roo.tree.TreePanel",
109 "name" : "enableDrag",
111 "desc" : "true to enable just drag",
112 "memberOf" : "Roo.tree.TreePanel",
119 "desc" : "The DD group this TreePanel belongs to",
120 "memberOf" : "Roo.tree.TreePanel",
127 "desc" : "false to disable tree lines (defaults to true)",
128 "memberOf" : "Roo.tree.TreePanel",
133 "name" : "dropConfig",
135 "desc" : "Custom config to pass to the {@link Roo.tree.TreeDropZone} instance",
136 "memberOf" : "Roo.tree.TreePanel",
143 "desc" : "A tree selection model to use with this TreePanel (defaults to a {@link Roo.tree.DefaultSelectionModel})",
144 "memberOf" : "Roo.tree.TreePanel",
151 "desc" : "A TreeLoader for use with this TreePanel",
152 "memberOf" : "Roo.tree.TreePanel",
157 "name" : "containerScroll",
159 "desc" : "true to register this container with ScrollManager",
160 "memberOf" : "Roo.tree.TreePanel",
167 "desc" : "true to enable YUI body scrolling",
168 "memberOf" : "Roo.tree.TreePanel",
175 "desc" : "true to enable animated expand/collapse (defaults to the value of Roo.enableFx)",
176 "memberOf" : "Roo.tree.TreePanel",
181 "name" : "pathSeparator",
183 "desc" : "The token used to separate sub-paths in path strings (defaults to '/')",
184 "memberOf" : "Roo.tree.TreePanel",
191 "name" : "getLoader",
192 "desc" : "Returns the default TreeLoader for this TreePanel",
194 "isConstructor" : false,
196 "memberOf" : "Roo.tree.TreePanel",
208 "desc" : "Trigger rendering of this TreePanel",
210 "isConstructor" : false,
212 "memberOf" : "Roo.tree.TreePanel",
223 "name" : "getSelectionModel",
224 "desc" : "Returns the selection model used by this TreePanel",
226 "isConstructor" : false,
228 "memberOf" : "Roo.tree.TreePanel",
239 "name" : "expandPath",
240 "desc" : "Expands a specified path in this TreePanel. A path can be retrieved from a node with {@link Roo.data.Node#getPath}",
242 "isConstructor" : false,
244 "memberOf" : "Roo.tree.TreePanel",
259 "desc" : "(optional) The attribute used in the path (see {@link Roo.data.Node#getPath} for more info)",
265 "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.",
273 "name" : "expandAll",
274 "desc" : "Expand all nodes",
276 "isConstructor" : false,
278 "memberOf" : "Roo.tree.TreePanel",
289 "name" : "getChecked",
290 "desc" : "Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. \"id\")",
292 "isConstructor" : false,
294 "memberOf" : "Roo.tree.TreePanel",
301 "name" : "attribute",
303 "desc" : "(optional) Defaults to null (return the actual nodes)",
307 "name" : "startNode",
309 "desc" : "(optional) The node to start from, defaults to the root",
322 "name" : "selectPath",
323 "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}",
325 "isConstructor" : false,
327 "memberOf" : "Roo.tree.TreePanel",
342 "desc" : "(optional) The attribute used in the path (see {@link Roo.data.Node#getPath} for more info)",
348 "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.",
357 "desc" : "Returns the container element for this TreePanel",
359 "isConstructor" : false,
361 "memberOf" : "Roo.tree.TreePanel",
372 "name" : "collapseAll",
373 "desc" : "Collapse all nodes",
375 "isConstructor" : false,
377 "memberOf" : "Roo.tree.TreePanel",
388 "name" : "setRootNode",
389 "desc" : "Sets the root node for this tree.",
391 "isConstructor" : false,
393 "memberOf" : "Roo.data.Tree",
415 "name" : "getRootNode",
416 "desc" : "Returns the root node for this tree.",
418 "isConstructor" : false,
420 "memberOf" : "Roo.data.Tree",
436 "name" : "getNodeById",
437 "desc" : "Gets a node in this tree by its id.",
439 "isConstructor" : false,
441 "memberOf" : "Roo.data.Tree",
463 "name" : "purgeListeners",
464 "desc" : "Removes all listeners for this object",
466 "isConstructor" : false,
468 "memberOf" : "Roo.util.Observable",
480 "desc" : "Appends an event handler to this element (shorthand for addListener)",
482 "isConstructor" : false,
484 "memberOf" : "Roo.util.Observable",
491 "name" : "eventName",
493 "desc" : "The type of event to listen for",
499 "desc" : "The method the event invokes",
505 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
511 "desc" : "(optional)",
520 "desc" : "Removes a listener (shorthand for removeListener)",
522 "isConstructor" : false,
524 "memberOf" : "Roo.util.Observable",
531 "name" : "eventName",
533 "desc" : "The type of event to listen for",
539 "desc" : "The handler to remove",
545 "desc" : "(optional) The scope (this object) for the handler",
553 "name" : "addEvents",
554 "desc" : "Used to define events on this Observable",
556 "isConstructor" : false,
558 "memberOf" : "Roo.util.Observable",
567 "desc" : "The object with the events defined",
575 "name" : "releaseCapture",
576 "desc" : "Removes <b>all</b> added captures from the Observable.",
578 "isConstructor" : false,
580 "memberOf" : "Roo.util.Observable",
588 "type" : "Observable",
589 "desc" : "The Observable to release",
597 "name" : "removeListener",
598 "desc" : "Removes a listener",
600 "isConstructor" : false,
602 "memberOf" : "Roo.util.Observable",
609 "name" : "eventName",
611 "desc" : "The type of event to listen for",
617 "desc" : "The handler to remove",
623 "desc" : "(optional) The scope (this object) for the handler",
631 "name" : "fireEvent",
632 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
634 "isConstructor" : false,
636 "memberOf" : "Roo.util.Observable",
643 "name" : "eventName",
650 "type" : "Object...",
651 "desc" : "Variable number of parameters are passed to handlers",
659 "desc" : "returns false if any of the handlers return false otherwise it returns true"
664 "name" : "hasListener",
665 "desc" : "Checks to see if this object has any listeners for a specified event",
667 "isConstructor" : false,
669 "memberOf" : "Roo.util.Observable",
676 "name" : "eventName",
678 "desc" : "The name of the event to check for",
686 "desc" : "True if the event is being listened for, else false"
692 "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.",
694 "isConstructor" : false,
696 "memberOf" : "Roo.util.Observable",
704 "type" : "Observable",
705 "desc" : "The Observable to capture",
711 "desc" : "The function to call",
717 "desc" : "(optional) The scope (this object) for the fn",
725 "name" : "addListener",
726 "desc" : "Appends an event handler to this component",
728 "isConstructor" : false,
730 "memberOf" : "Roo.util.Observable",
737 "name" : "eventName",
739 "desc" : "The type of event to listen for",
745 "desc" : "The method the event invokes",
751 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
757 "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>",
768 "desc" : "Fires when a node is double clicked",
783 "type" : "Roo.EventObject",
784 "desc" : "The event object",
792 "name" : "contextmenu",
793 "desc" : "Fires when a node is right clicked",
808 "type" : "Roo.EventObject",
809 "desc" : "The event object",
817 "name" : "beforeclick",
818 "desc" : "Fires before click processing on a node. Return false to cancel the default action.",
833 "type" : "Roo.EventObject",
834 "desc" : "The event object",
842 "name" : "checkchange",
843 "desc" : "Fires when a node with a checkbox's checked property changes",
853 "desc" : "This node",
867 "name" : "nodedragover",
868 "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>",
876 "name" : "dragOverEvent",
886 "name" : "beforeexpand",
887 "desc" : "Fires before a node is expanded, return false to cancel.",
918 "desc" : "Fires when a node is collapsed",
936 "name" : "beforenodedrop",
937 "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>",
945 "name" : "dropEvent",
955 "name" : "beforechildrenrendered",
956 "desc" : "Fires right before the child nodes for a node are rendered",
974 "name" : "textchange",
975 "desc" : "Fires when the text for a node is changed",
991 "desc" : "The new text",
997 "desc" : "The old text",
1006 "desc" : "Fires when a node is loaded",
1016 "desc" : "The node that was loaded",
1017 "isOptional" : false
1024 "name" : "startdrag",
1025 "desc" : "Fires when a node starts being dragged",
1034 "type" : "Roo.tree.TreePanel",
1036 "isOptional" : false
1040 "type" : "Roo.tree.TreeNode",
1042 "isOptional" : false
1047 "desc" : "The raw browser event",
1048 "isOptional" : false
1056 "desc" : "Fires when a node is clicked",
1066 "desc" : "The node",
1067 "isOptional" : false
1071 "type" : "Roo.EventObject",
1072 "desc" : "The event object",
1073 "isOptional" : false
1081 "desc" : "Fires when a node is expanded",
1091 "desc" : "The node",
1092 "isOptional" : false
1100 "desc" : "Fires when a drag operation is complete",
1109 "type" : "Roo.tree.TreePanel",
1111 "isOptional" : false
1115 "type" : "Roo.tree.TreeNode",
1117 "isOptional" : false
1122 "desc" : "The raw browser event",
1123 "isOptional" : false
1130 "name" : "nodedrop",
1131 "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>",
1139 "name" : "dropEvent",
1142 "isOptional" : false
1149 "name" : "dragdrop",
1150 "desc" : "Fires when a dragged node is dropped on a valid DD target",
1159 "type" : "Roo.tree.TreePanel",
1161 "isOptional" : false
1165 "type" : "Roo.tree.TreeNode",
1167 "isOptional" : false
1172 "desc" : "The dd it was dropped on",
1173 "isOptional" : false
1178 "desc" : "The raw browser event",
1179 "isOptional" : false
1186 "name" : "beforecollapse",
1187 "desc" : "Fires before a node is collapsed, return false to cancel.",
1197 "desc" : "The node",
1198 "isOptional" : false
1204 "isOptional" : false
1210 "isOptional" : false
1217 "name" : "disabledchange",
1218 "desc" : "Fires when the disabled status of a node changes",
1228 "desc" : "The node",
1229 "isOptional" : false
1232 "name" : "disabled",
1235 "isOptional" : false
1242 "name" : "beforeload",
1243 "desc" : "Fires before a node is loaded, return false to cancel",
1253 "desc" : "The node being loaded",
1254 "isOptional" : false
1262 "desc" : "Fires when a new child node is appended to a node in this tree.",
1263 "memberOf" : "Roo.data.Tree",
1272 "desc" : "The owner tree",
1273 "isOptional" : false
1278 "desc" : "The parent node",
1279 "isOptional" : false
1284 "desc" : "The newly appended node",
1285 "isOptional" : false
1290 "desc" : "The index of the newly appended node",
1291 "isOptional" : false
1298 "name" : "beforemove",
1299 "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.",
1300 "memberOf" : "Roo.data.Tree",
1309 "desc" : "The owner tree",
1310 "isOptional" : false
1315 "desc" : "The node being moved",
1316 "isOptional" : false
1319 "name" : "oldParent",
1321 "desc" : "The parent of the node",
1322 "isOptional" : false
1325 "name" : "newParent",
1327 "desc" : "The new parent the node is moving to",
1328 "isOptional" : false
1333 "desc" : "The index it is being moved to",
1334 "isOptional" : false
1342 "desc" : "Fires when a new child node is inserted in a node in this tree.",
1343 "memberOf" : "Roo.data.Tree",
1352 "desc" : "The owner tree",
1353 "isOptional" : false
1358 "desc" : "The parent node",
1359 "isOptional" : false
1364 "desc" : "The child node inserted",
1365 "isOptional" : false
1370 "desc" : "The child node the node was inserted before",
1371 "isOptional" : false
1378 "name" : "beforeappend",
1379 "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.",
1380 "memberOf" : "Roo.data.Tree",
1389 "desc" : "The owner tree",
1390 "isOptional" : false
1395 "desc" : "The parent node",
1396 "isOptional" : false
1401 "desc" : "The child node to be appended",
1402 "isOptional" : false
1410 "desc" : "Fires when a node is moved to a new location in the tree",
1411 "memberOf" : "Roo.data.Tree",
1420 "desc" : "The owner tree",
1421 "isOptional" : false
1426 "desc" : "The node moved",
1427 "isOptional" : false
1430 "name" : "oldParent",
1432 "desc" : "The old parent of this node",
1433 "isOptional" : false
1436 "name" : "newParent",
1438 "desc" : "The new parent of this node",
1439 "isOptional" : false
1444 "desc" : "The index it was moved to",
1445 "isOptional" : false
1452 "name" : "beforeremove",
1453 "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.",
1454 "memberOf" : "Roo.data.Tree",
1463 "desc" : "The owner tree",
1464 "isOptional" : false
1469 "desc" : "The parent node",
1470 "isOptional" : false
1475 "desc" : "The child node to be removed",
1476 "isOptional" : false
1484 "desc" : "Fires when a child node is removed from a node in this tree.",
1485 "memberOf" : "Roo.data.Tree",
1494 "desc" : "The owner tree",
1495 "isOptional" : false
1500 "desc" : "The parent node",
1501 "isOptional" : false
1506 "desc" : "The child node removed",
1507 "isOptional" : false
1514 "name" : "beforeinsert",
1515 "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.",
1516 "memberOf" : "Roo.data.Tree",
1525 "desc" : "The owner tree",
1526 "isOptional" : false
1531 "desc" : "The parent node",
1532 "isOptional" : false
1537 "desc" : "The child node to be inserted",
1538 "isOptional" : false
1543 "desc" : "The child node the node is being inserted before",
1544 "isOptional" : false