git.roojs.org Git - roojs1/blob - docs/symbols/Roo.data.Node.json

   1 {
   2   "name" : "Roo.data.Node",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "desc" : "",
   7   "isSingleton" : false,
   8   "isStatic" : false,
   9   "isBuiltin" : false,
  10   "memberOf" : "Node",
  11   "example" : "",
  12   "deprecated" : "",
  13   "since" : "",
  14   "see" : "",
  15   "params" : [
  16     {
  17       "name" : "attributes",
  18       "type" : "Object",
  19       "desc" : "The attributes/config for the node",
  20       "isOptional" : false
  21     }
  22   ],
  23   "returns" : [],
  24   "config" : [
  25     {
  26       "name" : "listeners",
  27       "type" : "Object",
  28       "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>",
  29       "memberOf" : "Roo.util.Observable",
  30       "optvals" : []
  31     },
  32     {
  33       "name" : "id",
  34       "type" : "String",
  35       "desc" : "The id for this node. If one is not specified, one is generated.",
  36       "memberOf" : "Roo.data.Node",
  37       "optvals" : []
  38     },
  39     {
  40       "name" : "leaf",
  41       "type" : "Boolean",
  42       "desc" : "true if this node is a leaf and does not have children",
  43       "memberOf" : "Roo.data.Node",
  44       "optvals" : []
  45     }
  46   ],
  47   "methods" : [
  48     {
  49       "name" : "sort",
  50       "desc" : "Sorts this nodes children using the supplied sort function",
  51       "isStatic" : false,
  52       "isConstructor" : false,
  53       "isPrivate" : false,
  54       "memberOf" : "Roo.data.Node",
  55       "example" : "",
  56       "deprecated" : "",
  57       "since" : "",
  58       "see" : "",
  59       "params" : [
  60         {
  61           "name" : "fn",
  62           "type" : "Function",
  63           "desc" : "",
  64           "isOptional" : false
  65         },
  66         {
  67           "name" : "scope",
  68           "type" : "Object",
  69           "desc" : "(optional)",
  70           "isOptional" : false
  71         }
  72       ],
  73       "returns" : []
  74     },
  75     {
  76       "name" : "removeChild",
  77       "desc" : "Removes a child node from this node.",
  78       "isStatic" : false,
  79       "isConstructor" : false,
  80       "isPrivate" : false,
  81       "memberOf" : "Roo.data.Node",
  82       "example" : "",
  83       "deprecated" : "",
  84       "since" : "",
  85       "see" : "",
  86       "params" : [
  87         {
  88           "name" : "node",
  89           "type" : "Node",
  90           "desc" : "The node to remove",
  91           "isOptional" : false
  92         }
  93       ],
  94       "returns" : [
  95         {
  96           "name" : "",
  97           "type" : "Node",
  98           "desc" : "The removed node"
  99         }
 100       ]
 101     },
 102     {
 103       "name" : "isAncestor",
 104       "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
 105       "isStatic" : false,
 106       "isConstructor" : false,
 107       "isPrivate" : false,
 108       "memberOf" : "Roo.data.Node",
 109       "example" : "",
 110       "deprecated" : "",
 111       "since" : "",
 112       "see" : "",
 113       "params" : [
 114         {
 115           "name" : "node",
 116           "type" : "Node",
 117           "desc" : "",
 118           "isOptional" : false
 119         }
 120       ],
 121       "returns" : [
 122         {
 123           "name" : "",
 124           "type" : "Boolean",
 125           "desc" : ""
 126         }
 127       ]
 128     },
 129     {
 130       "name" : "contains",
 131       "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
 132       "isStatic" : false,
 133       "isConstructor" : false,
 134       "isPrivate" : false,
 135       "memberOf" : "Roo.data.Node",
 136       "example" : "",
 137       "deprecated" : "",
 138       "since" : "",
 139       "see" : "",
 140       "params" : [
 141         {
 142           "name" : "node",
 143           "type" : "Node",
 144           "desc" : "",
 145           "isOptional" : false
 146         }
 147       ],
 148       "returns" : [
 149         {
 150           "name" : "",
 151           "type" : "Boolean",
 152           "desc" : ""
 153         }
 154       ]
 155     },
 156     {
 157       "name" : "cascade",
 158       "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.",
 159       "isStatic" : false,
 160       "isConstructor" : false,
 161       "isPrivate" : false,
 162       "memberOf" : "Roo.data.Node",
 163       "example" : "",
 164       "deprecated" : "",
 165       "since" : "",
 166       "see" : "",
 167       "params" : [
 168         {
 169           "name" : "fn",
 170           "type" : "Function",
 171           "desc" : "The function to call",
 172           "isOptional" : false
 173         },
 174         {
 175           "name" : "scope",
 176           "type" : "Object",
 177           "desc" : "(optional) The scope of the function (defaults to current node)",
 178           "isOptional" : false
 179         },
 180         {
 181           "name" : "args",
 182           "type" : "Array",
 183           "desc" : "(optional) The args to call the function with (default to passing the current node)",
 184           "isOptional" : false
 185         }
 186       ],
 187       "returns" : []
 188     },
 189     {
 190       "name" : "getDepth",
 191       "desc" : "Returns depth of this node (the root node has a depth of 0)",
 192       "isStatic" : false,
 193       "isConstructor" : false,
 194       "isPrivate" : false,
 195       "memberOf" : "Roo.data.Node",
 196       "example" : "",
 197       "deprecated" : "",
 198       "since" : "",
 199       "see" : "",
 200       "params" : [],
 201       "returns" : [
 202         {
 203           "name" : "",
 204           "type" : "Number",
 205           "desc" : ""
 206         }
 207       ]
 208     },
 209     {
 210       "name" : "getPath",
 211       "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.",
 212       "isStatic" : false,
 213       "isConstructor" : false,
 214       "isPrivate" : false,
 215       "memberOf" : "Roo.data.Node",
 216       "example" : "",
 217       "deprecated" : "",
 218       "since" : "",
 219       "see" : "",
 220       "params" : [
 221         {
 222           "name" : "attr",
 223           "type" : "String",
 224           "desc" : "(optional) The attr to use for the path (defaults to the node's id)",
 225           "isOptional" : false
 226         }
 227       ],
 228       "returns" : [
 229         {
 230           "name" : "",
 231           "type" : "String",
 232           "desc" : "The path"
 233         }
 234       ]
 235     },
 236     {
 237       "name" : "indexOf",
 238       "desc" : "Returns the index of a child node",
 239       "isStatic" : false,
 240       "isConstructor" : false,
 241       "isPrivate" : false,
 242       "memberOf" : "Roo.data.Node",
 243       "example" : "",
 244       "deprecated" : "",
 245       "since" : "",
 246       "see" : "",
 247       "params" : [
 248         {
 249           "name" : "node",
 250           "type" : "Node",
 251           "desc" : "",
 252           "isOptional" : false
 253         }
 254       ],
 255       "returns" : [
 256         {
 257           "name" : "",
 258           "type" : "Number",
 259           "desc" : "The index of the node or -1 if it was not found"
 260         }
 261       ]
 262     },
 263     {
 264       "name" : "isFirst",
 265       "desc" : "Returns true if this node is the first child of its parent",
 266       "isStatic" : false,
 267       "isConstructor" : false,
 268       "isPrivate" : false,
 269       "memberOf" : "Roo.data.Node",
 270       "example" : "",
 271       "deprecated" : "",
 272       "since" : "",
 273       "see" : "",
 274       "params" : [],
 275       "returns" : [
 276         {
 277           "name" : "",
 278           "type" : "Boolean",
 279           "desc" : ""
 280         }
 281       ]
 282     },
 283     {
 284       "name" : "isLast",
 285       "desc" : "Returns true if this node is the last child of its parent",
 286       "isStatic" : false,
 287       "isConstructor" : false,
 288       "isPrivate" : false,
 289       "memberOf" : "Roo.data.Node",
 290       "example" : "",
 291       "deprecated" : "",
 292       "since" : "",
 293       "see" : "",
 294       "params" : [],
 295       "returns" : [
 296         {
 297           "name" : "",
 298           "type" : "Boolean",
 299           "desc" : ""
 300         }
 301       ]
 302     },
 303     {
 304       "name" : "isLeaf",
 305       "desc" : "Returns true if this node is a leaf",
 306       "isStatic" : false,
 307       "isConstructor" : false,
 308       "isPrivate" : false,
 309       "memberOf" : "Roo.data.Node",
 310       "example" : "",
 311       "deprecated" : "",
 312       "since" : "",
 313       "see" : "",
 314       "params" : [],
 315       "returns" : [
 316         {
 317           "name" : "",
 318           "type" : "Boolean",
 319           "desc" : ""
 320         }
 321       ]
 322     },
 323     {
 324       "name" : "insertBefore",
 325       "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
 326       "isStatic" : false,
 327       "isConstructor" : false,
 328       "isPrivate" : false,
 329       "memberOf" : "Roo.data.Node",
 330       "example" : "",
 331       "deprecated" : "",
 332       "since" : "",
 333       "see" : "",
 334       "params" : [
 335         {
 336           "name" : "node",
 337           "type" : "Node",
 338           "desc" : "The node to insert",
 339           "isOptional" : false
 340         },
 341         {
 342           "name" : "refNode",
 343           "type" : "Node",
 344           "desc" : "The node to insert before (if null the node is appended)",
 345           "isOptional" : false
 346         }
 347       ],
 348       "returns" : [
 349         {
 350           "name" : "",
 351           "type" : "Node",
 352           "desc" : "The inserted node"
 353         }
 354       ]
 355     },
 356     {
 357       "name" : "item",
 358       "desc" : "Returns the child node at the specified index.",
 359       "isStatic" : false,
 360       "isConstructor" : false,
 361       "isPrivate" : false,
 362       "memberOf" : "Roo.data.Node",
 363       "example" : "",
 364       "deprecated" : "",
 365       "since" : "",
 366       "see" : "",
 367       "params" : [
 368         {
 369           "name" : "index",
 370           "type" : "Number",
 371           "desc" : "",
 372           "isOptional" : false
 373         }
 374       ],
 375       "returns" : [
 376         {
 377           "name" : "",
 378           "type" : "Node",
 379           "desc" : ""
 380         }
 381       ]
 382     },
 383     {
 384       "name" : "getOwnerTree",
 385       "desc" : "Returns the tree this node is in.",
 386       "isStatic" : false,
 387       "isConstructor" : false,
 388       "isPrivate" : false,
 389       "memberOf" : "Roo.data.Node",
 390       "example" : "",
 391       "deprecated" : "",
 392       "since" : "",
 393       "see" : "",
 394       "params" : [],
 395       "returns" : [
 396         {
 397           "name" : "",
 398           "type" : "Tree",
 399           "desc" : ""
 400         }
 401       ]
 402     },
 403     {
 404       "name" : "appendChild",
 405       "desc" : "Insert node(s) as the last child node of this node.",
 406       "isStatic" : false,
 407       "isConstructor" : false,
 408       "isPrivate" : false,
 409       "memberOf" : "Roo.data.Node",
 410       "example" : "",
 411       "deprecated" : "",
 412       "since" : "",
 413       "see" : "",
 414       "params" : [
 415         {
 416           "name" : "node",
 417           "type" : "Node/Array",
 418           "desc" : "The node or Array of nodes to append",
 419           "isOptional" : false
 420         }
 421       ],
 422       "returns" : [
 423         {
 424           "name" : "",
 425           "type" : "Node",
 426           "desc" : "The appended node if single append, or null if an array was passed"
 427         }
 428       ]
 429     },
 430     {
 431       "name" : "findChildBy",
 432       "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.",
 433       "isStatic" : false,
 434       "isConstructor" : false,
 435       "isPrivate" : false,
 436       "memberOf" : "Roo.data.Node",
 437       "example" : "",
 438       "deprecated" : "",
 439       "since" : "",
 440       "see" : "",
 441       "params" : [
 442         {
 443           "name" : "fn",
 444           "type" : "Function",
 445           "desc" : "",
 446           "isOptional" : false
 447         },
 448         {
 449           "name" : "scope",
 450           "type" : "Object",
 451           "desc" : "(optional)",
 452           "isOptional" : false
 453         }
 454       ],
 455       "returns" : [
 456         {
 457           "name" : "",
 458           "type" : "Node",
 459           "desc" : "The found child or null if none was found"
 460         }
 461       ]
 462     },
 463     {
 464       "name" : "replaceChild",
 465       "desc" : "Replaces one child node in this node with another.",
 466       "isStatic" : false,
 467       "isConstructor" : false,
 468       "isPrivate" : false,
 469       "memberOf" : "Roo.data.Node",
 470       "example" : "",
 471       "deprecated" : "",
 472       "since" : "",
 473       "see" : "",
 474       "params" : [
 475         {
 476           "name" : "newChild",
 477           "type" : "Node",
 478           "desc" : "The replacement node",
 479           "isOptional" : false
 480         },
 481         {
 482           "name" : "oldChild",
 483           "type" : "Node",
 484           "desc" : "The node to replace",
 485           "isOptional" : false
 486         }
 487       ],
 488       "returns" : [
 489         {
 490           "name" : "",
 491           "type" : "Node",
 492           "desc" : "The replaced node"
 493         }
 494       ]
 495     },
 496     {
 497       "name" : "bubble",
 498       "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.",
 499       "isStatic" : false,
 500       "isConstructor" : false,
 501       "isPrivate" : false,
 502       "memberOf" : "Roo.data.Node",
 503       "example" : "",
 504       "deprecated" : "",
 505       "since" : "",
 506       "see" : "",
 507       "params" : [
 508         {
 509           "name" : "fn",
 510           "type" : "Function",
 511           "desc" : "The function to call",
 512           "isOptional" : false
 513         },
 514         {
 515           "name" : "scope",
 516           "type" : "Object",
 517           "desc" : "(optional) The scope of the function (defaults to current node)",
 518           "isOptional" : false
 519         },
 520         {
 521           "name" : "args",
 522           "type" : "Array",
 523           "desc" : "(optional) The args to call the function with (default to passing the current node)",
 524           "isOptional" : false
 525         }
 526       ],
 527       "returns" : []
 528     },
 529     {
 530       "name" : "eachChild",
 531       "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.",
 532       "isStatic" : false,
 533       "isConstructor" : false,
 534       "isPrivate" : false,
 535       "memberOf" : "Roo.data.Node",
 536       "example" : "",
 537       "deprecated" : "",
 538       "since" : "",
 539       "see" : "",
 540       "params" : [
 541         {
 542           "name" : "fn",
 543           "type" : "Function",
 544           "desc" : "The function to call",
 545           "isOptional" : false
 546         },
 547         {
 548           "name" : "scope",
 549           "type" : "Object",
 550           "desc" : "(optional) The scope of the function (defaults to current node)",
 551           "isOptional" : false
 552         },
 553         {
 554           "name" : "args",
 555           "type" : "Array",
 556           "desc" : "(optional) The args to call the function with (default to passing the current node)",
 557           "isOptional" : false
 558         }
 559       ],
 560       "returns" : []
 561     },
 562     {
 563       "name" : "findChild",
 564       "desc" : "Finds the first child that has the attribute with the specified value.",
 565       "isStatic" : false,
 566       "isConstructor" : false,
 567       "isPrivate" : false,
 568       "memberOf" : "Roo.data.Node",
 569       "example" : "",
 570       "deprecated" : "",
 571       "since" : "",
 572       "see" : "",
 573       "params" : [
 574         {
 575           "name" : "attribute",
 576           "type" : "String",
 577           "desc" : "The attribute name",
 578           "isOptional" : false
 579         },
 580         {
 581           "name" : "value",
 582           "type" : "Mixed",
 583           "desc" : "The value to search for",
 584           "isOptional" : false
 585         }
 586       ],
 587       "returns" : [
 588         {
 589           "name" : "",
 590           "type" : "Node",
 591           "desc" : "The found child or null if none was found"
 592         }
 593       ]
 594     },
 595     {
 596       "name" : "purgeListeners",
 597       "desc" : "Removes all listeners for this object",
 598       "isStatic" : false,
 599       "isConstructor" : false,
 600       "isPrivate" : false,
 601       "memberOf" : "Roo.util.Observable",
 602       "example" : "",
 603       "deprecated" : "",
 604       "since" : "",
 605       "see" : "",
 606       "params" : [],
 607       "returns" : []
 608     },
 609     {
 610       "name" : "on",
 611       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 612       "isStatic" : false,
 613       "isConstructor" : false,
 614       "isPrivate" : false,
 615       "memberOf" : "Roo.util.Observable",
 616       "example" : "",
 617       "deprecated" : "",
 618       "since" : "",
 619       "see" : "",
 620       "params" : [
 621         {
 622           "name" : "eventName",
 623           "type" : "String",
 624           "desc" : "The type of event to listen for",
 625           "isOptional" : false
 626         },
 627         {
 628           "name" : "handler",
 629           "type" : "Function",
 630           "desc" : "The method the event invokes",
 631           "isOptional" : false
 632         },
 633         {
 634           "name" : "scope",
 635           "type" : "Object",
 636           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 637           "isOptional" : false
 638         },
 639         {
 640           "name" : "options",
 641           "type" : "Object",
 642           "desc" : "(optional)",
 643           "isOptional" : false
 644         }
 645       ],
 646       "returns" : []
 647     },
 648     {
 649       "name" : "un",
 650       "desc" : "Removes a listener (shorthand for removeListener)",
 651       "isStatic" : false,
 652       "isConstructor" : false,
 653       "isPrivate" : false,
 654       "memberOf" : "Roo.util.Observable",
 655       "example" : "",
 656       "deprecated" : "",
 657       "since" : "",
 658       "see" : "",
 659       "params" : [
 660         {
 661           "name" : "eventName",
 662           "type" : "String",
 663           "desc" : "The type of event to listen for",
 664           "isOptional" : false
 665         },
 666         {
 667           "name" : "handler",
 668           "type" : "Function",
 669           "desc" : "The handler to remove",
 670           "isOptional" : false
 671         },
 672         {
 673           "name" : "scope",
 674           "type" : "Object",
 675           "desc" : "(optional) The scope (this object) for the handler",
 676           "isOptional" : false
 677         }
 678       ],
 679       "returns" : []
 680     },
 681     {
 682       "name" : "addEvents",
 683       "desc" : "Used to define events on this Observable",
 684       "isStatic" : false,
 685       "isConstructor" : false,
 686       "isPrivate" : false,
 687       "memberOf" : "Roo.util.Observable",
 688       "example" : "",
 689       "deprecated" : "",
 690       "since" : "",
 691       "see" : "",
 692       "params" : [
 693         {
 694           "name" : "object",
 695           "type" : "Object",
 696           "desc" : "The object with the events defined",
 697           "isOptional" : false
 698         }
 699       ],
 700       "returns" : []
 701     },
 702     {
 703       "name" : "releaseCapture",
 704       "desc" : "Removes <b>all</b> added captures from the Observable.",
 705       "isStatic" : true,
 706       "isConstructor" : false,
 707       "isPrivate" : false,
 708       "memberOf" : "Roo.util.Observable",
 709       "example" : "",
 710       "deprecated" : "",
 711       "since" : "",
 712       "see" : "",
 713       "params" : [
 714         {
 715           "name" : "o",
 716           "type" : "Observable",
 717           "desc" : "The Observable to release",
 718           "isOptional" : false
 719         }
 720       ],
 721       "returns" : []
 722     },
 723     {
 724       "name" : "removeListener",
 725       "desc" : "Removes a listener",
 726       "isStatic" : false,
 727       "isConstructor" : false,
 728       "isPrivate" : false,
 729       "memberOf" : "Roo.util.Observable",
 730       "example" : "",
 731       "deprecated" : "",
 732       "since" : "",
 733       "see" : "",
 734       "params" : [
 735         {
 736           "name" : "eventName",
 737           "type" : "String",
 738           "desc" : "The type of event to listen for",
 739           "isOptional" : false
 740         },
 741         {
 742           "name" : "handler",
 743           "type" : "Function",
 744           "desc" : "The handler to remove",
 745           "isOptional" : false
 746         },
 747         {
 748           "name" : "scope",
 749           "type" : "Object",
 750           "desc" : "(optional) The scope (this object) for the handler",
 751           "isOptional" : false
 752         }
 753       ],
 754       "returns" : []
 755     },
 756     {
 757       "name" : "fireEvent",
 758       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 759       "isStatic" : false,
 760       "isConstructor" : false,
 761       "isPrivate" : false,
 762       "memberOf" : "Roo.util.Observable",
 763       "example" : "",
 764       "deprecated" : "",
 765       "since" : "",
 766       "see" : "",
 767       "params" : [
 768         {
 769           "name" : "eventName",
 770           "type" : "String",
 771           "desc" : "",
 772           "isOptional" : false
 773         },
 774         {
 775           "name" : "args",
 776           "type" : "Object...",
 777           "desc" : "Variable number of parameters are passed to handlers",
 778           "isOptional" : false
 779         }
 780       ],
 781       "returns" : [
 782         {
 783           "name" : "",
 784           "type" : "Boolean",
 785           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 786         }
 787       ]
 788     },
 789     {
 790       "name" : "hasListener",
 791       "desc" : "Checks to see if this object has any listeners for a specified event",
 792       "isStatic" : false,
 793       "isConstructor" : false,
 794       "isPrivate" : false,
 795       "memberOf" : "Roo.util.Observable",
 796       "example" : "",
 797       "deprecated" : "",
 798       "since" : "",
 799       "see" : "",
 800       "params" : [
 801         {
 802           "name" : "eventName",
 803           "type" : "String",
 804           "desc" : "The name of the event to check for",
 805           "isOptional" : false
 806         }
 807       ],
 808       "returns" : [
 809         {
 810           "name" : "",
 811           "type" : "Boolean",
 812           "desc" : "True if the event is being listened for, else false"
 813         }
 814       ]
 815     },
 816     {
 817       "name" : "capture",
 818       "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.",
 819       "isStatic" : true,
 820       "isConstructor" : false,
 821       "isPrivate" : false,
 822       "memberOf" : "Roo.util.Observable",
 823       "example" : "",
 824       "deprecated" : "",
 825       "since" : "",
 826       "see" : "",
 827       "params" : [
 828         {
 829           "name" : "o",
 830           "type" : "Observable",
 831           "desc" : "The Observable to capture",
 832           "isOptional" : false
 833         },
 834         {
 835           "name" : "fn",
 836           "type" : "Function",
 837           "desc" : "The function to call",
 838           "isOptional" : false
 839         },
 840         {
 841           "name" : "scope",
 842           "type" : "Object",
 843           "desc" : "(optional) The scope (this object) for the fn",
 844           "isOptional" : false
 845         }
 846       ],
 847       "returns" : []
 848     },
 849     {
 850       "name" : "addListener",
 851       "desc" : "Appends an event handler to this component",
 852       "isStatic" : false,
 853       "isConstructor" : false,
 854       "isPrivate" : false,
 855       "memberOf" : "Roo.util.Observable",
 856       "example" : "",
 857       "deprecated" : "",
 858       "since" : "",
 859       "see" : "",
 860       "params" : [
 861         {
 862           "name" : "eventName",
 863           "type" : "String",
 864           "desc" : "The type of event to listen for",
 865           "isOptional" : false
 866         },
 867         {
 868           "name" : "handler",
 869           "type" : "Function",
 870           "desc" : "The method the event invokes",
 871           "isOptional" : false
 872         },
 873         {
 874           "name" : "scope",
 875           "type" : "Object",
 876           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 877           "isOptional" : false
 878         },
 879         {
 880           "name" : "options",
 881           "type" : "Object",
 882           "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>",
 883           "isOptional" : false
 884         }
 885       ],
 886       "returns" : []
 887     }
 888   ],
 889   "events" : [
 890     {
 891       "name" : "beforeappend",
 892       "desc" : "Fires before a new child is appended, return false to cancel the append.",
 893       "memberOf" : "Roo.data.Node",
 894       "example" : "",
 895       "deprecated" : "",
 896       "since" : "",
 897       "see" : "",
 898       "params" : [
 899         {
 900           "name" : "tree",
 901           "type" : "Tree",
 902           "desc" : "The owner tree",
 903           "isOptional" : false
 904         },
 905         {
 906           "name" : "this",
 907           "type" : "Node",
 908           "desc" : "This node",
 909           "isOptional" : false
 910         },
 911         {
 912           "name" : "node",
 913           "type" : "Node",
 914           "desc" : "The child node to be appended",
 915           "isOptional" : false
 916         }
 917       ],
 918       "returns" : []
 919     },
 920     {
 921       "name" : "move",
 922       "desc" : "Fires when this node is moved to a new location in the tree",
 923       "memberOf" : "Roo.data.Node",
 924       "example" : "",
 925       "deprecated" : "",
 926       "since" : "",
 927       "see" : "",
 928       "params" : [
 929         {
 930           "name" : "tree",
 931           "type" : "Tree",
 932           "desc" : "The owner tree",
 933           "isOptional" : false
 934         },
 935         {
 936           "name" : "this",
 937           "type" : "Node",
 938           "desc" : "This node",
 939           "isOptional" : false
 940         },
 941         {
 942           "name" : "oldParent",
 943           "type" : "Node",
 944           "desc" : "The old parent of this node",
 945           "isOptional" : false
 946         },
 947         {
 948           "name" : "newParent",
 949           "type" : "Node",
 950           "desc" : "The new parent of this node",
 951           "isOptional" : false
 952         },
 953         {
 954           "name" : "index",
 955           "type" : "Number",
 956           "desc" : "The index it was moved to",
 957           "isOptional" : false
 958         }
 959       ],
 960       "returns" : []
 961     },
 962     {
 963       "name" : "append",
 964       "desc" : "Fires when a new child node is appended",
 965       "memberOf" : "Roo.data.Node",
 966       "example" : "",
 967       "deprecated" : "",
 968       "since" : "",
 969       "see" : "",
 970       "params" : [
 971         {
 972           "name" : "tree",
 973           "type" : "Tree",
 974           "desc" : "The owner tree",
 975           "isOptional" : false
 976         },
 977         {
 978           "name" : "this",
 979           "type" : "Node",
 980           "desc" : "This node",
 981           "isOptional" : false
 982         },
 983         {
 984           "name" : "node",
 985           "type" : "Node",
 986           "desc" : "The newly appended node",
 987           "isOptional" : false
 988         },
 989         {
 990           "name" : "index",
 991           "type" : "Number",
 992           "desc" : "The index of the newly appended node",
 993           "isOptional" : false
 994         }
 995       ],
 996       "returns" : []
 997     },
 998     {
 999       "name" : "beforeremove",
1000       "desc" : "Fires before a child is removed, return false to cancel the remove.",
1001       "memberOf" : "Roo.data.Node",
1002       "example" : "",
1003       "deprecated" : "",
1004       "since" : "",
1005       "see" : "",
1006       "params" : [
1007         {
1008           "name" : "tree",
1009           "type" : "Tree",
1010           "desc" : "The owner tree",
1011           "isOptional" : false
1012         },
1013         {
1014           "name" : "this",
1015           "type" : "Node",
1016           "desc" : "This node",
1017           "isOptional" : false
1018         },
1019         {
1020           "name" : "node",
1021           "type" : "Node",
1022           "desc" : "The child node to be removed",
1023           "isOptional" : false
1024         }
1025       ],
1026       "returns" : []
1027     },
1028     {
1029       "name" : "remove",
1030       "desc" : "Fires when a child node is removed",
1031       "memberOf" : "Roo.data.Node",
1032       "example" : "",
1033       "deprecated" : "",
1034       "since" : "",
1035       "see" : "",
1036       "params" : [
1037         {
1038           "name" : "tree",
1039           "type" : "Tree",
1040           "desc" : "The owner tree",
1041           "isOptional" : false
1042         },
1043         {
1044           "name" : "this",
1045           "type" : "Node",
1046           "desc" : "This node",
1047           "isOptional" : false
1048         },
1049         {
1050           "name" : "node",
1051           "type" : "Node",
1052           "desc" : "The removed node",
1053           "isOptional" : false
1054         }
1055       ],
1056       "returns" : []
1057     },
1058     {
1059       "name" : "beforeinsert",
1060       "desc" : "Fires before a new child is inserted, return false to cancel the insert.",
1061       "memberOf" : "Roo.data.Node",
1062       "example" : "",
1063       "deprecated" : "",
1064       "since" : "",
1065       "see" : "",
1066       "params" : [
1067         {
1068           "name" : "tree",
1069           "type" : "Tree",
1070           "desc" : "The owner tree",
1071           "isOptional" : false
1072         },
1073         {
1074           "name" : "this",
1075           "type" : "Node",
1076           "desc" : "This node",
1077           "isOptional" : false
1078         },
1079         {
1080           "name" : "node",
1081           "type" : "Node",
1082           "desc" : "The child node to be inserted",
1083           "isOptional" : false
1084         },
1085         {
1086           "name" : "refNode",
1087           "type" : "Node",
1088           "desc" : "The child node the node is being inserted before",
1089           "isOptional" : false
1090         }
1091       ],
1092       "returns" : []
1093     },
1094     {
1095       "name" : "insert",
1096       "desc" : "Fires when a new child node is inserted.",
1097       "memberOf" : "Roo.data.Node",
1098       "example" : "",
1099       "deprecated" : "",
1100       "since" : "",
1101       "see" : "",
1102       "params" : [
1103         {
1104           "name" : "tree",
1105           "type" : "Tree",
1106           "desc" : "The owner tree",
1107           "isOptional" : false
1108         },
1109         {
1110           "name" : "this",
1111           "type" : "Node",
1112           "desc" : "This node",
1113           "isOptional" : false
1114         },
1115         {
1116           "name" : "node",
1117           "type" : "Node",
1118           "desc" : "The child node inserted",
1119           "isOptional" : false
1120         },
1121         {
1122           "name" : "refNode",
1123           "type" : "Node",
1124           "desc" : "The child node the node was inserted before",
1125           "isOptional" : false
1126         }
1127       ],
1128       "returns" : []
1129     },
1130     {
1131       "name" : "beforemove",
1132       "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.",
1133       "memberOf" : "Roo.data.Node",
1134       "example" : "",
1135       "deprecated" : "",
1136       "since" : "",
1137       "see" : "",
1138       "params" : [
1139         {
1140           "name" : "tree",
1141           "type" : "Tree",
1142           "desc" : "The owner tree",
1143           "isOptional" : false
1144         },
1145         {
1146           "name" : "this",
1147           "type" : "Node",
1148           "desc" : "This node",
1149           "isOptional" : false
1150         },
1151         {
1152           "name" : "oldParent",
1153           "type" : "Node",
1154           "desc" : "The parent of this node",
1155           "isOptional" : false
1156         },
1157         {
1158           "name" : "newParent",
1159           "type" : "Node",
1160           "desc" : "The new parent this node is moving to",
1161           "isOptional" : false
1162         },
1163         {
1164           "name" : "index",
1165           "type" : "Number",
1166           "desc" : "The index it is being moved to",
1167           "isOptional" : false
1168         }
1169       ],
1170       "returns" : []
1171     }
1172   ]
1173 }