git.roojs.org Git - roojs1/blob - docs/symbols/Roo.View.json

   1 {
   2   "name" : "Roo.View",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "desc" : "Create a \"View\" for an element based on a data model or UpdateManager and the supplied DomHelper template. \nThis class also supports single and multi selection modes. <br>\nCreate a data model bound view:\n <pre><code>\n var store = new Roo.data.Store(...);\n\n var view = new Roo.View({\n    el : \"my-element\",\n    tpl : '&lt;div id=\"{0}\"&gt;{2} - {1}&lt;/div&gt;', // auto create template\n \n    singleSelect: true,\n    selectedClass: \"ydataview-selected\",\n    store: store\n });\n\n // listen for node click?\n view.on(\"click\", function(vw, index, node, e){\n alert('Node \"' + node.id + '\" at index: ' + index + \" was clicked.\");\n });\n\n // load XML data\n dataModel.load(\"foobar.xml\");\n </code></pre>\n For an example of creating a JSON/UpdateManager view, see {@link Roo.JsonView}.\n<br><br>\n<b>Note: The root of your template must be a single node. Table/row implementations may work but are not supported due to\nIE\"s limited insertion support with tables and Opera\"s faulty event bubbling.</b>\n\nNote: old style constructor is still suported (container, template, config)",
   7   "isSingleton" : false,
   8   "isStatic" : false,
   9   "isBuiltin" : false,
  10   "memberOf" : "View",
  11   "example" : "",
  12   "deprecated" : "",
  13   "since" : "",
  14   "see" : "",
  15   "params" : [
  16     {
  17       "name" : "config",
  18       "type" : "Object",
  19       "desc" : "The config object",
  20       "isOptional" : false
  21     }
  22   ],
  23   "returns" : [
  24   ],
  25   "config" : [
  26     {
  27       "name" : "selectedClass",
  28       "type" : "String",
  29       "desc" : "The css class to add to selected nodes",
  30       "memberOf" : "Roo.View",
  31       "values" : [
  32       ]
  33     },
  34     {
  35       "name" : "listeners",
  36       "type" : "Object",
  37       "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>",
  38       "memberOf" : "Roo.util.Observable",
  39       "values" : [
  40       ]
  41     },
  42     {
  43       "name" : "dataName",
  44       "type" : "String",
  45       "desc" : "the named area of the template to use as the data area\n                         Works with domtemplates roo-name=\"name\"",
  46       "memberOf" : "Roo.View",
  47       "values" : [
  48       ]
  49     },
  50     {
  51       "name" : "text",
  52       "type" : "String",
  53       "desc" : "to display on mask (default Loading)",
  54       "memberOf" : "Roo.View",
  55       "values" : [
  56       ]
  57     },
  58     {
  59       "name" : "multiSelect",
  60       "type" : "Boolean",
  61       "desc" : "Allow multiple selection",
  62       "memberOf" : "Roo.View",
  63       "values" : [
  64       ]
  65     },
  66     {
  67       "name" : "emptyText",
  68       "type" : "String",
  69       "desc" : "The empty text to show when nothing is loaded.",
  70       "memberOf" : "Roo.View",
  71       "values" : [
  72       ]
  73     },
  74     {
  75       "name" : "store",
  76       "type" : "Roo.data.Store",
  77       "desc" : "Data store to load data from.",
  78       "memberOf" : "Roo.View",
  79       "values" : [
  80       ]
  81     },
  82     {
  83       "name" : "toggleSelect",
  84       "type" : "Boolean",
  85       "desc" : "- selecting",
  86       "memberOf" : "Roo.View",
  87       "values" : [
  88       ]
  89     },
  90     {
  91       "name" : "singleSelect",
  92       "type" : "Boolean",
  93       "desc" : "Allow single selection",
  94       "memberOf" : "Roo.View",
  95       "values" : [
  96       ]
  97     },
  98     {
  99       "name" : "tickable",
 100       "type" : "Boolean",
 101       "desc" : "- selecting",
 102       "memberOf" : "Roo.View",
 103       "values" : [
 104       ]
 105     },
 106     {
 107       "name" : "el",
 108       "type" : "String|Roo.Element",
 109       "desc" : "The container element.",
 110       "memberOf" : "Roo.View",
 111       "values" : [
 112       ]
 113     },
 114     {
 115       "name" : "tpl",
 116       "type" : "String|Roo.Template",
 117       "desc" : "The template used by this View",
 118       "memberOf" : "Roo.View",
 119       "values" : [
 120       ]
 121     }
 122   ],
 123   "methods" : [
 124     {
 125       "name" : "getSelectedNodes",
 126       "desc" : "Get the currently selected nodes.",
 127       "isStatic" : false,
 128       "isConstructor" : false,
 129       "isPrivate" : false,
 130       "memberOf" : "Roo.View",
 131       "example" : "",
 132       "deprecated" : "",
 133       "since" : "",
 134       "see" : "",
 135       "params" : [
 136       ],
 137       "returns" : [
 138         {
 139           "name" : "",
 140           "type" : "Array",
 141           "desc" : "An array of HTMLElements"
 142         }
 143       ]
 144     },
 145     {
 146       "name" : "getNodes",
 147       "desc" : "Gets a range template nodes.",
 148       "isStatic" : false,
 149       "isConstructor" : false,
 150       "isPrivate" : false,
 151       "memberOf" : "Roo.View",
 152       "example" : "",
 153       "deprecated" : "",
 154       "since" : "",
 155       "see" : "",
 156       "params" : [
 157         {
 158           "name" : "startIndex",
 159           "type" : "Number",
 160           "desc" : "",
 161           "isOptional" : false
 162         },
 163         {
 164           "name" : "endIndex",
 165           "type" : "Number",
 166           "desc" : "",
 167           "isOptional" : false
 168         }
 169       ],
 170       "returns" : [
 171         {
 172           "name" : "",
 173           "type" : "Array",
 174           "desc" : "An array of nodes"
 175         }
 176       ]
 177     },
 178     {
 179       "name" : "select",
 180       "desc" : "Selects nodes.",
 181       "isStatic" : false,
 182       "isConstructor" : false,
 183       "isPrivate" : false,
 184       "memberOf" : "Roo.View",
 185       "example" : "",
 186       "deprecated" : "",
 187       "since" : "",
 188       "see" : "",
 189       "params" : [
 190         {
 191           "name" : "nodeInfo",
 192           "type" : "Array/HTMLElement/String/Number",
 193           "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select",
 194           "isOptional" : false
 195         },
 196         {
 197           "name" : "keepExisting",
 198           "type" : "Boolean",
 199           "desc" : "(optional) true to keep existing selections",
 200           "isOptional" : false
 201         },
 202         {
 203           "name" : "suppressEvent",
 204           "type" : "Boolean",
 205           "desc" : "(optional) true to skip firing of the selectionchange vent",
 206           "isOptional" : false
 207         }
 208       ],
 209       "returns" : [
 210       ]
 211     },
 212     {
 213       "name" : "clearSelections",
 214       "desc" : "Clear all selections",
 215       "isStatic" : false,
 216       "isConstructor" : false,
 217       "isPrivate" : false,
 218       "memberOf" : "Roo.View",
 219       "example" : "",
 220       "deprecated" : "",
 221       "since" : "",
 222       "see" : "",
 223       "params" : [
 224         {
 225           "name" : "suppressEvent",
 226           "type" : "Boolean",
 227           "desc" : "(optional) true to skip firing of the selectionchange event",
 228           "isOptional" : false
 229         }
 230       ],
 231       "returns" : [
 232       ]
 233     },
 234     {
 235       "name" : "isSelected",
 236       "desc" : "Returns true if the passed node is selected",
 237       "isStatic" : false,
 238       "isConstructor" : false,
 239       "isPrivate" : false,
 240       "memberOf" : "Roo.View",
 241       "example" : "",
 242       "deprecated" : "",
 243       "since" : "",
 244       "see" : "",
 245       "params" : [
 246         {
 247           "name" : "node",
 248           "type" : "HTMLElement/Number",
 249           "desc" : "The node or node index",
 250           "isOptional" : false
 251         }
 252       ],
 253       "returns" : [
 254         {
 255           "name" : "",
 256           "type" : "Boolean",
 257           "desc" : ""
 258         }
 259       ]
 260     },
 261     {
 262       "name" : "refresh",
 263       "desc" : "Refreshes the view. - called by datachanged on the store. - do not call directly.",
 264       "isStatic" : false,
 265       "isConstructor" : false,
 266       "isPrivate" : false,
 267       "memberOf" : "Roo.View",
 268       "example" : "",
 269       "deprecated" : "",
 270       "since" : "",
 271       "see" : "",
 272       "params" : [
 273       ],
 274       "returns" : [
 275       ]
 276     },
 277     {
 278       "name" : "onBeforeLoad",
 279       "desc" : "onbeforeLoad - masks the loading area.",
 280       "isStatic" : false,
 281       "isConstructor" : false,
 282       "isPrivate" : false,
 283       "memberOf" : "Roo.View",
 284       "example" : "",
 285       "deprecated" : "",
 286       "since" : "",
 287       "see" : "",
 288       "params" : [
 289       ],
 290       "returns" : [
 291       ]
 292     },
 293     {
 294       "name" : "getSelectedIndexes",
 295       "desc" : "Get the indexes of the selected nodes.",
 296       "isStatic" : false,
 297       "isConstructor" : false,
 298       "isPrivate" : false,
 299       "memberOf" : "Roo.View",
 300       "example" : "",
 301       "deprecated" : "",
 302       "since" : "",
 303       "see" : "",
 304       "params" : [
 305       ],
 306       "returns" : [
 307         {
 308           "name" : "",
 309           "type" : "Array",
 310           "desc" : ""
 311         }
 312       ]
 313     },
 314     {
 315       "name" : "indexOf",
 316       "desc" : "Finds the index of the passed node",
 317       "isStatic" : false,
 318       "isConstructor" : false,
 319       "isPrivate" : false,
 320       "memberOf" : "Roo.View",
 321       "example" : "",
 322       "deprecated" : "",
 323       "since" : "",
 324       "see" : "",
 325       "params" : [
 326         {
 327           "name" : "nodeInfo",
 328           "type" : "HTMLElement/String/Number",
 329           "desc" : "An HTMLElement template node, index of a template node or the id of a template node",
 330           "isOptional" : false
 331         }
 332       ],
 333       "returns" : [
 334         {
 335           "name" : "",
 336           "type" : "Number",
 337           "desc" : "The index of the node or -1"
 338         }
 339       ]
 340     },
 341     {
 342       "name" : "getEl",
 343       "desc" : "Returns the element this view is bound to.",
 344       "isStatic" : false,
 345       "isConstructor" : false,
 346       "isPrivate" : false,
 347       "memberOf" : "Roo.View",
 348       "example" : "",
 349       "deprecated" : "",
 350       "since" : "",
 351       "see" : "",
 352       "params" : [
 353       ],
 354       "returns" : [
 355         {
 356           "name" : "",
 357           "type" : "Roo.Element",
 358           "desc" : ""
 359         }
 360       ]
 361     },
 362     {
 363       "name" : "setStore",
 364       "desc" : "Changes the data store this view uses and refresh the view.",
 365       "isStatic" : false,
 366       "isConstructor" : false,
 367       "isPrivate" : false,
 368       "memberOf" : "Roo.View",
 369       "example" : "",
 370       "deprecated" : "",
 371       "since" : "",
 372       "see" : "",
 373       "params" : [
 374         {
 375           "name" : "store",
 376           "type" : "Store",
 377           "desc" : "",
 378           "isOptional" : false
 379         }
 380       ],
 381       "returns" : [
 382       ]
 383     },
 384     {
 385       "name" : "refreshNode",
 386       "desc" : "Refresh an individual node.",
 387       "isStatic" : false,
 388       "isConstructor" : false,
 389       "isPrivate" : false,
 390       "memberOf" : "Roo.View",
 391       "example" : "",
 392       "deprecated" : "",
 393       "since" : "",
 394       "see" : "",
 395       "params" : [
 396         {
 397           "name" : "index",
 398           "type" : "Number",
 399           "desc" : "",
 400           "isOptional" : false
 401         }
 402       ],
 403       "returns" : [
 404       ]
 405     },
 406     {
 407       "name" : "prepareData",
 408       "desc" : "Function to override to reformat the data that is sent to\nthe template for each node.\nDEPRICATED - use the preparedata event handler.",
 409       "isStatic" : false,
 410       "isConstructor" : false,
 411       "isPrivate" : false,
 412       "memberOf" : "Roo.View",
 413       "example" : "",
 414       "deprecated" : "",
 415       "since" : "",
 416       "see" : "",
 417       "params" : [
 418         {
 419           "name" : "data",
 420           "type" : "Array/Object",
 421           "desc" : "The raw data (array of colData for a data model bound view or\na JSON object for an UpdateManager bound view).",
 422           "isOptional" : false
 423         }
 424       ],
 425       "returns" : [
 426       ]
 427     },
 428     {
 429       "name" : "getSelectionCount",
 430       "desc" : "Get the number of selected nodes.",
 431       "isStatic" : false,
 432       "isConstructor" : false,
 433       "isPrivate" : false,
 434       "memberOf" : "Roo.View",
 435       "example" : "",
 436       "deprecated" : "",
 437       "since" : "",
 438       "see" : "",
 439       "params" : [
 440       ],
 441       "returns" : [
 442         {
 443           "name" : "",
 444           "type" : "Number",
 445           "desc" : ""
 446         }
 447       ]
 448     },
 449     {
 450       "name" : "findItemFromChild",
 451       "desc" : "Returns the template node the passed child belongs to or null if it doesn't belong to one.",
 452       "isStatic" : false,
 453       "isConstructor" : false,
 454       "isPrivate" : false,
 455       "memberOf" : "Roo.View",
 456       "example" : "",
 457       "deprecated" : "",
 458       "since" : "",
 459       "see" : "",
 460       "params" : [
 461         {
 462           "name" : "node",
 463           "type" : "HTMLElement",
 464           "desc" : "",
 465           "isOptional" : false
 466         }
 467       ],
 468       "returns" : [
 469         {
 470           "name" : "",
 471           "type" : "HTMLElement",
 472           "desc" : "The template node"
 473         }
 474       ]
 475     },
 476     {
 477       "name" : "unselect",
 478       "desc" : "Unselects nodes.",
 479       "isStatic" : false,
 480       "isConstructor" : false,
 481       "isPrivate" : false,
 482       "memberOf" : "Roo.View",
 483       "example" : "",
 484       "deprecated" : "",
 485       "since" : "",
 486       "see" : "",
 487       "params" : [
 488         {
 489           "name" : "nodeInfo",
 490           "type" : "Array/HTMLElement/String/Number",
 491           "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select",
 492           "isOptional" : false
 493         },
 494         {
 495           "name" : "keepExisting",
 496           "type" : "Boolean",
 497           "desc" : "(optional) true IGNORED (for campatibility with select)",
 498           "isOptional" : false
 499         },
 500         {
 501           "name" : "suppressEvent",
 502           "type" : "Boolean",
 503           "desc" : "(optional) true to skip firing of the selectionchange vent",
 504           "isOptional" : false
 505         }
 506       ],
 507       "returns" : [
 508       ]
 509     },
 510     {
 511       "name" : "getNode",
 512       "desc" : "Gets a template node.",
 513       "isStatic" : false,
 514       "isConstructor" : false,
 515       "isPrivate" : false,
 516       "memberOf" : "Roo.View",
 517       "example" : "",
 518       "deprecated" : "",
 519       "since" : "",
 520       "see" : "",
 521       "params" : [
 522         {
 523           "name" : "nodeInfo",
 524           "type" : "HTMLElement/String/Number",
 525           "desc" : "An HTMLElement template node, index of a template node or the id of a template node",
 526           "isOptional" : false
 527         }
 528       ],
 529       "returns" : [
 530         {
 531           "name" : "",
 532           "type" : "HTMLElement",
 533           "desc" : "The node or null if it wasn't found"
 534         }
 535       ]
 536     },
 537     {
 538       "name" : "purgeListeners",
 539       "desc" : "Removes all listeners for this object",
 540       "isStatic" : false,
 541       "isConstructor" : false,
 542       "isPrivate" : false,
 543       "memberOf" : "Roo.util.Observable",
 544       "example" : "",
 545       "deprecated" : "",
 546       "since" : "",
 547       "see" : "",
 548       "params" : [
 549       ],
 550       "returns" : [
 551       ]
 552     },
 553     {
 554       "name" : "on",
 555       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 556       "isStatic" : false,
 557       "isConstructor" : false,
 558       "isPrivate" : false,
 559       "memberOf" : "Roo.util.Observable",
 560       "example" : "",
 561       "deprecated" : "",
 562       "since" : "",
 563       "see" : "",
 564       "params" : [
 565         {
 566           "name" : "eventName",
 567           "type" : "String",
 568           "desc" : "The type of event to listen for",
 569           "isOptional" : false
 570         },
 571         {
 572           "name" : "handler",
 573           "type" : "Function",
 574           "desc" : "The method the event invokes",
 575           "isOptional" : false
 576         },
 577         {
 578           "name" : "scope",
 579           "type" : "Object",
 580           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 581           "isOptional" : false
 582         },
 583         {
 584           "name" : "options",
 585           "type" : "Object",
 586           "desc" : "(optional)",
 587           "isOptional" : false
 588         }
 589       ],
 590       "returns" : [
 591       ]
 592     },
 593     {
 594       "name" : "un",
 595       "desc" : "Removes a listener (shorthand for removeListener)",
 596       "isStatic" : false,
 597       "isConstructor" : false,
 598       "isPrivate" : false,
 599       "memberOf" : "Roo.util.Observable",
 600       "example" : "",
 601       "deprecated" : "",
 602       "since" : "",
 603       "see" : "",
 604       "params" : [
 605         {
 606           "name" : "eventName",
 607           "type" : "String",
 608           "desc" : "The type of event to listen for",
 609           "isOptional" : false
 610         },
 611         {
 612           "name" : "handler",
 613           "type" : "Function",
 614           "desc" : "The handler to remove",
 615           "isOptional" : false
 616         },
 617         {
 618           "name" : "scope",
 619           "type" : "Object",
 620           "desc" : "(optional) The scope (this object) for the handler",
 621           "isOptional" : false
 622         }
 623       ],
 624       "returns" : [
 625       ]
 626     },
 627     {
 628       "name" : "addEvents",
 629       "desc" : "Used to define events on this Observable",
 630       "isStatic" : false,
 631       "isConstructor" : false,
 632       "isPrivate" : false,
 633       "memberOf" : "Roo.util.Observable",
 634       "example" : "",
 635       "deprecated" : "",
 636       "since" : "",
 637       "see" : "",
 638       "params" : [
 639         {
 640           "name" : "object",
 641           "type" : "Object",
 642           "desc" : "The object with the events defined",
 643           "isOptional" : false
 644         }
 645       ],
 646       "returns" : [
 647       ]
 648     },
 649     {
 650       "name" : "releaseCapture",
 651       "desc" : "Removes <b>all</b> added captures from the Observable.",
 652       "isStatic" : true,
 653       "isConstructor" : false,
 654       "isPrivate" : false,
 655       "memberOf" : "Roo.util.Observable",
 656       "example" : "",
 657       "deprecated" : "",
 658       "since" : "",
 659       "see" : "",
 660       "params" : [
 661         {
 662           "name" : "o",
 663           "type" : "Observable",
 664           "desc" : "The Observable to release",
 665           "isOptional" : false
 666         }
 667       ],
 668       "returns" : [
 669       ]
 670     },
 671     {
 672       "name" : "removeListener",
 673       "desc" : "Removes a listener",
 674       "isStatic" : false,
 675       "isConstructor" : false,
 676       "isPrivate" : false,
 677       "memberOf" : "Roo.util.Observable",
 678       "example" : "",
 679       "deprecated" : "",
 680       "since" : "",
 681       "see" : "",
 682       "params" : [
 683         {
 684           "name" : "eventName",
 685           "type" : "String",
 686           "desc" : "The type of event to listen for",
 687           "isOptional" : false
 688         },
 689         {
 690           "name" : "handler",
 691           "type" : "Function",
 692           "desc" : "The handler to remove",
 693           "isOptional" : false
 694         },
 695         {
 696           "name" : "scope",
 697           "type" : "Object",
 698           "desc" : "(optional) The scope (this object) for the handler",
 699           "isOptional" : false
 700         }
 701       ],
 702       "returns" : [
 703       ]
 704     },
 705     {
 706       "name" : "fireEvent",
 707       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 708       "isStatic" : false,
 709       "isConstructor" : false,
 710       "isPrivate" : false,
 711       "memberOf" : "Roo.util.Observable",
 712       "example" : "",
 713       "deprecated" : "",
 714       "since" : "",
 715       "see" : "",
 716       "params" : [
 717         {
 718           "name" : "eventName",
 719           "type" : "String",
 720           "desc" : "",
 721           "isOptional" : false
 722         },
 723         {
 724           "name" : "args",
 725           "type" : "Object...",
 726           "desc" : "Variable number of parameters are passed to handlers",
 727           "isOptional" : false
 728         }
 729       ],
 730       "returns" : [
 731         {
 732           "name" : "",
 733           "type" : "Boolean",
 734           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 735         }
 736       ]
 737     },
 738     {
 739       "name" : "hasListener",
 740       "desc" : "Checks to see if this object has any listeners for a specified event",
 741       "isStatic" : false,
 742       "isConstructor" : false,
 743       "isPrivate" : false,
 744       "memberOf" : "Roo.util.Observable",
 745       "example" : "",
 746       "deprecated" : "",
 747       "since" : "",
 748       "see" : "",
 749       "params" : [
 750         {
 751           "name" : "eventName",
 752           "type" : "String",
 753           "desc" : "The name of the event to check for",
 754           "isOptional" : false
 755         }
 756       ],
 757       "returns" : [
 758         {
 759           "name" : "",
 760           "type" : "Boolean",
 761           "desc" : "True if the event is being listened for, else false"
 762         }
 763       ]
 764     },
 765     {
 766       "name" : "capture",
 767       "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.",
 768       "isStatic" : true,
 769       "isConstructor" : false,
 770       "isPrivate" : false,
 771       "memberOf" : "Roo.util.Observable",
 772       "example" : "",
 773       "deprecated" : "",
 774       "since" : "",
 775       "see" : "",
 776       "params" : [
 777         {
 778           "name" : "o",
 779           "type" : "Observable",
 780           "desc" : "The Observable to capture",
 781           "isOptional" : false
 782         },
 783         {
 784           "name" : "fn",
 785           "type" : "Function",
 786           "desc" : "The function to call",
 787           "isOptional" : false
 788         },
 789         {
 790           "name" : "scope",
 791           "type" : "Object",
 792           "desc" : "(optional) The scope (this object) for the fn",
 793           "isOptional" : false
 794         }
 795       ],
 796       "returns" : [
 797       ]
 798     },
 799     {
 800       "name" : "addListener",
 801       "desc" : "Appends an event handler to this component",
 802       "isStatic" : false,
 803       "isConstructor" : false,
 804       "isPrivate" : false,
 805       "memberOf" : "Roo.util.Observable",
 806       "example" : "",
 807       "deprecated" : "",
 808       "since" : "",
 809       "see" : "",
 810       "params" : [
 811         {
 812           "name" : "eventName",
 813           "type" : "String",
 814           "desc" : "The type of event to listen for",
 815           "isOptional" : false
 816         },
 817         {
 818           "name" : "handler",
 819           "type" : "Function",
 820           "desc" : "The method the event invokes",
 821           "isOptional" : false
 822         },
 823         {
 824           "name" : "scope",
 825           "type" : "Object",
 826           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 827           "isOptional" : false
 828         },
 829         {
 830           "name" : "options",
 831           "type" : "Object",
 832           "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>",
 833           "isOptional" : false
 834         }
 835       ],
 836       "returns" : [
 837       ]
 838     }
 839   ],
 840   "events" : [
 841     {
 842       "name" : "dblclick",
 843       "desc" : "Fires when a template node is double clicked.",
 844       "memberOf" : "Roo.View",
 845       "example" : "",
 846       "deprecated" : "",
 847       "since" : "",
 848       "see" : "",
 849       "params" : [
 850         {
 851           "name" : "this",
 852           "type" : "Roo.View",
 853           "desc" : "",
 854           "isOptional" : false
 855         },
 856         {
 857           "name" : "index",
 858           "type" : "Number",
 859           "desc" : "The index of the target node",
 860           "isOptional" : false
 861         },
 862         {
 863           "name" : "node",
 864           "type" : "HTMLElement",
 865           "desc" : "The target node",
 866           "isOptional" : false
 867         },
 868         {
 869           "name" : "e",
 870           "type" : "Roo.EventObject",
 871           "desc" : "The raw event object",
 872           "isOptional" : false
 873         }
 874       ],
 875       "returns" : [
 876       ]
 877     },
 878     {
 879       "name" : "preparedata",
 880       "desc" : "Fires on every row to render, to allow you to change the data.",
 881       "memberOf" : "Roo.View",
 882       "example" : "",
 883       "deprecated" : "",
 884       "since" : "",
 885       "see" : "",
 886       "params" : [
 887         {
 888           "name" : "this",
 889           "type" : "Roo.View",
 890           "desc" : "",
 891           "isOptional" : false
 892         },
 893         {
 894           "name" : "data",
 895           "type" : "Object",
 896           "desc" : "to be rendered (change this)",
 897           "isOptional" : false
 898         }
 899       ],
 900       "returns" : [
 901       ]
 902     },
 903     {
 904       "name" : "selectionchange",
 905       "desc" : "Fires when the selected nodes change.",
 906       "memberOf" : "Roo.View",
 907       "example" : "",
 908       "deprecated" : "",
 909       "since" : "",
 910       "see" : "",
 911       "params" : [
 912         {
 913           "name" : "this",
 914           "type" : "Roo.View",
 915           "desc" : "",
 916           "isOptional" : false
 917         },
 918         {
 919           "name" : "selections",
 920           "type" : "Array",
 921           "desc" : "Array of the selected nodes",
 922           "isOptional" : false
 923         }
 924       ],
 925       "returns" : [
 926       ]
 927     },
 928     {
 929       "name" : "beforeselect",
 930       "desc" : "Fires before a selection is made. If any handlers return false, the selection is cancelled.",
 931       "memberOf" : "Roo.View",
 932       "example" : "",
 933       "deprecated" : "",
 934       "since" : "",
 935       "see" : "",
 936       "params" : [
 937         {
 938           "name" : "this",
 939           "type" : "Roo.View",
 940           "desc" : "",
 941           "isOptional" : false
 942         },
 943         {
 944           "name" : "node",
 945           "type" : "HTMLElement",
 946           "desc" : "The node to be selected",
 947           "isOptional" : false
 948         },
 949         {
 950           "name" : "selections",
 951           "type" : "Array",
 952           "desc" : "Array of currently selected nodes",
 953           "isOptional" : false
 954         }
 955       ],
 956       "returns" : [
 957       ]
 958     },
 959     {
 960       "name" : "beforeclick",
 961       "desc" : "Fires before a click is processed. Returns false to cancel the default action.",
 962       "memberOf" : "Roo.View",
 963       "example" : "",
 964       "deprecated" : "",
 965       "since" : "",
 966       "see" : "",
 967       "params" : [
 968         {
 969           "name" : "this",
 970           "type" : "Roo.View",
 971           "desc" : "",
 972           "isOptional" : false
 973         },
 974         {
 975           "name" : "index",
 976           "type" : "Number",
 977           "desc" : "The index of the target node",
 978           "isOptional" : false
 979         },
 980         {
 981           "name" : "node",
 982           "type" : "HTMLElement",
 983           "desc" : "The target node",
 984           "isOptional" : false
 985         },
 986         {
 987           "name" : "e",
 988           "type" : "Roo.EventObject",
 989           "desc" : "The raw event object",
 990           "isOptional" : false
 991         }
 992       ],
 993       "returns" : [
 994       ]
 995     },
 996     {
 997       "name" : "click",
 998       "desc" : "Fires when a template node is clicked.",
 999       "memberOf" : "Roo.View",
1000       "example" : "",
1001       "deprecated" : "",
1002       "since" : "",
1003       "see" : "",
1004       "params" : [
1005         {
1006           "name" : "this",
1007           "type" : "Roo.View",
1008           "desc" : "",
1009           "isOptional" : false
1010         },
1011         {
1012           "name" : "index",
1013           "type" : "Number",
1014           "desc" : "The index of the target node",
1015           "isOptional" : false
1016         },
1017         {
1018           "name" : "node",
1019           "type" : "HTMLElement",
1020           "desc" : "The target node",
1021           "isOptional" : false
1022         },
1023         {
1024           "name" : "e",
1025           "type" : "Roo.EventObject",
1026           "desc" : "The raw event object",
1027           "isOptional" : false
1028         }
1029       ],
1030       "returns" : [
1031       ]
1032     },
1033     {
1034       "name" : "contextmenu",
1035       "desc" : "Fires when a template node is right clicked.",
1036       "memberOf" : "Roo.View",
1037       "example" : "",
1038       "deprecated" : "",
1039       "since" : "",
1040       "see" : "",
1041       "params" : [
1042         {
1043           "name" : "this",
1044           "type" : "Roo.View",
1045           "desc" : "",
1046           "isOptional" : false
1047         },
1048         {
1049           "name" : "index",
1050           "type" : "Number",
1051           "desc" : "The index of the target node",
1052           "isOptional" : false
1053         },
1054         {
1055           "name" : "node",
1056           "type" : "HTMLElement",
1057           "desc" : "The target node",
1058           "isOptional" : false
1059         },
1060         {
1061           "name" : "e",
1062           "type" : "Roo.EventObject",
1063           "desc" : "The raw event object",
1064           "isOptional" : false
1065         }
1066       ],
1067       "returns" : [
1068       ]
1069     }
1070   ]
1071 }