git.roojs.org Git - roojs1/blob - docs2/symbols/Roo.JsonView.json

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