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