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

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