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

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