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

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