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