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

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