git.roojs.org Git - roojs1/blob - docs/symbols/Roo.tree.TreePanel.json

   1 {
   2   "name" : "Roo.tree.TreePanel",
   3   "augments" : [
   4     "Roo.data.Tree",
   5     "Roo.util.Observable"
   6   ],
   7   "desc" : "",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "memberOf" : "TreePanel",
  12   "example" : "",
  13   "deprecated" : "",
  14   "since" : "",
  15   "see" : "",
  16   "params" : [
  17     {
  18       "name" : "el",
  19       "type" : "String/HTMLElement/Element",
  20       "desc" : "The container element",
  21       "isOptional" : false
  22     },
  23     {
  24       "name" : "config",
  25       "type" : "Object",
  26       "desc" : "",
  27       "isOptional" : false
  28     }
  29   ],
  30   "returns" : [],
  31   "config" : [
  32     {
  33       "name" : "editor",
  34       "type" : "Object|Roo.tree.TreeEditor",
  35       "desc" : "The TreeEditor or xtype data to display when clicked.",
  36       "memberOf" : "Roo.tree.TreePanel",
  37       "optvals" : []
  38     },
  39     {
  40       "name" : "listeners",
  41       "type" : "Object",
  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",
  44       "optvals" : []
  45     },
  46     {
  47       "name" : "singleExpand",
  48       "type" : "Boolean",
  49       "desc" : "true if only 1 node per branch may be expanded",
  50       "memberOf" : "Roo.tree.TreePanel",
  51       "optvals" : []
  52     },
  53     {
  54       "name" : "ddAppendOnly",
  55       "type" : "String",
  56       "desc" : "True if the tree should only allow append drops (use for trees which are sorted)",
  57       "memberOf" : "Roo.tree.TreePanel",
  58       "optvals" : []
  59     },
  60     {
  61       "name" : "dragConfig",
  62       "type" : "Object",
  63       "desc" : "Custom config to pass to the {@link Roo.tree.TreeDragZone} instance",
  64       "memberOf" : "Roo.tree.TreePanel",
  65       "optvals" : []
  66     },
  67     {
  68       "name" : "enableDrop",
  69       "type" : "Boolean",
  70       "desc" : "true to enable just drop",
  71       "memberOf" : "Roo.tree.TreePanel",
  72       "optvals" : []
  73     },
  74     {
  75       "name" : "hlColor",
  76       "type" : "String",
  77       "desc" : "The color of the node highlight (defaults to C3DAF9)",
  78       "memberOf" : "Roo.tree.TreePanel",
  79       "optvals" : []
  80     },
  81     {
  82       "name" : "rendererTip",
  83       "type" : "Function",
  84       "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>",
  85       "memberOf" : "Roo.tree.TreePanel",
  86       "optvals" : []
  87     },
  88     {
  89       "name" : "enableDD",
  90       "type" : "Boolean",
  91       "desc" : "true to enable drag and drop",
  92       "memberOf" : "Roo.tree.TreePanel",
  93       "optvals" : []
  94     },
  95     {
  96       "name" : "hlDrop",
  97       "type" : "Boolean",
  98       "desc" : "false to disable node highlight on drop (defaults to the value of Roo.enableFx)",
  99       "memberOf" : "Roo.tree.TreePanel",
 100       "optvals" : []
 101     },
 102     {
 103       "name" : "renderer",
 104       "type" : "Function",
 105       "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>",
 106       "memberOf" : "Roo.tree.TreePanel",
 107       "optvals" : []
 108     },
 109     {
 110       "name" : "rootVisible",
 111       "type" : "Boolean",
 112       "desc" : "false to hide the root node (defaults to true)",
 113       "memberOf" : "Roo.tree.TreePanel",
 114       "optvals" : []
 115     },
 116     {
 117       "name" : "enableDrag",
 118       "type" : "Boolean",
 119       "desc" : "true to enable just drag",
 120       "memberOf" : "Roo.tree.TreePanel",
 121       "optvals" : []
 122     },
 123     {
 124       "name" : "ddGroup",
 125       "type" : "String",
 126       "desc" : "The DD group this TreePanel belongs to",
 127       "memberOf" : "Roo.tree.TreePanel",
 128       "optvals" : []
 129     },
 130     {
 131       "name" : "lines",
 132       "type" : "Boolean",
 133       "desc" : "false to disable tree lines (defaults to true)",
 134       "memberOf" : "Roo.tree.TreePanel",
 135       "optvals" : []
 136     },
 137     {
 138       "name" : "dropConfig",
 139       "type" : "Object",
 140       "desc" : "Custom config to pass to the {@link Roo.tree.TreeDropZone} instance",
 141       "memberOf" : "Roo.tree.TreePanel",
 142       "optvals" : []
 143     },
 144     {
 145       "name" : "selModel",
 146       "type" : "Boolean",
 147       "desc" : "A tree selection model to use with this TreePanel (defaults to a {@link Roo.tree.DefaultSelectionModel})",
 148       "memberOf" : "Roo.tree.TreePanel",
 149       "optvals" : []
 150     },
 151     {
 152       "name" : "loader",
 153       "type" : "Boolean",
 154       "desc" : "A TreeLoader for use with this TreePanel",
 155       "memberOf" : "Roo.tree.TreePanel",
 156       "optvals" : []
 157     },
 158     {
 159       "name" : "containerScroll",
 160       "type" : "Boolean",
 161       "desc" : "true to register this container with ScrollManager",
 162       "memberOf" : "Roo.tree.TreePanel",
 163       "optvals" : []
 164     },
 165     {
 166       "name" : "ddScroll",
 167       "type" : "Boolean",
 168       "desc" : "true to enable YUI body scrolling",
 169       "memberOf" : "Roo.tree.TreePanel",
 170       "optvals" : []
 171     },
 172     {
 173       "name" : "animate",
 174       "type" : "Boolean",
 175       "desc" : "true to enable animated expand/collapse (defaults to the value of Roo.enableFx)",
 176       "memberOf" : "Roo.tree.TreePanel",
 177       "optvals" : []
 178     },
 179     {
 180       "name" : "pathSeparator",
 181       "type" : "String",
 182       "desc" : "The token used to separate sub-paths in path strings (defaults to '/')",
 183       "memberOf" : "Roo.tree.TreePanel",
 184       "optvals" : []
 185     }
 186   ],
 187   "methods" : [
 188     {
 189       "name" : "getLoader",
 190       "desc" : "Returns the default TreeLoader for this TreePanel",
 191       "isStatic" : false,
 192       "isConstructor" : false,
 193       "isPrivate" : false,
 194       "memberOf" : "Roo.tree.TreePanel",
 195       "example" : "",
 196       "deprecated" : "",
 197       "since" : "",
 198       "see" : "",
 199       "params" : [],
 200       "returns" : []
 201     },
 202     {
 203       "name" : "render",
 204       "desc" : "Trigger rendering of this TreePanel",
 205       "isStatic" : false,
 206       "isConstructor" : false,
 207       "isPrivate" : false,
 208       "memberOf" : "Roo.tree.TreePanel",
 209       "example" : "",
 210       "deprecated" : "",
 211       "since" : "",
 212       "see" : "",
 213       "params" : [],
 214       "returns" : []
 215     },
 216     {
 217       "name" : "getSelectionModel",
 218       "desc" : "Returns the selection model used by this TreePanel",
 219       "isStatic" : false,
 220       "isConstructor" : false,
 221       "isPrivate" : false,
 222       "memberOf" : "Roo.tree.TreePanel",
 223       "example" : "",
 224       "deprecated" : "",
 225       "since" : "",
 226       "see" : "",
 227       "params" : [],
 228       "returns" : []
 229     },
 230     {
 231       "name" : "expandPath",
 232       "desc" : "Expands a specified path in this TreePanel. A path can be retrieved from a node with {@link Roo.data.Node#getPath}",
 233       "isStatic" : false,
 234       "isConstructor" : false,
 235       "isPrivate" : false,
 236       "memberOf" : "Roo.tree.TreePanel",
 237       "example" : "",
 238       "deprecated" : "",
 239       "since" : "",
 240       "see" : "",
 241       "params" : [
 242         {
 243           "name" : "path",
 244           "type" : "String",
 245           "desc" : "",
 246           "isOptional" : false
 247         },
 248         {
 249           "name" : "attr",
 250           "type" : "String",
 251           "desc" : "(optional) The attribute used in the path (see {@link Roo.data.Node#getPath} for more info)",
 252           "isOptional" : false
 253         },
 254         {
 255           "name" : "callback",
 256           "type" : "Function",
 257           "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.",
 258           "isOptional" : false
 259         }
 260       ],
 261       "returns" : []
 262     },
 263     {
 264       "name" : "expandAll",
 265       "desc" : "Expand all nodes",
 266       "isStatic" : false,
 267       "isConstructor" : false,
 268       "isPrivate" : false,
 269       "memberOf" : "Roo.tree.TreePanel",
 270       "example" : "",
 271       "deprecated" : "",
 272       "since" : "",
 273       "see" : "",
 274       "params" : [],
 275       "returns" : []
 276     },
 277     {
 278       "name" : "getChecked",
 279       "desc" : "Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. \"id\")",
 280       "isStatic" : false,
 281       "isConstructor" : false,
 282       "isPrivate" : false,
 283       "memberOf" : "Roo.tree.TreePanel",
 284       "example" : "",
 285       "deprecated" : "",
 286       "since" : "",
 287       "see" : "",
 288       "params" : [
 289         {
 290           "name" : "attribute",
 291           "type" : "String",
 292           "desc" : "(optional) Defaults to null (return the actual nodes)",
 293           "isOptional" : false
 294         },
 295         {
 296           "name" : "startNode",
 297           "type" : "TreeNode",
 298           "desc" : "(optional) The node to start from, defaults to the root",
 299           "isOptional" : false
 300         }
 301       ],
 302       "returns" : [
 303         {
 304           "name" : "",
 305           "type" : "Array",
 306           "desc" : ""
 307         }
 308       ]
 309     },
 310     {
 311       "name" : "selectPath",
 312       "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}",
 313       "isStatic" : false,
 314       "isConstructor" : false,
 315       "isPrivate" : false,
 316       "memberOf" : "Roo.tree.TreePanel",
 317       "example" : "",
 318       "deprecated" : "",
 319       "since" : "",
 320       "see" : "",
 321       "params" : [
 322         {
 323           "name" : "path",
 324           "type" : "String",
 325           "desc" : "",
 326           "isOptional" : false
 327         },
 328         {
 329           "name" : "attr",
 330           "type" : "String",
 331           "desc" : "(optional) The attribute used in the path (see {@link Roo.data.Node#getPath} for more info)",
 332           "isOptional" : false
 333         },
 334         {
 335           "name" : "callback",
 336           "type" : "Function",
 337           "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.",
 338           "isOptional" : false
 339         }
 340       ],
 341       "returns" : []
 342     },
 343     {
 344       "name" : "getEl",
 345       "desc" : "Returns the container element for this TreePanel",
 346       "isStatic" : false,
 347       "isConstructor" : false,
 348       "isPrivate" : false,
 349       "memberOf" : "Roo.tree.TreePanel",
 350       "example" : "",
 351       "deprecated" : "",
 352       "since" : "",
 353       "see" : "",
 354       "params" : [],
 355       "returns" : []
 356     },
 357     {
 358       "name" : "collapseAll",
 359       "desc" : "Collapse all nodes",
 360       "isStatic" : false,
 361       "isConstructor" : false,
 362       "isPrivate" : false,
 363       "memberOf" : "Roo.tree.TreePanel",
 364       "example" : "",
 365       "deprecated" : "",
 366       "since" : "",
 367       "see" : "",
 368       "params" : [],
 369       "returns" : []
 370     },
 371     {
 372       "name" : "setRootNode",
 373       "desc" : "Sets the root node for this tree.",
 374       "isStatic" : false,
 375       "isConstructor" : false,
 376       "isPrivate" : false,
 377       "memberOf" : "Roo.data.Tree",
 378       "example" : "",
 379       "deprecated" : "",
 380       "since" : "",
 381       "see" : "",
 382       "params" : [
 383         {
 384           "name" : "node",
 385           "type" : "Node",
 386           "desc" : "",
 387           "isOptional" : false
 388         }
 389       ],
 390       "returns" : [
 391         {
 392           "name" : "",
 393           "type" : "Node",
 394           "desc" : ""
 395         }
 396       ]
 397     },
 398     {
 399       "name" : "getRootNode",
 400       "desc" : "Returns the root node for this tree.",
 401       "isStatic" : false,
 402       "isConstructor" : false,
 403       "isPrivate" : false,
 404       "memberOf" : "Roo.data.Tree",
 405       "example" : "",
 406       "deprecated" : "",
 407       "since" : "",
 408       "see" : "",
 409       "params" : [],
 410       "returns" : [
 411         {
 412           "name" : "",
 413           "type" : "Node",
 414           "desc" : ""
 415         }
 416       ]
 417     },
 418     {
 419       "name" : "getNodeById",
 420       "desc" : "Gets a node in this tree by its id.",
 421       "isStatic" : false,
 422       "isConstructor" : false,
 423       "isPrivate" : false,
 424       "memberOf" : "Roo.data.Tree",
 425       "example" : "",
 426       "deprecated" : "",
 427       "since" : "",
 428       "see" : "",
 429       "params" : [
 430         {
 431           "name" : "id",
 432           "type" : "String",
 433           "desc" : "",
 434           "isOptional" : false
 435         }
 436       ],
 437       "returns" : [
 438         {
 439           "name" : "",
 440           "type" : "Node",
 441           "desc" : ""
 442         }
 443       ]
 444     },
 445     {
 446       "name" : "purgeListeners",
 447       "desc" : "Removes all listeners for this object",
 448       "isStatic" : false,
 449       "isConstructor" : false,
 450       "isPrivate" : false,
 451       "memberOf" : "Roo.util.Observable",
 452       "example" : "",
 453       "deprecated" : "",
 454       "since" : "",
 455       "see" : "",
 456       "params" : [],
 457       "returns" : []
 458     },
 459     {
 460       "name" : "on",
 461       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 462       "isStatic" : false,
 463       "isConstructor" : false,
 464       "isPrivate" : false,
 465       "memberOf" : "Roo.util.Observable",
 466       "example" : "",
 467       "deprecated" : "",
 468       "since" : "",
 469       "see" : "",
 470       "params" : [
 471         {
 472           "name" : "eventName",
 473           "type" : "String",
 474           "desc" : "The type of event to listen for",
 475           "isOptional" : false
 476         },
 477         {
 478           "name" : "handler",
 479           "type" : "Function",
 480           "desc" : "The method the event invokes",
 481           "isOptional" : false
 482         },
 483         {
 484           "name" : "scope",
 485           "type" : "Object",
 486           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 487           "isOptional" : false
 488         },
 489         {
 490           "name" : "options",
 491           "type" : "Object",
 492           "desc" : "(optional)",
 493           "isOptional" : false
 494         }
 495       ],
 496       "returns" : []
 497     },
 498     {
 499       "name" : "un",
 500       "desc" : "Removes a listener (shorthand for removeListener)",
 501       "isStatic" : false,
 502       "isConstructor" : false,
 503       "isPrivate" : false,
 504       "memberOf" : "Roo.util.Observable",
 505       "example" : "",
 506       "deprecated" : "",
 507       "since" : "",
 508       "see" : "",
 509       "params" : [
 510         {
 511           "name" : "eventName",
 512           "type" : "String",
 513           "desc" : "The type of event to listen for",
 514           "isOptional" : false
 515         },
 516         {
 517           "name" : "handler",
 518           "type" : "Function",
 519           "desc" : "The handler to remove",
 520           "isOptional" : false
 521         },
 522         {
 523           "name" : "scope",
 524           "type" : "Object",
 525           "desc" : "(optional) The scope (this object) for the handler",
 526           "isOptional" : false
 527         }
 528       ],
 529       "returns" : []
 530     },
 531     {
 532       "name" : "addEvents",
 533       "desc" : "Used to define events on this Observable",
 534       "isStatic" : false,
 535       "isConstructor" : false,
 536       "isPrivate" : false,
 537       "memberOf" : "Roo.util.Observable",
 538       "example" : "",
 539       "deprecated" : "",
 540       "since" : "",
 541       "see" : "",
 542       "params" : [
 543         {
 544           "name" : "object",
 545           "type" : "Object",
 546           "desc" : "The object with the events defined",
 547           "isOptional" : false
 548         }
 549       ],
 550       "returns" : []
 551     },
 552     {
 553       "name" : "releaseCapture",
 554       "desc" : "Removes <b>all</b> added captures from the Observable.",
 555       "isStatic" : true,
 556       "isConstructor" : false,
 557       "isPrivate" : false,
 558       "memberOf" : "Roo.util.Observable",
 559       "example" : "",
 560       "deprecated" : "",
 561       "since" : "",
 562       "see" : "",
 563       "params" : [
 564         {
 565           "name" : "o",
 566           "type" : "Observable",
 567           "desc" : "The Observable to release",
 568           "isOptional" : false
 569         }
 570       ],
 571       "returns" : []
 572     },
 573     {
 574       "name" : "removeListener",
 575       "desc" : "Removes a listener",
 576       "isStatic" : false,
 577       "isConstructor" : false,
 578       "isPrivate" : false,
 579       "memberOf" : "Roo.util.Observable",
 580       "example" : "",
 581       "deprecated" : "",
 582       "since" : "",
 583       "see" : "",
 584       "params" : [
 585         {
 586           "name" : "eventName",
 587           "type" : "String",
 588           "desc" : "The type of event to listen for",
 589           "isOptional" : false
 590         },
 591         {
 592           "name" : "handler",
 593           "type" : "Function",
 594           "desc" : "The handler to remove",
 595           "isOptional" : false
 596         },
 597         {
 598           "name" : "scope",
 599           "type" : "Object",
 600           "desc" : "(optional) The scope (this object) for the handler",
 601           "isOptional" : false
 602         }
 603       ],
 604       "returns" : []
 605     },
 606     {
 607       "name" : "fireEvent",
 608       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 609       "isStatic" : false,
 610       "isConstructor" : false,
 611       "isPrivate" : false,
 612       "memberOf" : "Roo.util.Observable",
 613       "example" : "",
 614       "deprecated" : "",
 615       "since" : "",
 616       "see" : "",
 617       "params" : [
 618         {
 619           "name" : "eventName",
 620           "type" : "String",
 621           "desc" : "",
 622           "isOptional" : false
 623         },
 624         {
 625           "name" : "args",
 626           "type" : "Object...",
 627           "desc" : "Variable number of parameters are passed to handlers",
 628           "isOptional" : false
 629         }
 630       ],
 631       "returns" : [
 632         {
 633           "name" : "",
 634           "type" : "Boolean",
 635           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 636         }
 637       ]
 638     },
 639     {
 640       "name" : "hasListener",
 641       "desc" : "Checks to see if this object has any listeners for a specified event",
 642       "isStatic" : false,
 643       "isConstructor" : false,
 644       "isPrivate" : false,
 645       "memberOf" : "Roo.util.Observable",
 646       "example" : "",
 647       "deprecated" : "",
 648       "since" : "",
 649       "see" : "",
 650       "params" : [
 651         {
 652           "name" : "eventName",
 653           "type" : "String",
 654           "desc" : "The name of the event to check for",
 655           "isOptional" : false
 656         }
 657       ],
 658       "returns" : [
 659         {
 660           "name" : "",
 661           "type" : "Boolean",
 662           "desc" : "True if the event is being listened for, else false"
 663         }
 664       ]
 665     },
 666     {
 667       "name" : "capture",
 668       "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.",
 669       "isStatic" : true,
 670       "isConstructor" : false,
 671       "isPrivate" : false,
 672       "memberOf" : "Roo.util.Observable",
 673       "example" : "",
 674       "deprecated" : "",
 675       "since" : "",
 676       "see" : "",
 677       "params" : [
 678         {
 679           "name" : "o",
 680           "type" : "Observable",
 681           "desc" : "The Observable to capture",
 682           "isOptional" : false
 683         },
 684         {
 685           "name" : "fn",
 686           "type" : "Function",
 687           "desc" : "The function to call",
 688           "isOptional" : false
 689         },
 690         {
 691           "name" : "scope",
 692           "type" : "Object",
 693           "desc" : "(optional) The scope (this object) for the fn",
 694           "isOptional" : false
 695         }
 696       ],
 697       "returns" : []
 698     },
 699     {
 700       "name" : "addListener",
 701       "desc" : "Appends an event handler to this component",
 702       "isStatic" : false,
 703       "isConstructor" : false,
 704       "isPrivate" : false,
 705       "memberOf" : "Roo.util.Observable",
 706       "example" : "",
 707       "deprecated" : "",
 708       "since" : "",
 709       "see" : "",
 710       "params" : [
 711         {
 712           "name" : "eventName",
 713           "type" : "String",
 714           "desc" : "The type of event to listen for",
 715           "isOptional" : false
 716         },
 717         {
 718           "name" : "handler",
 719           "type" : "Function",
 720           "desc" : "The method the event invokes",
 721           "isOptional" : false
 722         },
 723         {
 724           "name" : "scope",
 725           "type" : "Object",
 726           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 727           "isOptional" : false
 728         },
 729         {
 730           "name" : "options",
 731           "type" : "Object",
 732           "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>",
 733           "isOptional" : false
 734         }
 735       ],
 736       "returns" : []
 737     }
 738   ],
 739   "events" : [
 740     {
 741       "name" : "dblclick",
 742       "desc" : "Fires when a node is double clicked",
 743       "memberOf" : "Roo.tree.TreePanel",
 744       "example" : "",
 745       "deprecated" : "",
 746       "since" : "",
 747       "see" : "",
 748       "params" : [
 749         {
 750           "name" : "node",
 751           "type" : "Node",
 752           "desc" : "The node",
 753           "isOptional" : false
 754         },
 755         {
 756           "name" : "e",
 757           "type" : "Roo.EventObject",
 758           "desc" : "The event object",
 759           "isOptional" : false
 760         }
 761       ],
 762       "returns" : []
 763     },
 764     {
 765       "name" : "contextmenu",
 766       "desc" : "Fires when a node is right clicked",
 767       "memberOf" : "Roo.tree.TreePanel",
 768       "example" : "",
 769       "deprecated" : "",
 770       "since" : "",
 771       "see" : "",
 772       "params" : [
 773         {
 774           "name" : "node",
 775           "type" : "Node",
 776           "desc" : "The node",
 777           "isOptional" : false
 778         },
 779         {
 780           "name" : "e",
 781           "type" : "Roo.EventObject",
 782           "desc" : "The event object",
 783           "isOptional" : false
 784         }
 785       ],
 786       "returns" : []
 787     },
 788     {
 789       "name" : "beforeclick",
 790       "desc" : "Fires before click processing on a node. Return false to cancel the default action.",
 791       "memberOf" : "Roo.tree.TreePanel",
 792       "example" : "",
 793       "deprecated" : "",
 794       "since" : "",
 795       "see" : "",
 796       "params" : [
 797         {
 798           "name" : "node",
 799           "type" : "Node",
 800           "desc" : "The node",
 801           "isOptional" : false
 802         },
 803         {
 804           "name" : "e",
 805           "type" : "Roo.EventObject",
 806           "desc" : "The event object",
 807           "isOptional" : false
 808         }
 809       ],
 810       "returns" : []
 811     },
 812     {
 813       "name" : "checkchange",
 814       "desc" : "Fires when a node with a checkbox's checked property changes",
 815       "memberOf" : "Roo.tree.TreePanel",
 816       "example" : "",
 817       "deprecated" : "",
 818       "since" : "",
 819       "see" : "",
 820       "params" : [
 821         {
 822           "name" : "this",
 823           "type" : "Node",
 824           "desc" : "This node",
 825           "isOptional" : false
 826         },
 827         {
 828           "name" : "checked",
 829           "type" : "Boolean",
 830           "desc" : "",
 831           "isOptional" : false
 832         }
 833       ],
 834       "returns" : []
 835     },
 836     {
 837       "name" : "nodedragover",
 838       "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>",
 839       "memberOf" : "Roo.tree.TreePanel",
 840       "example" : "",
 841       "deprecated" : "",
 842       "since" : "",
 843       "see" : "",
 844       "params" : [
 845         {
 846           "name" : "dragOverEvent",
 847           "type" : "Object",
 848           "desc" : "",
 849           "isOptional" : false
 850         }
 851       ],
 852       "returns" : []
 853     },
 854     {
 855       "name" : "beforeexpand",
 856       "desc" : "Fires before a node is expanded, return false to cancel.",
 857       "memberOf" : "Roo.tree.TreePanel",
 858       "example" : "",
 859       "deprecated" : "",
 860       "since" : "",
 861       "see" : "",
 862       "params" : [
 863         {
 864           "name" : "node",
 865           "type" : "Node",
 866           "desc" : "The node",
 867           "isOptional" : false
 868         },
 869         {
 870           "name" : "deep",
 871           "type" : "Boolean",
 872           "desc" : "",
 873           "isOptional" : false
 874         },
 875         {
 876           "name" : "anim",
 877           "type" : "Boolean",
 878           "desc" : "",
 879           "isOptional" : false
 880         }
 881       ],
 882       "returns" : []
 883     },
 884     {
 885       "name" : "collapse",
 886       "desc" : "Fires when a node is collapsed",
 887       "memberOf" : "Roo.tree.TreePanel",
 888       "example" : "",
 889       "deprecated" : "",
 890       "since" : "",
 891       "see" : "",
 892       "params" : [
 893         {
 894           "name" : "node",
 895           "type" : "Node",
 896           "desc" : "The node",
 897           "isOptional" : false
 898         }
 899       ],
 900       "returns" : []
 901     },
 902     {
 903       "name" : "beforenodedrop",
 904       "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>",
 905       "memberOf" : "Roo.tree.TreePanel",
 906       "example" : "",
 907       "deprecated" : "",
 908       "since" : "",
 909       "see" : "",
 910       "params" : [
 911         {
 912           "name" : "dropEvent",
 913           "type" : "Object",
 914           "desc" : "",
 915           "isOptional" : false
 916         }
 917       ],
 918       "returns" : []
 919     },
 920     {
 921       "name" : "beforechildrenrendered",
 922       "desc" : "Fires right before the child nodes for a node are rendered",
 923       "memberOf" : "Roo.tree.TreePanel",
 924       "example" : "",
 925       "deprecated" : "",
 926       "since" : "",
 927       "see" : "",
 928       "params" : [
 929         {
 930           "name" : "node",
 931           "type" : "Node",
 932           "desc" : "The node",
 933           "isOptional" : false
 934         }
 935       ],
 936       "returns" : []
 937     },
 938     {
 939       "name" : "textchange",
 940       "desc" : "Fires when the text for a node is changed",
 941       "memberOf" : "Roo.tree.TreePanel",
 942       "example" : "",
 943       "deprecated" : "",
 944       "since" : "",
 945       "see" : "",
 946       "params" : [
 947         {
 948           "name" : "node",
 949           "type" : "Node",
 950           "desc" : "The node",
 951           "isOptional" : false
 952         },
 953         {
 954           "name" : "text",
 955           "type" : "String",
 956           "desc" : "The new text",
 957           "isOptional" : false
 958         },
 959         {
 960           "name" : "oldText",
 961           "type" : "String",
 962           "desc" : "The old text",
 963           "isOptional" : false
 964         }
 965       ],
 966       "returns" : []
 967     },
 968     {
 969       "name" : "load",
 970       "desc" : "Fires when a node is loaded",
 971       "memberOf" : "Roo.tree.TreePanel",
 972       "example" : "",
 973       "deprecated" : "",
 974       "since" : "",
 975       "see" : "",
 976       "params" : [
 977         {
 978           "name" : "node",
 979           "type" : "Node",
 980           "desc" : "The node that was loaded",
 981           "isOptional" : false
 982         }
 983       ],
 984       "returns" : []
 985     },
 986     {
 987       "name" : "appendnode",
 988       "desc" : "Fires when append node to the tree",
 989       "memberOf" : "Roo.tree.TreePanel",
 990       "example" : "",
 991       "deprecated" : "",
 992       "since" : "",
 993       "see" : "",
 994       "params" : [
 995         {
 996           "name" : "this",
 997           "type" : "Roo.tree.TreePanel",
 998           "desc" : "",
 999           "isOptional" : false
1000         },
1001         {
1002           "name" : "node",
1003           "type" : "Roo.tree.TreeNode",
1004           "desc" : "",
1005           "isOptional" : false
1006         },
1007         {
1008           "name" : "index",
1009           "type" : "Number",
1010           "desc" : "The index of the newly appended node",
1011           "isOptional" : false
1012         }
1013       ],
1014       "returns" : []
1015     },
1016     {
1017       "name" : "startdrag",
1018       "desc" : "Fires when a node starts being dragged",
1019       "memberOf" : "Roo.tree.TreePanel",
1020       "example" : "",
1021       "deprecated" : "",
1022       "since" : "",
1023       "see" : "",
1024       "params" : [
1025         {
1026           "name" : "this",
1027           "type" : "Roo.tree.TreePanel",
1028           "desc" : "",
1029           "isOptional" : false
1030         },
1031         {
1032           "name" : "node",
1033           "type" : "Roo.tree.TreeNode",
1034           "desc" : "",
1035           "isOptional" : false
1036         },
1037         {
1038           "name" : "e",
1039           "type" : "event",
1040           "desc" : "The raw browser event",
1041           "isOptional" : false
1042         }
1043       ],
1044       "returns" : []
1045     },
1046     {
1047       "name" : "click",
1048       "desc" : "Fires when a node is clicked",
1049       "memberOf" : "Roo.tree.TreePanel",
1050       "example" : "",
1051       "deprecated" : "",
1052       "since" : "",
1053       "see" : "",
1054       "params" : [
1055         {
1056           "name" : "node",
1057           "type" : "Node",
1058           "desc" : "The node",
1059           "isOptional" : false
1060         },
1061         {
1062           "name" : "e",
1063           "type" : "Roo.EventObject",
1064           "desc" : "The event object",
1065           "isOptional" : false
1066         }
1067       ],
1068       "returns" : []
1069     },
1070     {
1071       "name" : "expand",
1072       "desc" : "Fires when a node is expanded",
1073       "memberOf" : "Roo.tree.TreePanel",
1074       "example" : "",
1075       "deprecated" : "",
1076       "since" : "",
1077       "see" : "",
1078       "params" : [
1079         {
1080           "name" : "node",
1081           "type" : "Node",
1082           "desc" : "The node",
1083           "isOptional" : false
1084         }
1085       ],
1086       "returns" : []
1087     },
1088     {
1089       "name" : "enddrag",
1090       "desc" : "Fires when a drag operation is complete",
1091       "memberOf" : "Roo.tree.TreePanel",
1092       "example" : "",
1093       "deprecated" : "",
1094       "since" : "",
1095       "see" : "",
1096       "params" : [
1097         {
1098           "name" : "this",
1099           "type" : "Roo.tree.TreePanel",
1100           "desc" : "",
1101           "isOptional" : false
1102         },
1103         {
1104           "name" : "node",
1105           "type" : "Roo.tree.TreeNode",
1106           "desc" : "",
1107           "isOptional" : false
1108         },
1109         {
1110           "name" : "e",
1111           "type" : "event",
1112           "desc" : "The raw browser event",
1113           "isOptional" : false
1114         }
1115       ],
1116       "returns" : []
1117     },
1118     {
1119       "name" : "nodedrop",
1120       "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>",
1121       "memberOf" : "Roo.tree.TreePanel",
1122       "example" : "",
1123       "deprecated" : "",
1124       "since" : "",
1125       "see" : "",
1126       "params" : [
1127         {
1128           "name" : "dropEvent",
1129           "type" : "Object",
1130           "desc" : "",
1131           "isOptional" : false
1132         }
1133       ],
1134       "returns" : []
1135     },
1136     {
1137       "name" : "dragdrop",
1138       "desc" : "Fires when a dragged node is dropped on a valid DD target",
1139       "memberOf" : "Roo.tree.TreePanel",
1140       "example" : "",
1141       "deprecated" : "",
1142       "since" : "",
1143       "see" : "",
1144       "params" : [
1145         {
1146           "name" : "this",
1147           "type" : "Roo.tree.TreePanel",
1148           "desc" : "",
1149           "isOptional" : false
1150         },
1151         {
1152           "name" : "node",
1153           "type" : "Roo.tree.TreeNode",
1154           "desc" : "",
1155           "isOptional" : false
1156         },
1157         {
1158           "name" : "dd",
1159           "type" : "DD",
1160           "desc" : "The dd it was dropped on",
1161           "isOptional" : false
1162         },
1163         {
1164           "name" : "e",
1165           "type" : "event",
1166           "desc" : "The raw browser event",
1167           "isOptional" : false
1168         }
1169       ],
1170       "returns" : []
1171     },
1172     {
1173       "name" : "beforecollapse",
1174       "desc" : "Fires before a node is collapsed, return false to cancel.",
1175       "memberOf" : "Roo.tree.TreePanel",
1176       "example" : "",
1177       "deprecated" : "",
1178       "since" : "",
1179       "see" : "",
1180       "params" : [
1181         {
1182           "name" : "node",
1183           "type" : "Node",
1184           "desc" : "The node",
1185           "isOptional" : false
1186         },
1187         {
1188           "name" : "deep",
1189           "type" : "Boolean",
1190           "desc" : "",
1191           "isOptional" : false
1192         },
1193         {
1194           "name" : "anim",
1195           "type" : "Boolean",
1196           "desc" : "",
1197           "isOptional" : false
1198         }
1199       ],
1200       "returns" : []
1201     },
1202     {
1203       "name" : "disabledchange",
1204       "desc" : "Fires when the disabled status of a node changes",
1205       "memberOf" : "Roo.tree.TreePanel",
1206       "example" : "",
1207       "deprecated" : "",
1208       "since" : "",
1209       "see" : "",
1210       "params" : [
1211         {
1212           "name" : "node",
1213           "type" : "Node",
1214           "desc" : "The node",
1215           "isOptional" : false
1216         },
1217         {
1218           "name" : "disabled",
1219           "type" : "Boolean",
1220           "desc" : "",
1221           "isOptional" : false
1222         }
1223       ],
1224       "returns" : []
1225     },
1226     {
1227       "name" : "beforeload",
1228       "desc" : "Fires before a node is loaded, return false to cancel",
1229       "memberOf" : "Roo.tree.TreePanel",
1230       "example" : "",
1231       "deprecated" : "",
1232       "since" : "",
1233       "see" : "",
1234       "params" : [
1235         {
1236           "name" : "node",
1237           "type" : "Node",
1238           "desc" : "The node being loaded",
1239           "isOptional" : false
1240         }
1241       ],
1242       "returns" : []
1243     },
1244     {
1245       "name" : "append",
1246       "desc" : "Fires when a new child node is appended to a node in this tree.",
1247       "memberOf" : "Roo.data.Tree",
1248       "example" : "",
1249       "deprecated" : "",
1250       "since" : "",
1251       "see" : "",
1252       "params" : [
1253         {
1254           "name" : "tree",
1255           "type" : "Tree",
1256           "desc" : "The owner tree",
1257           "isOptional" : false
1258         },
1259         {
1260           "name" : "parent",
1261           "type" : "Node",
1262           "desc" : "The parent node",
1263           "isOptional" : false
1264         },
1265         {
1266           "name" : "node",
1267           "type" : "Node",
1268           "desc" : "The newly appended node",
1269           "isOptional" : false
1270         },
1271         {
1272           "name" : "index",
1273           "type" : "Number",
1274           "desc" : "The index of the newly appended node",
1275           "isOptional" : false
1276         }
1277       ],
1278       "returns" : []
1279     },
1280     {
1281       "name" : "beforemove",
1282       "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.",
1283       "memberOf" : "Roo.data.Tree",
1284       "example" : "",
1285       "deprecated" : "",
1286       "since" : "",
1287       "see" : "",
1288       "params" : [
1289         {
1290           "name" : "tree",
1291           "type" : "Tree",
1292           "desc" : "The owner tree",
1293           "isOptional" : false
1294         },
1295         {
1296           "name" : "node",
1297           "type" : "Node",
1298           "desc" : "The node being moved",
1299           "isOptional" : false
1300         },
1301         {
1302           "name" : "oldParent",
1303           "type" : "Node",
1304           "desc" : "The parent of the node",
1305           "isOptional" : false
1306         },
1307         {
1308           "name" : "newParent",
1309           "type" : "Node",
1310           "desc" : "The new parent the node is moving to",
1311           "isOptional" : false
1312         },
1313         {
1314           "name" : "index",
1315           "type" : "Number",
1316           "desc" : "The index it is being moved to",
1317           "isOptional" : false
1318         }
1319       ],
1320       "returns" : []
1321     },
1322     {
1323       "name" : "insert",
1324       "desc" : "Fires when a new child node is inserted in a node in this tree.",
1325       "memberOf" : "Roo.data.Tree",
1326       "example" : "",
1327       "deprecated" : "",
1328       "since" : "",
1329       "see" : "",
1330       "params" : [
1331         {
1332           "name" : "tree",
1333           "type" : "Tree",
1334           "desc" : "The owner tree",
1335           "isOptional" : false
1336         },
1337         {
1338           "name" : "parent",
1339           "type" : "Node",
1340           "desc" : "The parent node",
1341           "isOptional" : false
1342         },
1343         {
1344           "name" : "node",
1345           "type" : "Node",
1346           "desc" : "The child node inserted",
1347           "isOptional" : false
1348         },
1349         {
1350           "name" : "refNode",
1351           "type" : "Node",
1352           "desc" : "The child node the node was inserted before",
1353           "isOptional" : false
1354         }
1355       ],
1356       "returns" : []
1357     },
1358     {
1359       "name" : "beforeappend",
1360       "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.",
1361       "memberOf" : "Roo.data.Tree",
1362       "example" : "",
1363       "deprecated" : "",
1364       "since" : "",
1365       "see" : "",
1366       "params" : [
1367         {
1368           "name" : "tree",
1369           "type" : "Tree",
1370           "desc" : "The owner tree",
1371           "isOptional" : false
1372         },
1373         {
1374           "name" : "parent",
1375           "type" : "Node",
1376           "desc" : "The parent node",
1377           "isOptional" : false
1378         },
1379         {
1380           "name" : "node",
1381           "type" : "Node",
1382           "desc" : "The child node to be appended",
1383           "isOptional" : false
1384         }
1385       ],
1386       "returns" : []
1387     },
1388     {
1389       "name" : "move",
1390       "desc" : "Fires when a node is moved to a new location in the tree",
1391       "memberOf" : "Roo.data.Tree",
1392       "example" : "",
1393       "deprecated" : "",
1394       "since" : "",
1395       "see" : "",
1396       "params" : [
1397         {
1398           "name" : "tree",
1399           "type" : "Tree",
1400           "desc" : "The owner tree",
1401           "isOptional" : false
1402         },
1403         {
1404           "name" : "node",
1405           "type" : "Node",
1406           "desc" : "The node moved",
1407           "isOptional" : false
1408         },
1409         {
1410           "name" : "oldParent",
1411           "type" : "Node",
1412           "desc" : "The old parent of this node",
1413           "isOptional" : false
1414         },
1415         {
1416           "name" : "newParent",
1417           "type" : "Node",
1418           "desc" : "The new parent of this node",
1419           "isOptional" : false
1420         },
1421         {
1422           "name" : "index",
1423           "type" : "Number",
1424           "desc" : "The index it was moved to",
1425           "isOptional" : false
1426         }
1427       ],
1428       "returns" : []
1429     },
1430     {
1431       "name" : "beforeremove",
1432       "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.",
1433       "memberOf" : "Roo.data.Tree",
1434       "example" : "",
1435       "deprecated" : "",
1436       "since" : "",
1437       "see" : "",
1438       "params" : [
1439         {
1440           "name" : "tree",
1441           "type" : "Tree",
1442           "desc" : "The owner tree",
1443           "isOptional" : false
1444         },
1445         {
1446           "name" : "parent",
1447           "type" : "Node",
1448           "desc" : "The parent node",
1449           "isOptional" : false
1450         },
1451         {
1452           "name" : "node",
1453           "type" : "Node",
1454           "desc" : "The child node to be removed",
1455           "isOptional" : false
1456         }
1457       ],
1458       "returns" : []
1459     },
1460     {
1461       "name" : "remove",
1462       "desc" : "Fires when a child node is removed from a node in this tree.",
1463       "memberOf" : "Roo.data.Tree",
1464       "example" : "",
1465       "deprecated" : "",
1466       "since" : "",
1467       "see" : "",
1468       "params" : [
1469         {
1470           "name" : "tree",
1471           "type" : "Tree",
1472           "desc" : "The owner tree",
1473           "isOptional" : false
1474         },
1475         {
1476           "name" : "parent",
1477           "type" : "Node",
1478           "desc" : "The parent node",
1479           "isOptional" : false
1480         },
1481         {
1482           "name" : "node",
1483           "type" : "Node",
1484           "desc" : "The child node removed",
1485           "isOptional" : false
1486         }
1487       ],
1488       "returns" : []
1489     },
1490     {
1491       "name" : "beforeinsert",
1492       "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.",
1493       "memberOf" : "Roo.data.Tree",
1494       "example" : "",
1495       "deprecated" : "",
1496       "since" : "",
1497       "see" : "",
1498       "params" : [
1499         {
1500           "name" : "tree",
1501           "type" : "Tree",
1502           "desc" : "The owner tree",
1503           "isOptional" : false
1504         },
1505         {
1506           "name" : "parent",
1507           "type" : "Node",
1508           "desc" : "The parent node",
1509           "isOptional" : false
1510         },
1511         {
1512           "name" : "node",
1513           "type" : "Node",
1514           "desc" : "The child node to be inserted",
1515           "isOptional" : false
1516         },
1517         {
1518           "name" : "refNode",
1519           "type" : "Node",
1520           "desc" : "The child node the node is being inserted before",
1521           "isOptional" : false
1522         }
1523       ],
1524       "returns" : []
1525     }
1526   ]
1527 }