git.roojs.org Git - roojs1/blob - docs2/symbols/Roo.bootstrap.TabGroup.json

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