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