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