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

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