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

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