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