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