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

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