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

   1 {
   2   "name" : "Roo.Toolbar.Button",
   3   "augments" : [
   4     "Roo.Button",
   5     "Roo.util.Observable"
   6   ],
   7   "childClasses" : {  },
   8   "tree_children" : [],
   9   "tree_parent" : [],
  10   "desc" : "A button that renders into a toolbar.",
  11   "isSingleton" : false,
  12   "isStatic" : false,
  13   "isBuiltin" : false,
  14   "isAbstract" : false,
  15   "isBuilderTop" : false,
  16   "memberOf" : "Button",
  17   "example" : "",
  18   "deprecated" : "",
  19   "since" : "",
  20   "see" : "",
  21   "params" : [
  22     {
  23       "name" : "config",
  24       "type" : "Object",
  25       "desc" : "A standard {@link Roo.Button} config object",
  26       "isOptional" : false
  27     }
  28   ],
  29   "returns" : [],
  30   "throws" : "",
  31   "requires" : "",
  32   "config" : [
  33     {
  34       "name" : "listeners",
  35       "type" : "Object",
  36       "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>",
  37       "memberOf" : "Roo.util.Observable",
  38       "isOptional" : false,
  39       "optvalues" : []
  40     },
  41     {
  42       "name" : "tooltip",
  43       "type" : "String/Object",
  44       "desc" : "The tooltip for the button - can be a string or QuickTips config object",
  45       "memberOf" : "Roo.Button",
  46       "isOptional" : false,
  47       "optvalues" : []
  48     },
  49     {
  50       "name" : "text",
  51       "type" : "String",
  52       "desc" : "The button text",
  53       "memberOf" : "Roo.Button",
  54       "isOptional" : false,
  55       "optvalues" : []
  56     },
  57     {
  58       "name" : "renderTo",
  59       "type" : "String/HTMLElement/Element",
  60       "desc" : "The element to append the button to",
  61       "memberOf" : "Roo.Button",
  62       "isOptional" : false,
  63       "optvalues" : []
  64     },
  65     {
  66       "name" : "hidden",
  67       "type" : "Boolean",
  68       "desc" : "True to start hidden (defaults to false)",
  69       "memberOf" : "Roo.Button",
  70       "isOptional" : false,
  71       "optvalues" : []
  72     },
  73     {
  74       "name" : "toggleGroup",
  75       "type" : "String",
  76       "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n   applies if enableToggle = true)",
  77       "memberOf" : "Roo.Button",
  78       "isOptional" : false,
  79       "optvalues" : []
  80     },
  81     {
  82       "name" : "handleMouseEvents",
  83       "type" : "Boolean",
  84       "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
  85       "memberOf" : "Roo.Button",
  86       "isOptional" : false,
  87       "optvalues" : []
  88     },
  89     {
  90       "name" : "menu",
  91       "type" : "Roo.menu.Menu",
  92       "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
  93       "memberOf" : "Roo.Button",
  94       "isOptional" : false,
  95       "optvalues" : []
  96     },
  97     {
  98       "name" : "enableToggle",
  99       "type" : "Boolean",
 100       "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
 101       "memberOf" : "Roo.Button",
 102       "isOptional" : false,
 103       "optvalues" : []
 104     },
 105     {
 106       "name" : "handler",
 107       "type" : "Function",
 108       "desc" : "A function called when the button is clicked (can be used instead of click event)",
 109       "memberOf" : "Roo.Button",
 110       "isOptional" : false,
 111       "optvalues" : []
 112     },
 113     {
 114       "name" : "scope",
 115       "type" : "Object",
 116       "desc" : "The scope of the handler",
 117       "memberOf" : "Roo.Button",
 118       "isOptional" : false,
 119       "optvalues" : []
 120     },
 121     {
 122       "name" : "minWidth",
 123       "type" : "Number",
 124       "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
 125       "memberOf" : "Roo.Button",
 126       "isOptional" : false,
 127       "optvalues" : []
 128     },
 129     {
 130       "name" : "disabled",
 131       "type" : "Boolean",
 132       "desc" : "True to start disabled (defaults to false)",
 133       "memberOf" : "Roo.Button",
 134       "isOptional" : false,
 135       "optvalues" : []
 136     },
 137     {
 138       "name" : "pressed",
 139       "type" : "Boolean",
 140       "desc" : "True to start pressed (only if enableToggle = true)",
 141       "memberOf" : "Roo.Button",
 142       "isOptional" : false,
 143       "optvalues" : []
 144     },
 145     {
 146       "name" : "template",
 147       "type" : "Roo.Template",
 148       "desc" : "An {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.",
 149       "memberOf" : "Roo.Button",
 150       "isOptional" : false,
 151       "optvalues" : []
 152     },
 153     {
 154       "name" : "cls",
 155       "type" : "String",
 156       "desc" : "A CSS class to apply to the button's main element.",
 157       "memberOf" : "Roo.Button",
 158       "isOptional" : false,
 159       "optvalues" : []
 160     },
 161     {
 162       "name" : "tabIndex",
 163       "type" : "Number",
 164       "desc" : "The DOM tabIndex for this button (defaults to undefined)",
 165       "memberOf" : "Roo.Button",
 166       "isOptional" : false,
 167       "optvalues" : []
 168     },
 169     {
 170       "name" : "iconCls",
 171       "type" : "String",
 172       "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
 173       "memberOf" : "Roo.Button",
 174       "isOptional" : false,
 175       "optvalues" : []
 176     },
 177     {
 178       "name" : "menuAlign",
 179       "type" : "String",
 180       "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
 181       "memberOf" : "Roo.Button",
 182       "isOptional" : false,
 183       "optvalues" : []
 184     },
 185     {
 186       "name" : "icon",
 187       "type" : "String",
 188       "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")",
 189       "memberOf" : "Roo.Button",
 190       "isOptional" : false,
 191       "optvalues" : []
 192     },
 193     {
 194       "name" : "tooltipType",
 195       "type" : "String",
 196       "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
 197       "memberOf" : "Roo.Button",
 198       "isOptional" : false,
 199       "optvalues" : []
 200     },
 201     {
 202       "name" : "clickEvent",
 203       "type" : "String",
 204       "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
 205       "memberOf" : "Roo.Button",
 206       "isOptional" : false,
 207       "optvalues" : []
 208     },
 209     {
 210       "name" : "repeat",
 211       "type" : "Boolean/Object",
 212       "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n  an {@link Roo.util.ClickRepeater} config object (defaults to false).",
 213       "memberOf" : "Roo.Button",
 214       "isOptional" : false,
 215       "optvalues" : []
 216     },
 217     {
 218       "name" : "type",
 219       "type" : "String",
 220       "desc" : "The button's type, corresponding to the DOM input element type attribute.  Either \"submit,\" \"reset\" or \"button\" (default).",
 221       "memberOf" : "Roo.Button",
 222       "isOptional" : false,
 223       "optvalues" : []
 224     }
 225   ],
 226   "methods" : [
 227     {
 228       "name" : "disable",
 229       "type" : "function",
 230       "desc" : "Disables this item",
 231       "sig" : "()\n{\n\n}",
 232       "static" : false,
 233       "memberOf" : "",
 234       "isStatic" : false,
 235       "isConstructor" : false,
 236       "isPrivate" : false,
 237       "example" : "",
 238       "deprecated" : "",
 239       "since" : "",
 240       "see" : "",
 241       "exceptions" : "",
 242       "requires" : "",
 243       "params" : [],
 244       "returns" : []
 245     },
 246     {
 247       "name" : "enable",
 248       "type" : "function",
 249       "desc" : "Enables this item",
 250       "sig" : "()\n{\n\n}",
 251       "static" : false,
 252       "memberOf" : "",
 253       "isStatic" : false,
 254       "isConstructor" : false,
 255       "isPrivate" : false,
 256       "example" : "",
 257       "deprecated" : "",
 258       "since" : "",
 259       "see" : "",
 260       "exceptions" : "",
 261       "requires" : "",
 262       "params" : [],
 263       "returns" : []
 264     },
 265     {
 266       "name" : "destroy",
 267       "type" : "function",
 268       "desc" : "Removes and destroys this button",
 269       "sig" : "()\n{\n\n}",
 270       "static" : false,
 271       "memberOf" : "",
 272       "isStatic" : false,
 273       "isConstructor" : false,
 274       "isPrivate" : false,
 275       "example" : "",
 276       "deprecated" : "",
 277       "since" : "",
 278       "see" : "",
 279       "exceptions" : "",
 280       "requires" : "",
 281       "params" : [],
 282       "returns" : []
 283     },
 284     {
 285       "name" : "hide",
 286       "type" : "function",
 287       "desc" : "Hides this button",
 288       "sig" : "()\n{\n\n}",
 289       "static" : false,
 290       "memberOf" : "",
 291       "isStatic" : false,
 292       "isConstructor" : false,
 293       "isPrivate" : false,
 294       "example" : "",
 295       "deprecated" : "",
 296       "since" : "",
 297       "see" : "",
 298       "exceptions" : "",
 299       "requires" : "",
 300       "params" : [],
 301       "returns" : []
 302     },
 303     {
 304       "name" : "show",
 305       "type" : "function",
 306       "desc" : "Shows this button",
 307       "sig" : "()\n{\n\n}",
 308       "static" : false,
 309       "memberOf" : "",
 310       "isStatic" : false,
 311       "isConstructor" : false,
 312       "isPrivate" : false,
 313       "example" : "",
 314       "deprecated" : "",
 315       "since" : "",
 316       "see" : "",
 317       "exceptions" : "",
 318       "requires" : "",
 319       "params" : [],
 320       "returns" : []
 321     },
 322     {
 323       "name" : "focus",
 324       "type" : "function",
 325       "desc" : "Focus the button",
 326       "sig" : "()\n{\n\n}",
 327       "static" : false,
 328       "memberOf" : "Roo.Button",
 329       "isStatic" : false,
 330       "isConstructor" : false,
 331       "isPrivate" : false,
 332       "example" : "",
 333       "deprecated" : "",
 334       "since" : "",
 335       "see" : "",
 336       "exceptions" : "",
 337       "requires" : "",
 338       "params" : [],
 339       "returns" : []
 340     },
 341     {
 342       "name" : "setHandler",
 343       "type" : "function",
 344       "desc" : "Assigns this button's click handler",
 345       "sig" : "(handler, scope)",
 346       "static" : false,
 347       "memberOf" : "Roo.Button",
 348       "isStatic" : false,
 349       "isConstructor" : false,
 350       "isPrivate" : false,
 351       "example" : "",
 352       "deprecated" : "",
 353       "since" : "",
 354       "see" : "",
 355       "exceptions" : "",
 356       "requires" : "",
 357       "params" : [
 358         {
 359           "name" : "handler",
 360           "type" : "Function",
 361           "desc" : "The function to call when the button is clicked",
 362           "isOptional" : false
 363         },
 364         {
 365           "name" : "scope",
 366           "type" : "Object",
 367           "desc" : "(optional) Scope for the function passed in",
 368           "isOptional" : false
 369         }
 370       ],
 371       "returns" : []
 372     },
 373     {
 374       "name" : "getEl",
 375       "type" : "function",
 376       "desc" : "Returns the button's underlying element",
 377       "sig" : "()\n{\n\n}",
 378       "static" : false,
 379       "memberOf" : "Roo.Button",
 380       "isStatic" : false,
 381       "isConstructor" : false,
 382       "isPrivate" : false,
 383       "example" : "",
 384       "deprecated" : "",
 385       "since" : "",
 386       "see" : "",
 387       "exceptions" : "",
 388       "requires" : "",
 389       "params" : [],
 390       "returns" : [
 391         {
 392           "name" : "",
 393           "type" : "Roo.Element",
 394           "desc" : "The element"
 395         }
 396       ]
 397     },
 398     {
 399       "name" : "setDisabled",
 400       "type" : "function",
 401       "desc" : "Convenience function for boolean enable/disable",
 402       "sig" : "(enabled)",
 403       "static" : false,
 404       "memberOf" : "Roo.Button",
 405       "isStatic" : false,
 406       "isConstructor" : false,
 407       "isPrivate" : false,
 408       "example" : "",
 409       "deprecated" : "",
 410       "since" : "",
 411       "see" : "",
 412       "exceptions" : "",
 413       "requires" : "",
 414       "params" : [
 415         {
 416           "name" : "enabled",
 417           "type" : "Boolean",
 418           "desc" : "True to enable, false to disable",
 419           "isOptional" : false
 420         }
 421       ],
 422       "returns" : []
 423     },
 424     {
 425       "name" : "setVisible",
 426       "type" : "function",
 427       "desc" : "Convenience function for boolean show/hide",
 428       "sig" : "(visible)",
 429       "static" : false,
 430       "memberOf" : "Roo.Button",
 431       "isStatic" : false,
 432       "isConstructor" : false,
 433       "isPrivate" : false,
 434       "example" : "",
 435       "deprecated" : "",
 436       "since" : "",
 437       "see" : "",
 438       "exceptions" : "",
 439       "requires" : "",
 440       "params" : [
 441         {
 442           "name" : "visible",
 443           "type" : "Boolean",
 444           "desc" : "True to show, false to hide",
 445           "isOptional" : false
 446         }
 447       ],
 448       "returns" : []
 449     },
 450     {
 451       "name" : "getText",
 452       "type" : "function",
 453       "desc" : "Gets the text for this button",
 454       "sig" : "()\n{\n\n}",
 455       "static" : false,
 456       "memberOf" : "Roo.Button",
 457       "isStatic" : false,
 458       "isConstructor" : false,
 459       "isPrivate" : false,
 460       "example" : "",
 461       "deprecated" : "",
 462       "since" : "",
 463       "see" : "",
 464       "exceptions" : "",
 465       "requires" : "",
 466       "params" : [],
 467       "returns" : [
 468         {
 469           "name" : "",
 470           "type" : "String",
 471           "desc" : "The button text"
 472         }
 473       ]
 474     },
 475     {
 476       "name" : "setText",
 477       "type" : "function",
 478       "desc" : "Sets this button's text",
 479       "sig" : "(text)",
 480       "static" : false,
 481       "memberOf" : "Roo.Button",
 482       "isStatic" : false,
 483       "isConstructor" : false,
 484       "isPrivate" : false,
 485       "example" : "",
 486       "deprecated" : "",
 487       "since" : "",
 488       "see" : "",
 489       "exceptions" : "",
 490       "requires" : "",
 491       "params" : [
 492         {
 493           "name" : "text",
 494           "type" : "String",
 495           "desc" : "The button text",
 496           "isOptional" : false
 497         }
 498       ],
 499       "returns" : []
 500     },
 501     {
 502       "name" : "toggle",
 503       "type" : "function",
 504       "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
 505       "sig" : "(state)",
 506       "static" : false,
 507       "memberOf" : "Roo.Button",
 508       "isStatic" : false,
 509       "isConstructor" : false,
 510       "isPrivate" : false,
 511       "example" : "",
 512       "deprecated" : "",
 513       "since" : "",
 514       "see" : "",
 515       "exceptions" : "",
 516       "requires" : "",
 517       "params" : [
 518         {
 519           "name" : "state",
 520           "type" : "Boolean",
 521           "desc" : "(optional) Force a particular state",
 522           "isOptional" : false
 523         }
 524       ],
 525       "returns" : []
 526     },
 527     {
 528       "name" : "purgeListeners",
 529       "type" : "function",
 530       "desc" : "Removes all listeners for this object",
 531       "sig" : "()\n{\n\n}",
 532       "static" : false,
 533       "memberOf" : "Roo.util.Observable",
 534       "isStatic" : false,
 535       "isConstructor" : false,
 536       "isPrivate" : false,
 537       "example" : "",
 538       "deprecated" : "",
 539       "since" : "",
 540       "see" : "",
 541       "exceptions" : "",
 542       "requires" : "",
 543       "params" : [],
 544       "returns" : []
 545     },
 546     {
 547       "name" : "on",
 548       "type" : "function",
 549       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 550       "sig" : "(eventName, handler, scope, options)",
 551       "static" : false,
 552       "memberOf" : "Roo.util.Observable",
 553       "isStatic" : false,
 554       "isConstructor" : false,
 555       "isPrivate" : false,
 556       "example" : "",
 557       "deprecated" : "",
 558       "since" : "",
 559       "see" : "",
 560       "exceptions" : "",
 561       "requires" : "",
 562       "params" : [
 563         {
 564           "name" : "eventName",
 565           "type" : "String",
 566           "desc" : "The type of event to listen for",
 567           "isOptional" : false
 568         },
 569         {
 570           "name" : "handler",
 571           "type" : "Function",
 572           "desc" : "The method the event invokes",
 573           "isOptional" : false
 574         },
 575         {
 576           "name" : "scope",
 577           "type" : "Object",
 578           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 579           "isOptional" : false
 580         },
 581         {
 582           "name" : "options",
 583           "type" : "Object",
 584           "desc" : "(optional)",
 585           "isOptional" : false
 586         }
 587       ],
 588       "returns" : []
 589     },
 590     {
 591       "name" : "un",
 592       "type" : "function",
 593       "desc" : "Removes a listener (shorthand for removeListener)",
 594       "sig" : "(eventName, handler, scope)",
 595       "static" : false,
 596       "memberOf" : "Roo.util.Observable",
 597       "isStatic" : false,
 598       "isConstructor" : false,
 599       "isPrivate" : false,
 600       "example" : "",
 601       "deprecated" : "",
 602       "since" : "",
 603       "see" : "",
 604       "exceptions" : "",
 605       "requires" : "",
 606       "params" : [
 607         {
 608           "name" : "eventName",
 609           "type" : "String",
 610           "desc" : "The type of event to listen for",
 611           "isOptional" : false
 612         },
 613         {
 614           "name" : "handler",
 615           "type" : "Function",
 616           "desc" : "The handler to remove",
 617           "isOptional" : false
 618         },
 619         {
 620           "name" : "scope",
 621           "type" : "Object",
 622           "desc" : "(optional) The scope (this object) for the handler",
 623           "isOptional" : false
 624         }
 625       ],
 626       "returns" : []
 627     },
 628     {
 629       "name" : "addEvents",
 630       "type" : "function",
 631       "desc" : "Used to define events on this Observable",
 632       "sig" : "(object)",
 633       "static" : false,
 634       "memberOf" : "Roo.util.Observable",
 635       "isStatic" : false,
 636       "isConstructor" : false,
 637       "isPrivate" : false,
 638       "example" : "",
 639       "deprecated" : "",
 640       "since" : "",
 641       "see" : "",
 642       "exceptions" : "",
 643       "requires" : "",
 644       "params" : [
 645         {
 646           "name" : "object",
 647           "type" : "Object",
 648           "desc" : "The object with the events defined",
 649           "isOptional" : false
 650         }
 651       ],
 652       "returns" : []
 653     },
 654     {
 655       "name" : "releaseCapture",
 656       "type" : "function",
 657       "desc" : "Removes <b>all</b> added captures from the Observable.",
 658       "sig" : "(o)",
 659       "static" : true,
 660       "memberOf" : "Roo.util.Observable",
 661       "isStatic" : true,
 662       "isConstructor" : false,
 663       "isPrivate" : false,
 664       "example" : "",
 665       "deprecated" : "",
 666       "since" : "",
 667       "see" : "",
 668       "exceptions" : "",
 669       "requires" : "",
 670       "params" : [
 671         {
 672           "name" : "o",
 673           "type" : "Observable",
 674           "desc" : "The Observable to release",
 675           "isOptional" : false
 676         }
 677       ],
 678       "returns" : []
 679     },
 680     {
 681       "name" : "removeListener",
 682       "type" : "function",
 683       "desc" : "Removes a listener",
 684       "sig" : "(eventName, handler, scope)",
 685       "static" : false,
 686       "memberOf" : "Roo.util.Observable",
 687       "isStatic" : false,
 688       "isConstructor" : false,
 689       "isPrivate" : false,
 690       "example" : "",
 691       "deprecated" : "",
 692       "since" : "",
 693       "see" : "",
 694       "exceptions" : "",
 695       "requires" : "",
 696       "params" : [
 697         {
 698           "name" : "eventName",
 699           "type" : "String",
 700           "desc" : "The type of event to listen for",
 701           "isOptional" : false
 702         },
 703         {
 704           "name" : "handler",
 705           "type" : "Function",
 706           "desc" : "The handler to remove",
 707           "isOptional" : false
 708         },
 709         {
 710           "name" : "scope",
 711           "type" : "Object",
 712           "desc" : "(optional) The scope (this object) for the handler",
 713           "isOptional" : false
 714         }
 715       ],
 716       "returns" : []
 717     },
 718     {
 719       "name" : "fireEvent",
 720       "type" : "function",
 721       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 722       "sig" : "(eventName, args)",
 723       "static" : false,
 724       "memberOf" : "Roo.util.Observable",
 725       "isStatic" : false,
 726       "isConstructor" : false,
 727       "isPrivate" : false,
 728       "example" : "",
 729       "deprecated" : "",
 730       "since" : "",
 731       "see" : "",
 732       "exceptions" : "",
 733       "requires" : "",
 734       "params" : [
 735         {
 736           "name" : "eventName",
 737           "type" : "String",
 738           "desc" : "",
 739           "isOptional" : false
 740         },
 741         {
 742           "name" : "args",
 743           "type" : "Object...",
 744           "desc" : "Variable number of parameters are passed to handlers",
 745           "isOptional" : false
 746         }
 747       ],
 748       "returns" : [
 749         {
 750           "name" : "",
 751           "type" : "Boolean",
 752           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 753         }
 754       ]
 755     },
 756     {
 757       "name" : "hasListener",
 758       "type" : "function",
 759       "desc" : "Checks to see if this object has any listeners for a specified event",
 760       "sig" : "(eventName)",
 761       "static" : false,
 762       "memberOf" : "Roo.util.Observable",
 763       "isStatic" : false,
 764       "isConstructor" : false,
 765       "isPrivate" : false,
 766       "example" : "",
 767       "deprecated" : "",
 768       "since" : "",
 769       "see" : "",
 770       "exceptions" : "",
 771       "requires" : "",
 772       "params" : [
 773         {
 774           "name" : "eventName",
 775           "type" : "String",
 776           "desc" : "The name of the event to check for",
 777           "isOptional" : false
 778         }
 779       ],
 780       "returns" : [
 781         {
 782           "name" : "",
 783           "type" : "Boolean",
 784           "desc" : "True if the event is being listened for, else false"
 785         }
 786       ]
 787     },
 788     {
 789       "name" : "capture",
 790       "type" : "function",
 791       "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.",
 792       "sig" : "(o, fn, scope)",
 793       "static" : true,
 794       "memberOf" : "Roo.util.Observable",
 795       "isStatic" : true,
 796       "isConstructor" : false,
 797       "isPrivate" : false,
 798       "example" : "",
 799       "deprecated" : "",
 800       "since" : "",
 801       "see" : "",
 802       "exceptions" : "",
 803       "requires" : "",
 804       "params" : [
 805         {
 806           "name" : "o",
 807           "type" : "Observable",
 808           "desc" : "The Observable to capture",
 809           "isOptional" : false
 810         },
 811         {
 812           "name" : "fn",
 813           "type" : "Function",
 814           "desc" : "The function to call",
 815           "isOptional" : false
 816         },
 817         {
 818           "name" : "scope",
 819           "type" : "Object",
 820           "desc" : "(optional) The scope (this object) for the fn",
 821           "isOptional" : false
 822         }
 823       ],
 824       "returns" : []
 825     },
 826     {
 827       "name" : "addListener",
 828       "type" : "function",
 829       "desc" : "Appends an event handler to this component",
 830       "sig" : "(eventName, handler, scope, options)",
 831       "static" : false,
 832       "memberOf" : "Roo.util.Observable",
 833       "isStatic" : false,
 834       "isConstructor" : false,
 835       "isPrivate" : false,
 836       "example" : "",
 837       "deprecated" : "",
 838       "since" : "",
 839       "see" : "",
 840       "exceptions" : "",
 841       "requires" : "",
 842       "params" : [
 843         {
 844           "name" : "eventName",
 845           "type" : "String",
 846           "desc" : "The type of event to listen for",
 847           "isOptional" : false
 848         },
 849         {
 850           "name" : "handler",
 851           "type" : "Function",
 852           "desc" : "The method the event invokes",
 853           "isOptional" : false
 854         },
 855         {
 856           "name" : "scope",
 857           "type" : "Object",
 858           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 859           "isOptional" : false
 860         },
 861         {
 862           "name" : "options",
 863           "type" : "Object",
 864           "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>",
 865           "isOptional" : false
 866         }
 867       ],
 868       "returns" : []
 869     }
 870   ],
 871   "events" : [
 872     {
 873       "name" : "render",
 874       "type" : "function",
 875       "desc" : "Fires when the button is rendered",
 876       "sig" : "function (_self)\n{\n\n}",
 877       "memberOf" : "Roo.Button",
 878       "example" : "",
 879       "deprecated" : "",
 880       "since" : "",
 881       "see" : "",
 882       "params" : [
 883         {
 884           "name" : "this",
 885           "type" : "Button",
 886           "desc" : "",
 887           "isOptional" : false
 888         }
 889       ],
 890       "returns" : []
 891     },
 892     {
 893       "name" : "click",
 894       "type" : "function",
 895       "desc" : "Fires when this button is clicked",
 896       "sig" : "function (_self, e)\n{\n\n}",
 897       "memberOf" : "Roo.Button",
 898       "example" : "",
 899       "deprecated" : "",
 900       "since" : "",
 901       "see" : "",
 902       "params" : [
 903         {
 904           "name" : "this",
 905           "type" : "Button",
 906           "desc" : "",
 907           "isOptional" : false
 908         },
 909         {
 910           "name" : "e",
 911           "type" : "EventObject",
 912           "desc" : "The click event",
 913           "isOptional" : false
 914         }
 915       ],
 916       "returns" : []
 917     },
 918     {
 919       "name" : "mouseover",
 920       "type" : "function",
 921       "desc" : "Fires when the mouse hovers over the button",
 922       "sig" : "function (_self, e)\n{\n\n}",
 923       "memberOf" : "Roo.Button",
 924       "example" : "",
 925       "deprecated" : "",
 926       "since" : "",
 927       "see" : "",
 928       "params" : [
 929         {
 930           "name" : "this",
 931           "type" : "Button",
 932           "desc" : "",
 933           "isOptional" : false
 934         },
 935         {
 936           "name" : "e",
 937           "type" : "Event",
 938           "desc" : "The event object",
 939           "isOptional" : false
 940         }
 941       ],
 942       "returns" : []
 943     },
 944     {
 945       "name" : "toggle",
 946       "type" : "function",
 947       "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
 948       "sig" : "function (_self, pressed)\n{\n\n}",
 949       "memberOf" : "Roo.Button",
 950       "example" : "",
 951       "deprecated" : "",
 952       "since" : "",
 953       "see" : "",
 954       "params" : [
 955         {
 956           "name" : "this",
 957           "type" : "Button",
 958           "desc" : "",
 959           "isOptional" : false
 960         },
 961         {
 962           "name" : "pressed",
 963           "type" : "Boolean",
 964           "desc" : "",
 965           "isOptional" : false
 966         }
 967       ],
 968       "returns" : []
 969     },
 970     {
 971       "name" : "mouseout",
 972       "type" : "function",
 973       "desc" : "Fires when the mouse exits the button",
 974       "sig" : "function (_self, e)\n{\n\n}",
 975       "memberOf" : "Roo.Button",
 976       "example" : "",
 977       "deprecated" : "",
 978       "since" : "",
 979       "see" : "",
 980       "params" : [
 981         {
 982           "name" : "this",
 983           "type" : "Button",
 984           "desc" : "",
 985           "isOptional" : false
 986         },
 987         {
 988           "name" : "e",
 989           "type" : "Event",
 990           "desc" : "The event object",
 991           "isOptional" : false
 992         }
 993       ],
 994       "returns" : []
 995     }
 996   ]
 997 }