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