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