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