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