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