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

   1 {
   2   "name" : "Roo.bootstrap.Button",
   3   "augments" : [
   4     "Roo.bootstrap.Component",
   5     "Roo.Component",
   6     "Roo.util.Observable"
   7   ],
   8   "childClasses" : [
   9     "Roo.bootstrap.CardUploader",
  10     "Roo.bootstrap.ButtonUploader"
  11   ],
  12   "desc" : "Bootstrap Button class",
  13   "isSingleton" : false,
  14   "isStatic" : false,
  15   "isBuiltin" : false,
  16   "memberOf" : "Button",
  17   "example" : "",
  18   "deprecated" : "",
  19   "since" : "",
  20   "see" : "",
  21   "params" : [
  22     {
  23       "name" : "config",
  24       "type" : "Object",
  25       "desc" : "The config object",
  26       "isOptional" : false
  27     }
  28   ],
  29   "returns" : [],
  30   "throws" : "",
  31   "requires" : "",
  32   "config" : [
  33     {
  34       "name" : "toggle",
  35       "type" : "Boolean",
  36       "desc" : "is it a slidy toggle button",
  37       "memberOf" : ""
  38     },
  39     {
  40       "name" : "inverse",
  41       "type" : "Boolean",
  42       "desc" : "dark themed version",
  43       "memberOf" : ""
  44     },
  45     {
  46       "name" : "badge",
  47       "type" : "String",
  48       "desc" : "text for badge",
  49       "memberOf" : ""
  50     },
  51     {
  52       "name" : "hideMode",
  53       "type" : "String",
  54       "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\".",
  55       "memberOf" : "Roo.Component"
  56     },
  57     {
  58       "name" : "xattr",
  59       "type" : "Object",
  60       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
  61       "memberOf" : "Roo.bootstrap.Component"
  62     },
  63     {
  64       "name" : "disabled",
  65       "type" : "Boolean",
  66       "desc" : "default false;",
  67       "memberOf" : ""
  68     },
  69     {
  70       "name" : "name",
  71       "type" : "string",
  72       "desc" : "Specifies name attribute",
  73       "memberOf" : "Roo.bootstrap.Component"
  74     },
  75     {
  76       "name" : "weight",
  77       "type" : "String",
  78       "desc" : "k) default",
  79       "memberOf" : ""
  80     },
  81     {
  82       "name" : "grpup",
  83       "type" : "Boolean",
  84       "desc" : "if parent is a btn group - then it turns it into a toogleGroup.",
  85       "memberOf" : ""
  86     },
  87     {
  88       "name" : "tooltip",
  89       "type" : "string",
  90       "desc" : "Text for the tooltip",
  91       "memberOf" : "Roo.bootstrap.Component"
  92     },
  93     {
  94       "name" : "ontext",
  95       "type" : "String",
  96       "desc" : "text for on slidy toggle state",
  97       "memberOf" : ""
  98     },
  99     {
 100       "name" : "preventDefault",
 101       "type" : "Boolean",
 102       "desc" : "default true (stop click event triggering the URL if it's a link.)",
 103       "memberOf" : ""
 104     },
 105     {
 106       "name" : "theme",
 107       "type" : "String",
 108       "desc" : "w)",
 109       "memberOf" : ""
 110     },
 111     {
 112       "name" : "target",
 113       "type" : "String",
 114       "desc" : "r) target for a href.",
 115       "memberOf" : ""
 116     },
 117     {
 118       "name" : "glyphicon",
 119       "type" : "String",
 120       "desc" : "depricated - use fa",
 121       "memberOf" : ""
 122     },
 123     {
 124       "name" : "allowDomMove",
 125       "type" : "Boolean",
 126       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 127       "memberOf" : "Roo.Component"
 128     },
 129     {
 130       "name" : "style",
 131       "type" : "String",
 132       "desc" : "any extra css",
 133       "memberOf" : "Roo.bootstrap.Component"
 134     },
 135     {
 136       "name" : "isClose",
 137       "type" : "Boolean",
 138       "desc" : "default false;",
 139       "memberOf" : ""
 140     },
 141     {
 142       "name" : "actionMode",
 143       "type" : "String",
 144       "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",
 145       "memberOf" : "Roo.Component"
 146     },
 147     {
 148       "name" : "listeners",
 149       "type" : "Object",
 150       "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>",
 151       "memberOf" : "Roo.util.Observable"
 152     },
 153     {
 154       "name" : "container_method",
 155       "type" : "string",
 156       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
 157       "memberOf" : "Roo.bootstrap.Component"
 158     },
 159     {
 160       "name" : "fa",
 161       "type" : "String",
 162       "desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..",
 163       "memberOf" : ""
 164     },
 165     {
 166       "name" : "size",
 167       "type" : "String",
 168       "desc" : "s)",
 169       "memberOf" : ""
 170     },
 171     {
 172       "name" : "cls",
 173       "type" : "String",
 174       "desc" : "css class",
 175       "memberOf" : "Roo.bootstrap.Component"
 176     },
 177     {
 178       "name" : "badge_weight",
 179       "type" : "String",
 180       "desc" : "k) default (same as button)",
 181       "memberOf" : ""
 182     },
 183     {
 184       "name" : "can_build_overlaid",
 185       "type" : "Boolean",
 186       "desc" : "True if element can be rebuild from a HTML page",
 187       "memberOf" : "Roo.bootstrap.Component"
 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     },
 195     {
 196       "name" : "visibilityEl",
 197       "type" : "string|object",
 198       "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
 199       "memberOf" : "Roo.bootstrap.Component"
 200     },
 201     {
 202       "name" : "href",
 203       "type" : "String",
 204       "desc" : "empty or href",
 205       "memberOf" : ""
 206     },
 207     {
 208       "name" : "tag",
 209       "type" : "String",
 210       "desc" : "t)",
 211       "memberOf" : ""
 212     },
 213     {
 214       "name" : "dataId",
 215       "type" : "string",
 216       "desc" : "cutomer id",
 217       "memberOf" : "Roo.bootstrap.Component"
 218     },
 219     {
 220       "name" : "outline",
 221       "type" : "Boolean",
 222       "desc" : "default false (except for weight=default which emulates old behaveiour with an outline)",
 223       "memberOf" : ""
 224     },
 225     {
 226       "name" : "offtext",
 227       "type" : "String",
 228       "desc" : "text for off slidy toggle state",
 229       "memberOf" : ""
 230     },
 231     {
 232       "name" : "removeClass",
 233       "type" : "Boolean",
 234       "desc" : "remove the standard class..",
 235       "memberOf" : ""
 236     },
 237     {
 238       "name" : "html",
 239       "type" : "String",
 240       "desc" : "The button content",
 241       "memberOf" : ""
 242     },
 243     {
 244       "name" : "pressed",
 245       "type" : "Boolean",
 246       "desc" : "default null - if the button ahs active state",
 247       "memberOf" : ""
 248     },
 249     {
 250       "name" : "menu",
 251       "type" : "Roo.bootstrap.menu.Menu",
 252       "desc" : "a Menu",
 253       "memberOf" : ""
 254     }
 255   ],
 256   "methods" : [
 257     {
 258       "name" : "setText",
 259       "type" : "function",
 260       "desc" : "set the text of the first selected button",
 261       "sig" : "()\n{\n\n}",
 262       "static" : false,
 263       "memberOf" : "",
 264       "isStatic" : false,
 265       "isConstructor" : false,
 266       "isPrivate" : false,
 267       "example" : "",
 268       "deprecated" : "",
 269       "since" : "",
 270       "see" : "",
 271       "exceptions" : "",
 272       "requires" : "",
 273       "params" : [],
 274       "returns" : []
 275     },
 276     {
 277       "name" : "isActive",
 278       "type" : "function",
 279       "desc" : "get the current active state",
 280       "sig" : "()\n{\n\n}",
 281       "static" : false,
 282       "memberOf" : "",
 283       "isStatic" : false,
 284       "isConstructor" : false,
 285       "isPrivate" : false,
 286       "example" : "",
 287       "deprecated" : "",
 288       "since" : "",
 289       "see" : "",
 290       "exceptions" : "",
 291       "requires" : "",
 292       "params" : [],
 293       "returns" : [
 294         {
 295           "name" : "",
 296           "type" : "boolean",
 297           "desc" : "true if it's active"
 298         }
 299       ]
 300     },
 301     {
 302       "name" : "setActive",
 303       "type" : "function",
 304       "desc" : "sets the active state on/off,",
 305       "sig" : "(state)",
 306       "static" : false,
 307       "memberOf" : "",
 308       "isStatic" : false,
 309       "isConstructor" : false,
 310       "isPrivate" : false,
 311       "example" : "",
 312       "deprecated" : "",
 313       "since" : "",
 314       "see" : "",
 315       "exceptions" : "",
 316       "requires" : "",
 317       "params" : [
 318         {
 319           "name" : "state",
 320           "type" : "Boolean",
 321           "desc" : "(optional) Force a particular state",
 322           "isOptional" : false
 323         }
 324       ],
 325       "returns" : []
 326     },
 327     {
 328       "name" : "toggleActive",
 329       "type" : "function",
 330       "desc" : "toggles the current active state",
 331       "sig" : "()\n{\n\n}",
 332       "static" : false,
 333       "memberOf" : "",
 334       "isStatic" : false,
 335       "isConstructor" : false,
 336       "isPrivate" : false,
 337       "example" : "",
 338       "deprecated" : "",
 339       "since" : "",
 340       "see" : "",
 341       "exceptions" : "",
 342       "requires" : "",
 343       "params" : [],
 344       "returns" : []
 345     },
 346     {
 347       "name" : "getText",
 348       "type" : "function",
 349       "desc" : "get the text of the first selected button",
 350       "sig" : "()\n{\n\n}",
 351       "static" : false,
 352       "memberOf" : "",
 353       "isStatic" : false,
 354       "isConstructor" : false,
 355       "isPrivate" : false,
 356       "example" : "",
 357       "deprecated" : "",
 358       "since" : "",
 359       "see" : "",
 360       "exceptions" : "",
 361       "requires" : "",
 362       "params" : [],
 363       "returns" : []
 364     },
 365     {
 366       "name" : "enable",
 367       "type" : "function",
 368       "desc" : "Enables this button",
 369       "sig" : "()\n{\n\n}",
 370       "static" : false,
 371       "memberOf" : "",
 372       "isStatic" : false,
 373       "isConstructor" : false,
 374       "isPrivate" : false,
 375       "example" : "",
 376       "deprecated" : "",
 377       "since" : "",
 378       "see" : "",
 379       "exceptions" : "",
 380       "requires" : "",
 381       "params" : [],
 382       "returns" : []
 383     },
 384     {
 385       "name" : "disable",
 386       "type" : "function",
 387       "desc" : "Disable this button",
 388       "sig" : "()\n{\n\n}",
 389       "static" : false,
 390       "memberOf" : "",
 391       "isStatic" : false,
 392       "isConstructor" : false,
 393       "isPrivate" : false,
 394       "example" : "",
 395       "deprecated" : "",
 396       "since" : "",
 397       "see" : "",
 398       "exceptions" : "",
 399       "requires" : "",
 400       "params" : [],
 401       "returns" : []
 402     },
 403     {
 404       "name" : "tooltipEl",
 405       "type" : "function",
 406       "desc" : "Fetch the element to display the tooltip on.",
 407       "sig" : "()\n{\n\n}",
 408       "static" : false,
 409       "memberOf" : "Roo.bootstrap.Component",
 410       "isStatic" : false,
 411       "isConstructor" : false,
 412       "isPrivate" : false,
 413       "example" : "",
 414       "deprecated" : "",
 415       "since" : "",
 416       "see" : "",
 417       "exceptions" : "",
 418       "requires" : "",
 419       "params" : [],
 420       "returns" : [
 421         {
 422           "name" : "",
 423           "type" : "Roo.Element",
 424           "desc" : "defaults to this.el"
 425         }
 426       ]
 427     },
 428     {
 429       "name" : "hide",
 430       "type" : "function",
 431       "desc" : "Hide a component - adds 'hidden' class",
 432       "sig" : "()\n{\n\n}",
 433       "static" : false,
 434       "memberOf" : "Roo.bootstrap.Component",
 435       "isStatic" : false,
 436       "isConstructor" : false,
 437       "isPrivate" : false,
 438       "example" : "",
 439       "deprecated" : "",
 440       "since" : "",
 441       "see" : "",
 442       "exceptions" : "",
 443       "requires" : "",
 444       "params" : [],
 445       "returns" : []
 446     },
 447     {
 448       "name" : "show",
 449       "type" : "function",
 450       "desc" : "Show a component - removes 'hidden' class",
 451       "sig" : "()\n{\n\n}",
 452       "static" : false,
 453       "memberOf" : "Roo.bootstrap.Component",
 454       "isStatic" : false,
 455       "isConstructor" : false,
 456       "isPrivate" : false,
 457       "example" : "",
 458       "deprecated" : "",
 459       "since" : "",
 460       "see" : "",
 461       "exceptions" : "",
 462       "requires" : "",
 463       "params" : [],
 464       "returns" : []
 465     },
 466     {
 467       "name" : "setVisibilityEl",
 468       "type" : "function",
 469       "desc" : "Set the element that will be used to show or hide",
 470       "sig" : "()\n{\n\n}",
 471       "static" : false,
 472       "memberOf" : "Roo.bootstrap.Component",
 473       "isStatic" : false,
 474       "isConstructor" : false,
 475       "isPrivate" : false,
 476       "example" : "",
 477       "deprecated" : "",
 478       "since" : "",
 479       "see" : "",
 480       "exceptions" : "",
 481       "requires" : "",
 482       "params" : [],
 483       "returns" : []
 484     },
 485     {
 486       "name" : "getVisibilityEl",
 487       "type" : "function",
 488       "desc" : "Get the element that will be used to show or hide",
 489       "sig" : "()\n{\n\n}",
 490       "static" : false,
 491       "memberOf" : "Roo.bootstrap.Component",
 492       "isStatic" : false,
 493       "isConstructor" : false,
 494       "isPrivate" : false,
 495       "example" : "",
 496       "deprecated" : "",
 497       "since" : "",
 498       "see" : "",
 499       "exceptions" : "",
 500       "requires" : "",
 501       "params" : [],
 502       "returns" : []
 503     },
 504     {
 505       "name" : "initEvents",
 506       "type" : "function",
 507       "desc" : "Initialize Events for the element",
 508       "sig" : "()\n{\n\n}",
 509       "static" : false,
 510       "memberOf" : "Roo.bootstrap.Component",
 511       "isStatic" : false,
 512       "isConstructor" : false,
 513       "isPrivate" : false,
 514       "example" : "",
 515       "deprecated" : "",
 516       "since" : "",
 517       "see" : "",
 518       "exceptions" : "",
 519       "requires" : "",
 520       "params" : [],
 521       "returns" : []
 522     },
 523     {
 524       "name" : "getChildContainer",
 525       "type" : "function",
 526       "desc" : "Fetch the element to add children to",
 527       "sig" : "()\n{\n\n}",
 528       "static" : false,
 529       "memberOf" : "Roo.bootstrap.Component",
 530       "isStatic" : false,
 531       "isConstructor" : false,
 532       "isPrivate" : false,
 533       "example" : "",
 534       "deprecated" : "",
 535       "since" : "",
 536       "see" : "",
 537       "exceptions" : "",
 538       "requires" : "",
 539       "params" : [],
 540       "returns" : [
 541         {
 542           "name" : "",
 543           "type" : "Roo.Element",
 544           "desc" : "defaults to this.el"
 545         }
 546       ]
 547     },
 548     {
 549       "name" : "getId",
 550       "type" : "function",
 551       "desc" : "Returns the id of this component.",
 552       "sig" : "()\n{\n\n}",
 553       "static" : false,
 554       "memberOf" : "Roo.Component",
 555       "isStatic" : false,
 556       "isConstructor" : false,
 557       "isPrivate" : false,
 558       "example" : "",
 559       "deprecated" : "",
 560       "since" : "",
 561       "see" : "",
 562       "exceptions" : "",
 563       "requires" : "",
 564       "params" : [],
 565       "returns" : [
 566         {
 567           "name" : "",
 568           "type" : "String",
 569           "desc" : ""
 570         }
 571       ]
 572     },
 573     {
 574       "name" : "render",
 575       "type" : "function",
 576       "desc" : "If this is a lazy rendering component, render it to its container element.",
 577       "sig" : "(container)",
 578       "static" : false,
 579       "memberOf" : "Roo.Component",
 580       "isStatic" : false,
 581       "isConstructor" : false,
 582       "isPrivate" : false,
 583       "example" : "",
 584       "deprecated" : "",
 585       "since" : "",
 586       "see" : "",
 587       "exceptions" : "",
 588       "requires" : "",
 589       "params" : [
 590         {
 591           "name" : "container",
 592           "type" : "String/HTMLElement/Element",
 593           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 594           "isOptional" : false
 595         }
 596       ],
 597       "returns" : []
 598     },
 599     {
 600       "name" : "destroy",
 601       "type" : "function",
 602       "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}.",
 603       "sig" : "()\n{\n\n}",
 604       "static" : false,
 605       "memberOf" : "Roo.Component",
 606       "isStatic" : false,
 607       "isConstructor" : false,
 608       "isPrivate" : false,
 609       "example" : "",
 610       "deprecated" : "",
 611       "since" : "",
 612       "see" : "",
 613       "exceptions" : "",
 614       "requires" : "",
 615       "params" : [],
 616       "returns" : []
 617     },
 618     {
 619       "name" : "isVisible",
 620       "type" : "function",
 621       "desc" : "Returns true if this component is visible.",
 622       "sig" : "()\n{\n\n}",
 623       "static" : false,
 624       "memberOf" : "Roo.Component",
 625       "isStatic" : false,
 626       "isConstructor" : false,
 627       "isPrivate" : false,
 628       "example" : "",
 629       "deprecated" : "",
 630       "since" : "",
 631       "see" : "",
 632       "exceptions" : "",
 633       "requires" : "",
 634       "params" : [],
 635       "returns" : []
 636     },
 637     {
 638       "name" : "setDisabled",
 639       "type" : "function",
 640       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 641       "sig" : "(disabled)",
 642       "static" : false,
 643       "memberOf" : "Roo.Component",
 644       "isStatic" : false,
 645       "isConstructor" : false,
 646       "isPrivate" : false,
 647       "example" : "",
 648       "deprecated" : "",
 649       "since" : "",
 650       "see" : "",
 651       "exceptions" : "",
 652       "requires" : "",
 653       "params" : [
 654         {
 655           "name" : "disabled",
 656           "type" : "Boolean",
 657           "desc" : "",
 658           "isOptional" : false
 659         }
 660       ],
 661       "returns" : []
 662     },
 663     {
 664       "name" : "focus",
 665       "type" : "function",
 666       "desc" : "Try to focus this component.",
 667       "sig" : "(selectText)",
 668       "static" : false,
 669       "memberOf" : "Roo.Component",
 670       "isStatic" : false,
 671       "isConstructor" : false,
 672       "isPrivate" : false,
 673       "example" : "",
 674       "deprecated" : "",
 675       "since" : "",
 676       "see" : "",
 677       "exceptions" : "",
 678       "requires" : "",
 679       "params" : [
 680         {
 681           "name" : "selectText",
 682           "type" : "Boolean",
 683           "desc" : "True to also select the text in this component (if applicable)",
 684           "isOptional" : false
 685         }
 686       ],
 687       "returns" : [
 688         {
 689           "name" : "",
 690           "type" : "Roo.Component",
 691           "desc" : "this"
 692         }
 693       ]
 694     },
 695     {
 696       "name" : "setVisible",
 697       "type" : "function",
 698       "desc" : "Convenience function to hide or show this component by boolean.",
 699       "sig" : "(visible)",
 700       "static" : false,
 701       "memberOf" : "Roo.Component",
 702       "isStatic" : false,
 703       "isConstructor" : false,
 704       "isPrivate" : false,
 705       "example" : "",
 706       "deprecated" : "",
 707       "since" : "",
 708       "see" : "",
 709       "exceptions" : "",
 710       "requires" : "",
 711       "params" : [
 712         {
 713           "name" : "visible",
 714           "type" : "Boolean",
 715           "desc" : "True to show, false to hide",
 716           "isOptional" : false
 717         }
 718       ],
 719       "returns" : [
 720         {
 721           "name" : "",
 722           "type" : "Roo.Component",
 723           "desc" : "this"
 724         }
 725       ]
 726     },
 727     {
 728       "name" : "getEl",
 729       "type" : "function",
 730       "desc" : "Returns the underlying {@link Roo.Element}.",
 731       "sig" : "()\n{\n\n}",
 732       "static" : false,
 733       "memberOf" : "Roo.Component",
 734       "isStatic" : false,
 735       "isConstructor" : false,
 736       "isPrivate" : false,
 737       "example" : "",
 738       "deprecated" : "",
 739       "since" : "",
 740       "see" : "",
 741       "exceptions" : "",
 742       "requires" : "",
 743       "params" : [],
 744       "returns" : [
 745         {
 746           "name" : "",
 747           "type" : "Roo.Element",
 748           "desc" : "The element"
 749         }
 750       ]
 751     },
 752     {
 753       "name" : "purgeListeners",
 754       "type" : "function",
 755       "desc" : "Removes all listeners for this object",
 756       "sig" : "()\n{\n\n}",
 757       "static" : false,
 758       "memberOf" : "Roo.util.Observable",
 759       "isStatic" : false,
 760       "isConstructor" : false,
 761       "isPrivate" : false,
 762       "example" : "",
 763       "deprecated" : "",
 764       "since" : "",
 765       "see" : "",
 766       "exceptions" : "",
 767       "requires" : "",
 768       "params" : [],
 769       "returns" : []
 770     },
 771     {
 772       "name" : "on",
 773       "type" : "function",
 774       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 775       "sig" : "(eventName, handler, scope, options)",
 776       "static" : false,
 777       "memberOf" : "Roo.util.Observable",
 778       "isStatic" : false,
 779       "isConstructor" : false,
 780       "isPrivate" : false,
 781       "example" : "",
 782       "deprecated" : "",
 783       "since" : "",
 784       "see" : "",
 785       "exceptions" : "",
 786       "requires" : "",
 787       "params" : [
 788         {
 789           "name" : "eventName",
 790           "type" : "String",
 791           "desc" : "The type of event to listen for",
 792           "isOptional" : false
 793         },
 794         {
 795           "name" : "handler",
 796           "type" : "Function",
 797           "desc" : "The method the event invokes",
 798           "isOptional" : false
 799         },
 800         {
 801           "name" : "scope",
 802           "type" : "Object",
 803           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 804           "isOptional" : false
 805         },
 806         {
 807           "name" : "options",
 808           "type" : "Object",
 809           "desc" : "(optional)",
 810           "isOptional" : false
 811         }
 812       ],
 813       "returns" : []
 814     },
 815     {
 816       "name" : "un",
 817       "type" : "function",
 818       "desc" : "Removes a listener (shorthand for removeListener)",
 819       "sig" : "(eventName, handler, scope)",
 820       "static" : false,
 821       "memberOf" : "Roo.util.Observable",
 822       "isStatic" : false,
 823       "isConstructor" : false,
 824       "isPrivate" : false,
 825       "example" : "",
 826       "deprecated" : "",
 827       "since" : "",
 828       "see" : "",
 829       "exceptions" : "",
 830       "requires" : "",
 831       "params" : [
 832         {
 833           "name" : "eventName",
 834           "type" : "String",
 835           "desc" : "The type of event to listen for",
 836           "isOptional" : false
 837         },
 838         {
 839           "name" : "handler",
 840           "type" : "Function",
 841           "desc" : "The handler to remove",
 842           "isOptional" : false
 843         },
 844         {
 845           "name" : "scope",
 846           "type" : "Object",
 847           "desc" : "(optional) The scope (this object) for the handler",
 848           "isOptional" : false
 849         }
 850       ],
 851       "returns" : []
 852     },
 853     {
 854       "name" : "addEvents",
 855       "type" : "function",
 856       "desc" : "Used to define events on this Observable",
 857       "sig" : "(object)",
 858       "static" : false,
 859       "memberOf" : "Roo.util.Observable",
 860       "isStatic" : false,
 861       "isConstructor" : false,
 862       "isPrivate" : false,
 863       "example" : "",
 864       "deprecated" : "",
 865       "since" : "",
 866       "see" : "",
 867       "exceptions" : "",
 868       "requires" : "",
 869       "params" : [
 870         {
 871           "name" : "object",
 872           "type" : "Object",
 873           "desc" : "The object with the events defined",
 874           "isOptional" : false
 875         }
 876       ],
 877       "returns" : []
 878     },
 879     {
 880       "name" : "releaseCapture",
 881       "type" : "function",
 882       "desc" : "Removes <b>all</b> added captures from the Observable.",
 883       "sig" : "(o)",
 884       "static" : true,
 885       "memberOf" : "Roo.util.Observable",
 886       "isStatic" : true,
 887       "isConstructor" : false,
 888       "isPrivate" : false,
 889       "example" : "",
 890       "deprecated" : "",
 891       "since" : "",
 892       "see" : "",
 893       "exceptions" : "",
 894       "requires" : "",
 895       "params" : [
 896         {
 897           "name" : "o",
 898           "type" : "Observable",
 899           "desc" : "The Observable to release",
 900           "isOptional" : false
 901         }
 902       ],
 903       "returns" : []
 904     },
 905     {
 906       "name" : "removeListener",
 907       "type" : "function",
 908       "desc" : "Removes a listener",
 909       "sig" : "(eventName, handler, scope)",
 910       "static" : false,
 911       "memberOf" : "Roo.util.Observable",
 912       "isStatic" : false,
 913       "isConstructor" : false,
 914       "isPrivate" : false,
 915       "example" : "",
 916       "deprecated" : "",
 917       "since" : "",
 918       "see" : "",
 919       "exceptions" : "",
 920       "requires" : "",
 921       "params" : [
 922         {
 923           "name" : "eventName",
 924           "type" : "String",
 925           "desc" : "The type of event to listen for",
 926           "isOptional" : false
 927         },
 928         {
 929           "name" : "handler",
 930           "type" : "Function",
 931           "desc" : "The handler to remove",
 932           "isOptional" : false
 933         },
 934         {
 935           "name" : "scope",
 936           "type" : "Object",
 937           "desc" : "(optional) The scope (this object) for the handler",
 938           "isOptional" : false
 939         }
 940       ],
 941       "returns" : []
 942     },
 943     {
 944       "name" : "fireEvent",
 945       "type" : "function",
 946       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 947       "sig" : "(eventName, args)",
 948       "static" : false,
 949       "memberOf" : "Roo.util.Observable",
 950       "isStatic" : false,
 951       "isConstructor" : false,
 952       "isPrivate" : false,
 953       "example" : "",
 954       "deprecated" : "",
 955       "since" : "",
 956       "see" : "",
 957       "exceptions" : "",
 958       "requires" : "",
 959       "params" : [
 960         {
 961           "name" : "eventName",
 962           "type" : "String",
 963           "desc" : "",
 964           "isOptional" : false
 965         },
 966         {
 967           "name" : "args",
 968           "type" : "Object...",
 969           "desc" : "Variable number of parameters are passed to handlers",
 970           "isOptional" : false
 971         }
 972       ],
 973       "returns" : [
 974         {
 975           "name" : "",
 976           "type" : "Boolean",
 977           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 978         }
 979       ]
 980     },
 981     {
 982       "name" : "hasListener",
 983       "type" : "function",
 984       "desc" : "Checks to see if this object has any listeners for a specified event",
 985       "sig" : "(eventName)",
 986       "static" : false,
 987       "memberOf" : "Roo.util.Observable",
 988       "isStatic" : false,
 989       "isConstructor" : false,
 990       "isPrivate" : false,
 991       "example" : "",
 992       "deprecated" : "",
 993       "since" : "",
 994       "see" : "",
 995       "exceptions" : "",
 996       "requires" : "",
 997       "params" : [
 998         {
 999           "name" : "eventName",
1000           "type" : "String",
1001           "desc" : "The name of the event to check for",
1002           "isOptional" : false
1003         }
1004       ],
1005       "returns" : [
1006         {
1007           "name" : "",
1008           "type" : "Boolean",
1009           "desc" : "True if the event is being listened for, else false"
1010         }
1011       ]
1012     },
1013     {
1014       "name" : "capture",
1015       "type" : "function",
1016       "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.",
1017       "sig" : "(o, fn, scope)",
1018       "static" : true,
1019       "memberOf" : "Roo.util.Observable",
1020       "isStatic" : true,
1021       "isConstructor" : false,
1022       "isPrivate" : false,
1023       "example" : "",
1024       "deprecated" : "",
1025       "since" : "",
1026       "see" : "",
1027       "exceptions" : "",
1028       "requires" : "",
1029       "params" : [
1030         {
1031           "name" : "o",
1032           "type" : "Observable",
1033           "desc" : "The Observable to capture",
1034           "isOptional" : false
1035         },
1036         {
1037           "name" : "fn",
1038           "type" : "Function",
1039           "desc" : "The function to call",
1040           "isOptional" : false
1041         },
1042         {
1043           "name" : "scope",
1044           "type" : "Object",
1045           "desc" : "(optional) The scope (this object) for the fn",
1046           "isOptional" : false
1047         }
1048       ],
1049       "returns" : []
1050     },
1051     {
1052       "name" : "addListener",
1053       "type" : "function",
1054       "desc" : "Appends an event handler to this component",
1055       "sig" : "(eventName, handler, scope, options)",
1056       "static" : false,
1057       "memberOf" : "Roo.util.Observable",
1058       "isStatic" : false,
1059       "isConstructor" : false,
1060       "isPrivate" : false,
1061       "example" : "",
1062       "deprecated" : "",
1063       "since" : "",
1064       "see" : "",
1065       "exceptions" : "",
1066       "requires" : "",
1067       "params" : [
1068         {
1069           "name" : "eventName",
1070           "type" : "String",
1071           "desc" : "The type of event to listen for",
1072           "isOptional" : false
1073         },
1074         {
1075           "name" : "handler",
1076           "type" : "Function",
1077           "desc" : "The method the event invokes",
1078           "isOptional" : false
1079         },
1080         {
1081           "name" : "scope",
1082           "type" : "Object",
1083           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1084           "isOptional" : false
1085         },
1086         {
1087           "name" : "options",
1088           "type" : "Object",
1089           "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>",
1090           "isOptional" : false
1091         }
1092       ],
1093       "returns" : []
1094     }
1095   ],
1096   "events" : [
1097     {
1098       "name" : "toggle",
1099       "type" : "function",
1100       "desc" : "After the button has been toggles",
1101       "sig" : "function (btn, e, pressed)\n{\n\n}",
1102       "memberOf" : "",
1103       "example" : "",
1104       "deprecated" : "",
1105       "since" : "",
1106       "see" : "",
1107       "params" : [
1108         {
1109           "name" : "btn",
1110           "type" : "Roo.bootstrap.Button",
1111           "desc" : "",
1112           "isOptional" : false
1113         },
1114         {
1115           "name" : "e",
1116           "type" : "Roo.EventObject",
1117           "desc" : "",
1118           "isOptional" : false
1119         },
1120         {
1121           "name" : "pressed",
1122           "type" : "boolean",
1123           "desc" : "(also available as button.pressed)",
1124           "isOptional" : false
1125         }
1126       ],
1127       "returns" : []
1128     },
1129     {
1130       "name" : "dblclick",
1131       "type" : "function",
1132       "desc" : "When a button is double clicked",
1133       "sig" : "function (btn, e)\n{\n\n}",
1134       "memberOf" : "",
1135       "example" : "",
1136       "deprecated" : "",
1137       "since" : "",
1138       "see" : "",
1139       "params" : [
1140         {
1141           "name" : "btn",
1142           "type" : "Roo.bootstrap.Button",
1143           "desc" : "",
1144           "isOptional" : false
1145         },
1146         {
1147           "name" : "e",
1148           "type" : "Roo.EventObject",
1149           "desc" : "",
1150           "isOptional" : false
1151         }
1152       ],
1153       "returns" : []
1154     },
1155     {
1156       "name" : "click",
1157       "type" : "function",
1158       "desc" : "When a button is pressed",
1159       "sig" : "function (btn, e)\n{\n\n}",
1160       "memberOf" : "",
1161       "example" : "",
1162       "deprecated" : "",
1163       "since" : "",
1164       "see" : "",
1165       "params" : [
1166         {
1167           "name" : "btn",
1168           "type" : "Roo.bootstrap.Button",
1169           "desc" : "",
1170           "isOptional" : false
1171         },
1172         {
1173           "name" : "e",
1174           "type" : "Roo.EventObject",
1175           "desc" : "",
1176           "isOptional" : false
1177         }
1178       ],
1179       "returns" : []
1180     },
1181     {
1182       "name" : "childrenrendered",
1183       "type" : "function",
1184       "desc" : "Fires when the children have been rendered..",
1185       "sig" : "function (_self)\n{\n\n}",
1186       "memberOf" : "Roo.bootstrap.Component",
1187       "example" : "",
1188       "deprecated" : "",
1189       "since" : "",
1190       "see" : "",
1191       "params" : [
1192         {
1193           "name" : "this",
1194           "type" : "Roo.bootstrap.Component",
1195           "desc" : "",
1196           "isOptional" : false
1197         }
1198       ],
1199       "returns" : []
1200     },
1201     {
1202       "name" : "beforerender",
1203       "type" : "function",
1204       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1205       "sig" : "function (_self)\n{\n\n}",
1206       "memberOf" : "Roo.Component",
1207       "example" : "",
1208       "deprecated" : "",
1209       "since" : "",
1210       "see" : "",
1211       "params" : [
1212         {
1213           "name" : "this",
1214           "type" : "Roo.Component",
1215           "desc" : "",
1216           "isOptional" : false
1217         }
1218       ],
1219       "returns" : []
1220     },
1221     {
1222       "name" : "disable",
1223       "type" : "function",
1224       "desc" : "Fires after the component is disabled.",
1225       "sig" : "function (_self)\n{\n\n}",
1226       "memberOf" : "Roo.Component",
1227       "example" : "",
1228       "deprecated" : "",
1229       "since" : "",
1230       "see" : "",
1231       "params" : [
1232         {
1233           "name" : "this",
1234           "type" : "Roo.Component",
1235           "desc" : "",
1236           "isOptional" : false
1237         }
1238       ],
1239       "returns" : []
1240     },
1241     {
1242       "name" : "render",
1243       "type" : "function",
1244       "desc" : "Fires after the component is rendered.",
1245       "sig" : "function (_self)\n{\n\n}",
1246       "memberOf" : "Roo.Component",
1247       "example" : "",
1248       "deprecated" : "",
1249       "since" : "",
1250       "see" : "",
1251       "params" : [
1252         {
1253           "name" : "this",
1254           "type" : "Roo.Component",
1255           "desc" : "",
1256           "isOptional" : false
1257         }
1258       ],
1259       "returns" : []
1260     },
1261     {
1262       "name" : "destroy",
1263       "type" : "function",
1264       "desc" : "Fires after the component is destroyed.",
1265       "sig" : "function (_self)\n{\n\n}",
1266       "memberOf" : "Roo.Component",
1267       "example" : "",
1268       "deprecated" : "",
1269       "since" : "",
1270       "see" : "",
1271       "params" : [
1272         {
1273           "name" : "this",
1274           "type" : "Roo.Component",
1275           "desc" : "",
1276           "isOptional" : false
1277         }
1278       ],
1279       "returns" : []
1280     },
1281     {
1282       "name" : "hide",
1283       "type" : "function",
1284       "desc" : "Fires after the component is hidden.",
1285       "sig" : "function (_self)\n{\n\n}",
1286       "memberOf" : "Roo.Component",
1287       "example" : "",
1288       "deprecated" : "",
1289       "since" : "",
1290       "see" : "",
1291       "params" : [
1292         {
1293           "name" : "this",
1294           "type" : "Roo.Component",
1295           "desc" : "",
1296           "isOptional" : false
1297         }
1298       ],
1299       "returns" : []
1300     },
1301     {
1302       "name" : "beforehide",
1303       "type" : "function",
1304       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1305       "sig" : "function (_self)\n{\n\n}",
1306       "memberOf" : "Roo.Component",
1307       "example" : "",
1308       "deprecated" : "",
1309       "since" : "",
1310       "see" : "",
1311       "params" : [
1312         {
1313           "name" : "this",
1314           "type" : "Roo.Component",
1315           "desc" : "",
1316           "isOptional" : false
1317         }
1318       ],
1319       "returns" : []
1320     },
1321     {
1322       "name" : "show",
1323       "type" : "function",
1324       "desc" : "Fires after the component is shown.",
1325       "sig" : "function (_self)\n{\n\n}",
1326       "memberOf" : "Roo.Component",
1327       "example" : "",
1328       "deprecated" : "",
1329       "since" : "",
1330       "see" : "",
1331       "params" : [
1332         {
1333           "name" : "this",
1334           "type" : "Roo.Component",
1335           "desc" : "",
1336           "isOptional" : false
1337         }
1338       ],
1339       "returns" : []
1340     },
1341     {
1342       "name" : "beforeshow",
1343       "type" : "function",
1344       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1345       "sig" : "function (_self)\n{\n\n}",
1346       "memberOf" : "Roo.Component",
1347       "example" : "",
1348       "deprecated" : "",
1349       "since" : "",
1350       "see" : "",
1351       "params" : [
1352         {
1353           "name" : "this",
1354           "type" : "Roo.Component",
1355           "desc" : "",
1356           "isOptional" : false
1357         }
1358       ],
1359       "returns" : []
1360     },
1361     {
1362       "name" : "enable",
1363       "type" : "function",
1364       "desc" : "Fires after the component is enabled.",
1365       "sig" : "function (_self)\n{\n\n}",
1366       "memberOf" : "Roo.Component",
1367       "example" : "",
1368       "deprecated" : "",
1369       "since" : "",
1370       "see" : "",
1371       "params" : [
1372         {
1373           "name" : "this",
1374           "type" : "Roo.Component",
1375           "desc" : "",
1376           "isOptional" : false
1377         }
1378       ],
1379       "returns" : []
1380     },
1381     {
1382       "name" : "beforedestroy",
1383       "type" : "function",
1384       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1385       "sig" : "function (_self)\n{\n\n}",
1386       "memberOf" : "Roo.Component",
1387       "example" : "",
1388       "deprecated" : "",
1389       "since" : "",
1390       "see" : "",
1391       "params" : [
1392         {
1393           "name" : "this",
1394           "type" : "Roo.Component",
1395           "desc" : "",
1396           "isOptional" : false
1397         }
1398       ],
1399       "returns" : []
1400     }
1401   ]
1402 }