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

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