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