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

   1 {
   2   "name" : "Roo.data.Tree",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "childClasses" : [
   7     "Roo.tree.TreePanel"
   8   ],
   9   "desc" : "Represents a tree data structure and bubbles all the events for its nodes. The nodes\nin the tree have most standard DOM functionality.",
  10   "isSingleton" : false,
  11   "isStatic" : false,
  12   "isBuiltin" : false,
  13   "memberOf" : "Tree",
  14   "example" : "",
  15   "deprecated" : "",
  16   "since" : "",
  17   "see" : "",
  18   "params" : [
  19     {
  20       "name" : "root",
  21       "type" : "Node",
  22       "desc" : "(optional) The root node",
  23       "isOptional" : false
  24     }
  25   ],
  26   "returns" : [],
  27   "throws" : "",
  28   "requires" : "",
  29   "config" : [
  30     {
  31       "name" : "listeners",
  32       "type" : "Object",
  33       "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>",
  34       "memberOf" : "Roo.util.Observable"
  35     }
  36   ],
  37   "methods" : [
  38     {
  39       "name" : "setRootNode",
  40       "type" : "function",
  41       "desc" : "Sets the root node for this tree.",
  42       "sig" : "(node)",
  43       "static" : false,
  44       "memberOf" : "",
  45       "isStatic" : false,
  46       "isConstructor" : false,
  47       "isPrivate" : false,
  48       "example" : "",
  49       "deprecated" : "",
  50       "since" : "",
  51       "see" : "",
  52       "exceptions" : "",
  53       "requires" : "",
  54       "params" : [
  55         {
  56           "name" : "node",
  57           "type" : "Node",
  58           "desc" : "",
  59           "isOptional" : false
  60         }
  61       ],
  62       "returns" : [
  63         {
  64           "name" : "",
  65           "type" : "Node",
  66           "desc" : ""
  67         }
  68       ]
  69     },
  70     {
  71       "name" : "getRootNode",
  72       "type" : "function",
  73       "desc" : "Returns the root node for this tree.",
  74       "sig" : "()\n{\n\n}",
  75       "static" : false,
  76       "memberOf" : "",
  77       "isStatic" : false,
  78       "isConstructor" : false,
  79       "isPrivate" : false,
  80       "example" : "",
  81       "deprecated" : "",
  82       "since" : "",
  83       "see" : "",
  84       "exceptions" : "",
  85       "requires" : "",
  86       "params" : [],
  87       "returns" : [
  88         {
  89           "name" : "",
  90           "type" : "Node",
  91           "desc" : ""
  92         }
  93       ]
  94     },
  95     {
  96       "name" : "getNodeById",
  97       "type" : "function",
  98       "desc" : "Gets a node in this tree by its id.",
  99       "sig" : "(id)",
 100       "static" : false,
 101       "memberOf" : "",
 102       "isStatic" : false,
 103       "isConstructor" : false,
 104       "isPrivate" : false,
 105       "example" : "",
 106       "deprecated" : "",
 107       "since" : "",
 108       "see" : "",
 109       "exceptions" : "",
 110       "requires" : "",
 111       "params" : [
 112         {
 113           "name" : "id",
 114           "type" : "String",
 115           "desc" : "",
 116           "isOptional" : false
 117         }
 118       ],
 119       "returns" : [
 120         {
 121           "name" : "",
 122           "type" : "Node",
 123           "desc" : ""
 124         }
 125       ]
 126     },
 127     {
 128       "name" : "purgeListeners",
 129       "type" : "function",
 130       "desc" : "Removes all listeners for this object",
 131       "sig" : "()\n{\n\n}",
 132       "static" : false,
 133       "memberOf" : "Roo.util.Observable",
 134       "isStatic" : false,
 135       "isConstructor" : false,
 136       "isPrivate" : false,
 137       "example" : "",
 138       "deprecated" : "",
 139       "since" : "",
 140       "see" : "",
 141       "exceptions" : "",
 142       "requires" : "",
 143       "params" : [],
 144       "returns" : []
 145     },
 146     {
 147       "name" : "on",
 148       "type" : "function",
 149       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 150       "sig" : "(eventName, handler, scope, options)",
 151       "static" : false,
 152       "memberOf" : "Roo.util.Observable",
 153       "isStatic" : false,
 154       "isConstructor" : false,
 155       "isPrivate" : false,
 156       "example" : "",
 157       "deprecated" : "",
 158       "since" : "",
 159       "see" : "",
 160       "exceptions" : "",
 161       "requires" : "",
 162       "params" : [
 163         {
 164           "name" : "eventName",
 165           "type" : "String",
 166           "desc" : "The type of event to listen for",
 167           "isOptional" : false
 168         },
 169         {
 170           "name" : "handler",
 171           "type" : "Function",
 172           "desc" : "The method the event invokes",
 173           "isOptional" : false
 174         },
 175         {
 176           "name" : "scope",
 177           "type" : "Object",
 178           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 179           "isOptional" : false
 180         },
 181         {
 182           "name" : "options",
 183           "type" : "Object",
 184           "desc" : "(optional)",
 185           "isOptional" : false
 186         }
 187       ],
 188       "returns" : []
 189     },
 190     {
 191       "name" : "un",
 192       "type" : "function",
 193       "desc" : "Removes a listener (shorthand for removeListener)",
 194       "sig" : "(eventName, handler, scope)",
 195       "static" : false,
 196       "memberOf" : "Roo.util.Observable",
 197       "isStatic" : false,
 198       "isConstructor" : false,
 199       "isPrivate" : false,
 200       "example" : "",
 201       "deprecated" : "",
 202       "since" : "",
 203       "see" : "",
 204       "exceptions" : "",
 205       "requires" : "",
 206       "params" : [
 207         {
 208           "name" : "eventName",
 209           "type" : "String",
 210           "desc" : "The type of event to listen for",
 211           "isOptional" : false
 212         },
 213         {
 214           "name" : "handler",
 215           "type" : "Function",
 216           "desc" : "The handler to remove",
 217           "isOptional" : false
 218         },
 219         {
 220           "name" : "scope",
 221           "type" : "Object",
 222           "desc" : "(optional) The scope (this object) for the handler",
 223           "isOptional" : false
 224         }
 225       ],
 226       "returns" : []
 227     },
 228     {
 229       "name" : "addEvents",
 230       "type" : "function",
 231       "desc" : "Used to define events on this Observable",
 232       "sig" : "(object)",
 233       "static" : false,
 234       "memberOf" : "Roo.util.Observable",
 235       "isStatic" : false,
 236       "isConstructor" : false,
 237       "isPrivate" : false,
 238       "example" : "",
 239       "deprecated" : "",
 240       "since" : "",
 241       "see" : "",
 242       "exceptions" : "",
 243       "requires" : "",
 244       "params" : [
 245         {
 246           "name" : "object",
 247           "type" : "Object",
 248           "desc" : "The object with the events defined",
 249           "isOptional" : false
 250         }
 251       ],
 252       "returns" : []
 253     },
 254     {
 255       "name" : "releaseCapture",
 256       "type" : "function",
 257       "desc" : "Removes <b>all</b> added captures from the Observable.",
 258       "sig" : "(o)",
 259       "static" : true,
 260       "memberOf" : "Roo.util.Observable",
 261       "isStatic" : true,
 262       "isConstructor" : false,
 263       "isPrivate" : false,
 264       "example" : "",
 265       "deprecated" : "",
 266       "since" : "",
 267       "see" : "",
 268       "exceptions" : "",
 269       "requires" : "",
 270       "params" : [
 271         {
 272           "name" : "o",
 273           "type" : "Observable",
 274           "desc" : "The Observable to release",
 275           "isOptional" : false
 276         }
 277       ],
 278       "returns" : []
 279     },
 280     {
 281       "name" : "removeListener",
 282       "type" : "function",
 283       "desc" : "Removes a listener",
 284       "sig" : "(eventName, handler, scope)",
 285       "static" : false,
 286       "memberOf" : "Roo.util.Observable",
 287       "isStatic" : false,
 288       "isConstructor" : false,
 289       "isPrivate" : false,
 290       "example" : "",
 291       "deprecated" : "",
 292       "since" : "",
 293       "see" : "",
 294       "exceptions" : "",
 295       "requires" : "",
 296       "params" : [
 297         {
 298           "name" : "eventName",
 299           "type" : "String",
 300           "desc" : "The type of event to listen for",
 301           "isOptional" : false
 302         },
 303         {
 304           "name" : "handler",
 305           "type" : "Function",
 306           "desc" : "The handler to remove",
 307           "isOptional" : false
 308         },
 309         {
 310           "name" : "scope",
 311           "type" : "Object",
 312           "desc" : "(optional) The scope (this object) for the handler",
 313           "isOptional" : false
 314         }
 315       ],
 316       "returns" : []
 317     },
 318     {
 319       "name" : "fireEvent",
 320       "type" : "function",
 321       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 322       "sig" : "(eventName, args)",
 323       "static" : false,
 324       "memberOf" : "Roo.util.Observable",
 325       "isStatic" : false,
 326       "isConstructor" : false,
 327       "isPrivate" : false,
 328       "example" : "",
 329       "deprecated" : "",
 330       "since" : "",
 331       "see" : "",
 332       "exceptions" : "",
 333       "requires" : "",
 334       "params" : [
 335         {
 336           "name" : "eventName",
 337           "type" : "String",
 338           "desc" : "",
 339           "isOptional" : false
 340         },
 341         {
 342           "name" : "args",
 343           "type" : "Object...",
 344           "desc" : "Variable number of parameters are passed to handlers",
 345           "isOptional" : false
 346         }
 347       ],
 348       "returns" : [
 349         {
 350           "name" : "",
 351           "type" : "Boolean",
 352           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 353         }
 354       ]
 355     },
 356     {
 357       "name" : "hasListener",
 358       "type" : "function",
 359       "desc" : "Checks to see if this object has any listeners for a specified event",
 360       "sig" : "(eventName)",
 361       "static" : false,
 362       "memberOf" : "Roo.util.Observable",
 363       "isStatic" : false,
 364       "isConstructor" : false,
 365       "isPrivate" : false,
 366       "example" : "",
 367       "deprecated" : "",
 368       "since" : "",
 369       "see" : "",
 370       "exceptions" : "",
 371       "requires" : "",
 372       "params" : [
 373         {
 374           "name" : "eventName",
 375           "type" : "String",
 376           "desc" : "The name of the event to check for",
 377           "isOptional" : false
 378         }
 379       ],
 380       "returns" : [
 381         {
 382           "name" : "",
 383           "type" : "Boolean",
 384           "desc" : "True if the event is being listened for, else false"
 385         }
 386       ]
 387     },
 388     {
 389       "name" : "capture",
 390       "type" : "function",
 391       "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.",
 392       "sig" : "(o, fn, scope)",
 393       "static" : true,
 394       "memberOf" : "Roo.util.Observable",
 395       "isStatic" : true,
 396       "isConstructor" : false,
 397       "isPrivate" : false,
 398       "example" : "",
 399       "deprecated" : "",
 400       "since" : "",
 401       "see" : "",
 402       "exceptions" : "",
 403       "requires" : "",
 404       "params" : [
 405         {
 406           "name" : "o",
 407           "type" : "Observable",
 408           "desc" : "The Observable to capture",
 409           "isOptional" : false
 410         },
 411         {
 412           "name" : "fn",
 413           "type" : "Function",
 414           "desc" : "The function to call",
 415           "isOptional" : false
 416         },
 417         {
 418           "name" : "scope",
 419           "type" : "Object",
 420           "desc" : "(optional) The scope (this object) for the fn",
 421           "isOptional" : false
 422         }
 423       ],
 424       "returns" : []
 425     },
 426     {
 427       "name" : "addListener",
 428       "type" : "function",
 429       "desc" : "Appends an event handler to this component",
 430       "sig" : "(eventName, handler, scope, options)",
 431       "static" : false,
 432       "memberOf" : "Roo.util.Observable",
 433       "isStatic" : false,
 434       "isConstructor" : false,
 435       "isPrivate" : false,
 436       "example" : "",
 437       "deprecated" : "",
 438       "since" : "",
 439       "see" : "",
 440       "exceptions" : "",
 441       "requires" : "",
 442       "params" : [
 443         {
 444           "name" : "eventName",
 445           "type" : "String",
 446           "desc" : "The type of event to listen for",
 447           "isOptional" : false
 448         },
 449         {
 450           "name" : "handler",
 451           "type" : "Function",
 452           "desc" : "The method the event invokes",
 453           "isOptional" : false
 454         },
 455         {
 456           "name" : "scope",
 457           "type" : "Object",
 458           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 459           "isOptional" : false
 460         },
 461         {
 462           "name" : "options",
 463           "type" : "Object",
 464           "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>",
 465           "isOptional" : false
 466         }
 467       ],
 468       "returns" : []
 469     }
 470   ],
 471   "events" : [
 472     {
 473       "name" : "append",
 474       "type" : "function",
 475       "desc" : "Fires when a new child node is appended to a node in this tree.",
 476       "sig" : "function (tree, parent, node, index)\n{\n\n}",
 477       "memberOf" : "",
 478       "example" : "",
 479       "deprecated" : "",
 480       "since" : "",
 481       "see" : "",
 482       "params" : [
 483         {
 484           "name" : "tree",
 485           "type" : "Tree",
 486           "desc" : "The owner tree",
 487           "isOptional" : false
 488         },
 489         {
 490           "name" : "parent",
 491           "type" : "Node",
 492           "desc" : "The parent node",
 493           "isOptional" : false
 494         },
 495         {
 496           "name" : "node",
 497           "type" : "Node",
 498           "desc" : "The newly appended node",
 499           "isOptional" : false
 500         },
 501         {
 502           "name" : "index",
 503           "type" : "Number",
 504           "desc" : "The index of the newly appended node",
 505           "isOptional" : false
 506         }
 507       ],
 508       "returns" : []
 509     },
 510     {
 511       "name" : "beforemove",
 512       "type" : "function",
 513       "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.",
 514       "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
 515       "memberOf" : "",
 516       "example" : "",
 517       "deprecated" : "",
 518       "since" : "",
 519       "see" : "",
 520       "params" : [
 521         {
 522           "name" : "tree",
 523           "type" : "Tree",
 524           "desc" : "The owner tree",
 525           "isOptional" : false
 526         },
 527         {
 528           "name" : "node",
 529           "type" : "Node",
 530           "desc" : "The node being moved",
 531           "isOptional" : false
 532         },
 533         {
 534           "name" : "oldParent",
 535           "type" : "Node",
 536           "desc" : "The parent of the node",
 537           "isOptional" : false
 538         },
 539         {
 540           "name" : "newParent",
 541           "type" : "Node",
 542           "desc" : "The new parent the node is moving to",
 543           "isOptional" : false
 544         },
 545         {
 546           "name" : "index",
 547           "type" : "Number",
 548           "desc" : "The index it is being moved to",
 549           "isOptional" : false
 550         }
 551       ],
 552       "returns" : []
 553     },
 554     {
 555       "name" : "insert",
 556       "type" : "function",
 557       "desc" : "Fires when a new child node is inserted in a node in this tree.",
 558       "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
 559       "memberOf" : "",
 560       "example" : "",
 561       "deprecated" : "",
 562       "since" : "",
 563       "see" : "",
 564       "params" : [
 565         {
 566           "name" : "tree",
 567           "type" : "Tree",
 568           "desc" : "The owner tree",
 569           "isOptional" : false
 570         },
 571         {
 572           "name" : "parent",
 573           "type" : "Node",
 574           "desc" : "The parent node",
 575           "isOptional" : false
 576         },
 577         {
 578           "name" : "node",
 579           "type" : "Node",
 580           "desc" : "The child node inserted",
 581           "isOptional" : false
 582         },
 583         {
 584           "name" : "refNode",
 585           "type" : "Node",
 586           "desc" : "The child node the node was inserted before",
 587           "isOptional" : false
 588         }
 589       ],
 590       "returns" : []
 591     },
 592     {
 593       "name" : "beforeappend",
 594       "type" : "function",
 595       "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.",
 596       "sig" : "function (tree, parent, node)\n{\n\n}",
 597       "memberOf" : "",
 598       "example" : "",
 599       "deprecated" : "",
 600       "since" : "",
 601       "see" : "",
 602       "params" : [
 603         {
 604           "name" : "tree",
 605           "type" : "Tree",
 606           "desc" : "The owner tree",
 607           "isOptional" : false
 608         },
 609         {
 610           "name" : "parent",
 611           "type" : "Node",
 612           "desc" : "The parent node",
 613           "isOptional" : false
 614         },
 615         {
 616           "name" : "node",
 617           "type" : "Node",
 618           "desc" : "The child node to be appended",
 619           "isOptional" : false
 620         }
 621       ],
 622       "returns" : []
 623     },
 624     {
 625       "name" : "move",
 626       "type" : "function",
 627       "desc" : "Fires when a node is moved to a new location in the tree",
 628       "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
 629       "memberOf" : "",
 630       "example" : "",
 631       "deprecated" : "",
 632       "since" : "",
 633       "see" : "",
 634       "params" : [
 635         {
 636           "name" : "tree",
 637           "type" : "Tree",
 638           "desc" : "The owner tree",
 639           "isOptional" : false
 640         },
 641         {
 642           "name" : "node",
 643           "type" : "Node",
 644           "desc" : "The node moved",
 645           "isOptional" : false
 646         },
 647         {
 648           "name" : "oldParent",
 649           "type" : "Node",
 650           "desc" : "The old parent of this node",
 651           "isOptional" : false
 652         },
 653         {
 654           "name" : "newParent",
 655           "type" : "Node",
 656           "desc" : "The new parent of this node",
 657           "isOptional" : false
 658         },
 659         {
 660           "name" : "index",
 661           "type" : "Number",
 662           "desc" : "The index it was moved to",
 663           "isOptional" : false
 664         }
 665       ],
 666       "returns" : []
 667     },
 668     {
 669       "name" : "beforeremove",
 670       "type" : "function",
 671       "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.",
 672       "sig" : "function (tree, parent, node)\n{\n\n}",
 673       "memberOf" : "",
 674       "example" : "",
 675       "deprecated" : "",
 676       "since" : "",
 677       "see" : "",
 678       "params" : [
 679         {
 680           "name" : "tree",
 681           "type" : "Tree",
 682           "desc" : "The owner tree",
 683           "isOptional" : false
 684         },
 685         {
 686           "name" : "parent",
 687           "type" : "Node",
 688           "desc" : "The parent node",
 689           "isOptional" : false
 690         },
 691         {
 692           "name" : "node",
 693           "type" : "Node",
 694           "desc" : "The child node to be removed",
 695           "isOptional" : false
 696         }
 697       ],
 698       "returns" : []
 699     },
 700     {
 701       "name" : "remove",
 702       "type" : "function",
 703       "desc" : "Fires when a child node is removed from a node in this tree.",
 704       "sig" : "function (tree, parent, node)\n{\n\n}",
 705       "memberOf" : "",
 706       "example" : "",
 707       "deprecated" : "",
 708       "since" : "",
 709       "see" : "",
 710       "params" : [
 711         {
 712           "name" : "tree",
 713           "type" : "Tree",
 714           "desc" : "The owner tree",
 715           "isOptional" : false
 716         },
 717         {
 718           "name" : "parent",
 719           "type" : "Node",
 720           "desc" : "The parent node",
 721           "isOptional" : false
 722         },
 723         {
 724           "name" : "node",
 725           "type" : "Node",
 726           "desc" : "The child node removed",
 727           "isOptional" : false
 728         }
 729       ],
 730       "returns" : []
 731     },
 732     {
 733       "name" : "beforeinsert",
 734       "type" : "function",
 735       "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.",
 736       "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
 737       "memberOf" : "",
 738       "example" : "",
 739       "deprecated" : "",
 740       "since" : "",
 741       "see" : "",
 742       "params" : [
 743         {
 744           "name" : "tree",
 745           "type" : "Tree",
 746           "desc" : "The owner tree",
 747           "isOptional" : false
 748         },
 749         {
 750           "name" : "parent",
 751           "type" : "Node",
 752           "desc" : "The parent node",
 753           "isOptional" : false
 754         },
 755         {
 756           "name" : "node",
 757           "type" : "Node",
 758           "desc" : "The child node to be inserted",
 759           "isOptional" : false
 760         },
 761         {
 762           "name" : "refNode",
 763           "type" : "Node",
 764           "desc" : "The child node the node is being inserted before",
 765           "isOptional" : false
 766         }
 767       ],
 768       "returns" : []
 769     }
 770   ]
 771 }