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