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

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