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