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

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