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

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