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