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