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