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