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