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