git.roojs.org Git - roojs1/blob - docs/symbols/Roo.bootstrap.panel.Content.json

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