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