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

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