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       "optvals" : []
  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       "optvals" : []
  48     },
  49     {
  50       "name" : "text",
  51       "type" : "String",
  52       "desc" : "The button text",
  53       "memberOf" : "Roo.Button",
  54       "isOptional" : false,
  55       "optvals" : []
  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       "optvals" : []
  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       "optvals" : []
  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       "optvals" : []
  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       "optvals" : []
  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       "optvals" : []
  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       "optvals" : []
 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       "optvals" : []
 112     },
 113     {
 114       "name" : "scope",
 115       "type" : "Object",
 116       "desc" : "The scope of the handler",
 117       "memberOf" : "Roo.Button",
 118       "isOptional" : false,
 119       "optvals" : []
 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       "optvals" : []
 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       "optvals" : []
 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       "optvals" : []
 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       "optvals" : []
 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       "optvals" : []
 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       "optvals" : []
 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       "optvals" : []
 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       "optvals" : []
 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       "optvals" : []
 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       "optvals" : []
 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       "optvals" : []
 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       "optvals" : []
 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       "optvals" : []
 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" : "setPressed",
 426       "type" : "function",
 427       "desc" : "Similar to toggle, but does not trigger event.",
 428       "sig" : "(state)",
 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" : "state",
 443           "type" : "Boolean",
 444           "desc" : "[required] Force a particular state",
 445           "isOptional" : false
 446         }
 447       ],
 448       "returns" : []
 449     },
 450     {
 451       "name" : "setVisible",
 452       "type" : "function",
 453       "desc" : "Convenience function for boolean show/hide",
 454       "sig" : "(visible)",
 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         {
 468           "name" : "visible",
 469           "type" : "Boolean",
 470           "desc" : "True to show, false to hide",
 471           "isOptional" : false
 472         }
 473       ],
 474       "returns" : []
 475     },
 476     {
 477       "name" : "getText",
 478       "type" : "function",
 479       "desc" : "Gets the text for this button",
 480       "sig" : "()\n{\n\n}",
 481       "static" : false,
 482       "memberOf" : "Roo.Button",
 483       "isStatic" : false,
 484       "isConstructor" : false,
 485       "isPrivate" : false,
 486       "example" : "",
 487       "deprecated" : "",
 488       "since" : "",
 489       "see" : "",
 490       "exceptions" : "",
 491       "requires" : "",
 492       "params" : [],
 493       "returns" : [
 494         {
 495           "name" : "",
 496           "type" : "String",
 497           "desc" : "The button text"
 498         }
 499       ]
 500     },
 501     {
 502       "name" : "setText",
 503       "type" : "function",
 504       "desc" : "Sets this button's text",
 505       "sig" : "(text)",
 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" : "text",
 520           "type" : "String",
 521           "desc" : "The button text",
 522           "isOptional" : false
 523         }
 524       ],
 525       "returns" : []
 526     },
 527     {
 528       "name" : "toggle",
 529       "type" : "function",
 530       "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
 531       "sig" : "(state)",
 532       "static" : false,
 533       "memberOf" : "Roo.Button",
 534       "isStatic" : false,
 535       "isConstructor" : false,
 536       "isPrivate" : false,
 537       "example" : "",
 538       "deprecated" : "",
 539       "since" : "",
 540       "see" : "",
 541       "exceptions" : "",
 542       "requires" : "",
 543       "params" : [
 544         {
 545           "name" : "state",
 546           "type" : "Boolean",
 547           "desc" : "(optional) Force a particular state",
 548           "isOptional" : false
 549         }
 550       ],
 551       "returns" : []
 552     },
 553     {
 554       "name" : "purgeListeners",
 555       "type" : "function",
 556       "desc" : "Removes all listeners for this object",
 557       "sig" : "()\n{\n\n}",
 558       "static" : false,
 559       "memberOf" : "Roo.util.Observable",
 560       "isStatic" : false,
 561       "isConstructor" : false,
 562       "isPrivate" : false,
 563       "example" : "",
 564       "deprecated" : "",
 565       "since" : "",
 566       "see" : "",
 567       "exceptions" : "",
 568       "requires" : "",
 569       "params" : [],
 570       "returns" : []
 571     },
 572     {
 573       "name" : "on",
 574       "type" : "function",
 575       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 576       "sig" : "(eventName, handler, scope, options)",
 577       "static" : false,
 578       "memberOf" : "Roo.util.Observable",
 579       "isStatic" : false,
 580       "isConstructor" : false,
 581       "isPrivate" : false,
 582       "example" : "",
 583       "deprecated" : "",
 584       "since" : "",
 585       "see" : "",
 586       "exceptions" : "",
 587       "requires" : "",
 588       "params" : [
 589         {
 590           "name" : "eventName",
 591           "type" : "String",
 592           "desc" : "The type of event to listen for",
 593           "isOptional" : false
 594         },
 595         {
 596           "name" : "handler",
 597           "type" : "Function",
 598           "desc" : "The method the event invokes",
 599           "isOptional" : false
 600         },
 601         {
 602           "name" : "scope",
 603           "type" : "Object",
 604           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 605           "isOptional" : false
 606         },
 607         {
 608           "name" : "options",
 609           "type" : "Object",
 610           "desc" : "(optional)",
 611           "isOptional" : false
 612         }
 613       ],
 614       "returns" : []
 615     },
 616     {
 617       "name" : "un",
 618       "type" : "function",
 619       "desc" : "Removes a listener (shorthand for removeListener)",
 620       "sig" : "(eventName, handler, scope)",
 621       "static" : false,
 622       "memberOf" : "Roo.util.Observable",
 623       "isStatic" : false,
 624       "isConstructor" : false,
 625       "isPrivate" : false,
 626       "example" : "",
 627       "deprecated" : "",
 628       "since" : "",
 629       "see" : "",
 630       "exceptions" : "",
 631       "requires" : "",
 632       "params" : [
 633         {
 634           "name" : "eventName",
 635           "type" : "String",
 636           "desc" : "The type of event to listen for",
 637           "isOptional" : false
 638         },
 639         {
 640           "name" : "handler",
 641           "type" : "Function",
 642           "desc" : "The handler to remove",
 643           "isOptional" : false
 644         },
 645         {
 646           "name" : "scope",
 647           "type" : "Object",
 648           "desc" : "(optional) The scope (this object) for the handler",
 649           "isOptional" : false
 650         }
 651       ],
 652       "returns" : []
 653     },
 654     {
 655       "name" : "addEvents",
 656       "type" : "function",
 657       "desc" : "Used to define events on this Observable",
 658       "sig" : "(object)",
 659       "static" : false,
 660       "memberOf" : "Roo.util.Observable",
 661       "isStatic" : false,
 662       "isConstructor" : false,
 663       "isPrivate" : false,
 664       "example" : "",
 665       "deprecated" : "",
 666       "since" : "",
 667       "see" : "",
 668       "exceptions" : "",
 669       "requires" : "",
 670       "params" : [
 671         {
 672           "name" : "object",
 673           "type" : "Object",
 674           "desc" : "The object with the events defined",
 675           "isOptional" : false
 676         }
 677       ],
 678       "returns" : []
 679     },
 680     {
 681       "name" : "releaseCapture",
 682       "type" : "function",
 683       "desc" : "Removes <b>all</b> added captures from the Observable.",
 684       "sig" : "(o)",
 685       "static" : true,
 686       "memberOf" : "Roo.util.Observable",
 687       "isStatic" : true,
 688       "isConstructor" : false,
 689       "isPrivate" : false,
 690       "example" : "",
 691       "deprecated" : "",
 692       "since" : "",
 693       "see" : "",
 694       "exceptions" : "",
 695       "requires" : "",
 696       "params" : [
 697         {
 698           "name" : "o",
 699           "type" : "Observable",
 700           "desc" : "The Observable to release",
 701           "isOptional" : false
 702         }
 703       ],
 704       "returns" : []
 705     },
 706     {
 707       "name" : "removeListener",
 708       "type" : "function",
 709       "desc" : "Removes a listener",
 710       "sig" : "(eventName, handler, scope)",
 711       "static" : false,
 712       "memberOf" : "Roo.util.Observable",
 713       "isStatic" : false,
 714       "isConstructor" : false,
 715       "isPrivate" : false,
 716       "example" : "",
 717       "deprecated" : "",
 718       "since" : "",
 719       "see" : "",
 720       "exceptions" : "",
 721       "requires" : "",
 722       "params" : [
 723         {
 724           "name" : "eventName",
 725           "type" : "String",
 726           "desc" : "The type of event to listen for",
 727           "isOptional" : false
 728         },
 729         {
 730           "name" : "handler",
 731           "type" : "Function",
 732           "desc" : "The handler to remove",
 733           "isOptional" : false
 734         },
 735         {
 736           "name" : "scope",
 737           "type" : "Object",
 738           "desc" : "(optional) The scope (this object) for the handler",
 739           "isOptional" : false
 740         }
 741       ],
 742       "returns" : []
 743     },
 744     {
 745       "name" : "fireEvent",
 746       "type" : "function",
 747       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 748       "sig" : "(eventName, args)",
 749       "static" : false,
 750       "memberOf" : "Roo.util.Observable",
 751       "isStatic" : false,
 752       "isConstructor" : false,
 753       "isPrivate" : false,
 754       "example" : "",
 755       "deprecated" : "",
 756       "since" : "",
 757       "see" : "",
 758       "exceptions" : "",
 759       "requires" : "",
 760       "params" : [
 761         {
 762           "name" : "eventName",
 763           "type" : "String",
 764           "desc" : "",
 765           "isOptional" : false
 766         },
 767         {
 768           "name" : "args",
 769           "type" : "Object...",
 770           "desc" : "Variable number of parameters are passed to handlers",
 771           "isOptional" : false
 772         }
 773       ],
 774       "returns" : [
 775         {
 776           "name" : "",
 777           "type" : "Boolean",
 778           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 779         }
 780       ]
 781     },
 782     {
 783       "name" : "hasListener",
 784       "type" : "function",
 785       "desc" : "Checks to see if this object has any listeners for a specified event",
 786       "sig" : "(eventName)",
 787       "static" : false,
 788       "memberOf" : "Roo.util.Observable",
 789       "isStatic" : false,
 790       "isConstructor" : false,
 791       "isPrivate" : false,
 792       "example" : "",
 793       "deprecated" : "",
 794       "since" : "",
 795       "see" : "",
 796       "exceptions" : "",
 797       "requires" : "",
 798       "params" : [
 799         {
 800           "name" : "eventName",
 801           "type" : "String",
 802           "desc" : "The name of the event to check for",
 803           "isOptional" : false
 804         }
 805       ],
 806       "returns" : [
 807         {
 808           "name" : "",
 809           "type" : "Boolean",
 810           "desc" : "True if the event is being listened for, else false"
 811         }
 812       ]
 813     },
 814     {
 815       "name" : "capture",
 816       "type" : "function",
 817       "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.",
 818       "sig" : "(o, fn, scope)",
 819       "static" : true,
 820       "memberOf" : "Roo.util.Observable",
 821       "isStatic" : true,
 822       "isConstructor" : false,
 823       "isPrivate" : false,
 824       "example" : "",
 825       "deprecated" : "",
 826       "since" : "",
 827       "see" : "",
 828       "exceptions" : "",
 829       "requires" : "",
 830       "params" : [
 831         {
 832           "name" : "o",
 833           "type" : "Observable",
 834           "desc" : "The Observable to capture",
 835           "isOptional" : false
 836         },
 837         {
 838           "name" : "fn",
 839           "type" : "Function",
 840           "desc" : "The function to call",
 841           "isOptional" : false
 842         },
 843         {
 844           "name" : "scope",
 845           "type" : "Object",
 846           "desc" : "(optional) The scope (this object) for the fn",
 847           "isOptional" : false
 848         }
 849       ],
 850       "returns" : []
 851     },
 852     {
 853       "name" : "addListener",
 854       "type" : "function",
 855       "desc" : "Appends an event handler to this component",
 856       "sig" : "(eventName, handler, scope, options)",
 857       "static" : false,
 858       "memberOf" : "Roo.util.Observable",
 859       "isStatic" : false,
 860       "isConstructor" : false,
 861       "isPrivate" : false,
 862       "example" : "",
 863       "deprecated" : "",
 864       "since" : "",
 865       "see" : "",
 866       "exceptions" : "",
 867       "requires" : "",
 868       "params" : [
 869         {
 870           "name" : "eventName",
 871           "type" : "String",
 872           "desc" : "The type of event to listen for",
 873           "isOptional" : false
 874         },
 875         {
 876           "name" : "handler",
 877           "type" : "Function",
 878           "desc" : "The method the event invokes",
 879           "isOptional" : false
 880         },
 881         {
 882           "name" : "scope",
 883           "type" : "Object",
 884           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 885           "isOptional" : false
 886         },
 887         {
 888           "name" : "options",
 889           "type" : "Object",
 890           "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>",
 891           "isOptional" : false
 892         }
 893       ],
 894       "returns" : []
 895     }
 896   ],
 897   "events" : [
 898     {
 899       "name" : "render",
 900       "type" : "function",
 901       "desc" : "Fires when the button is rendered",
 902       "sig" : "function (_self)\n{\n\n}",
 903       "memberOf" : "Roo.Button",
 904       "example" : "",
 905       "deprecated" : "",
 906       "since" : "",
 907       "see" : "",
 908       "params" : [
 909         {
 910           "name" : "this",
 911           "type" : "Button",
 912           "desc" : "",
 913           "isOptional" : false
 914         }
 915       ],
 916       "returns" : []
 917     },
 918     {
 919       "name" : "click",
 920       "type" : "function",
 921       "desc" : "Fires when this button is clicked",
 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" : "EventObject",
 938           "desc" : "The click event",
 939           "isOptional" : false
 940         }
 941       ],
 942       "returns" : []
 943     },
 944     {
 945       "name" : "mouseover",
 946       "type" : "function",
 947       "desc" : "Fires when the mouse hovers over the button",
 948       "sig" : "function (_self, e)\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" : "e",
 963           "type" : "Event",
 964           "desc" : "The event object",
 965           "isOptional" : false
 966         }
 967       ],
 968       "returns" : []
 969     },
 970     {
 971       "name" : "toggle",
 972       "type" : "function",
 973       "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
 974       "sig" : "function (_self, pressed)\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" : "pressed",
 989           "type" : "Boolean",
 990           "desc" : "",
 991           "isOptional" : false
 992         }
 993       ],
 994       "returns" : []
 995     },
 996     {
 997       "name" : "mouseout",
 998       "type" : "function",
 999       "desc" : "Fires when the mouse exits the button",
1000       "sig" : "function (_self, e)\n{\n\n}",
1001       "memberOf" : "Roo.Button",
1002       "example" : "",
1003       "deprecated" : "",
1004       "since" : "",
1005       "see" : "",
1006       "params" : [
1007         {
1008           "name" : "this",
1009           "type" : "Button",
1010           "desc" : "",
1011           "isOptional" : false
1012         },
1013         {
1014           "name" : "e",
1015           "type" : "Event",
1016           "desc" : "The event object",
1017           "isOptional" : false
1018         }
1019       ],
1020       "returns" : []
1021     }
1022   ]
1023 }