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