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