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

   1 {
   2   "name" : "Roo.bootstrap.ButtonGroup",
   3   "augments" : [
   4     "Roo.bootstrap.Component",
   5     "Roo.Component",
   6     "Roo.util.Observable"
   7   ],
   8   "childClasses" : {  },
   9   "tree_children" : [
  10     "Roo.bootstrap.Button",
  11     "Roo.bootstrap.ButtonUploader",
  12     "Roo.bootstrap.form.CardUploader",
  13     "Roo.bootstrap.form.Form"
  14   ],
  15   "tree_parent" : [],
  16   "desc" : "Bootstrap ButtonGroup class",
  17   "isSingleton" : false,
  18   "isStatic" : false,
  19   "isBuiltin" : false,
  20   "isAbstract" : false,
  21   "isBuilderTop" : false,
  22   "memberOf" : "ButtonGroup",
  23   "example" : "",
  24   "deprecated" : "",
  25   "since" : "",
  26   "see" : "",
  27   "params" : [
  28     {
  29       "name" : "config",
  30       "type" : "Object",
  31       "desc" : "The config object",
  32       "isOptional" : false
  33     }
  34   ],
  35   "returns" : [],
  36   "throws" : "",
  37   "requires" : "",
  38   "config" : [
  39     {
  40       "name" : "btn",
  41       "type" : "Boolean",
  42       "desc" : "true | false",
  43       "memberOf" : "",
  44       "isOptional" : false,
  45       "optvals" : []
  46     },
  47     {
  48       "name" : "listeners",
  49       "type" : "Object",
  50       "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>",
  51       "memberOf" : "Roo.util.Observable",
  52       "isOptional" : false,
  53       "optvals" : []
  54     },
  55     {
  56       "name" : "tooltip",
  57       "type" : "string",
  58       "desc" : "Text for the tooltip",
  59       "memberOf" : "Roo.bootstrap.Component",
  60       "isOptional" : false,
  61       "optvals" : []
  62     },
  63     {
  64       "name" : "container_method",
  65       "type" : "string",
  66       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
  67       "memberOf" : "Roo.bootstrap.Component",
  68       "isOptional" : false,
  69       "optvals" : []
  70     },
  71     {
  72       "name" : "visibilityEl",
  73       "type" : "string|object",
  74       "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
  75       "memberOf" : "Roo.bootstrap.Component",
  76       "isOptional" : false,
  77       "optvals" : [
  78         "el",
  79         "parent"
  80       ]
  81     },
  82     {
  83       "name" : "align",
  84       "type" : "String",
  85       "desc" : "vertical | justified  (default none)",
  86       "memberOf" : "",
  87       "isOptional" : false,
  88       "optvals" : []
  89     },
  90     {
  91       "name" : "direction",
  92       "type" : "String",
  93       "desc" : "up | down (default down)",
  94       "memberOf" : "",
  95       "isOptional" : false,
  96       "optvals" : []
  97     },
  98     {
  99       "name" : "toolbar",
 100       "type" : "Boolean",
 101       "desc" : "false | true",
 102       "memberOf" : "",
 103       "isOptional" : false,
 104       "optvals" : []
 105     },
 106     {
 107       "name" : "can_build_overlaid",
 108       "type" : "Boolean",
 109       "desc" : "True if element can be rebuild from a HTML page",
 110       "memberOf" : "Roo.bootstrap.Component",
 111       "isOptional" : false,
 112       "optvals" : []
 113     },
 114     {
 115       "name" : "hideMode",
 116       "type" : "String",
 117       "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
 118       "memberOf" : "Roo.Component",
 119       "isOptional" : false,
 120       "optvals" : [
 121         "display",
 122         "visibility"
 123       ]
 124     },
 125     {
 126       "name" : "style",
 127       "type" : "String",
 128       "desc" : "any extra css",
 129       "memberOf" : "Roo.bootstrap.Component",
 130       "isOptional" : false,
 131       "optvals" : []
 132     },
 133     {
 134       "name" : "allowDomMove",
 135       "type" : "Boolean",
 136       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 137       "memberOf" : "Roo.Component",
 138       "isOptional" : false,
 139       "optvals" : []
 140     },
 141     {
 142       "name" : "cls",
 143       "type" : "String",
 144       "desc" : "css class",
 145       "memberOf" : "Roo.bootstrap.Component",
 146       "isOptional" : false,
 147       "optvals" : []
 148     },
 149     {
 150       "name" : "xattr",
 151       "type" : "Object",
 152       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
 153       "memberOf" : "Roo.bootstrap.Component",
 154       "isOptional" : false,
 155       "optvals" : []
 156     },
 157     {
 158       "name" : "actionMode",
 159       "type" : "String",
 160       "desc" : "which property holds the element that used for  hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
 161       "memberOf" : "Roo.Component",
 162       "isOptional" : false,
 163       "optvals" : []
 164     },
 165     {
 166       "name" : "dataId",
 167       "type" : "string",
 168       "desc" : "cutomer id",
 169       "memberOf" : "Roo.bootstrap.Component",
 170       "isOptional" : false,
 171       "optvals" : []
 172     },
 173     {
 174       "name" : "size",
 175       "type" : "String",
 176       "desc" : "lg | sm | xs (default empty normal)",
 177       "memberOf" : "",
 178       "isOptional" : false,
 179       "optvals" : []
 180     },
 181     {
 182       "name" : "name",
 183       "type" : "string",
 184       "desc" : "Specifies name attribute",
 185       "memberOf" : "Roo.bootstrap.Component",
 186       "isOptional" : false,
 187       "optvals" : []
 188     },
 189     {
 190       "name" : "disableClass",
 191       "type" : "String",
 192       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 193       "memberOf" : "Roo.Component",
 194       "isOptional" : false,
 195       "optvals" : []
 196     }
 197   ],
 198   "methods" : [
 199     {
 200       "name" : "addItem",
 201       "type" : "function",
 202       "desc" : "Add a button to the group (similar to NavItem API.)",
 203       "sig" : "()\n{\n\n}",
 204       "static" : false,
 205       "memberOf" : "",
 206       "isStatic" : false,
 207       "isConstructor" : false,
 208       "isPrivate" : false,
 209       "example" : "",
 210       "deprecated" : "",
 211       "since" : "",
 212       "see" : "",
 213       "exceptions" : "",
 214       "requires" : "",
 215       "params" : [],
 216       "returns" : []
 217     },
 218     {
 219       "name" : "tooltipEl",
 220       "type" : "function",
 221       "desc" : "Fetch the element to display the tooltip on.",
 222       "sig" : "()\n{\n\n}",
 223       "static" : false,
 224       "memberOf" : "Roo.bootstrap.Component",
 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" : "Roo.Element",
 239           "desc" : "defaults to this.el"
 240         }
 241       ]
 242     },
 243     {
 244       "name" : "hide",
 245       "type" : "function",
 246       "desc" : "Hide a component - adds 'hidden' class",
 247       "sig" : "()\n{\n\n}",
 248       "static" : false,
 249       "memberOf" : "Roo.bootstrap.Component",
 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" : "show",
 264       "type" : "function",
 265       "desc" : "Show a component - removes 'hidden' class",
 266       "sig" : "()\n{\n\n}",
 267       "static" : false,
 268       "memberOf" : "Roo.bootstrap.Component",
 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     {
 282       "name" : "setVisibilityEl",
 283       "type" : "function",
 284       "desc" : "Set the element that will be used to show or hide",
 285       "sig" : "()\n{\n\n}",
 286       "static" : false,
 287       "memberOf" : "Roo.bootstrap.Component",
 288       "isStatic" : false,
 289       "isConstructor" : false,
 290       "isPrivate" : false,
 291       "example" : "",
 292       "deprecated" : "",
 293       "since" : "",
 294       "see" : "",
 295       "exceptions" : "",
 296       "requires" : "",
 297       "params" : [],
 298       "returns" : []
 299     },
 300     {
 301       "name" : "getVisibilityEl",
 302       "type" : "function",
 303       "desc" : "Get the element that will be used to show or hide",
 304       "sig" : "()\n{\n\n}",
 305       "static" : false,
 306       "memberOf" : "Roo.bootstrap.Component",
 307       "isStatic" : false,
 308       "isConstructor" : false,
 309       "isPrivate" : false,
 310       "example" : "",
 311       "deprecated" : "",
 312       "since" : "",
 313       "see" : "",
 314       "exceptions" : "",
 315       "requires" : "",
 316       "params" : [],
 317       "returns" : []
 318     },
 319     {
 320       "name" : "initEvents",
 321       "type" : "function",
 322       "desc" : "Initialize Events for the element",
 323       "sig" : "()\n{\n\n}",
 324       "static" : false,
 325       "memberOf" : "Roo.bootstrap.Component",
 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     {
 339       "name" : "getChildContainer",
 340       "type" : "function",
 341       "desc" : "Fetch the element to add children to",
 342       "sig" : "()\n{\n\n}",
 343       "static" : false,
 344       "memberOf" : "Roo.bootstrap.Component",
 345       "isStatic" : false,
 346       "isConstructor" : false,
 347       "isPrivate" : false,
 348       "example" : "",
 349       "deprecated" : "",
 350       "since" : "",
 351       "see" : "",
 352       "exceptions" : "",
 353       "requires" : "",
 354       "params" : [],
 355       "returns" : [
 356         {
 357           "name" : "",
 358           "type" : "Roo.Element",
 359           "desc" : "defaults to this.el"
 360         }
 361       ]
 362     },
 363     {
 364       "name" : "getId",
 365       "type" : "function",
 366       "desc" : "Returns the id of this component.",
 367       "sig" : "()\n{\n\n}",
 368       "static" : false,
 369       "memberOf" : "Roo.Component",
 370       "isStatic" : false,
 371       "isConstructor" : false,
 372       "isPrivate" : false,
 373       "example" : "",
 374       "deprecated" : "",
 375       "since" : "",
 376       "see" : "",
 377       "exceptions" : "",
 378       "requires" : "",
 379       "params" : [],
 380       "returns" : [
 381         {
 382           "name" : "",
 383           "type" : "String",
 384           "desc" : ""
 385         }
 386       ]
 387     },
 388     {
 389       "name" : "render",
 390       "type" : "function",
 391       "desc" : "If this is a lazy rendering component, render it to its container element.",
 392       "sig" : "(container)",
 393       "static" : false,
 394       "memberOf" : "Roo.Component",
 395       "isStatic" : false,
 396       "isConstructor" : false,
 397       "isPrivate" : false,
 398       "example" : "",
 399       "deprecated" : "",
 400       "since" : "",
 401       "see" : "",
 402       "exceptions" : "",
 403       "requires" : "",
 404       "params" : [
 405         {
 406           "name" : "container",
 407           "type" : "String/HTMLElement/Element",
 408           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 409           "isOptional" : false
 410         }
 411       ],
 412       "returns" : []
 413     },
 414     {
 415       "name" : "destroy",
 416       "type" : "function",
 417       "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
 418       "sig" : "()\n{\n\n}",
 419       "static" : false,
 420       "memberOf" : "Roo.Component",
 421       "isStatic" : false,
 422       "isConstructor" : false,
 423       "isPrivate" : false,
 424       "example" : "",
 425       "deprecated" : "",
 426       "since" : "",
 427       "see" : "",
 428       "exceptions" : "",
 429       "requires" : "",
 430       "params" : [],
 431       "returns" : []
 432     },
 433     {
 434       "name" : "isVisible",
 435       "type" : "function",
 436       "desc" : "Returns true if this component is visible.",
 437       "sig" : "()\n{\n\n}",
 438       "static" : false,
 439       "memberOf" : "Roo.Component",
 440       "isStatic" : false,
 441       "isConstructor" : false,
 442       "isPrivate" : false,
 443       "example" : "",
 444       "deprecated" : "",
 445       "since" : "",
 446       "see" : "",
 447       "exceptions" : "",
 448       "requires" : "",
 449       "params" : [],
 450       "returns" : []
 451     },
 452     {
 453       "name" : "setDisabled",
 454       "type" : "function",
 455       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 456       "sig" : "(disabled)",
 457       "static" : false,
 458       "memberOf" : "Roo.Component",
 459       "isStatic" : false,
 460       "isConstructor" : false,
 461       "isPrivate" : false,
 462       "example" : "",
 463       "deprecated" : "",
 464       "since" : "",
 465       "see" : "",
 466       "exceptions" : "",
 467       "requires" : "",
 468       "params" : [
 469         {
 470           "name" : "disabled",
 471           "type" : "Boolean",
 472           "desc" : "",
 473           "isOptional" : false
 474         }
 475       ],
 476       "returns" : []
 477     },
 478     {
 479       "name" : "focus",
 480       "type" : "function",
 481       "desc" : "Try to focus this component.",
 482       "sig" : "(selectText)",
 483       "static" : false,
 484       "memberOf" : "Roo.Component",
 485       "isStatic" : false,
 486       "isConstructor" : false,
 487       "isPrivate" : false,
 488       "example" : "",
 489       "deprecated" : "",
 490       "since" : "",
 491       "see" : "",
 492       "exceptions" : "",
 493       "requires" : "",
 494       "params" : [
 495         {
 496           "name" : "selectText",
 497           "type" : "Boolean",
 498           "desc" : "True to also select the text in this component (if applicable)",
 499           "isOptional" : false
 500         }
 501       ],
 502       "returns" : [
 503         {
 504           "name" : "",
 505           "type" : "Roo.Component",
 506           "desc" : "this"
 507         }
 508       ]
 509     },
 510     {
 511       "name" : "enable",
 512       "type" : "function",
 513       "desc" : "Enable this component.",
 514       "sig" : "()\n{\n\n}",
 515       "static" : false,
 516       "memberOf" : "Roo.Component",
 517       "isStatic" : false,
 518       "isConstructor" : false,
 519       "isPrivate" : false,
 520       "example" : "",
 521       "deprecated" : "",
 522       "since" : "",
 523       "see" : "",
 524       "exceptions" : "",
 525       "requires" : "",
 526       "params" : [],
 527       "returns" : [
 528         {
 529           "name" : "",
 530           "type" : "Roo.Component",
 531           "desc" : "this"
 532         }
 533       ]
 534     },
 535     {
 536       "name" : "setVisible",
 537       "type" : "function",
 538       "desc" : "Convenience function to hide or show this component by boolean.",
 539       "sig" : "(visible)",
 540       "static" : false,
 541       "memberOf" : "Roo.Component",
 542       "isStatic" : false,
 543       "isConstructor" : false,
 544       "isPrivate" : false,
 545       "example" : "",
 546       "deprecated" : "",
 547       "since" : "",
 548       "see" : "",
 549       "exceptions" : "",
 550       "requires" : "",
 551       "params" : [
 552         {
 553           "name" : "visible",
 554           "type" : "Boolean",
 555           "desc" : "True to show, false to hide",
 556           "isOptional" : false
 557         }
 558       ],
 559       "returns" : [
 560         {
 561           "name" : "",
 562           "type" : "Roo.Component",
 563           "desc" : "this"
 564         }
 565       ]
 566     },
 567     {
 568       "name" : "disable",
 569       "type" : "function",
 570       "desc" : "Disable this component.",
 571       "sig" : "()\n{\n\n}",
 572       "static" : false,
 573       "memberOf" : "Roo.Component",
 574       "isStatic" : false,
 575       "isConstructor" : false,
 576       "isPrivate" : false,
 577       "example" : "",
 578       "deprecated" : "",
 579       "since" : "",
 580       "see" : "",
 581       "exceptions" : "",
 582       "requires" : "",
 583       "params" : [],
 584       "returns" : [
 585         {
 586           "name" : "",
 587           "type" : "Roo.Component",
 588           "desc" : "this"
 589         }
 590       ]
 591     },
 592     {
 593       "name" : "getEl",
 594       "type" : "function",
 595       "desc" : "Returns the underlying {@link Roo.Element}.",
 596       "sig" : "()\n{\n\n}",
 597       "static" : false,
 598       "memberOf" : "Roo.Component",
 599       "isStatic" : false,
 600       "isConstructor" : false,
 601       "isPrivate" : false,
 602       "example" : "",
 603       "deprecated" : "",
 604       "since" : "",
 605       "see" : "",
 606       "exceptions" : "",
 607       "requires" : "",
 608       "params" : [],
 609       "returns" : [
 610         {
 611           "name" : "",
 612           "type" : "Roo.Element",
 613           "desc" : "The element"
 614         }
 615       ]
 616     },
 617     {
 618       "name" : "purgeListeners",
 619       "type" : "function",
 620       "desc" : "Removes all listeners for this object",
 621       "sig" : "()\n{\n\n}",
 622       "static" : false,
 623       "memberOf" : "Roo.util.Observable",
 624       "isStatic" : false,
 625       "isConstructor" : false,
 626       "isPrivate" : false,
 627       "example" : "",
 628       "deprecated" : "",
 629       "since" : "",
 630       "see" : "",
 631       "exceptions" : "",
 632       "requires" : "",
 633       "params" : [],
 634       "returns" : []
 635     },
 636     {
 637       "name" : "on",
 638       "type" : "function",
 639       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 640       "sig" : "(eventName, handler, scope, options)",
 641       "static" : false,
 642       "memberOf" : "Roo.util.Observable",
 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" : "eventName",
 655           "type" : "String",
 656           "desc" : "The type of event to listen for",
 657           "isOptional" : false
 658         },
 659         {
 660           "name" : "handler",
 661           "type" : "Function",
 662           "desc" : "The method the event invokes",
 663           "isOptional" : false
 664         },
 665         {
 666           "name" : "scope",
 667           "type" : "Object",
 668           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 669           "isOptional" : false
 670         },
 671         {
 672           "name" : "options",
 673           "type" : "Object",
 674           "desc" : "(optional)",
 675           "isOptional" : false
 676         }
 677       ],
 678       "returns" : []
 679     },
 680     {
 681       "name" : "un",
 682       "type" : "function",
 683       "desc" : "Removes a listener (shorthand for removeListener)",
 684       "sig" : "(eventName, handler, scope)",
 685       "static" : false,
 686       "memberOf" : "Roo.util.Observable",
 687       "isStatic" : false,
 688       "isConstructor" : false,
 689       "isPrivate" : false,
 690       "example" : "",
 691       "deprecated" : "",
 692       "since" : "",
 693       "see" : "",
 694       "exceptions" : "",
 695       "requires" : "",
 696       "params" : [
 697         {
 698           "name" : "eventName",
 699           "type" : "String",
 700           "desc" : "The type of event to listen for",
 701           "isOptional" : false
 702         },
 703         {
 704           "name" : "handler",
 705           "type" : "Function",
 706           "desc" : "The handler to remove",
 707           "isOptional" : false
 708         },
 709         {
 710           "name" : "scope",
 711           "type" : "Object",
 712           "desc" : "(optional) The scope (this object) for the handler",
 713           "isOptional" : false
 714         }
 715       ],
 716       "returns" : []
 717     },
 718     {
 719       "name" : "addEvents",
 720       "type" : "function",
 721       "desc" : "Used to define events on this Observable",
 722       "sig" : "(object)",
 723       "static" : false,
 724       "memberOf" : "Roo.util.Observable",
 725       "isStatic" : false,
 726       "isConstructor" : false,
 727       "isPrivate" : false,
 728       "example" : "",
 729       "deprecated" : "",
 730       "since" : "",
 731       "see" : "",
 732       "exceptions" : "",
 733       "requires" : "",
 734       "params" : [
 735         {
 736           "name" : "object",
 737           "type" : "Object",
 738           "desc" : "The object with the events defined",
 739           "isOptional" : false
 740         }
 741       ],
 742       "returns" : []
 743     },
 744     {
 745       "name" : "releaseCapture",
 746       "type" : "function",
 747       "desc" : "Removes <b>all</b> added captures from the Observable.",
 748       "sig" : "(o)",
 749       "static" : true,
 750       "memberOf" : "Roo.util.Observable",
 751       "isStatic" : true,
 752       "isConstructor" : false,
 753       "isPrivate" : false,
 754       "example" : "",
 755       "deprecated" : "",
 756       "since" : "",
 757       "see" : "",
 758       "exceptions" : "",
 759       "requires" : "",
 760       "params" : [
 761         {
 762           "name" : "o",
 763           "type" : "Observable",
 764           "desc" : "The Observable to release",
 765           "isOptional" : false
 766         }
 767       ],
 768       "returns" : []
 769     },
 770     {
 771       "name" : "removeListener",
 772       "type" : "function",
 773       "desc" : "Removes a listener",
 774       "sig" : "(eventName, handler, scope)",
 775       "static" : false,
 776       "memberOf" : "Roo.util.Observable",
 777       "isStatic" : false,
 778       "isConstructor" : false,
 779       "isPrivate" : false,
 780       "example" : "",
 781       "deprecated" : "",
 782       "since" : "",
 783       "see" : "",
 784       "exceptions" : "",
 785       "requires" : "",
 786       "params" : [
 787         {
 788           "name" : "eventName",
 789           "type" : "String",
 790           "desc" : "The type of event to listen for",
 791           "isOptional" : false
 792         },
 793         {
 794           "name" : "handler",
 795           "type" : "Function",
 796           "desc" : "The handler to remove",
 797           "isOptional" : false
 798         },
 799         {
 800           "name" : "scope",
 801           "type" : "Object",
 802           "desc" : "(optional) The scope (this object) for the handler",
 803           "isOptional" : false
 804         }
 805       ],
 806       "returns" : []
 807     },
 808     {
 809       "name" : "fireEvent",
 810       "type" : "function",
 811       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 812       "sig" : "(eventName, args)",
 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" : "",
 829           "isOptional" : false
 830         },
 831         {
 832           "name" : "args",
 833           "type" : "Object...",
 834           "desc" : "Variable number of parameters are passed to handlers",
 835           "isOptional" : false
 836         }
 837       ],
 838       "returns" : [
 839         {
 840           "name" : "",
 841           "type" : "Boolean",
 842           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 843         }
 844       ]
 845     },
 846     {
 847       "name" : "hasListener",
 848       "type" : "function",
 849       "desc" : "Checks to see if this object has any listeners for a specified event",
 850       "sig" : "(eventName)",
 851       "static" : false,
 852       "memberOf" : "Roo.util.Observable",
 853       "isStatic" : false,
 854       "isConstructor" : false,
 855       "isPrivate" : false,
 856       "example" : "",
 857       "deprecated" : "",
 858       "since" : "",
 859       "see" : "",
 860       "exceptions" : "",
 861       "requires" : "",
 862       "params" : [
 863         {
 864           "name" : "eventName",
 865           "type" : "String",
 866           "desc" : "The name of the event to check for",
 867           "isOptional" : false
 868         }
 869       ],
 870       "returns" : [
 871         {
 872           "name" : "",
 873           "type" : "Boolean",
 874           "desc" : "True if the event is being listened for, else false"
 875         }
 876       ]
 877     },
 878     {
 879       "name" : "capture",
 880       "type" : "function",
 881       "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.",
 882       "sig" : "(o, fn, scope)",
 883       "static" : true,
 884       "memberOf" : "Roo.util.Observable",
 885       "isStatic" : true,
 886       "isConstructor" : false,
 887       "isPrivate" : false,
 888       "example" : "",
 889       "deprecated" : "",
 890       "since" : "",
 891       "see" : "",
 892       "exceptions" : "",
 893       "requires" : "",
 894       "params" : [
 895         {
 896           "name" : "o",
 897           "type" : "Observable",
 898           "desc" : "The Observable to capture",
 899           "isOptional" : false
 900         },
 901         {
 902           "name" : "fn",
 903           "type" : "Function",
 904           "desc" : "The function to call",
 905           "isOptional" : false
 906         },
 907         {
 908           "name" : "scope",
 909           "type" : "Object",
 910           "desc" : "(optional) The scope (this object) for the fn",
 911           "isOptional" : false
 912         }
 913       ],
 914       "returns" : []
 915     },
 916     {
 917       "name" : "addListener",
 918       "type" : "function",
 919       "desc" : "Appends an event handler to this component",
 920       "sig" : "(eventName, handler, scope, options)",
 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 type of event to listen for",
 937           "isOptional" : false
 938         },
 939         {
 940           "name" : "handler",
 941           "type" : "Function",
 942           "desc" : "The method the event invokes",
 943           "isOptional" : false
 944         },
 945         {
 946           "name" : "scope",
 947           "type" : "Object",
 948           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 949           "isOptional" : false
 950         },
 951         {
 952           "name" : "options",
 953           "type" : "Object",
 954           "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>",
 955           "isOptional" : false
 956         }
 957       ],
 958       "returns" : []
 959     }
 960   ],
 961   "events" : [
 962     {
 963       "name" : "childrenrendered",
 964       "type" : "function",
 965       "desc" : "Fires when the children have been rendered..",
 966       "sig" : "function (_self)\n{\n\n}",
 967       "memberOf" : "Roo.bootstrap.Component",
 968       "example" : "",
 969       "deprecated" : "",
 970       "since" : "",
 971       "see" : "",
 972       "params" : [
 973         {
 974           "name" : "this",
 975           "type" : "Roo.bootstrap.Component",
 976           "desc" : "",
 977           "isOptional" : false
 978         }
 979       ],
 980       "returns" : []
 981     },
 982     {
 983       "name" : "beforerender",
 984       "type" : "function",
 985       "desc" : "Fires before the component is rendered. Return false to stop the render.",
 986       "sig" : "function (_self)\n{\n\n}",
 987       "memberOf" : "Roo.Component",
 988       "example" : "",
 989       "deprecated" : "",
 990       "since" : "",
 991       "see" : "",
 992       "params" : [
 993         {
 994           "name" : "this",
 995           "type" : "Roo.Component",
 996           "desc" : "",
 997           "isOptional" : false
 998         }
 999       ],
1000       "returns" : []
1001     },
1002     {
1003       "name" : "disable",
1004       "type" : "function",
1005       "desc" : "Fires after the component is disabled.",
1006       "sig" : "function (_self)\n{\n\n}",
1007       "memberOf" : "Roo.Component",
1008       "example" : "",
1009       "deprecated" : "",
1010       "since" : "",
1011       "see" : "",
1012       "params" : [
1013         {
1014           "name" : "this",
1015           "type" : "Roo.Component",
1016           "desc" : "",
1017           "isOptional" : false
1018         }
1019       ],
1020       "returns" : []
1021     },
1022     {
1023       "name" : "render",
1024       "type" : "function",
1025       "desc" : "Fires after the component is rendered.",
1026       "sig" : "function (_self)\n{\n\n}",
1027       "memberOf" : "Roo.Component",
1028       "example" : "",
1029       "deprecated" : "",
1030       "since" : "",
1031       "see" : "",
1032       "params" : [
1033         {
1034           "name" : "this",
1035           "type" : "Roo.Component",
1036           "desc" : "",
1037           "isOptional" : false
1038         }
1039       ],
1040       "returns" : []
1041     },
1042     {
1043       "name" : "destroy",
1044       "type" : "function",
1045       "desc" : "Fires after the component is destroyed.",
1046       "sig" : "function (_self)\n{\n\n}",
1047       "memberOf" : "Roo.Component",
1048       "example" : "",
1049       "deprecated" : "",
1050       "since" : "",
1051       "see" : "",
1052       "params" : [
1053         {
1054           "name" : "this",
1055           "type" : "Roo.Component",
1056           "desc" : "",
1057           "isOptional" : false
1058         }
1059       ],
1060       "returns" : []
1061     },
1062     {
1063       "name" : "hide",
1064       "type" : "function",
1065       "desc" : "Fires after the component is hidden.",
1066       "sig" : "function (_self)\n{\n\n}",
1067       "memberOf" : "Roo.Component",
1068       "example" : "",
1069       "deprecated" : "",
1070       "since" : "",
1071       "see" : "",
1072       "params" : [
1073         {
1074           "name" : "this",
1075           "type" : "Roo.Component",
1076           "desc" : "",
1077           "isOptional" : false
1078         }
1079       ],
1080       "returns" : []
1081     },
1082     {
1083       "name" : "beforehide",
1084       "type" : "function",
1085       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1086       "sig" : "function (_self)\n{\n\n}",
1087       "memberOf" : "Roo.Component",
1088       "example" : "",
1089       "deprecated" : "",
1090       "since" : "",
1091       "see" : "",
1092       "params" : [
1093         {
1094           "name" : "this",
1095           "type" : "Roo.Component",
1096           "desc" : "",
1097           "isOptional" : false
1098         }
1099       ],
1100       "returns" : []
1101     },
1102     {
1103       "name" : "show",
1104       "type" : "function",
1105       "desc" : "Fires after the component is shown.",
1106       "sig" : "function (_self)\n{\n\n}",
1107       "memberOf" : "Roo.Component",
1108       "example" : "",
1109       "deprecated" : "",
1110       "since" : "",
1111       "see" : "",
1112       "params" : [
1113         {
1114           "name" : "this",
1115           "type" : "Roo.Component",
1116           "desc" : "",
1117           "isOptional" : false
1118         }
1119       ],
1120       "returns" : []
1121     },
1122     {
1123       "name" : "beforeshow",
1124       "type" : "function",
1125       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1126       "sig" : "function (_self)\n{\n\n}",
1127       "memberOf" : "Roo.Component",
1128       "example" : "",
1129       "deprecated" : "",
1130       "since" : "",
1131       "see" : "",
1132       "params" : [
1133         {
1134           "name" : "this",
1135           "type" : "Roo.Component",
1136           "desc" : "",
1137           "isOptional" : false
1138         }
1139       ],
1140       "returns" : []
1141     },
1142     {
1143       "name" : "enable",
1144       "type" : "function",
1145       "desc" : "Fires after the component is enabled.",
1146       "sig" : "function (_self)\n{\n\n}",
1147       "memberOf" : "Roo.Component",
1148       "example" : "",
1149       "deprecated" : "",
1150       "since" : "",
1151       "see" : "",
1152       "params" : [
1153         {
1154           "name" : "this",
1155           "type" : "Roo.Component",
1156           "desc" : "",
1157           "isOptional" : false
1158         }
1159       ],
1160       "returns" : []
1161     },
1162     {
1163       "name" : "beforedestroy",
1164       "type" : "function",
1165       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1166       "sig" : "function (_self)\n{\n\n}",
1167       "memberOf" : "Roo.Component",
1168       "example" : "",
1169       "deprecated" : "",
1170       "since" : "",
1171       "see" : "",
1172       "params" : [
1173         {
1174           "name" : "this",
1175           "type" : "Roo.Component",
1176           "desc" : "",
1177           "isOptional" : false
1178         }
1179       ],
1180       "returns" : []
1181     }
1182   ]
1183 }