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