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

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