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