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

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