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

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