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