git.roojs.org Git - roojs1/blob - docs/symbols/Roo.GridPanel.json

   1 {
   2   "name" : "Roo.GridPanel",
   3   "augments" : [
   4     "Roo.ContentPanel",
   5     "Roo.util.Observable"
   6   ],
   7   "childClasses" : [],
   8   "desc" : "Create a new GridPanel.",
   9   "isSingleton" : false,
  10   "isStatic" : false,
  11   "isBuiltin" : false,
  12   "memberOf" : "GridPanel",
  13   "example" : "",
  14   "deprecated" : "",
  15   "since" : "",
  16   "see" : "",
  17   "params" : [
  18     {
  19       "name" : "grid",
  20       "type" : "Roo.grid.Grid",
  21       "desc" : "The grid for this panel",
  22       "isOptional" : false
  23     },
  24     {
  25       "name" : "config",
  26       "type" : "String/Object",
  27       "desc" : "A string to set only the panel's title, or a config object",
  28       "isOptional" : false
  29     }
  30   ],
  31   "returns" : [],
  32   "throws" : "",
  33   "requires" : "",
  34   "config" : [
  35     {
  36       "name" : "loadOnce",
  37       "type" : "Boolean",
  38       "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
  39       "memberOf" : "Roo.ContentPanel"
  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     },
  47     {
  48       "name" : "autoScroll",
  49       "type" : "Boolean",
  50       "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
  51       "memberOf" : "Roo.ContentPanel"
  52     },
  53     {
  54       "name" : "fitToFrame",
  55       "type" : "Boolean",
  56       "desc" : "True for this panel to adjust its size to fit when the region resizes  (defaults to false)",
  57       "memberOf" : "Roo.ContentPanel"
  58     },
  59     {
  60       "name" : "background",
  61       "type" : "Boolean",
  62       "desc" : "True if the panel should not be activated when it is added (defaults to false)",
  63       "memberOf" : "Roo.ContentPanel"
  64     },
  65     {
  66       "name" : "toolbar",
  67       "type" : "Roo.Toolbar",
  68       "desc" : "A toolbar for this panel",
  69       "memberOf" : "Roo.ContentPanel"
  70     },
  71     {
  72       "name" : "region",
  73       "type" : "String",
  74       "desc" : "[required]   (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
  75       "memberOf" : "Roo.ContentPanel"
  76     },
  77     {
  78       "name" : "content",
  79       "type" : "String",
  80       "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
  81       "memberOf" : "Roo.ContentPanel"
  82     },
  83     {
  84       "name" : "menu",
  85       "type" : "Roo.menu.Menu",
  86       "desc" : "popup menu",
  87       "memberOf" : "Roo.ContentPanel"
  88     },
  89     {
  90       "name" : "title",
  91       "type" : "String",
  92       "desc" : "The title for this panel",
  93       "memberOf" : "Roo.ContentPanel"
  94     },
  95     {
  96       "name" : "style",
  97       "type" : "String",
  98       "desc" : "Extra style to add to the content panel",
  99       "memberOf" : "Roo.ContentPanel"
 100     },
 101     {
 102       "name" : "autoCreate",
 103       "type" : "Boolean|Object",
 104       "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
 105       "memberOf" : "Roo.ContentPanel"
 106     },
 107     {
 108       "name" : "fitContainer",
 109       "type" : "Boolean",
 110       "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container  (defaults to false)",
 111       "memberOf" : "Roo.ContentPanel"
 112     },
 113     {
 114       "name" : "closable",
 115       "type" : "Boolean",
 116       "desc" : "True if the panel can be closed/removed",
 117       "memberOf" : "Roo.ContentPanel"
 118     },
 119     {
 120       "name" : "params",
 121       "type" : "String|Object",
 122       "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
 123       "memberOf" : "Roo.ContentPanel"
 124     },
 125     {
 126       "name" : "adjustments",
 127       "type" : "Array",
 128       "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
 129       "memberOf" : "Roo.ContentPanel"
 130     },
 131     {
 132       "name" : "url",
 133       "type" : "String",
 134       "desc" : "Calls {@link #setUrl} with this value",
 135       "memberOf" : "Roo.ContentPanel"
 136     },
 137     {
 138       "name" : "resizeEl",
 139       "type" : "String|HTMLElement|Element",
 140       "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
 141       "memberOf" : "Roo.ContentPanel"
 142     }
 143   ],
 144   "methods" : [
 145     {
 146       "name" : "getGrid",
 147       "type" : "function",
 148       "desc" : "Returns the grid for this panel",
 149       "sig" : "()\n{\n\n}",
 150       "static" : false,
 151       "memberOf" : "",
 152       "isStatic" : false,
 153       "isConstructor" : false,
 154       "isPrivate" : false,
 155       "example" : "",
 156       "deprecated" : "",
 157       "since" : "",
 158       "see" : "",
 159       "exceptions" : "",
 160       "requires" : "",
 161       "params" : [],
 162       "returns" : [
 163         {
 164           "name" : "",
 165           "type" : "Roo.grid.Grid",
 166           "desc" : ""
 167         }
 168       ]
 169     },
 170     {
 171       "name" : "load",
 172       "type" : "function",
 173       "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
 174       "sig" : "(url, params, callback, discardUrl)",
 175       "static" : false,
 176       "memberOf" : "Roo.ContentPanel",
 177       "isStatic" : false,
 178       "isConstructor" : false,
 179       "isPrivate" : false,
 180       "example" : "",
 181       "deprecated" : "",
 182       "since" : "",
 183       "see" : "",
 184       "exceptions" : "",
 185       "requires" : "",
 186       "params" : [
 187         {
 188           "name" : "url",
 189           "type" : "Object/String/Function",
 190           "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>\npanel.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 shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
 191           "isOptional" : false
 192         },
 193         {
 194           "name" : "params",
 195           "type" : "String/Object",
 196           "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&amp;param2=2\" or an object {param1: 1, param2: 2}",
 197           "isOptional" : false
 198         },
 199         {
 200           "name" : "callback",
 201           "type" : "Function",
 202           "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
 203           "isOptional" : false
 204         },
 205         {
 206           "name" : "discardUrl",
 207           "type" : "Boolean",
 208           "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.",
 209           "isOptional" : false
 210         }
 211       ],
 212       "returns" : [
 213         {
 214           "name" : "",
 215           "type" : "Roo.ContentPanel",
 216           "desc" : "this"
 217         }
 218       ]
 219     },
 220     {
 221       "name" : "getUpdateManager",
 222       "type" : "function",
 223       "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
 224       "sig" : "()\n{\n\n}",
 225       "static" : false,
 226       "memberOf" : "Roo.ContentPanel",
 227       "isStatic" : false,
 228       "isConstructor" : false,
 229       "isPrivate" : false,
 230       "example" : "",
 231       "deprecated" : "",
 232       "since" : "",
 233       "see" : "",
 234       "exceptions" : "",
 235       "requires" : "",
 236       "params" : [],
 237       "returns" : [
 238         {
 239           "name" : "",
 240           "type" : "Roo.UpdateManager",
 241           "desc" : "The UpdateManager"
 242         }
 243       ]
 244     },
 245     {
 246       "name" : "isClosable",
 247       "type" : "function",
 248       "desc" : "Returns true is this panel was configured to be closable",
 249       "sig" : "()\n{\n\n}",
 250       "static" : false,
 251       "memberOf" : "Roo.ContentPanel",
 252       "isStatic" : false,
 253       "isConstructor" : false,
 254       "isPrivate" : false,
 255       "example" : "",
 256       "deprecated" : "",
 257       "since" : "",
 258       "see" : "",
 259       "exceptions" : "",
 260       "requires" : "",
 261       "params" : [],
 262       "returns" : [
 263         {
 264           "name" : "",
 265           "type" : "Boolean",
 266           "desc" : ""
 267         }
 268       ]
 269     },
 270     {
 271       "name" : "destroy",
 272       "type" : "function",
 273       "desc" : "Destroys this panel",
 274       "sig" : "()\n{\n\n}",
 275       "static" : false,
 276       "memberOf" : "Roo.ContentPanel",
 277       "isStatic" : false,
 278       "isConstructor" : false,
 279       "isPrivate" : false,
 280       "example" : "",
 281       "deprecated" : "",
 282       "since" : "",
 283       "see" : "",
 284       "exceptions" : "",
 285       "requires" : "",
 286       "params" : [],
 287       "returns" : []
 288     },
 289     {
 290       "name" : "getEl",
 291       "type" : "function",
 292       "desc" : "Returns this panel's element - used by regiosn to add.",
 293       "sig" : "()\n{\n\n}",
 294       "static" : false,
 295       "memberOf" : "Roo.ContentPanel",
 296       "isStatic" : false,
 297       "isConstructor" : false,
 298       "isPrivate" : false,
 299       "example" : "",
 300       "deprecated" : "",
 301       "since" : "",
 302       "see" : "",
 303       "exceptions" : "",
 304       "requires" : "",
 305       "params" : [],
 306       "returns" : [
 307         {
 308           "name" : "",
 309           "type" : "Roo.Element",
 310           "desc" : ""
 311         }
 312       ]
 313     },
 314     {
 315       "name" : "setContent",
 316       "type" : "function",
 317       "desc" : "Updates this panel's element",
 318       "sig" : "(content, loadScripts)",
 319       "static" : false,
 320       "memberOf" : "Roo.ContentPanel",
 321       "isStatic" : false,
 322       "isConstructor" : false,
 323       "isPrivate" : false,
 324       "example" : "",
 325       "deprecated" : "",
 326       "since" : "",
 327       "see" : "",
 328       "exceptions" : "",
 329       "requires" : "",
 330       "params" : [
 331         {
 332           "name" : "content",
 333           "type" : "String",
 334           "desc" : "The new content",
 335           "isOptional" : false
 336         },
 337         {
 338           "name" : "loadScripts",
 339           "type" : "Boolean",
 340           "desc" : "(optional) true to look for and process scripts",
 341           "isOptional" : false
 342         }
 343       ],
 344       "returns" : []
 345     },
 346     {
 347       "name" : "getId",
 348       "type" : "function",
 349       "desc" : "Returns this panel's id",
 350       "sig" : "()\n{\n\n}",
 351       "static" : false,
 352       "memberOf" : "Roo.ContentPanel",
 353       "isStatic" : false,
 354       "isConstructor" : false,
 355       "isPrivate" : false,
 356       "example" : "",
 357       "deprecated" : "",
 358       "since" : "",
 359       "see" : "",
 360       "exceptions" : "",
 361       "requires" : "",
 362       "params" : [],
 363       "returns" : [
 364         {
 365           "name" : "",
 366           "type" : "String",
 367           "desc" : ""
 368         }
 369       ]
 370     },
 371     {
 372       "name" : "addxtype",
 373       "type" : "function",
 374       "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n</code></pre>",
 375       "sig" : "(cfg)",
 376       "static" : false,
 377       "memberOf" : "Roo.ContentPanel",
 378       "isStatic" : false,
 379       "isConstructor" : false,
 380       "isPrivate" : false,
 381       "example" : "",
 382       "deprecated" : "",
 383       "since" : "",
 384       "see" : "",
 385       "exceptions" : "",
 386       "requires" : "",
 387       "params" : [
 388         {
 389           "name" : "cfg",
 390           "type" : "Object",
 391           "desc" : "Xtype definition of item to add.",
 392           "isOptional" : false
 393         }
 394       ],
 395       "returns" : []
 396     },
 397     {
 398       "name" : "refresh",
 399       "type" : "function",
 400       "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n  Will fail silently if the {@link #setUrl} method has not been called.\n  This does not activate the panel, just updates its content.",
 401       "sig" : "()\n{\n\n}",
 402       "static" : false,
 403       "memberOf" : "Roo.ContentPanel",
 404       "isStatic" : false,
 405       "isConstructor" : false,
 406       "isPrivate" : false,
 407       "example" : "",
 408       "deprecated" : "",
 409       "since" : "",
 410       "see" : "",
 411       "exceptions" : "",
 412       "requires" : "",
 413       "params" : [],
 414       "returns" : []
 415     },
 416     {
 417       "name" : "getTitle",
 418       "type" : "function",
 419       "desc" : "Returns this panel's title",
 420       "sig" : "()\n{\n\n}",
 421       "static" : false,
 422       "memberOf" : "Roo.ContentPanel",
 423       "isStatic" : false,
 424       "isConstructor" : false,
 425       "isPrivate" : false,
 426       "example" : "",
 427       "deprecated" : "",
 428       "since" : "",
 429       "see" : "",
 430       "exceptions" : "",
 431       "requires" : "",
 432       "params" : [],
 433       "returns" : [
 434         {
 435           "name" : "",
 436           "type" : "String",
 437           "desc" : ""
 438         }
 439       ]
 440     },
 441     {
 442       "name" : "setTitle",
 443       "type" : "function",
 444       "desc" : "Set this panel's title",
 445       "sig" : "(title)",
 446       "static" : false,
 447       "memberOf" : "Roo.ContentPanel",
 448       "isStatic" : false,
 449       "isConstructor" : false,
 450       "isPrivate" : false,
 451       "example" : "",
 452       "deprecated" : "",
 453       "since" : "",
 454       "see" : "",
 455       "exceptions" : "",
 456       "requires" : "",
 457       "params" : [
 458         {
 459           "name" : "title",
 460           "type" : "String",
 461           "desc" : "",
 462           "isOptional" : false
 463         }
 464       ],
 465       "returns" : []
 466     },
 467     {
 468       "name" : "getToolbar",
 469       "type" : "function",
 470       "desc" : "Returns the toolbar for this Panel if one was configured.",
 471       "sig" : "()\n{\n\n}",
 472       "static" : false,
 473       "memberOf" : "Roo.ContentPanel",
 474       "isStatic" : false,
 475       "isConstructor" : false,
 476       "isPrivate" : false,
 477       "example" : "",
 478       "deprecated" : "",
 479       "since" : "",
 480       "see" : "",
 481       "exceptions" : "",
 482       "requires" : "",
 483       "params" : [],
 484       "returns" : [
 485         {
 486           "name" : "",
 487           "type" : "Roo.Toolbar",
 488           "desc" : ""
 489         }
 490       ]
 491     },
 492     {
 493       "name" : "setUrl",
 494       "type" : "function",
 495       "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
 496       "sig" : "(url, params, loadOnce)",
 497       "static" : false,
 498       "memberOf" : "Roo.ContentPanel",
 499       "isStatic" : false,
 500       "isConstructor" : false,
 501       "isPrivate" : false,
 502       "example" : "",
 503       "deprecated" : "",
 504       "since" : "",
 505       "see" : "",
 506       "exceptions" : "",
 507       "requires" : "",
 508       "params" : [
 509         {
 510           "name" : "url",
 511           "type" : "String/Function",
 512           "desc" : "The URL to load the content from or a function to call to get the URL",
 513           "isOptional" : false
 514         },
 515         {
 516           "name" : "params",
 517           "type" : "String/Object",
 518           "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
 519           "isOptional" : false
 520         },
 521         {
 522           "name" : "loadOnce",
 523           "type" : "Boolean",
 524           "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
 525           "isOptional" : false
 526         }
 527       ],
 528       "returns" : [
 529         {
 530           "name" : "",
 531           "type" : "Roo.UpdateManager",
 532           "desc" : "The UpdateManager"
 533         }
 534       ]
 535     },
 536     {
 537       "name" : "purgeListeners",
 538       "type" : "function",
 539       "desc" : "Removes all listeners for this object",
 540       "sig" : "()\n{\n\n}",
 541       "static" : false,
 542       "memberOf" : "Roo.util.Observable",
 543       "isStatic" : false,
 544       "isConstructor" : false,
 545       "isPrivate" : false,
 546       "example" : "",
 547       "deprecated" : "",
 548       "since" : "",
 549       "see" : "",
 550       "exceptions" : "",
 551       "requires" : "",
 552       "params" : [],
 553       "returns" : []
 554     },
 555     {
 556       "name" : "on",
 557       "type" : "function",
 558       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 559       "sig" : "(eventName, handler, scope, options)",
 560       "static" : false,
 561       "memberOf" : "Roo.util.Observable",
 562       "isStatic" : false,
 563       "isConstructor" : false,
 564       "isPrivate" : false,
 565       "example" : "",
 566       "deprecated" : "",
 567       "since" : "",
 568       "see" : "",
 569       "exceptions" : "",
 570       "requires" : "",
 571       "params" : [
 572         {
 573           "name" : "eventName",
 574           "type" : "String",
 575           "desc" : "The type of event to listen for",
 576           "isOptional" : false
 577         },
 578         {
 579           "name" : "handler",
 580           "type" : "Function",
 581           "desc" : "The method the event invokes",
 582           "isOptional" : false
 583         },
 584         {
 585           "name" : "scope",
 586           "type" : "Object",
 587           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 588           "isOptional" : false
 589         },
 590         {
 591           "name" : "options",
 592           "type" : "Object",
 593           "desc" : "(optional)",
 594           "isOptional" : false
 595         }
 596       ],
 597       "returns" : []
 598     },
 599     {
 600       "name" : "un",
 601       "type" : "function",
 602       "desc" : "Removes a listener (shorthand for removeListener)",
 603       "sig" : "(eventName, handler, scope)",
 604       "static" : false,
 605       "memberOf" : "Roo.util.Observable",
 606       "isStatic" : false,
 607       "isConstructor" : false,
 608       "isPrivate" : false,
 609       "example" : "",
 610       "deprecated" : "",
 611       "since" : "",
 612       "see" : "",
 613       "exceptions" : "",
 614       "requires" : "",
 615       "params" : [
 616         {
 617           "name" : "eventName",
 618           "type" : "String",
 619           "desc" : "The type of event to listen for",
 620           "isOptional" : false
 621         },
 622         {
 623           "name" : "handler",
 624           "type" : "Function",
 625           "desc" : "The handler to remove",
 626           "isOptional" : false
 627         },
 628         {
 629           "name" : "scope",
 630           "type" : "Object",
 631           "desc" : "(optional) The scope (this object) for the handler",
 632           "isOptional" : false
 633         }
 634       ],
 635       "returns" : []
 636     },
 637     {
 638       "name" : "addEvents",
 639       "type" : "function",
 640       "desc" : "Used to define events on this Observable",
 641       "sig" : "(object)",
 642       "static" : false,
 643       "memberOf" : "Roo.util.Observable",
 644       "isStatic" : false,
 645       "isConstructor" : false,
 646       "isPrivate" : false,
 647       "example" : "",
 648       "deprecated" : "",
 649       "since" : "",
 650       "see" : "",
 651       "exceptions" : "",
 652       "requires" : "",
 653       "params" : [
 654         {
 655           "name" : "object",
 656           "type" : "Object",
 657           "desc" : "The object with the events defined",
 658           "isOptional" : false
 659         }
 660       ],
 661       "returns" : []
 662     },
 663     {
 664       "name" : "releaseCapture",
 665       "type" : "function",
 666       "desc" : "Removes <b>all</b> added captures from the Observable.",
 667       "sig" : "(o)",
 668       "static" : true,
 669       "memberOf" : "Roo.util.Observable",
 670       "isStatic" : true,
 671       "isConstructor" : false,
 672       "isPrivate" : false,
 673       "example" : "",
 674       "deprecated" : "",
 675       "since" : "",
 676       "see" : "",
 677       "exceptions" : "",
 678       "requires" : "",
 679       "params" : [
 680         {
 681           "name" : "o",
 682           "type" : "Observable",
 683           "desc" : "The Observable to release",
 684           "isOptional" : false
 685         }
 686       ],
 687       "returns" : []
 688     },
 689     {
 690       "name" : "removeListener",
 691       "type" : "function",
 692       "desc" : "Removes a listener",
 693       "sig" : "(eventName, handler, scope)",
 694       "static" : false,
 695       "memberOf" : "Roo.util.Observable",
 696       "isStatic" : false,
 697       "isConstructor" : false,
 698       "isPrivate" : false,
 699       "example" : "",
 700       "deprecated" : "",
 701       "since" : "",
 702       "see" : "",
 703       "exceptions" : "",
 704       "requires" : "",
 705       "params" : [
 706         {
 707           "name" : "eventName",
 708           "type" : "String",
 709           "desc" : "The type of event to listen for",
 710           "isOptional" : false
 711         },
 712         {
 713           "name" : "handler",
 714           "type" : "Function",
 715           "desc" : "The handler to remove",
 716           "isOptional" : false
 717         },
 718         {
 719           "name" : "scope",
 720           "type" : "Object",
 721           "desc" : "(optional) The scope (this object) for the handler",
 722           "isOptional" : false
 723         }
 724       ],
 725       "returns" : []
 726     },
 727     {
 728       "name" : "fireEvent",
 729       "type" : "function",
 730       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 731       "sig" : "(eventName, args)",
 732       "static" : false,
 733       "memberOf" : "Roo.util.Observable",
 734       "isStatic" : false,
 735       "isConstructor" : false,
 736       "isPrivate" : false,
 737       "example" : "",
 738       "deprecated" : "",
 739       "since" : "",
 740       "see" : "",
 741       "exceptions" : "",
 742       "requires" : "",
 743       "params" : [
 744         {
 745           "name" : "eventName",
 746           "type" : "String",
 747           "desc" : "",
 748           "isOptional" : false
 749         },
 750         {
 751           "name" : "args",
 752           "type" : "Object...",
 753           "desc" : "Variable number of parameters are passed to handlers",
 754           "isOptional" : false
 755         }
 756       ],
 757       "returns" : [
 758         {
 759           "name" : "",
 760           "type" : "Boolean",
 761           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 762         }
 763       ]
 764     },
 765     {
 766       "name" : "hasListener",
 767       "type" : "function",
 768       "desc" : "Checks to see if this object has any listeners for a specified event",
 769       "sig" : "(eventName)",
 770       "static" : false,
 771       "memberOf" : "Roo.util.Observable",
 772       "isStatic" : false,
 773       "isConstructor" : false,
 774       "isPrivate" : false,
 775       "example" : "",
 776       "deprecated" : "",
 777       "since" : "",
 778       "see" : "",
 779       "exceptions" : "",
 780       "requires" : "",
 781       "params" : [
 782         {
 783           "name" : "eventName",
 784           "type" : "String",
 785           "desc" : "The name of the event to check for",
 786           "isOptional" : false
 787         }
 788       ],
 789       "returns" : [
 790         {
 791           "name" : "",
 792           "type" : "Boolean",
 793           "desc" : "True if the event is being listened for, else false"
 794         }
 795       ]
 796     },
 797     {
 798       "name" : "capture",
 799       "type" : "function",
 800       "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.",
 801       "sig" : "(o, fn, scope)",
 802       "static" : true,
 803       "memberOf" : "Roo.util.Observable",
 804       "isStatic" : true,
 805       "isConstructor" : false,
 806       "isPrivate" : false,
 807       "example" : "",
 808       "deprecated" : "",
 809       "since" : "",
 810       "see" : "",
 811       "exceptions" : "",
 812       "requires" : "",
 813       "params" : [
 814         {
 815           "name" : "o",
 816           "type" : "Observable",
 817           "desc" : "The Observable to capture",
 818           "isOptional" : false
 819         },
 820         {
 821           "name" : "fn",
 822           "type" : "Function",
 823           "desc" : "The function to call",
 824           "isOptional" : false
 825         },
 826         {
 827           "name" : "scope",
 828           "type" : "Object",
 829           "desc" : "(optional) The scope (this object) for the fn",
 830           "isOptional" : false
 831         }
 832       ],
 833       "returns" : []
 834     },
 835     {
 836       "name" : "addListener",
 837       "type" : "function",
 838       "desc" : "Appends an event handler to this component",
 839       "sig" : "(eventName, handler, scope, options)",
 840       "static" : false,
 841       "memberOf" : "Roo.util.Observable",
 842       "isStatic" : false,
 843       "isConstructor" : false,
 844       "isPrivate" : false,
 845       "example" : "",
 846       "deprecated" : "",
 847       "since" : "",
 848       "see" : "",
 849       "exceptions" : "",
 850       "requires" : "",
 851       "params" : [
 852         {
 853           "name" : "eventName",
 854           "type" : "String",
 855           "desc" : "The type of event to listen for",
 856           "isOptional" : false
 857         },
 858         {
 859           "name" : "handler",
 860           "type" : "Function",
 861           "desc" : "The method the event invokes",
 862           "isOptional" : false
 863         },
 864         {
 865           "name" : "scope",
 866           "type" : "Object",
 867           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 868           "isOptional" : false
 869         },
 870         {
 871           "name" : "options",
 872           "type" : "Object",
 873           "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>",
 874           "isOptional" : false
 875         }
 876       ],
 877       "returns" : []
 878     }
 879   ],
 880   "events" : [
 881     {
 882       "name" : "deactivate",
 883       "type" : "function",
 884       "desc" : "Fires when this panel is activated.",
 885       "sig" : "function (_self)\n{\n\n}",
 886       "memberOf" : "Roo.ContentPanel",
 887       "example" : "",
 888       "deprecated" : "",
 889       "since" : "",
 890       "see" : "",
 891       "params" : [
 892         {
 893           "name" : "this",
 894           "type" : "Roo.ContentPanel",
 895           "desc" : "",
 896           "isOptional" : false
 897         }
 898       ],
 899       "returns" : []
 900     },
 901     {
 902       "name" : "resize",
 903       "type" : "function",
 904       "desc" : "Fires when this panel is resized if fitToFrame is true.",
 905       "sig" : "function (_self, width, height)\n{\n\n}",
 906       "memberOf" : "Roo.ContentPanel",
 907       "example" : "",
 908       "deprecated" : "",
 909       "since" : "",
 910       "see" : "",
 911       "params" : [
 912         {
 913           "name" : "this",
 914           "type" : "Roo.ContentPanel",
 915           "desc" : "",
 916           "isOptional" : false
 917         },
 918         {
 919           "name" : "width",
 920           "type" : "Number",
 921           "desc" : "The width after any component adjustments",
 922           "isOptional" : false
 923         },
 924         {
 925           "name" : "height",
 926           "type" : "Number",
 927           "desc" : "The height after any component adjustments",
 928           "isOptional" : false
 929         }
 930       ],
 931       "returns" : []
 932     },
 933     {
 934       "name" : "render",
 935       "type" : "function",
 936       "desc" : "Fires when this tab is created",
 937       "sig" : "function (_self)\n{\n\n}",
 938       "memberOf" : "Roo.ContentPanel",
 939       "example" : "",
 940       "deprecated" : "",
 941       "since" : "",
 942       "see" : "",
 943       "params" : [
 944         {
 945           "name" : "this",
 946           "type" : "Roo.ContentPanel",
 947           "desc" : "",
 948           "isOptional" : false
 949         }
 950       ],
 951       "returns" : []
 952     },
 953     {
 954       "name" : "activate",
 955       "type" : "function",
 956       "desc" : "Fires when this panel is activated.",
 957       "sig" : "function (_self)\n{\n\n}",
 958       "memberOf" : "Roo.ContentPanel",
 959       "example" : "",
 960       "deprecated" : "",
 961       "since" : "",
 962       "see" : "",
 963       "params" : [
 964         {
 965           "name" : "this",
 966           "type" : "Roo.ContentPanel",
 967           "desc" : "",
 968           "isOptional" : false
 969         }
 970       ],
 971       "returns" : []
 972     }
 973   ]
 974 }