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