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