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