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