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

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