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