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

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