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