git.roojs.org Git - roojs1/blob - docs/symbols/Roo.bootstrap.layout.Region.json

   1 {
   2   "name" : "Roo.bootstrap.layout.Region",
   3   "augments" : [
   4     "Roo.bootstrap.layout.Basic",
   5     "Roo.util.Observable"
   6   ],
   7   "childClasses" : {  },
   8   "tree_children" : [],
   9   "tree_parent" : [],
  10   "desc" : "This class represents a region in a layout manager.",
  11   "isSingleton" : false,
  12   "isStatic" : false,
  13   "isBuiltin" : false,
  14   "isAbstract" : false,
  15   "isBuilderTop" : false,
  16   "memberOf" : "Region",
  17   "example" : "",
  18   "deprecated" : "",
  19   "since" : "",
  20   "see" : "",
  21   "params" : [],
  22   "returns" : [],
  23   "throws" : "",
  24   "requires" : "",
  25   "config" : [
  26     {
  27       "name" : "cmargins",
  28       "type" : "Object",
  29       "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
  30       "memberOf" : "Roo.bootstrap.layout.Region"
  31     },
  32     {
  33       "name" : "alwaysShowTabs",
  34       "type" : "Boolean",
  35       "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
  36       "memberOf" : "Roo.bootstrap.layout.Region"
  37     },
  38     {
  39       "name" : "overflow",
  40       "type" : "String",
  41       "desc" : "e) if you have menus in the region, then you need to set this to visible.",
  42       "memberOf" : "Roo.bootstrap.layout.Region"
  43     },
  44     {
  45       "name" : "listeners",
  46       "type" : "Object",
  47       "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>",
  48       "memberOf" : "Roo.util.Observable"
  49     },
  50     {
  51       "name" : "margins",
  52       "type" : "Object",
  53       "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
  54       "memberOf" : "Roo.bootstrap.layout.Region"
  55     },
  56     {
  57       "name" : "preferredTabWidth",
  58       "type" : "Number",
  59       "desc" : "The preferred tab width (defaults to 150)",
  60       "memberOf" : "Roo.bootstrap.layout.Region"
  61     },
  62     {
  63       "name" : "disableTabTips",
  64       "type" : "Boolean",
  65       "desc" : "True to disable tab tooltips",
  66       "memberOf" : "Roo.bootstrap.layout.Region"
  67     },
  68     {
  69       "name" : "skipConfig",
  70       "type" : "bool",
  71       "desc" : "skip config?",
  72       "memberOf" : "Roo.bootstrap.layout.Basic"
  73     },
  74     {
  75       "name" : "autoScroll",
  76       "type" : "Boolean",
  77       "desc" : "True to enable overflow scrolling (defaults to false)",
  78       "memberOf" : "Roo.bootstrap.layout.Region"
  79     },
  80     {
  81       "name" : "hidden",
  82       "type" : "Boolean",
  83       "desc" : "True to start the region hidden (defaults to false)",
  84       "memberOf" : "Roo.bootstrap.layout.Region"
  85     },
  86     {
  87       "name" : "toolbar",
  88       "type" : "Boolean",
  89       "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
  90       "memberOf" : "Roo.bootstrap.layout.Region"
  91     },
  92     {
  93       "name" : "region",
  94       "type" : "string",
  95       "desc" : "the region that it inhabits..",
  96       "memberOf" : "Roo.bootstrap.layout.Region"
  97     },
  98     {
  99       "name" : "title",
 100       "type" : "String",
 101       "desc" : "The title for the region (overrides panel titles)",
 102       "memberOf" : "Roo.bootstrap.layout.Region"
 103     },
 104     {
 105       "name" : "hideWhenEmpty",
 106       "type" : "Boolean",
 107       "desc" : "True to hide the region when it has no panels",
 108       "memberOf" : "Roo.bootstrap.layout.Region"
 109     },
 110     {
 111       "name" : "mgr",
 112       "type" : "Roo.bootstrap.layout.Manager",
 113       "desc" : "The manager",
 114       "memberOf" : "Roo.bootstrap.layout.Region"
 115     },
 116     {
 117       "name" : "cls",
 118       "type" : "string",
 119       "desc" : "Extra CSS classes to add to region",
 120       "memberOf" : "Roo.bootstrap.layout.Region"
 121     },
 122     {
 123       "name" : "hideTabs",
 124       "type" : "Boolean",
 125       "desc" : "True to hide the tab strip (defaults to false)",
 126       "memberOf" : "Roo.bootstrap.layout.Region"
 127     },
 128     {
 129       "name" : "resizeTabs",
 130       "type" : "Boolean",
 131       "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n                     the space available, similar to FireFox 1.5 tabs (defaults to false)",
 132       "memberOf" : "Roo.bootstrap.layout.Region"
 133     },
 134     {
 135       "name" : "tabPosition",
 136       "type" : "String",
 137       "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
 138       "memberOf" : "Roo.bootstrap.layout.Region"
 139     },
 140     {
 141       "name" : "width",
 142       "type" : "Number",
 143       "desc" : "For East/West panels",
 144       "memberOf" : "Roo.bootstrap.layout.Region"
 145     },
 146     {
 147       "name" : "minTabWidth",
 148       "type" : "Number",
 149       "desc" : "The minimum tab width (defaults to 40)",
 150       "memberOf" : "Roo.bootstrap.layout.Region"
 151     },
 152     {
 153       "name" : "split",
 154       "type" : "Boolean",
 155       "desc" : "To show the splitter",
 156       "memberOf" : "Roo.bootstrap.layout.Region"
 157     },
 158     {
 159       "name" : "titlebar",
 160       "type" : "Boolean",
 161       "desc" : "True to display a title bar (defaults to true)",
 162       "memberOf" : "Roo.bootstrap.layout.Region"
 163     },
 164     {
 165       "name" : "preservePanels",
 166       "type" : "Boolean",
 167       "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
 168       "memberOf" : "Roo.bootstrap.layout.Region"
 169     },
 170     {
 171       "name" : "closeOnTab",
 172       "type" : "Boolean",
 173       "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
 174       "memberOf" : "Roo.bootstrap.layout.Region"
 175     },
 176     {
 177       "name" : "height",
 178       "type" : "Number",
 179       "desc" : "For North/South panels",
 180       "memberOf" : "Roo.bootstrap.layout.Region"
 181     },
 182     {
 183       "name" : "animate",
 184       "type" : "Boolean",
 185       "desc" : "True to animate expand/collapse (defaults to false)",
 186       "memberOf" : "Roo.bootstrap.layout.Region"
 187     },
 188     {
 189       "name" : "autoHide",
 190       "type" : "Boolean",
 191       "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
 192       "memberOf" : "Roo.bootstrap.layout.Region"
 193     }
 194   ],
 195   "methods" : [
 196     {
 197       "name" : "unhidePanel",
 198       "type" : "function",
 199       "desc" : "Unhides the tab for a previously hidden panel.",
 200       "sig" : "(panel)",
 201       "static" : false,
 202       "memberOf" : "",
 203       "isStatic" : false,
 204       "isConstructor" : false,
 205       "isPrivate" : false,
 206       "example" : "",
 207       "deprecated" : "",
 208       "since" : "",
 209       "see" : "",
 210       "exceptions" : "",
 211       "requires" : "",
 212       "params" : [
 213         {
 214           "name" : "panel",
 215           "type" : "Number/String/ContentPanel",
 216           "desc" : "The panel's index, id or the panel itself",
 217           "isOptional" : false
 218         }
 219       ],
 220       "returns" : []
 221     },
 222     {
 223       "name" : "showPanel",
 224       "type" : "function",
 225       "desc" : "Shows the specified panel.",
 226       "sig" : "(panelId)",
 227       "static" : false,
 228       "memberOf" : "",
 229       "isStatic" : false,
 230       "isConstructor" : false,
 231       "isPrivate" : false,
 232       "example" : "",
 233       "deprecated" : "",
 234       "since" : "",
 235       "see" : "",
 236       "exceptions" : "",
 237       "requires" : "",
 238       "params" : [
 239         {
 240           "name" : "panelId",
 241           "type" : "Number/String/ContentPanel",
 242           "desc" : "The panel's index, id or the panel itself",
 243           "isOptional" : false
 244         }
 245       ],
 246       "returns" : [
 247         {
 248           "name" : "",
 249           "type" : "Roo.ContentPanel",
 250           "desc" : "The shown panel, or null if a panel could not be found from panelId"
 251         }
 252       ]
 253     },
 254     {
 255       "name" : "add",
 256       "type" : "function",
 257       "desc" : "Adds the passed ContentPanel(s) to this region.",
 258       "sig" : "(panel)",
 259       "static" : false,
 260       "memberOf" : "",
 261       "isStatic" : false,
 262       "isConstructor" : false,
 263       "isPrivate" : false,
 264       "example" : "",
 265       "deprecated" : "",
 266       "since" : "",
 267       "see" : "",
 268       "exceptions" : "",
 269       "requires" : "",
 270       "params" : [
 271         {
 272           "name" : "panel",
 273           "type" : "ContentPanel...",
 274           "desc" : "The ContentPanel(s) to add (you can pass more than one)",
 275           "isOptional" : false
 276         }
 277       ],
 278       "returns" : [
 279         {
 280           "name" : "",
 281           "type" : "Roo.ContentPanel",
 282           "desc" : "The panel added (if only one was added; null otherwise)"
 283         }
 284       ]
 285     },
 286     {
 287       "name" : "animateCollapse",
 288       "type" : "function",
 289       "desc" : "Collapses this region.",
 290       "sig" : "(skipAnim)",
 291       "static" : false,
 292       "memberOf" : "",
 293       "isStatic" : false,
 294       "isConstructor" : false,
 295       "isPrivate" : false,
 296       "example" : "",
 297       "deprecated" : "",
 298       "since" : "",
 299       "see" : "",
 300       "exceptions" : "",
 301       "requires" : "",
 302       "params" : [
 303         {
 304           "name" : "skipAnim",
 305           "type" : "Boolean",
 306           "desc" : "(optional) true to collapse the element without animation (if animate is true)",
 307           "isOptional" : false
 308         }
 309       ],
 310       "returns" : []
 311     },
 312     {
 313       "name" : "animateExpand",
 314       "type" : "function",
 315       "desc" : "Expands this region if it was previously collapsed.",
 316       "sig" : "(e, skipAnim)",
 317       "static" : false,
 318       "memberOf" : "",
 319       "isStatic" : false,
 320       "isConstructor" : false,
 321       "isPrivate" : false,
 322       "example" : "",
 323       "deprecated" : "",
 324       "since" : "",
 325       "see" : "",
 326       "exceptions" : "",
 327       "requires" : "",
 328       "params" : [
 329         {
 330           "name" : "e",
 331           "type" : "Roo.EventObject",
 332           "desc" : "The event that triggered the expand (or null if calling manually)",
 333           "isOptional" : false
 334         },
 335         {
 336           "name" : "skipAnim",
 337           "type" : "Boolean",
 338           "desc" : "(optional) true to expand the element without animation (if animate is true)",
 339           "isOptional" : false
 340         }
 341       ],
 342       "returns" : []
 343     },
 344     {
 345       "name" : "remove",
 346       "type" : "function",
 347       "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
 348       "sig" : "(panel, preservePanel)",
 349       "static" : false,
 350       "memberOf" : "",
 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" : "panel",
 363           "type" : "Number/String/ContentPanel",
 364           "desc" : "The panel's index, id or the panel itself",
 365           "isOptional" : false
 366         },
 367         {
 368           "name" : "preservePanel",
 369           "type" : "Boolean",
 370           "desc" : "Overrides the config preservePanel option",
 371           "isOptional" : false
 372         }
 373       ],
 374       "returns" : [
 375         {
 376           "name" : "",
 377           "type" : "Roo.ContentPanel",
 378           "desc" : "The panel that was removed"
 379         }
 380       ]
 381     },
 382     {
 383       "name" : "hide",
 384       "type" : "function",
 385       "desc" : "Hides this region.",
 386       "sig" : "()\n{\n\n}",
 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       "returns" : []
 400     },
 401     {
 402       "name" : "show",
 403       "type" : "function",
 404       "desc" : "Shows this region if it was previously hidden.",
 405       "sig" : "()\n{\n\n}",
 406       "static" : false,
 407       "memberOf" : "",
 408       "isStatic" : false,
 409       "isConstructor" : false,
 410       "isPrivate" : false,
 411       "example" : "",
 412       "deprecated" : "",
 413       "since" : "",
 414       "see" : "",
 415       "exceptions" : "",
 416       "requires" : "",
 417       "params" : [],
 418       "returns" : []
 419     },
 420     {
 421       "name" : "getBox",
 422       "type" : "function",
 423       "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
 424       "sig" : "(title)",
 425       "static" : false,
 426       "memberOf" : "",
 427       "isStatic" : false,
 428       "isConstructor" : false,
 429       "isPrivate" : false,
 430       "example" : "",
 431       "deprecated" : "",
 432       "since" : "",
 433       "see" : "",
 434       "exceptions" : "",
 435       "requires" : "",
 436       "params" : [
 437         {
 438           "name" : "title",
 439           "type" : "String",
 440           "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&amp;#160;\")",
 441           "isOptional" : false
 442         }
 443       ],
 444       "returns" : []
 445     },
 446     {
 447       "name" : "hidePanel",
 448       "type" : "function",
 449       "desc" : "Hides the tab for the specified panel.",
 450       "sig" : "(panel)",
 451       "static" : false,
 452       "memberOf" : "",
 453       "isStatic" : false,
 454       "isConstructor" : false,
 455       "isPrivate" : false,
 456       "example" : "",
 457       "deprecated" : "",
 458       "since" : "",
 459       "see" : "",
 460       "exceptions" : "",
 461       "requires" : "",
 462       "params" : [
 463         {
 464           "name" : "panel",
 465           "type" : "Number/String/ContentPanel",
 466           "desc" : "The panel's index, id or the panel itself",
 467           "isOptional" : false
 468         }
 469       ],
 470       "returns" : []
 471     },
 472     {
 473       "name" : "getActivePanel",
 474       "type" : "function",
 475       "desc" : "Get the active panel for this region.",
 476       "sig" : "()\n{\n\n}",
 477       "static" : false,
 478       "memberOf" : "",
 479       "isStatic" : false,
 480       "isConstructor" : false,
 481       "isPrivate" : false,
 482       "example" : "",
 483       "deprecated" : "",
 484       "since" : "",
 485       "see" : "",
 486       "exceptions" : "",
 487       "requires" : "",
 488       "params" : [],
 489       "returns" : [
 490         {
 491           "name" : "",
 492           "type" : "Roo.ContentPanel",
 493           "desc" : "The active panel or null"
 494         }
 495       ]
 496     },
 497     {
 498       "name" : "getEl",
 499       "type" : "function",
 500       "desc" : "Returns the container element for this region.",
 501       "sig" : "()\n{\n\n}",
 502       "static" : false,
 503       "memberOf" : "",
 504       "isStatic" : false,
 505       "isConstructor" : false,
 506       "isPrivate" : false,
 507       "example" : "",
 508       "deprecated" : "",
 509       "since" : "",
 510       "see" : "",
 511       "exceptions" : "",
 512       "requires" : "",
 513       "params" : [],
 514       "returns" : [
 515         {
 516           "name" : "",
 517           "type" : "Roo.Element",
 518           "desc" : ""
 519         }
 520       ]
 521     },
 522     {
 523       "name" : "getTabs",
 524       "type" : "function",
 525       "desc" : "Returns the TabPanel component used by this region",
 526       "sig" : "()\n{\n\n}",
 527       "static" : false,
 528       "memberOf" : "",
 529       "isStatic" : false,
 530       "isConstructor" : false,
 531       "isPrivate" : false,
 532       "example" : "",
 533       "deprecated" : "",
 534       "since" : "",
 535       "see" : "",
 536       "exceptions" : "",
 537       "requires" : "",
 538       "params" : [],
 539       "returns" : [
 540         {
 541           "name" : "",
 542           "type" : "Roo.TabPanel",
 543           "desc" : ""
 544         }
 545       ]
 546     },
 547     {
 548       "name" : "isVisible",
 549       "type" : "function",
 550       "desc" : "Returns true if this region is currently visible.",
 551       "sig" : "()\n{\n\n}",
 552       "static" : false,
 553       "memberOf" : "",
 554       "isStatic" : false,
 555       "isConstructor" : false,
 556       "isPrivate" : false,
 557       "example" : "",
 558       "deprecated" : "",
 559       "since" : "",
 560       "see" : "",
 561       "exceptions" : "",
 562       "requires" : "",
 563       "params" : [],
 564       "returns" : [
 565         {
 566           "name" : "",
 567           "type" : "Boolean",
 568           "desc" : ""
 569         }
 570       ]
 571     },
 572     {
 573       "name" : "getPanel",
 574       "type" : "function",
 575       "desc" : "Returns the panel specified or null if it's not in this region.",
 576       "sig" : "(panel)",
 577       "static" : false,
 578       "memberOf" : "Roo.bootstrap.layout.Basic",
 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" : "panel",
 591           "type" : "Number/String/ContentPanel",
 592           "desc" : "The panels index, id or the panel itself",
 593           "isOptional" : false
 594         }
 595       ],
 596       "returns" : [
 597         {
 598           "name" : "",
 599           "type" : "Roo.ContentPanel",
 600           "desc" : ""
 601         }
 602       ]
 603     },
 604     {
 605       "name" : "hasPanel",
 606       "type" : "function",
 607       "desc" : "Returns true if the panel is in this region.",
 608       "sig" : "(panel)",
 609       "static" : false,
 610       "memberOf" : "Roo.bootstrap.layout.Basic",
 611       "isStatic" : false,
 612       "isConstructor" : false,
 613       "isPrivate" : false,
 614       "example" : "",
 615       "deprecated" : "",
 616       "since" : "",
 617       "see" : "",
 618       "exceptions" : "",
 619       "requires" : "",
 620       "params" : [
 621         {
 622           "name" : "panel",
 623           "type" : "Number/String/ContentPanel",
 624           "desc" : "The panels index, id or the panel itself",
 625           "isOptional" : false
 626         }
 627       ],
 628       "returns" : [
 629         {
 630           "name" : "",
 631           "type" : "Boolean",
 632           "desc" : ""
 633         }
 634       ]
 635     },
 636     {
 637       "name" : "resizeTo",
 638       "type" : "function",
 639       "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
 640       "sig" : "(newSize)",
 641       "static" : false,
 642       "memberOf" : "Roo.bootstrap.layout.Basic",
 643       "isStatic" : false,
 644       "isConstructor" : false,
 645       "isPrivate" : false,
 646       "example" : "",
 647       "deprecated" : "",
 648       "since" : "",
 649       "see" : "",
 650       "exceptions" : "",
 651       "requires" : "",
 652       "params" : [
 653         {
 654           "name" : "newSize",
 655           "type" : "Number",
 656           "desc" : "The new width or height",
 657           "isOptional" : false
 658         }
 659       ],
 660       "returns" : []
 661     },
 662     {
 663       "name" : "getPosition",
 664       "type" : "function",
 665       "desc" : "Returns this regions position (north/south/east/west/center).",
 666       "sig" : "()\n{\n\n}",
 667       "static" : false,
 668       "memberOf" : "Roo.bootstrap.layout.Basic",
 669       "isStatic" : false,
 670       "isConstructor" : false,
 671       "isPrivate" : false,
 672       "example" : "",
 673       "deprecated" : "",
 674       "since" : "",
 675       "see" : "",
 676       "exceptions" : "",
 677       "requires" : "",
 678       "params" : [],
 679       "returns" : [
 680         {
 681           "name" : "",
 682           "type" : "String",
 683           "desc" : ""
 684         }
 685       ]
 686     },
 687     {
 688       "name" : "purgeListeners",
 689       "type" : "function",
 690       "desc" : "Removes all listeners for this object",
 691       "sig" : "()\n{\n\n}",
 692       "static" : false,
 693       "memberOf" : "Roo.util.Observable",
 694       "isStatic" : false,
 695       "isConstructor" : false,
 696       "isPrivate" : false,
 697       "example" : "",
 698       "deprecated" : "",
 699       "since" : "",
 700       "see" : "",
 701       "exceptions" : "",
 702       "requires" : "",
 703       "params" : [],
 704       "returns" : []
 705     },
 706     {
 707       "name" : "on",
 708       "type" : "function",
 709       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 710       "sig" : "(eventName, handler, scope, options)",
 711       "static" : false,
 712       "memberOf" : "Roo.util.Observable",
 713       "isStatic" : false,
 714       "isConstructor" : false,
 715       "isPrivate" : false,
 716       "example" : "",
 717       "deprecated" : "",
 718       "since" : "",
 719       "see" : "",
 720       "exceptions" : "",
 721       "requires" : "",
 722       "params" : [
 723         {
 724           "name" : "eventName",
 725           "type" : "String",
 726           "desc" : "The type of event to listen for",
 727           "isOptional" : false
 728         },
 729         {
 730           "name" : "handler",
 731           "type" : "Function",
 732           "desc" : "The method the event invokes",
 733           "isOptional" : false
 734         },
 735         {
 736           "name" : "scope",
 737           "type" : "Object",
 738           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 739           "isOptional" : false
 740         },
 741         {
 742           "name" : "options",
 743           "type" : "Object",
 744           "desc" : "(optional)",
 745           "isOptional" : false
 746         }
 747       ],
 748       "returns" : []
 749     },
 750     {
 751       "name" : "un",
 752       "type" : "function",
 753       "desc" : "Removes a listener (shorthand for removeListener)",
 754       "sig" : "(eventName, handler, scope)",
 755       "static" : false,
 756       "memberOf" : "Roo.util.Observable",
 757       "isStatic" : false,
 758       "isConstructor" : false,
 759       "isPrivate" : false,
 760       "example" : "",
 761       "deprecated" : "",
 762       "since" : "",
 763       "see" : "",
 764       "exceptions" : "",
 765       "requires" : "",
 766       "params" : [
 767         {
 768           "name" : "eventName",
 769           "type" : "String",
 770           "desc" : "The type of event to listen for",
 771           "isOptional" : false
 772         },
 773         {
 774           "name" : "handler",
 775           "type" : "Function",
 776           "desc" : "The handler to remove",
 777           "isOptional" : false
 778         },
 779         {
 780           "name" : "scope",
 781           "type" : "Object",
 782           "desc" : "(optional) The scope (this object) for the handler",
 783           "isOptional" : false
 784         }
 785       ],
 786       "returns" : []
 787     },
 788     {
 789       "name" : "addEvents",
 790       "type" : "function",
 791       "desc" : "Used to define events on this Observable",
 792       "sig" : "(object)",
 793       "static" : false,
 794       "memberOf" : "Roo.util.Observable",
 795       "isStatic" : false,
 796       "isConstructor" : false,
 797       "isPrivate" : false,
 798       "example" : "",
 799       "deprecated" : "",
 800       "since" : "",
 801       "see" : "",
 802       "exceptions" : "",
 803       "requires" : "",
 804       "params" : [
 805         {
 806           "name" : "object",
 807           "type" : "Object",
 808           "desc" : "The object with the events defined",
 809           "isOptional" : false
 810         }
 811       ],
 812       "returns" : []
 813     },
 814     {
 815       "name" : "releaseCapture",
 816       "type" : "function",
 817       "desc" : "Removes <b>all</b> added captures from the Observable.",
 818       "sig" : "(o)",
 819       "static" : true,
 820       "memberOf" : "Roo.util.Observable",
 821       "isStatic" : true,
 822       "isConstructor" : false,
 823       "isPrivate" : false,
 824       "example" : "",
 825       "deprecated" : "",
 826       "since" : "",
 827       "see" : "",
 828       "exceptions" : "",
 829       "requires" : "",
 830       "params" : [
 831         {
 832           "name" : "o",
 833           "type" : "Observable",
 834           "desc" : "The Observable to release",
 835           "isOptional" : false
 836         }
 837       ],
 838       "returns" : []
 839     },
 840     {
 841       "name" : "removeListener",
 842       "type" : "function",
 843       "desc" : "Removes a listener",
 844       "sig" : "(eventName, handler, scope)",
 845       "static" : false,
 846       "memberOf" : "Roo.util.Observable",
 847       "isStatic" : false,
 848       "isConstructor" : false,
 849       "isPrivate" : false,
 850       "example" : "",
 851       "deprecated" : "",
 852       "since" : "",
 853       "see" : "",
 854       "exceptions" : "",
 855       "requires" : "",
 856       "params" : [
 857         {
 858           "name" : "eventName",
 859           "type" : "String",
 860           "desc" : "The type of event to listen for",
 861           "isOptional" : false
 862         },
 863         {
 864           "name" : "handler",
 865           "type" : "Function",
 866           "desc" : "The handler to remove",
 867           "isOptional" : false
 868         },
 869         {
 870           "name" : "scope",
 871           "type" : "Object",
 872           "desc" : "(optional) The scope (this object) for the handler",
 873           "isOptional" : false
 874         }
 875       ],
 876       "returns" : []
 877     },
 878     {
 879       "name" : "fireEvent",
 880       "type" : "function",
 881       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 882       "sig" : "(eventName, args)",
 883       "static" : false,
 884       "memberOf" : "Roo.util.Observable",
 885       "isStatic" : false,
 886       "isConstructor" : false,
 887       "isPrivate" : false,
 888       "example" : "",
 889       "deprecated" : "",
 890       "since" : "",
 891       "see" : "",
 892       "exceptions" : "",
 893       "requires" : "",
 894       "params" : [
 895         {
 896           "name" : "eventName",
 897           "type" : "String",
 898           "desc" : "",
 899           "isOptional" : false
 900         },
 901         {
 902           "name" : "args",
 903           "type" : "Object...",
 904           "desc" : "Variable number of parameters are passed to handlers",
 905           "isOptional" : false
 906         }
 907       ],
 908       "returns" : [
 909         {
 910           "name" : "",
 911           "type" : "Boolean",
 912           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 913         }
 914       ]
 915     },
 916     {
 917       "name" : "hasListener",
 918       "type" : "function",
 919       "desc" : "Checks to see if this object has any listeners for a specified event",
 920       "sig" : "(eventName)",
 921       "static" : false,
 922       "memberOf" : "Roo.util.Observable",
 923       "isStatic" : false,
 924       "isConstructor" : false,
 925       "isPrivate" : false,
 926       "example" : "",
 927       "deprecated" : "",
 928       "since" : "",
 929       "see" : "",
 930       "exceptions" : "",
 931       "requires" : "",
 932       "params" : [
 933         {
 934           "name" : "eventName",
 935           "type" : "String",
 936           "desc" : "The name of the event to check for",
 937           "isOptional" : false
 938         }
 939       ],
 940       "returns" : [
 941         {
 942           "name" : "",
 943           "type" : "Boolean",
 944           "desc" : "True if the event is being listened for, else false"
 945         }
 946       ]
 947     },
 948     {
 949       "name" : "capture",
 950       "type" : "function",
 951       "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.",
 952       "sig" : "(o, fn, scope)",
 953       "static" : true,
 954       "memberOf" : "Roo.util.Observable",
 955       "isStatic" : true,
 956       "isConstructor" : false,
 957       "isPrivate" : false,
 958       "example" : "",
 959       "deprecated" : "",
 960       "since" : "",
 961       "see" : "",
 962       "exceptions" : "",
 963       "requires" : "",
 964       "params" : [
 965         {
 966           "name" : "o",
 967           "type" : "Observable",
 968           "desc" : "The Observable to capture",
 969           "isOptional" : false
 970         },
 971         {
 972           "name" : "fn",
 973           "type" : "Function",
 974           "desc" : "The function to call",
 975           "isOptional" : false
 976         },
 977         {
 978           "name" : "scope",
 979           "type" : "Object",
 980           "desc" : "(optional) The scope (this object) for the fn",
 981           "isOptional" : false
 982         }
 983       ],
 984       "returns" : []
 985     },
 986     {
 987       "name" : "addListener",
 988       "type" : "function",
 989       "desc" : "Appends an event handler to this component",
 990       "sig" : "(eventName, handler, scope, options)",
 991       "static" : false,
 992       "memberOf" : "Roo.util.Observable",
 993       "isStatic" : false,
 994       "isConstructor" : false,
 995       "isPrivate" : false,
 996       "example" : "",
 997       "deprecated" : "",
 998       "since" : "",
 999       "see" : "",
1000       "exceptions" : "",
1001       "requires" : "",
1002       "params" : [
1003         {
1004           "name" : "eventName",
1005           "type" : "String",
1006           "desc" : "The type of event to listen for",
1007           "isOptional" : false
1008         },
1009         {
1010           "name" : "handler",
1011           "type" : "Function",
1012           "desc" : "The method the event invokes",
1013           "isOptional" : false
1014         },
1015         {
1016           "name" : "scope",
1017           "type" : "Object",
1018           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1019           "isOptional" : false
1020         },
1021         {
1022           "name" : "options",
1023           "type" : "Object",
1024           "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>",
1025           "isOptional" : false
1026         }
1027       ],
1028       "returns" : []
1029     }
1030   ],
1031   "events" : []
1032 }