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

   1 {
   2   "name" : "Roo.bootstrap.BezierSignature",
   3   "augments" : [
   4     "Roo.bootstrap.Component",
   5     "Roo.Component",
   6     "Roo.util.Observable"
   7   ],
   8   "desc" : "Bootstrap BezierSignature class\nThis script refer to:\n   Title: Signature Pad\n   Author: szimek\n   Availability: https://github.com/szimek/signature_pad",
   9   "isSingleton" : false,
  10   "isStatic" : false,
  11   "isBuiltin" : false,
  12   "memberOf" : "BezierSignature",
  13   "example" : "",
  14   "deprecated" : "",
  15   "since" : "",
  16   "see" : "",
  17   "params" : [
  18     {
  19       "name" : "config",
  20       "type" : "Object",
  21       "desc" : "The config object",
  22       "isOptional" : false
  23     }
  24   ],
  25   "returns" : [],
  26   "config" : [
  27     {
  28       "name" : "Callback",
  29       "type" : "function",
  30       "desc" : "when stroke begin.",
  31       "memberOf" : "Roo.bootstrap.BezierSignature",
  32       "optvals" : []
  33     },
  34     {
  35       "name" : "listeners",
  36       "type" : "Object",
  37       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
  38       "memberOf" : "Roo.util.Observable",
  39       "optvals" : []
  40     },
  41     {
  42       "name" : "Radius",
  43       "type" : "float|function",
  44       "desc" : "of a single dot.",
  45       "memberOf" : "Roo.bootstrap.BezierSignature",
  46       "optvals" : []
  47     },
  48     {
  49       "name" : "canvas",
  50       "type" : "int",
  51       "desc" : "height",
  52       "memberOf" : "Roo.bootstrap.BezierSignature",
  53       "optvals" : []
  54     },
  55     {
  56       "name" : "Add",
  57       "type" : "integer",
  58       "desc" : "the next point only if the previous one is farther than x pixels. Defaults to 5.",
  59       "memberOf" : "Roo.bootstrap.BezierSignature",
  60       "optvals" : []
  61     },
  62     {
  63       "name" : "tooltip",
  64       "type" : "string",
  65       "desc" : "Text for the tooltip",
  66       "memberOf" : "Roo.bootstrap.Component",
  67       "optvals" : []
  68     },
  69     {
  70       "name" : "container_method",
  71       "type" : "string",
  72       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
  73       "memberOf" : "Roo.bootstrap.Component",
  74       "optvals" : []
  75     },
  76     {
  77       "name" : "visibilityEl",
  78       "type" : "string|object",
  79       "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
  80       "memberOf" : "Roo.bootstrap.Component",
  81       "optvals" : [
  82         "el",
  83         "parent"
  84       ]
  85     },
  86     {
  87       "name" : "Weight",
  88       "type" : "float",
  89       "desc" : "used to modify new velocity based on the previous velocity. Defaults to 0.7.",
  90       "memberOf" : "Roo.bootstrap.BezierSignature",
  91       "optvals" : []
  92     },
  93     {
  94       "name" : "can_build_overlaid",
  95       "type" : "Boolean",
  96       "desc" : "True if element can be rebuild from a HTML page",
  97       "memberOf" : "Roo.bootstrap.Component",
  98       "optvals" : []
  99     },
 100     {
 101       "name" : "hideMode",
 102       "type" : "String",
 103       "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
 104       "memberOf" : "Roo.Component",
 105       "optvals" : [
 106         "display",
 107         "visibility"
 108       ]
 109     },
 110     {
 111       "name" : "style",
 112       "type" : "String",
 113       "desc" : "any extra css",
 114       "memberOf" : "Roo.bootstrap.Component",
 115       "optvals" : []
 116     },
 117     {
 118       "name" : "allowDomMove",
 119       "type" : "Boolean",
 120       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 121       "memberOf" : "Roo.Component",
 122       "optvals" : []
 123     },
 124     {
 125       "name" : "Draw",
 126       "type" : "integer",
 127       "desc" : "the next point at most once per every x milliseconds. Set it to 0 to turn off throttling. Defaults to 16.",
 128       "memberOf" : "Roo.bootstrap.BezierSignature",
 129       "optvals" : []
 130     },
 131     {
 132       "name" : "cls",
 133       "type" : "String",
 134       "desc" : "css class",
 135       "memberOf" : "Roo.bootstrap.Component",
 136       "optvals" : []
 137     },
 138     {
 139       "name" : "Color",
 140       "type" : "string",
 141       "desc" : "used to draw the lines. Can be any color format accepted by context.fillStyle. Defaults to \"black\".",
 142       "memberOf" : "Roo.bootstrap.BezierSignature",
 143       "optvals" : []
 144     },
 145     {
 146       "name" : "xattr",
 147       "type" : "Object",
 148       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
 149       "memberOf" : "Roo.bootstrap.Component",
 150       "optvals" : []
 151     },
 152     {
 153       "name" : "actionMode",
 154       "type" : "String",
 155       "desc" : "which property holds the element that used for  hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
 156       "memberOf" : "Roo.Component",
 157       "optvals" : []
 158     },
 159     {
 160       "name" : "dataId",
 161       "type" : "string",
 162       "desc" : "cutomer id",
 163       "memberOf" : "Roo.bootstrap.Component",
 164       "optvals" : []
 165     },
 166     {
 167       "name" : "Minimum",
 168       "type" : "float",
 169       "desc" : "width of a line. Defaults to 0.5.",
 170       "memberOf" : "Roo.bootstrap.BezierSignature",
 171       "optvals" : []
 172     },
 173     {
 174       "name" : "Maximum",
 175       "type" : "float",
 176       "desc" : "width of a line. Defaults to 2.5.",
 177       "memberOf" : "Roo.bootstrap.BezierSignature",
 178       "optvals" : []
 179     },
 180     {
 181       "name" : "name",
 182       "type" : "string",
 183       "desc" : "Specifies name attribute",
 184       "memberOf" : "Roo.bootstrap.Component",
 185       "optvals" : []
 186     },
 187     {
 188       "name" : "disableClass",
 189       "type" : "String",
 190       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 191       "memberOf" : "Roo.Component",
 192       "optvals" : []
 193     }
 194   ],
 195   "methods" : [
 196     {
 197       "name" : "tooltipEl",
 198       "desc" : "Fetch the element to display the tooltip on.",
 199       "isStatic" : false,
 200       "isConstructor" : false,
 201       "isPrivate" : false,
 202       "memberOf" : "Roo.bootstrap.Component",
 203       "example" : "",
 204       "deprecated" : "",
 205       "since" : "",
 206       "see" : "",
 207       "params" : [],
 208       "returns" : [
 209         {
 210           "name" : "",
 211           "type" : "Roo.Element",
 212           "desc" : "defaults to this.el"
 213         }
 214       ]
 215     },
 216     {
 217       "name" : "hide",
 218       "desc" : "Hide a component - adds 'hidden' class",
 219       "isStatic" : false,
 220       "isConstructor" : false,
 221       "isPrivate" : false,
 222       "memberOf" : "Roo.bootstrap.Component",
 223       "example" : "",
 224       "deprecated" : "",
 225       "since" : "",
 226       "see" : "",
 227       "params" : [],
 228       "returns" : []
 229     },
 230     {
 231       "name" : "show",
 232       "desc" : "Show a component - removes 'hidden' class",
 233       "isStatic" : false,
 234       "isConstructor" : false,
 235       "isPrivate" : false,
 236       "memberOf" : "Roo.bootstrap.Component",
 237       "example" : "",
 238       "deprecated" : "",
 239       "since" : "",
 240       "see" : "",
 241       "params" : [],
 242       "returns" : []
 243     },
 244     {
 245       "name" : "setVisibilityEl",
 246       "desc" : "Set the element that will be used to show or hide",
 247       "isStatic" : false,
 248       "isConstructor" : false,
 249       "isPrivate" : false,
 250       "memberOf" : "Roo.bootstrap.Component",
 251       "example" : "",
 252       "deprecated" : "",
 253       "since" : "",
 254       "see" : "",
 255       "params" : [],
 256       "returns" : []
 257     },
 258     {
 259       "name" : "getVisibilityEl",
 260       "desc" : "Get the element that will be used to show or hide",
 261       "isStatic" : false,
 262       "isConstructor" : false,
 263       "isPrivate" : false,
 264       "memberOf" : "Roo.bootstrap.Component",
 265       "example" : "",
 266       "deprecated" : "",
 267       "since" : "",
 268       "see" : "",
 269       "params" : [],
 270       "returns" : []
 271     },
 272     {
 273       "name" : "initEvents",
 274       "desc" : "Initialize Events for the element",
 275       "isStatic" : false,
 276       "isConstructor" : false,
 277       "isPrivate" : false,
 278       "memberOf" : "Roo.bootstrap.Component",
 279       "example" : "",
 280       "deprecated" : "",
 281       "since" : "",
 282       "see" : "",
 283       "params" : [],
 284       "returns" : []
 285     },
 286     {
 287       "name" : "getChildContainer",
 288       "desc" : "Fetch the element to add children to",
 289       "isStatic" : false,
 290       "isConstructor" : false,
 291       "isPrivate" : false,
 292       "memberOf" : "Roo.bootstrap.Component",
 293       "example" : "",
 294       "deprecated" : "",
 295       "since" : "",
 296       "see" : "",
 297       "params" : [],
 298       "returns" : [
 299         {
 300           "name" : "",
 301           "type" : "Roo.Element",
 302           "desc" : "defaults to this.el"
 303         }
 304       ]
 305     },
 306     {
 307       "name" : "getId",
 308       "desc" : "Returns the id of this component.",
 309       "isStatic" : false,
 310       "isConstructor" : false,
 311       "isPrivate" : false,
 312       "memberOf" : "Roo.Component",
 313       "example" : "",
 314       "deprecated" : "",
 315       "since" : "",
 316       "see" : "",
 317       "params" : [],
 318       "returns" : [
 319         {
 320           "name" : "",
 321           "type" : "String",
 322           "desc" : ""
 323         }
 324       ]
 325     },
 326     {
 327       "name" : "render",
 328       "desc" : "If this is a lazy rendering component, render it to its container element.",
 329       "isStatic" : false,
 330       "isConstructor" : false,
 331       "isPrivate" : false,
 332       "memberOf" : "Roo.Component",
 333       "example" : "",
 334       "deprecated" : "",
 335       "since" : "",
 336       "see" : "",
 337       "params" : [
 338         {
 339           "name" : "container",
 340           "type" : "String/HTMLElement/Element",
 341           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 342           "isOptional" : false
 343         }
 344       ],
 345       "returns" : []
 346     },
 347     {
 348       "name" : "destroy",
 349       "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
 350       "isStatic" : false,
 351       "isConstructor" : false,
 352       "isPrivate" : false,
 353       "memberOf" : "Roo.Component",
 354       "example" : "",
 355       "deprecated" : "",
 356       "since" : "",
 357       "see" : "",
 358       "params" : [],
 359       "returns" : []
 360     },
 361     {
 362       "name" : "isVisible",
 363       "desc" : "Returns true if this component is visible.",
 364       "isStatic" : false,
 365       "isConstructor" : false,
 366       "isPrivate" : false,
 367       "memberOf" : "Roo.Component",
 368       "example" : "",
 369       "deprecated" : "",
 370       "since" : "",
 371       "see" : "",
 372       "params" : [],
 373       "returns" : []
 374     },
 375     {
 376       "name" : "setDisabled",
 377       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 378       "isStatic" : false,
 379       "isConstructor" : false,
 380       "isPrivate" : false,
 381       "memberOf" : "Roo.Component",
 382       "example" : "",
 383       "deprecated" : "",
 384       "since" : "",
 385       "see" : "",
 386       "params" : [
 387         {
 388           "name" : "disabled",
 389           "type" : "Boolean",
 390           "desc" : "",
 391           "isOptional" : false
 392         }
 393       ],
 394       "returns" : []
 395     },
 396     {
 397       "name" : "focus",
 398       "desc" : "Try to focus this component.",
 399       "isStatic" : false,
 400       "isConstructor" : false,
 401       "isPrivate" : false,
 402       "memberOf" : "Roo.Component",
 403       "example" : "",
 404       "deprecated" : "",
 405       "since" : "",
 406       "see" : "",
 407       "params" : [
 408         {
 409           "name" : "selectText",
 410           "type" : "Boolean",
 411           "desc" : "True to also select the text in this component (if applicable)",
 412           "isOptional" : false
 413         }
 414       ],
 415       "returns" : [
 416         {
 417           "name" : "",
 418           "type" : "Roo.Component",
 419           "desc" : "this"
 420         }
 421       ]
 422     },
 423     {
 424       "name" : "enable",
 425       "desc" : "Enable this component.",
 426       "isStatic" : false,
 427       "isConstructor" : false,
 428       "isPrivate" : false,
 429       "memberOf" : "Roo.Component",
 430       "example" : "",
 431       "deprecated" : "",
 432       "since" : "",
 433       "see" : "",
 434       "params" : [],
 435       "returns" : [
 436         {
 437           "name" : "",
 438           "type" : "Roo.Component",
 439           "desc" : "this"
 440         }
 441       ]
 442     },
 443     {
 444       "name" : "setVisible",
 445       "desc" : "Convenience function to hide or show this component by boolean.",
 446       "isStatic" : false,
 447       "isConstructor" : false,
 448       "isPrivate" : false,
 449       "memberOf" : "Roo.Component",
 450       "example" : "",
 451       "deprecated" : "",
 452       "since" : "",
 453       "see" : "",
 454       "params" : [
 455         {
 456           "name" : "visible",
 457           "type" : "Boolean",
 458           "desc" : "True to show, false to hide",
 459           "isOptional" : false
 460         }
 461       ],
 462       "returns" : [
 463         {
 464           "name" : "",
 465           "type" : "Roo.Component",
 466           "desc" : "this"
 467         }
 468       ]
 469     },
 470     {
 471       "name" : "disable",
 472       "desc" : "Disable this component.",
 473       "isStatic" : false,
 474       "isConstructor" : false,
 475       "isPrivate" : false,
 476       "memberOf" : "Roo.Component",
 477       "example" : "",
 478       "deprecated" : "",
 479       "since" : "",
 480       "see" : "",
 481       "params" : [],
 482       "returns" : [
 483         {
 484           "name" : "",
 485           "type" : "Roo.Component",
 486           "desc" : "this"
 487         }
 488       ]
 489     },
 490     {
 491       "name" : "getEl",
 492       "desc" : "Returns the underlying {@link Roo.Element}.",
 493       "isStatic" : false,
 494       "isConstructor" : false,
 495       "isPrivate" : false,
 496       "memberOf" : "Roo.Component",
 497       "example" : "",
 498       "deprecated" : "",
 499       "since" : "",
 500       "see" : "",
 501       "params" : [],
 502       "returns" : [
 503         {
 504           "name" : "",
 505           "type" : "Roo.Element",
 506           "desc" : "The element"
 507         }
 508       ]
 509     },
 510     {
 511       "name" : "purgeListeners",
 512       "desc" : "Removes all listeners for this object",
 513       "isStatic" : false,
 514       "isConstructor" : false,
 515       "isPrivate" : false,
 516       "memberOf" : "Roo.util.Observable",
 517       "example" : "",
 518       "deprecated" : "",
 519       "since" : "",
 520       "see" : "",
 521       "params" : [],
 522       "returns" : []
 523     },
 524     {
 525       "name" : "on",
 526       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 527       "isStatic" : false,
 528       "isConstructor" : false,
 529       "isPrivate" : false,
 530       "memberOf" : "Roo.util.Observable",
 531       "example" : "",
 532       "deprecated" : "",
 533       "since" : "",
 534       "see" : "",
 535       "params" : [
 536         {
 537           "name" : "eventName",
 538           "type" : "String",
 539           "desc" : "The type of event to listen for",
 540           "isOptional" : false
 541         },
 542         {
 543           "name" : "handler",
 544           "type" : "Function",
 545           "desc" : "The method the event invokes",
 546           "isOptional" : false
 547         },
 548         {
 549           "name" : "scope",
 550           "type" : "Object",
 551           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 552           "isOptional" : false
 553         },
 554         {
 555           "name" : "options",
 556           "type" : "Object",
 557           "desc" : "(optional)",
 558           "isOptional" : false
 559         }
 560       ],
 561       "returns" : []
 562     },
 563     {
 564       "name" : "un",
 565       "desc" : "Removes a listener (shorthand for removeListener)",
 566       "isStatic" : false,
 567       "isConstructor" : false,
 568       "isPrivate" : false,
 569       "memberOf" : "Roo.util.Observable",
 570       "example" : "",
 571       "deprecated" : "",
 572       "since" : "",
 573       "see" : "",
 574       "params" : [
 575         {
 576           "name" : "eventName",
 577           "type" : "String",
 578           "desc" : "The type of event to listen for",
 579           "isOptional" : false
 580         },
 581         {
 582           "name" : "handler",
 583           "type" : "Function",
 584           "desc" : "The handler to remove",
 585           "isOptional" : false
 586         },
 587         {
 588           "name" : "scope",
 589           "type" : "Object",
 590           "desc" : "(optional) The scope (this object) for the handler",
 591           "isOptional" : false
 592         }
 593       ],
 594       "returns" : []
 595     },
 596     {
 597       "name" : "addEvents",
 598       "desc" : "Used to define events on this Observable",
 599       "isStatic" : false,
 600       "isConstructor" : false,
 601       "isPrivate" : false,
 602       "memberOf" : "Roo.util.Observable",
 603       "example" : "",
 604       "deprecated" : "",
 605       "since" : "",
 606       "see" : "",
 607       "params" : [
 608         {
 609           "name" : "object",
 610           "type" : "Object",
 611           "desc" : "The object with the events defined",
 612           "isOptional" : false
 613         }
 614       ],
 615       "returns" : []
 616     },
 617     {
 618       "name" : "releaseCapture",
 619       "desc" : "Removes <b>all</b> added captures from the Observable.",
 620       "isStatic" : true,
 621       "isConstructor" : false,
 622       "isPrivate" : false,
 623       "memberOf" : "Roo.util.Observable",
 624       "example" : "",
 625       "deprecated" : "",
 626       "since" : "",
 627       "see" : "",
 628       "params" : [
 629         {
 630           "name" : "o",
 631           "type" : "Observable",
 632           "desc" : "The Observable to release",
 633           "isOptional" : false
 634         }
 635       ],
 636       "returns" : []
 637     },
 638     {
 639       "name" : "removeListener",
 640       "desc" : "Removes a listener",
 641       "isStatic" : false,
 642       "isConstructor" : false,
 643       "isPrivate" : false,
 644       "memberOf" : "Roo.util.Observable",
 645       "example" : "",
 646       "deprecated" : "",
 647       "since" : "",
 648       "see" : "",
 649       "params" : [
 650         {
 651           "name" : "eventName",
 652           "type" : "String",
 653           "desc" : "The type of event to listen for",
 654           "isOptional" : false
 655         },
 656         {
 657           "name" : "handler",
 658           "type" : "Function",
 659           "desc" : "The handler to remove",
 660           "isOptional" : false
 661         },
 662         {
 663           "name" : "scope",
 664           "type" : "Object",
 665           "desc" : "(optional) The scope (this object) for the handler",
 666           "isOptional" : false
 667         }
 668       ],
 669       "returns" : []
 670     },
 671     {
 672       "name" : "fireEvent",
 673       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 674       "isStatic" : false,
 675       "isConstructor" : false,
 676       "isPrivate" : false,
 677       "memberOf" : "Roo.util.Observable",
 678       "example" : "",
 679       "deprecated" : "",
 680       "since" : "",
 681       "see" : "",
 682       "params" : [
 683         {
 684           "name" : "eventName",
 685           "type" : "String",
 686           "desc" : "",
 687           "isOptional" : false
 688         },
 689         {
 690           "name" : "args",
 691           "type" : "Object...",
 692           "desc" : "Variable number of parameters are passed to handlers",
 693           "isOptional" : false
 694         }
 695       ],
 696       "returns" : [
 697         {
 698           "name" : "",
 699           "type" : "Boolean",
 700           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 701         }
 702       ]
 703     },
 704     {
 705       "name" : "hasListener",
 706       "desc" : "Checks to see if this object has any listeners for a specified event",
 707       "isStatic" : false,
 708       "isConstructor" : false,
 709       "isPrivate" : false,
 710       "memberOf" : "Roo.util.Observable",
 711       "example" : "",
 712       "deprecated" : "",
 713       "since" : "",
 714       "see" : "",
 715       "params" : [
 716         {
 717           "name" : "eventName",
 718           "type" : "String",
 719           "desc" : "The name of the event to check for",
 720           "isOptional" : false
 721         }
 722       ],
 723       "returns" : [
 724         {
 725           "name" : "",
 726           "type" : "Boolean",
 727           "desc" : "True if the event is being listened for, else false"
 728         }
 729       ]
 730     },
 731     {
 732       "name" : "capture",
 733       "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.",
 734       "isStatic" : true,
 735       "isConstructor" : false,
 736       "isPrivate" : false,
 737       "memberOf" : "Roo.util.Observable",
 738       "example" : "",
 739       "deprecated" : "",
 740       "since" : "",
 741       "see" : "",
 742       "params" : [
 743         {
 744           "name" : "o",
 745           "type" : "Observable",
 746           "desc" : "The Observable to capture",
 747           "isOptional" : false
 748         },
 749         {
 750           "name" : "fn",
 751           "type" : "Function",
 752           "desc" : "The function to call",
 753           "isOptional" : false
 754         },
 755         {
 756           "name" : "scope",
 757           "type" : "Object",
 758           "desc" : "(optional) The scope (this object) for the fn",
 759           "isOptional" : false
 760         }
 761       ],
 762       "returns" : []
 763     },
 764     {
 765       "name" : "addListener",
 766       "desc" : "Appends an event handler to this component",
 767       "isStatic" : false,
 768       "isConstructor" : false,
 769       "isPrivate" : false,
 770       "memberOf" : "Roo.util.Observable",
 771       "example" : "",
 772       "deprecated" : "",
 773       "since" : "",
 774       "see" : "",
 775       "params" : [
 776         {
 777           "name" : "eventName",
 778           "type" : "String",
 779           "desc" : "The type of event to listen for",
 780           "isOptional" : false
 781         },
 782         {
 783           "name" : "handler",
 784           "type" : "Function",
 785           "desc" : "The method the event invokes",
 786           "isOptional" : false
 787         },
 788         {
 789           "name" : "scope",
 790           "type" : "Object",
 791           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 792           "isOptional" : false
 793         },
 794         {
 795           "name" : "options",
 796           "type" : "Object",
 797           "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>",
 798           "isOptional" : false
 799         }
 800       ],
 801       "returns" : []
 802     }
 803   ],
 804   "events" : [
 805     {
 806       "name" : "childrenrendered",
 807       "desc" : "Fires when the children have been rendered..",
 808       "memberOf" : "Roo.bootstrap.Component",
 809       "example" : "",
 810       "deprecated" : "",
 811       "since" : "",
 812       "see" : "",
 813       "params" : [
 814         {
 815           "name" : "this",
 816           "type" : "Roo.bootstrap.Component",
 817           "desc" : "",
 818           "isOptional" : false
 819         }
 820       ],
 821       "returns" : []
 822     },
 823     {
 824       "name" : "beforerender",
 825       "desc" : "Fires before the component is rendered. Return false to stop the render.",
 826       "memberOf" : "Roo.Component",
 827       "example" : "",
 828       "deprecated" : "",
 829       "since" : "",
 830       "see" : "",
 831       "params" : [
 832         {
 833           "name" : "this",
 834           "type" : "Roo.Component",
 835           "desc" : "",
 836           "isOptional" : false
 837         }
 838       ],
 839       "returns" : []
 840     },
 841     {
 842       "name" : "disable",
 843       "desc" : "Fires after the component is disabled.",
 844       "memberOf" : "Roo.Component",
 845       "example" : "",
 846       "deprecated" : "",
 847       "since" : "",
 848       "see" : "",
 849       "params" : [
 850         {
 851           "name" : "this",
 852           "type" : "Roo.Component",
 853           "desc" : "",
 854           "isOptional" : false
 855         }
 856       ],
 857       "returns" : []
 858     },
 859     {
 860       "name" : "render",
 861       "desc" : "Fires after the component is rendered.",
 862       "memberOf" : "Roo.Component",
 863       "example" : "",
 864       "deprecated" : "",
 865       "since" : "",
 866       "see" : "",
 867       "params" : [
 868         {
 869           "name" : "this",
 870           "type" : "Roo.Component",
 871           "desc" : "",
 872           "isOptional" : false
 873         }
 874       ],
 875       "returns" : []
 876     },
 877     {
 878       "name" : "destroy",
 879       "desc" : "Fires after the component is destroyed.",
 880       "memberOf" : "Roo.Component",
 881       "example" : "",
 882       "deprecated" : "",
 883       "since" : "",
 884       "see" : "",
 885       "params" : [
 886         {
 887           "name" : "this",
 888           "type" : "Roo.Component",
 889           "desc" : "",
 890           "isOptional" : false
 891         }
 892       ],
 893       "returns" : []
 894     },
 895     {
 896       "name" : "hide",
 897       "desc" : "Fires after the component is hidden.",
 898       "memberOf" : "Roo.Component",
 899       "example" : "",
 900       "deprecated" : "",
 901       "since" : "",
 902       "see" : "",
 903       "params" : [
 904         {
 905           "name" : "this",
 906           "type" : "Roo.Component",
 907           "desc" : "",
 908           "isOptional" : false
 909         }
 910       ],
 911       "returns" : []
 912     },
 913     {
 914       "name" : "beforehide",
 915       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
 916       "memberOf" : "Roo.Component",
 917       "example" : "",
 918       "deprecated" : "",
 919       "since" : "",
 920       "see" : "",
 921       "params" : [
 922         {
 923           "name" : "this",
 924           "type" : "Roo.Component",
 925           "desc" : "",
 926           "isOptional" : false
 927         }
 928       ],
 929       "returns" : []
 930     },
 931     {
 932       "name" : "show",
 933       "desc" : "Fires after the component is shown.",
 934       "memberOf" : "Roo.Component",
 935       "example" : "",
 936       "deprecated" : "",
 937       "since" : "",
 938       "see" : "",
 939       "params" : [
 940         {
 941           "name" : "this",
 942           "type" : "Roo.Component",
 943           "desc" : "",
 944           "isOptional" : false
 945         }
 946       ],
 947       "returns" : []
 948     },
 949     {
 950       "name" : "beforeshow",
 951       "desc" : "Fires before the component is shown.  Return false to stop the show.",
 952       "memberOf" : "Roo.Component",
 953       "example" : "",
 954       "deprecated" : "",
 955       "since" : "",
 956       "see" : "",
 957       "params" : [
 958         {
 959           "name" : "this",
 960           "type" : "Roo.Component",
 961           "desc" : "",
 962           "isOptional" : false
 963         }
 964       ],
 965       "returns" : []
 966     },
 967     {
 968       "name" : "enable",
 969       "desc" : "Fires after the component is enabled.",
 970       "memberOf" : "Roo.Component",
 971       "example" : "",
 972       "deprecated" : "",
 973       "since" : "",
 974       "see" : "",
 975       "params" : [
 976         {
 977           "name" : "this",
 978           "type" : "Roo.Component",
 979           "desc" : "",
 980           "isOptional" : false
 981         }
 982       ],
 983       "returns" : []
 984     },
 985     {
 986       "name" : "beforedestroy",
 987       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
 988       "memberOf" : "Roo.Component",
 989       "example" : "",
 990       "deprecated" : "",
 991       "since" : "",
 992       "see" : "",
 993       "params" : [
 994         {
 995           "name" : "this",
 996           "type" : "Roo.Component",
 997           "desc" : "",
 998           "isOptional" : false
 999         }
1000       ],
1001       "returns" : []
1002     }
1003   ]
1004 }