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

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