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

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