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