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

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