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