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