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' for forms you probably want to set this to fieldEl",
 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" : "initEvents",
 550       "desc" : "Initialize Events for the element",
 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" : "getChildContainer",
 566       "desc" : "Fetch the element to add children to",
 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           "name" : "",
 580           "type" : "Roo.Element",
 581           "desc" : "defaults to this.el"
 582         }
 583       ]
 584     },
 585     {
 586       "name" : "getId",
 587       "desc" : "Returns the id of this component.",
 588       "isStatic" : false,
 589       "isConstructor" : false,
 590       "isPrivate" : false,
 591       "memberOf" : "Roo.Component",
 592       "example" : "",
 593       "deprecated" : "",
 594       "since" : "",
 595       "see" : "",
 596       "params" : [
 597       ],
 598       "returns" : [
 599         {
 600           "name" : "",
 601           "type" : "String",
 602           "desc" : ""
 603         }
 604       ]
 605     },
 606     {
 607       "name" : "render",
 608       "desc" : "If this is a lazy rendering component, render it to its container element.",
 609       "isStatic" : false,
 610       "isConstructor" : false,
 611       "isPrivate" : false,
 612       "memberOf" : "Roo.Component",
 613       "example" : "",
 614       "deprecated" : "",
 615       "since" : "",
 616       "see" : "",
 617       "params" : [
 618         {
 619           "name" : "container",
 620           "type" : "String/HTMLElement/Element",
 621           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 622           "isOptional" : false
 623         }
 624       ],
 625       "returns" : [
 626       ]
 627     },
 628     {
 629       "name" : "destroy",
 630       "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}.",
 631       "isStatic" : false,
 632       "isConstructor" : false,
 633       "isPrivate" : false,
 634       "memberOf" : "Roo.Component",
 635       "example" : "",
 636       "deprecated" : "",
 637       "since" : "",
 638       "see" : "",
 639       "params" : [
 640       ],
 641       "returns" : [
 642       ]
 643     },
 644     {
 645       "name" : "isVisible",
 646       "desc" : "Returns true if this component is visible.",
 647       "isStatic" : false,
 648       "isConstructor" : false,
 649       "isPrivate" : false,
 650       "memberOf" : "Roo.Component",
 651       "example" : "",
 652       "deprecated" : "",
 653       "since" : "",
 654       "see" : "",
 655       "params" : [
 656       ],
 657       "returns" : [
 658       ]
 659     },
 660     {
 661       "name" : "setDisabled",
 662       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 663       "isStatic" : false,
 664       "isConstructor" : false,
 665       "isPrivate" : false,
 666       "memberOf" : "Roo.Component",
 667       "example" : "",
 668       "deprecated" : "",
 669       "since" : "",
 670       "see" : "",
 671       "params" : [
 672         {
 673           "name" : "disabled",
 674           "type" : "Boolean",
 675           "desc" : "",
 676           "isOptional" : false
 677         }
 678       ],
 679       "returns" : [
 680       ]
 681     },
 682     {
 683       "name" : "focus",
 684       "desc" : "Try to focus this component.",
 685       "isStatic" : false,
 686       "isConstructor" : false,
 687       "isPrivate" : false,
 688       "memberOf" : "Roo.Component",
 689       "example" : "",
 690       "deprecated" : "",
 691       "since" : "",
 692       "see" : "",
 693       "params" : [
 694         {
 695           "name" : "selectText",
 696           "type" : "Boolean",
 697           "desc" : "True to also select the text in this component (if applicable)",
 698           "isOptional" : false
 699         }
 700       ],
 701       "returns" : [
 702         {
 703           "name" : "",
 704           "type" : "Roo.Component",
 705           "desc" : "this"
 706         }
 707       ]
 708     },
 709     {
 710       "name" : "setVisible",
 711       "desc" : "Convenience function to hide or show this component by boolean.",
 712       "isStatic" : false,
 713       "isConstructor" : false,
 714       "isPrivate" : false,
 715       "memberOf" : "Roo.Component",
 716       "example" : "",
 717       "deprecated" : "",
 718       "since" : "",
 719       "see" : "",
 720       "params" : [
 721         {
 722           "name" : "visible",
 723           "type" : "Boolean",
 724           "desc" : "True to show, false to hide",
 725           "isOptional" : false
 726         }
 727       ],
 728       "returns" : [
 729         {
 730           "name" : "",
 731           "type" : "Roo.Component",
 732           "desc" : "this"
 733         }
 734       ]
 735     },
 736     {
 737       "name" : "getEl",
 738       "desc" : "Returns the underlying {@link Roo.Element}.",
 739       "isStatic" : false,
 740       "isConstructor" : false,
 741       "isPrivate" : false,
 742       "memberOf" : "Roo.Component",
 743       "example" : "",
 744       "deprecated" : "",
 745       "since" : "",
 746       "see" : "",
 747       "params" : [
 748       ],
 749       "returns" : [
 750         {
 751           "name" : "",
 752           "type" : "Roo.Element",
 753           "desc" : "The element"
 754         }
 755       ]
 756     },
 757     {
 758       "name" : "purgeListeners",
 759       "desc" : "Removes all listeners for this object",
 760       "isStatic" : false,
 761       "isConstructor" : false,
 762       "isPrivate" : false,
 763       "memberOf" : "Roo.util.Observable",
 764       "example" : "",
 765       "deprecated" : "",
 766       "since" : "",
 767       "see" : "",
 768       "params" : [
 769       ],
 770       "returns" : [
 771       ]
 772     },
 773     {
 774       "name" : "on",
 775       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 776       "isStatic" : false,
 777       "isConstructor" : false,
 778       "isPrivate" : false,
 779       "memberOf" : "Roo.util.Observable",
 780       "example" : "",
 781       "deprecated" : "",
 782       "since" : "",
 783       "see" : "",
 784       "params" : [
 785         {
 786           "name" : "eventName",
 787           "type" : "String",
 788           "desc" : "The type of event to listen for",
 789           "isOptional" : false
 790         },
 791         {
 792           "name" : "handler",
 793           "type" : "Function",
 794           "desc" : "The method the event invokes",
 795           "isOptional" : false
 796         },
 797         {
 798           "name" : "scope",
 799           "type" : "Object",
 800           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 801           "isOptional" : false
 802         },
 803         {
 804           "name" : "options",
 805           "type" : "Object",
 806           "desc" : "(optional)",
 807           "isOptional" : false
 808         }
 809       ],
 810       "returns" : [
 811       ]
 812     },
 813     {
 814       "name" : "un",
 815       "desc" : "Removes a listener (shorthand for removeListener)",
 816       "isStatic" : false,
 817       "isConstructor" : false,
 818       "isPrivate" : false,
 819       "memberOf" : "Roo.util.Observable",
 820       "example" : "",
 821       "deprecated" : "",
 822       "since" : "",
 823       "see" : "",
 824       "params" : [
 825         {
 826           "name" : "eventName",
 827           "type" : "String",
 828           "desc" : "The type of event to listen for",
 829           "isOptional" : false
 830         },
 831         {
 832           "name" : "handler",
 833           "type" : "Function",
 834           "desc" : "The handler to remove",
 835           "isOptional" : false
 836         },
 837         {
 838           "name" : "scope",
 839           "type" : "Object",
 840           "desc" : "(optional) The scope (this object) for the handler",
 841           "isOptional" : false
 842         }
 843       ],
 844       "returns" : [
 845       ]
 846     },
 847     {
 848       "name" : "addEvents",
 849       "desc" : "Used to define events on this Observable",
 850       "isStatic" : false,
 851       "isConstructor" : false,
 852       "isPrivate" : false,
 853       "memberOf" : "Roo.util.Observable",
 854       "example" : "",
 855       "deprecated" : "",
 856       "since" : "",
 857       "see" : "",
 858       "params" : [
 859         {
 860           "name" : "object",
 861           "type" : "Object",
 862           "desc" : "The object with the events defined",
 863           "isOptional" : false
 864         }
 865       ],
 866       "returns" : [
 867       ]
 868     },
 869     {
 870       "name" : "releaseCapture",
 871       "desc" : "Removes <b>all</b> added captures from the Observable.",
 872       "isStatic" : true,
 873       "isConstructor" : false,
 874       "isPrivate" : false,
 875       "memberOf" : "Roo.util.Observable",
 876       "example" : "",
 877       "deprecated" : "",
 878       "since" : "",
 879       "see" : "",
 880       "params" : [
 881         {
 882           "name" : "o",
 883           "type" : "Observable",
 884           "desc" : "The Observable to release",
 885           "isOptional" : false
 886         }
 887       ],
 888       "returns" : [
 889       ]
 890     },
 891     {
 892       "name" : "removeListener",
 893       "desc" : "Removes a listener",
 894       "isStatic" : false,
 895       "isConstructor" : false,
 896       "isPrivate" : false,
 897       "memberOf" : "Roo.util.Observable",
 898       "example" : "",
 899       "deprecated" : "",
 900       "since" : "",
 901       "see" : "",
 902       "params" : [
 903         {
 904           "name" : "eventName",
 905           "type" : "String",
 906           "desc" : "The type of event to listen for",
 907           "isOptional" : false
 908         },
 909         {
 910           "name" : "handler",
 911           "type" : "Function",
 912           "desc" : "The handler to remove",
 913           "isOptional" : false
 914         },
 915         {
 916           "name" : "scope",
 917           "type" : "Object",
 918           "desc" : "(optional) The scope (this object) for the handler",
 919           "isOptional" : false
 920         }
 921       ],
 922       "returns" : [
 923       ]
 924     },
 925     {
 926       "name" : "fireEvent",
 927       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 928       "isStatic" : false,
 929       "isConstructor" : false,
 930       "isPrivate" : false,
 931       "memberOf" : "Roo.util.Observable",
 932       "example" : "",
 933       "deprecated" : "",
 934       "since" : "",
 935       "see" : "",
 936       "params" : [
 937         {
 938           "name" : "eventName",
 939           "type" : "String",
 940           "desc" : "",
 941           "isOptional" : false
 942         },
 943         {
 944           "name" : "args",
 945           "type" : "Object...",
 946           "desc" : "Variable number of parameters are passed to handlers",
 947           "isOptional" : false
 948         }
 949       ],
 950       "returns" : [
 951         {
 952           "name" : "",
 953           "type" : "Boolean",
 954           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 955         }
 956       ]
 957     },
 958     {
 959       "name" : "hasListener",
 960       "desc" : "Checks to see if this object has any listeners for a specified event",
 961       "isStatic" : false,
 962       "isConstructor" : false,
 963       "isPrivate" : false,
 964       "memberOf" : "Roo.util.Observable",
 965       "example" : "",
 966       "deprecated" : "",
 967       "since" : "",
 968       "see" : "",
 969       "params" : [
 970         {
 971           "name" : "eventName",
 972           "type" : "String",
 973           "desc" : "The name of the event to check for",
 974           "isOptional" : false
 975         }
 976       ],
 977       "returns" : [
 978         {
 979           "name" : "",
 980           "type" : "Boolean",
 981           "desc" : "True if the event is being listened for, else false"
 982         }
 983       ]
 984     },
 985     {
 986       "name" : "capture",
 987       "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.",
 988       "isStatic" : true,
 989       "isConstructor" : false,
 990       "isPrivate" : false,
 991       "memberOf" : "Roo.util.Observable",
 992       "example" : "",
 993       "deprecated" : "",
 994       "since" : "",
 995       "see" : "",
 996       "params" : [
 997         {
 998           "name" : "o",
 999           "type" : "Observable",
1000           "desc" : "The Observable to capture",
1001           "isOptional" : false
1002         },
1003         {
1004           "name" : "fn",
1005           "type" : "Function",
1006           "desc" : "The function to call",
1007           "isOptional" : false
1008         },
1009         {
1010           "name" : "scope",
1011           "type" : "Object",
1012           "desc" : "(optional) The scope (this object) for the fn",
1013           "isOptional" : false
1014         }
1015       ],
1016       "returns" : [
1017       ]
1018     },
1019     {
1020       "name" : "addListener",
1021       "desc" : "Appends an event handler to this component",
1022       "isStatic" : false,
1023       "isConstructor" : false,
1024       "isPrivate" : false,
1025       "memberOf" : "Roo.util.Observable",
1026       "example" : "",
1027       "deprecated" : "",
1028       "since" : "",
1029       "see" : "",
1030       "params" : [
1031         {
1032           "name" : "eventName",
1033           "type" : "String",
1034           "desc" : "The type of event to listen for",
1035           "isOptional" : false
1036         },
1037         {
1038           "name" : "handler",
1039           "type" : "Function",
1040           "desc" : "The method the event invokes",
1041           "isOptional" : false
1042         },
1043         {
1044           "name" : "scope",
1045           "type" : "Object",
1046           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1047           "isOptional" : false
1048         },
1049         {
1050           "name" : "options",
1051           "type" : "Object",
1052           "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>",
1053           "isOptional" : false
1054         }
1055       ],
1056       "returns" : [
1057       ]
1058     }
1059   ],
1060   "events" : [
1061     {
1062       "name" : "toggle",
1063       "desc" : "After the button has been toggles",
1064       "memberOf" : "Roo.bootstrap.Button",
1065       "example" : "",
1066       "deprecated" : "",
1067       "since" : "",
1068       "see" : "",
1069       "params" : [
1070         {
1071           "name" : "btn",
1072           "type" : "Roo.bootstrap.Button",
1073           "desc" : "",
1074           "isOptional" : false
1075         },
1076         {
1077           "name" : "e",
1078           "type" : "Roo.EventObject",
1079           "desc" : "",
1080           "isOptional" : false
1081         },
1082         {
1083           "name" : "pressed",
1084           "type" : "boolean",
1085           "desc" : "(also available as button.pressed)",
1086           "isOptional" : false
1087         }
1088       ],
1089       "returns" : [
1090       ]
1091     },
1092     {
1093       "name" : "click",
1094       "desc" : "When a butotn is pressed",
1095       "memberOf" : "Roo.bootstrap.Button",
1096       "example" : "",
1097       "deprecated" : "",
1098       "since" : "",
1099       "see" : "",
1100       "params" : [
1101         {
1102           "name" : "btn",
1103           "type" : "Roo.bootstrap.Button",
1104           "desc" : "",
1105           "isOptional" : false
1106         },
1107         {
1108           "name" : "e",
1109           "type" : "Roo.EventObject",
1110           "desc" : "",
1111           "isOptional" : false
1112         }
1113       ],
1114       "returns" : [
1115       ]
1116     },
1117     {
1118       "name" : "childrenrendered",
1119       "desc" : "Fires when the children have been rendered..",
1120       "memberOf" : "Roo.bootstrap.Component",
1121       "example" : "",
1122       "deprecated" : "",
1123       "since" : "",
1124       "see" : "",
1125       "params" : [
1126         {
1127           "name" : "this",
1128           "type" : "Roo.bootstrap.Component",
1129           "desc" : "",
1130           "isOptional" : false
1131         }
1132       ],
1133       "returns" : [
1134       ]
1135     },
1136     {
1137       "name" : "beforerender",
1138       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1139       "memberOf" : "Roo.Component",
1140       "example" : "",
1141       "deprecated" : "",
1142       "since" : "",
1143       "see" : "",
1144       "params" : [
1145         {
1146           "name" : "this",
1147           "type" : "Roo.Component",
1148           "desc" : "",
1149           "isOptional" : false
1150         }
1151       ],
1152       "returns" : [
1153       ]
1154     },
1155     {
1156       "name" : "disable",
1157       "desc" : "Fires after the component is disabled.",
1158       "memberOf" : "Roo.Component",
1159       "example" : "",
1160       "deprecated" : "",
1161       "since" : "",
1162       "see" : "",
1163       "params" : [
1164         {
1165           "name" : "this",
1166           "type" : "Roo.Component",
1167           "desc" : "",
1168           "isOptional" : false
1169         }
1170       ],
1171       "returns" : [
1172       ]
1173     },
1174     {
1175       "name" : "render",
1176       "desc" : "Fires after the component is rendered.",
1177       "memberOf" : "Roo.Component",
1178       "example" : "",
1179       "deprecated" : "",
1180       "since" : "",
1181       "see" : "",
1182       "params" : [
1183         {
1184           "name" : "this",
1185           "type" : "Roo.Component",
1186           "desc" : "",
1187           "isOptional" : false
1188         }
1189       ],
1190       "returns" : [
1191       ]
1192     },
1193     {
1194       "name" : "destroy",
1195       "desc" : "Fires after the component is destroyed.",
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     {
1213       "name" : "hide",
1214       "desc" : "Fires after the component is hidden.",
1215       "memberOf" : "Roo.Component",
1216       "example" : "",
1217       "deprecated" : "",
1218       "since" : "",
1219       "see" : "",
1220       "params" : [
1221         {
1222           "name" : "this",
1223           "type" : "Roo.Component",
1224           "desc" : "",
1225           "isOptional" : false
1226         }
1227       ],
1228       "returns" : [
1229       ]
1230     },
1231     {
1232       "name" : "beforehide",
1233       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1234       "memberOf" : "Roo.Component",
1235       "example" : "",
1236       "deprecated" : "",
1237       "since" : "",
1238       "see" : "",
1239       "params" : [
1240         {
1241           "name" : "this",
1242           "type" : "Roo.Component",
1243           "desc" : "",
1244           "isOptional" : false
1245         }
1246       ],
1247       "returns" : [
1248       ]
1249     },
1250     {
1251       "name" : "show",
1252       "desc" : "Fires after the component is shown.",
1253       "memberOf" : "Roo.Component",
1254       "example" : "",
1255       "deprecated" : "",
1256       "since" : "",
1257       "see" : "",
1258       "params" : [
1259         {
1260           "name" : "this",
1261           "type" : "Roo.Component",
1262           "desc" : "",
1263           "isOptional" : false
1264         }
1265       ],
1266       "returns" : [
1267       ]
1268     },
1269     {
1270       "name" : "beforeshow",
1271       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1272       "memberOf" : "Roo.Component",
1273       "example" : "",
1274       "deprecated" : "",
1275       "since" : "",
1276       "see" : "",
1277       "params" : [
1278         {
1279           "name" : "this",
1280           "type" : "Roo.Component",
1281           "desc" : "",
1282           "isOptional" : false
1283         }
1284       ],
1285       "returns" : [
1286       ]
1287     },
1288     {
1289       "name" : "enable",
1290       "desc" : "Fires after the component is enabled.",
1291       "memberOf" : "Roo.Component",
1292       "example" : "",
1293       "deprecated" : "",
1294       "since" : "",
1295       "see" : "",
1296       "params" : [
1297         {
1298           "name" : "this",
1299           "type" : "Roo.Component",
1300           "desc" : "",
1301           "isOptional" : false
1302         }
1303       ],
1304       "returns" : [
1305       ]
1306     },
1307     {
1308       "name" : "beforedestroy",
1309       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1310       "memberOf" : "Roo.Component",
1311       "example" : "",
1312       "deprecated" : "",
1313       "since" : "",
1314       "see" : "",
1315       "params" : [
1316         {
1317           "name" : "this",
1318           "type" : "Roo.Component",
1319           "desc" : "",
1320           "isOptional" : false
1321         }
1322       ],
1323       "returns" : [
1324       ]
1325     }
1326   ]
1327 }