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