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

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