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