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