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