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

   1 {
   2   "name" : "Roo.bootstrap.form.TriggerField",
   3   "augments" : [
   4     "Roo.bootstrap.form.Input",
   5     "Roo.bootstrap.Component",
   6     "Roo.Component",
   7     "Roo.util.Observable"
   8   ],
   9   "childClasses" : {
  10     "Roo.bootstrap.form.TriggerField" : [
  11       "Roo.bootstrap.form.ComboBox",
  12       "Roo.bootstrap.form.PhoneInput"
  13     ],
  14     "Roo.bootstrap.form.ComboBox" : [
  15       "Roo.bootstrap.form.MoneyField"
  16     ]
  17   },
  18   "tree_children" : [],
  19   "tree_parent" : [],
  20   "desc" : "Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default).\nThe trigger has no default action, so you must assign a function to implement the trigger click handler by\noverriding {@link #onTriggerClick}. You can create a TriggerField directly, as it renders exactly like a combobox\nfor which you can provide a custom implementation.  For example:\n<pre><code>\nvar trigger = new Roo.bootstrap.form.TriggerField();\ntrigger.onTriggerClick = myTriggerFn;\ntrigger.applyTo('my-field');\n</code></pre>\n\nHowever, in general you will most likely want to use TriggerField as the base class for a reusable component.\n{@link Roo.bootstrap.form.DateField} and {@link Roo.bootstrap.form.ComboBox} are perfect examples of this.",
  21   "isSingleton" : false,
  22   "isStatic" : true,
  23   "isBuiltin" : false,
  24   "isAbstract" : false,
  25   "isBuilderTop" : false,
  26   "memberOf" : "TriggerField",
  27   "example" : "",
  28   "deprecated" : "",
  29   "since" : "",
  30   "see" : "",
  31   "params" : [
  32     {
  33       "name" : "config",
  34       "type" : "Object",
  35       "desc" : "Configuration options (valid {@Roo.bootstrap.form.Input} config options will also be applied\nto the base TextField)",
  36       "isOptional" : false
  37     }
  38   ],
  39   "returns" : [],
  40   "throws" : "",
  41   "requires" : "",
  42   "config" : [
  43     {
  44       "name" : "triggerClass",
  45       "type" : "String",
  46       "desc" : "An additional CSS class used to style the trigger button.  The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
  47       "memberOf" : ""
  48     },
  49     {
  50       "name" : "validFeedbackIcon",
  51       "type" : "String",
  52       "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
  53       "memberOf" : "Roo.bootstrap.form.Input"
  54     },
  55     {
  56       "name" : "lg",
  57       "type" : "Number",
  58       "desc" : "colspan out of 12 for large computer-sized screens",
  59       "memberOf" : "Roo.bootstrap.form.Input"
  60     },
  61     {
  62       "name" : "accept",
  63       "type" : "String",
  64       "desc" : "o) use for file input only. (default empty)",
  65       "memberOf" : "Roo.bootstrap.form.Input"
  66     },
  67     {
  68       "name" : "afterButton",
  69       "type" : "Roo.bootstrap.Button",
  70       "desc" : "to show before",
  71       "memberOf" : "Roo.bootstrap.form.Input"
  72     },
  73     {
  74       "name" : "xs",
  75       "type" : "Number",
  76       "desc" : "colspan out of 12 for mobile-sized screens",
  77       "memberOf" : "Roo.bootstrap.form.Input"
  78     },
  79     {
  80       "name" : "hideMode",
  81       "type" : "String",
  82       "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\".",
  83       "memberOf" : "Roo.Component"
  84     },
  85     {
  86       "name" : "disableKeyFilter",
  87       "type" : "Boolean",
  88       "desc" : "True to disable input keystroke filtering (defaults to false)",
  89       "memberOf" : "Roo.bootstrap.form.Input"
  90     },
  91     {
  92       "name" : "xattr",
  93       "type" : "Object",
  94       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
  95       "memberOf" : "Roo.bootstrap.Component"
  96     },
  97     {
  98       "name" : "disabled",
  99       "type" : "Boolean",
 100       "desc" : "is it disabled",
 101       "memberOf" : "Roo.bootstrap.form.Input"
 102     },
 103     {
 104       "name" : "validator",
 105       "type" : "Function",
 106       "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
 107       "memberOf" : "Roo.bootstrap.form.Input"
 108     },
 109     {
 110       "name" : "name",
 111       "type" : "String",
 112       "desc" : "name of the input",
 113       "memberOf" : "Roo.bootstrap.form.Input"
 114     },
 115     {
 116       "name" : "autocomplete",
 117       "type" : "String",
 118       "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
 119       "memberOf" : "Roo.bootstrap.form.Input"
 120     },
 121     {
 122       "name" : "tooltip",
 123       "type" : "string",
 124       "desc" : "Text for the tooltip",
 125       "memberOf" : "Roo.bootstrap.Component"
 126     },
 127     {
 128       "name" : "labelAlign",
 129       "type" : "String",
 130       "desc" : "t)",
 131       "memberOf" : "Roo.bootstrap.form.Input"
 132     },
 133     {
 134       "name" : "regexText",
 135       "type" : "String",
 136       "desc" : "-- Depricated - use Invalid Text",
 137       "memberOf" : "Roo.bootstrap.form.Input"
 138     },
 139     {
 140       "name" : "allowDomMove",
 141       "type" : "Boolean",
 142       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 143       "memberOf" : "Roo.Component"
 144     },
 145     {
 146       "name" : "style",
 147       "type" : "String",
 148       "desc" : "any extra css",
 149       "memberOf" : "Roo.bootstrap.Component"
 150     },
 151     {
 152       "name" : "labelmd",
 153       "type" : "Number",
 154       "desc" : "set the width of label (1-12)",
 155       "memberOf" : "Roo.bootstrap.form.Input"
 156     },
 157     {
 158       "name" : "value",
 159       "type" : "string",
 160       "desc" : "default value of the input",
 161       "memberOf" : "Roo.bootstrap.form.Input"
 162     },
 163     {
 164       "name" : "hasFeedback",
 165       "type" : "Boolean",
 166       "desc" : "e) default true",
 167       "memberOf" : "Roo.bootstrap.form.Input"
 168     },
 169     {
 170       "name" : "actionMode",
 171       "type" : "String",
 172       "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",
 173       "memberOf" : "Roo.Component"
 174     },
 175     {
 176       "name" : "sm",
 177       "type" : "Number",
 178       "desc" : "colspan out of 12 for tablet-sized screens",
 179       "memberOf" : "Roo.bootstrap.form.Input"
 180     },
 181     {
 182       "name" : "minLengthText",
 183       "type" : "String",
 184       "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
 185       "memberOf" : "Roo.bootstrap.form.Input"
 186     },
 187     {
 188       "name" : "maxLengthText",
 189       "type" : "String",
 190       "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
 191       "memberOf" : "Roo.bootstrap.form.Input"
 192     },
 193     {
 194       "name" : "listeners",
 195       "type" : "Object",
 196       "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>",
 197       "memberOf" : "Roo.util.Observable"
 198     },
 199     {
 200       "name" : "container_method",
 201       "type" : "string",
 202       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
 203       "memberOf" : "Roo.bootstrap.Component"
 204     },
 205     {
 206       "name" : "readOnly",
 207       "type" : "Boolean",
 208       "desc" : "Specifies that the field should be read-only",
 209       "memberOf" : "Roo.bootstrap.form.Input"
 210     },
 211     {
 212       "name" : "indicatorpos",
 213       "type" : "String",
 214       "desc" : "t) default left",
 215       "memberOf" : "Roo.bootstrap.form.Input"
 216     },
 217     {
 218       "name" : "align",
 219       "type" : "String",
 220       "desc" : "t) Default left",
 221       "memberOf" : "Roo.bootstrap.form.Input"
 222     },
 223     {
 224       "name" : "size",
 225       "type" : "string",
 226       "desc" : "- (lg|sm) or leave empty..",
 227       "memberOf" : "Roo.bootstrap.form.Input"
 228     },
 229     {
 230       "name" : "labellg",
 231       "type" : "Number",
 232       "desc" : "set the width of label (1-12)",
 233       "memberOf" : "Roo.bootstrap.form.Input"
 234     },
 235     {
 236       "name" : "focusClass",
 237       "type" : "String",
 238       "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
 239       "memberOf" : "Roo.bootstrap.form.Input"
 240     },
 241     {
 242       "name" : "hideTrigger",
 243       "type" : "Boolean",
 244       "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
 245       "memberOf" : ""
 246     },
 247     {
 248       "name" : "removable",
 249       "type" : "Boolean",
 250       "desc" : "e) special filter default false",
 251       "memberOf" : ""
 252     },
 253     {
 254       "name" : "labelxs",
 255       "type" : "Number",
 256       "desc" : "set the width of label (1-12)",
 257       "memberOf" : "Roo.bootstrap.form.Input"
 258     },
 259     {
 260       "name" : "validateOnBlur",
 261       "type" : "Boolean",
 262       "desc" : "Whether the field should validate when it loses focus (defaults to true).",
 263       "memberOf" : "Roo.bootstrap.form.Input"
 264     },
 265     {
 266       "name" : "cls",
 267       "type" : "String",
 268       "desc" : "css class",
 269       "memberOf" : "Roo.bootstrap.Component"
 270     },
 271     {
 272       "name" : "caret",
 273       "type" : "String",
 274       "desc" : "r) BS3 only - carat fa name",
 275       "memberOf" : ""
 276     },
 277     {
 278       "name" : "inputType",
 279       "type" : "String",
 280       "desc" : "t)",
 281       "memberOf" : "Roo.bootstrap.form.Input"
 282     },
 283     {
 284       "name" : "validationEvent",
 285       "type" : "String/Boolean",
 286       "desc" : "The event that should initiate field validation. Set to false to disable\n      automatic validation (defaults to \"keyup\").",
 287       "memberOf" : "Roo.bootstrap.form.Input"
 288     },
 289     {
 290       "name" : "invalidClass",
 291       "type" : "String",
 292       "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
 293       "memberOf" : "Roo.bootstrap.form.Input"
 294     },
 295     {
 296       "name" : "maskRe",
 297       "type" : "String",
 298       "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
 299       "memberOf" : "Roo.bootstrap.form.Input"
 300     },
 301     {
 302       "name" : "vtype",
 303       "type" : "String",
 304       "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
 305       "memberOf" : "Roo.bootstrap.form.Input"
 306     },
 307     {
 308       "name" : "fieldLabel",
 309       "type" : "string",
 310       "desc" : "- the label associated",
 311       "memberOf" : "Roo.bootstrap.form.Input"
 312     },
 313     {
 314       "name" : "can_build_overlaid",
 315       "type" : "Boolean",
 316       "desc" : "True if element can be rebuild from a HTML page",
 317       "memberOf" : "Roo.bootstrap.Component"
 318     },
 319     {
 320       "name" : "before",
 321       "type" : "string",
 322       "desc" : "- input group add on before",
 323       "memberOf" : "Roo.bootstrap.form.Input"
 324     },
 325     {
 326       "name" : "selectOnFocus",
 327       "type" : "Boolean",
 328       "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
 329       "memberOf" : "Roo.bootstrap.form.Input"
 330     },
 331     {
 332       "name" : "validationDelay",
 333       "type" : "Number",
 334       "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
 335       "memberOf" : "Roo.bootstrap.form.Input"
 336     },
 337     {
 338       "name" : "blankText",
 339       "type" : "String",
 340       "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
 341       "memberOf" : "Roo.bootstrap.form.Input"
 342     },
 343     {
 344       "name" : "disableClass",
 345       "type" : "String",
 346       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 347       "memberOf" : "Roo.Component"
 348     },
 349     {
 350       "name" : "invalidFeedbackIcon",
 351       "type" : "String",
 352       "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
 353       "memberOf" : "Roo.bootstrap.form.Input"
 354     },
 355     {
 356       "name" : "visibilityEl",
 357       "type" : "string|object",
 358       "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
 359       "memberOf" : "Roo.bootstrap.Component"
 360     },
 361     {
 362       "name" : "placeholder",
 363       "type" : "string",
 364       "desc" : "- placeholder to put in text.",
 365       "memberOf" : "Roo.bootstrap.form.Input"
 366     },
 367     {
 368       "name" : "dataId",
 369       "type" : "string",
 370       "desc" : "cutomer id",
 371       "memberOf" : "Roo.bootstrap.Component"
 372     },
 373     {
 374       "name" : "md",
 375       "type" : "Number",
 376       "desc" : "colspan out of 12 for computer-sized screens",
 377       "memberOf" : "Roo.bootstrap.form.Input"
 378     },
 379     {
 380       "name" : "regex",
 381       "type" : "RegExp",
 382       "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value.  If the test fails, the field will be marked invalid using {@link #regexText}.",
 383       "memberOf" : "Roo.bootstrap.form.Input"
 384     },
 385     {
 386       "name" : "labelWidth",
 387       "type" : "Number",
 388       "desc" : "set the width of label",
 389       "memberOf" : "Roo.bootstrap.form.Input"
 390     },
 391     {
 392       "name" : "minLength",
 393       "type" : "Number",
 394       "desc" : "Minimum input field length required (defaults to 0)",
 395       "memberOf" : "Roo.bootstrap.form.Input"
 396     },
 397     {
 398       "name" : "capture",
 399       "type" : "String",
 400       "desc" : "a) use for file input only. (default empty)",
 401       "memberOf" : "Roo.bootstrap.form.Input"
 402     },
 403     {
 404       "name" : "validClass",
 405       "type" : "String",
 406       "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
 407       "memberOf" : "Roo.bootstrap.form.Input"
 408     },
 409     {
 410       "name" : "allowBlank",
 411       "type" : "Boolean",
 412       "desc" : "False to validate that the value length > 0 (defaults to true)",
 413       "memberOf" : "Roo.bootstrap.form.Input"
 414     },
 415     {
 416       "name" : "preventMark",
 417       "type" : "Boolean",
 418       "desc" : "Do not show tick or cross if error/success",
 419       "memberOf" : "Roo.bootstrap.form.Input"
 420     },
 421     {
 422       "name" : "forceFeedback",
 423       "type" : "Boolean",
 424       "desc" : "e) Default false",
 425       "memberOf" : "Roo.bootstrap.form.Input"
 426     },
 427     {
 428       "name" : "labelsm",
 429       "type" : "Number",
 430       "desc" : "set the width of label (1-12)",
 431       "memberOf" : "Roo.bootstrap.form.Input"
 432     },
 433     {
 434       "name" : "after",
 435       "type" : "string",
 436       "desc" : "- input group add on after",
 437       "memberOf" : "Roo.bootstrap.form.Input"
 438     },
 439     {
 440       "name" : "maxLength",
 441       "type" : "Number",
 442       "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
 443       "memberOf" : "Roo.bootstrap.form.Input"
 444     },
 445     {
 446       "name" : "invalidText",
 447       "type" : "String",
 448       "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
 449       "memberOf" : "Roo.bootstrap.form.Input"
 450     }
 451   ],
 452   "methods" : [
 453     {
 454       "name" : "onTriggerClick",
 455       "type" : "function",
 456       "desc" : "The function that should handle the trigger's click event.  This method does nothing by default until overridden\nby an implementing function.",
 457       "sig" : "(e)",
 458       "static" : false,
 459       "memberOf" : "",
 460       "isStatic" : false,
 461       "isConstructor" : false,
 462       "isPrivate" : false,
 463       "example" : "",
 464       "deprecated" : "",
 465       "since" : "",
 466       "see" : "",
 467       "exceptions" : "",
 468       "requires" : "",
 469       "params" : [
 470         {
 471           "name" : "e",
 472           "type" : "EventObject",
 473           "desc" : "",
 474           "isOptional" : false
 475         }
 476       ],
 477       "returns" : []
 478     },
 479     {
 480       "name" : "autoSize",
 481       "type" : "function",
 482       "desc" : "",
 483       "sig" : "()\n{\n\n}",
 484       "static" : false,
 485       "memberOf" : "",
 486       "isStatic" : false,
 487       "isConstructor" : false,
 488       "isPrivate" : false,
 489       "example" : "",
 490       "deprecated" : "",
 491       "since" : "",
 492       "see" : "",
 493       "exceptions" : "",
 494       "requires" : "",
 495       "params" : [],
 496       "returns" : []
 497     },
 498     {
 499       "name" : "setRawValue",
 500       "type" : "function",
 501       "desc" : "Sets the underlying DOM field's value directly, bypassing validation.  To set the value with validation see {@link #setValue}.",
 502       "sig" : "(value)",
 503       "static" : false,
 504       "memberOf" : "Roo.bootstrap.form.Input",
 505       "isStatic" : false,
 506       "isConstructor" : false,
 507       "isPrivate" : false,
 508       "example" : "",
 509       "deprecated" : "",
 510       "since" : "",
 511       "see" : "",
 512       "exceptions" : "",
 513       "requires" : "",
 514       "params" : [
 515         {
 516           "name" : "value",
 517           "type" : "Mixed",
 518           "desc" : "The value to set",
 519           "isOptional" : false
 520         }
 521       ],
 522       "returns" : []
 523     },
 524     {
 525       "name" : "getValue",
 526       "type" : "function",
 527       "desc" : "Returns the normalized data value (undefined or emptyText will be returned as '').  To return the raw value see {@link #getRawValue}.",
 528       "sig" : "()\n{\n\n}",
 529       "static" : false,
 530       "memberOf" : "Roo.bootstrap.form.Input",
 531       "isStatic" : false,
 532       "isConstructor" : false,
 533       "isPrivate" : false,
 534       "example" : "",
 535       "deprecated" : "",
 536       "since" : "",
 537       "see" : "",
 538       "exceptions" : "",
 539       "requires" : "",
 540       "params" : [],
 541       "returns" : [
 542         {
 543           "name" : "",
 544           "type" : "Mixed",
 545           "desc" : "value The field value"
 546         }
 547       ]
 548     },
 549     {
 550       "name" : "markInvalid",
 551       "type" : "function",
 552       "desc" : "Mark this field as invalid",
 553       "sig" : "(msg)",
 554       "static" : false,
 555       "memberOf" : "Roo.bootstrap.form.Input",
 556       "isStatic" : false,
 557       "isConstructor" : false,
 558       "isPrivate" : false,
 559       "example" : "",
 560       "deprecated" : "",
 561       "since" : "",
 562       "see" : "",
 563       "exceptions" : "",
 564       "requires" : "",
 565       "params" : [
 566         {
 567           "name" : "msg",
 568           "type" : "String",
 569           "desc" : "The validation message",
 570           "isOptional" : false
 571         }
 572       ],
 573       "returns" : []
 574     },
 575     {
 576       "name" : "getRawValue",
 577       "type" : "function",
 578       "desc" : "Returns the raw data value which may or may not be a valid, defined value.  To return a normalized value see {@link #getValue}.",
 579       "sig" : "()\n{\n\n}",
 580       "static" : false,
 581       "memberOf" : "Roo.bootstrap.form.Input",
 582       "isStatic" : false,
 583       "isConstructor" : false,
 584       "isPrivate" : false,
 585       "example" : "",
 586       "deprecated" : "",
 587       "since" : "",
 588       "see" : "",
 589       "exceptions" : "",
 590       "requires" : "",
 591       "params" : [],
 592       "returns" : [
 593         {
 594           "name" : "",
 595           "type" : "Mixed",
 596           "desc" : "value The field value"
 597         }
 598       ]
 599     },
 600     {
 601       "name" : "setValue",
 602       "type" : "function",
 603       "desc" : "Sets a data value into the field and validates it.  To set the value directly without validation see {@link #setRawValue}.",
 604       "sig" : "(value)",
 605       "static" : false,
 606       "memberOf" : "Roo.bootstrap.form.Input",
 607       "isStatic" : false,
 608       "isConstructor" : false,
 609       "isPrivate" : false,
 610       "example" : "",
 611       "deprecated" : "",
 612       "since" : "",
 613       "see" : "",
 614       "exceptions" : "",
 615       "requires" : "",
 616       "params" : [
 617         {
 618           "name" : "value",
 619           "type" : "Mixed",
 620           "desc" : "The value to set",
 621           "isOptional" : false
 622         }
 623       ],
 624       "returns" : []
 625     },
 626     {
 627       "name" : "reset",
 628       "type" : "function",
 629       "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
 630       "sig" : "()\n{\n\n}",
 631       "static" : false,
 632       "memberOf" : "Roo.bootstrap.form.Input",
 633       "isStatic" : false,
 634       "isConstructor" : false,
 635       "isPrivate" : false,
 636       "example" : "",
 637       "deprecated" : "",
 638       "since" : "",
 639       "see" : "",
 640       "exceptions" : "",
 641       "requires" : "",
 642       "params" : [],
 643       "returns" : []
 644     },
 645     {
 646       "name" : "validate",
 647       "type" : "function",
 648       "desc" : "Validates the field value",
 649       "sig" : "()\n{\n\n}",
 650       "static" : false,
 651       "memberOf" : "Roo.bootstrap.form.Input",
 652       "isStatic" : false,
 653       "isConstructor" : false,
 654       "isPrivate" : false,
 655       "example" : "",
 656       "deprecated" : "",
 657       "since" : "",
 658       "see" : "",
 659       "exceptions" : "",
 660       "requires" : "",
 661       "params" : [],
 662       "returns" : [
 663         {
 664           "name" : "",
 665           "type" : "Boolean",
 666           "desc" : "True if the value is valid, else false"
 667         }
 668       ]
 669     },
 670     {
 671       "name" : "getName",
 672       "type" : "function",
 673       "desc" : "Returns the name of the field",
 674       "sig" : "()\n{\n\n}",
 675       "static" : false,
 676       "memberOf" : "Roo.bootstrap.form.Input",
 677       "isStatic" : false,
 678       "isConstructor" : false,
 679       "isPrivate" : false,
 680       "example" : "",
 681       "deprecated" : "",
 682       "since" : "",
 683       "see" : "",
 684       "exceptions" : "",
 685       "requires" : "",
 686       "params" : [],
 687       "returns" : [
 688         {
 689           "name" : "",
 690           "type" : "Mixed",
 691           "desc" : "name The name field"
 692         }
 693       ]
 694     },
 695     {
 696       "name" : "clearInvalid",
 697       "type" : "function",
 698       "desc" : "Clear any invalid styles/messages for this field",
 699       "sig" : "()\n{\n\n}",
 700       "static" : false,
 701       "memberOf" : "Roo.bootstrap.form.Input",
 702       "isStatic" : false,
 703       "isConstructor" : false,
 704       "isPrivate" : false,
 705       "example" : "",
 706       "deprecated" : "",
 707       "since" : "",
 708       "see" : "",
 709       "exceptions" : "",
 710       "requires" : "",
 711       "params" : [],
 712       "returns" : []
 713     },
 714     {
 715       "name" : "markValid",
 716       "type" : "function",
 717       "desc" : "Mark this field as valid",
 718       "sig" : "()\n{\n\n}",
 719       "static" : false,
 720       "memberOf" : "Roo.bootstrap.form.Input",
 721       "isStatic" : false,
 722       "isConstructor" : false,
 723       "isPrivate" : false,
 724       "example" : "",
 725       "deprecated" : "",
 726       "since" : "",
 727       "see" : "",
 728       "exceptions" : "",
 729       "requires" : "",
 730       "params" : [],
 731       "returns" : []
 732     },
 733     {
 734       "name" : "inputEl",
 735       "type" : "function",
 736       "desc" : "return the real input element.",
 737       "sig" : "()\n{\n\n}",
 738       "static" : false,
 739       "memberOf" : "Roo.bootstrap.form.Input",
 740       "isStatic" : false,
 741       "isConstructor" : false,
 742       "isPrivate" : false,
 743       "example" : "",
 744       "deprecated" : "",
 745       "since" : "",
 746       "see" : "",
 747       "exceptions" : "",
 748       "requires" : "",
 749       "params" : [],
 750       "returns" : []
 751     },
 752     {
 753       "name" : "validateValue",
 754       "type" : "function",
 755       "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
 756       "sig" : "(value)",
 757       "static" : false,
 758       "memberOf" : "Roo.bootstrap.form.Input",
 759       "isStatic" : false,
 760       "isConstructor" : false,
 761       "isPrivate" : false,
 762       "example" : "",
 763       "deprecated" : "",
 764       "since" : "",
 765       "see" : "",
 766       "exceptions" : "",
 767       "requires" : "",
 768       "params" : [
 769         {
 770           "name" : "value",
 771           "type" : "Mixed",
 772           "desc" : "The value to validate",
 773           "isOptional" : false
 774         }
 775       ],
 776       "returns" : [
 777         {
 778           "name" : "",
 779           "type" : "Boolean",
 780           "desc" : "True if the value is valid, else false"
 781         }
 782       ]
 783     },
 784     {
 785       "name" : "tooltipEl",
 786       "type" : "function",
 787       "desc" : "Fetch the element to display the tooltip on.",
 788       "sig" : "()\n{\n\n}",
 789       "static" : false,
 790       "memberOf" : "Roo.bootstrap.Component",
 791       "isStatic" : false,
 792       "isConstructor" : false,
 793       "isPrivate" : false,
 794       "example" : "",
 795       "deprecated" : "",
 796       "since" : "",
 797       "see" : "",
 798       "exceptions" : "",
 799       "requires" : "",
 800       "params" : [],
 801       "returns" : [
 802         {
 803           "name" : "",
 804           "type" : "Roo.Element",
 805           "desc" : "defaults to this.el"
 806         }
 807       ]
 808     },
 809     {
 810       "name" : "hide",
 811       "type" : "function",
 812       "desc" : "Hide a component - adds 'hidden' class",
 813       "sig" : "()\n{\n\n}",
 814       "static" : false,
 815       "memberOf" : "Roo.bootstrap.Component",
 816       "isStatic" : false,
 817       "isConstructor" : false,
 818       "isPrivate" : false,
 819       "example" : "",
 820       "deprecated" : "",
 821       "since" : "",
 822       "see" : "",
 823       "exceptions" : "",
 824       "requires" : "",
 825       "params" : [],
 826       "returns" : []
 827     },
 828     {
 829       "name" : "show",
 830       "type" : "function",
 831       "desc" : "Show a component - removes 'hidden' class",
 832       "sig" : "()\n{\n\n}",
 833       "static" : false,
 834       "memberOf" : "Roo.bootstrap.Component",
 835       "isStatic" : false,
 836       "isConstructor" : false,
 837       "isPrivate" : false,
 838       "example" : "",
 839       "deprecated" : "",
 840       "since" : "",
 841       "see" : "",
 842       "exceptions" : "",
 843       "requires" : "",
 844       "params" : [],
 845       "returns" : []
 846     },
 847     {
 848       "name" : "setVisibilityEl",
 849       "type" : "function",
 850       "desc" : "Set the element that will be used to show or hide",
 851       "sig" : "()\n{\n\n}",
 852       "static" : false,
 853       "memberOf" : "Roo.bootstrap.Component",
 854       "isStatic" : false,
 855       "isConstructor" : false,
 856       "isPrivate" : false,
 857       "example" : "",
 858       "deprecated" : "",
 859       "since" : "",
 860       "see" : "",
 861       "exceptions" : "",
 862       "requires" : "",
 863       "params" : [],
 864       "returns" : []
 865     },
 866     {
 867       "name" : "getVisibilityEl",
 868       "type" : "function",
 869       "desc" : "Get the element that will be used to show or hide",
 870       "sig" : "()\n{\n\n}",
 871       "static" : false,
 872       "memberOf" : "Roo.bootstrap.Component",
 873       "isStatic" : false,
 874       "isConstructor" : false,
 875       "isPrivate" : false,
 876       "example" : "",
 877       "deprecated" : "",
 878       "since" : "",
 879       "see" : "",
 880       "exceptions" : "",
 881       "requires" : "",
 882       "params" : [],
 883       "returns" : []
 884     },
 885     {
 886       "name" : "initEvents",
 887       "type" : "function",
 888       "desc" : "Initialize Events for the element",
 889       "sig" : "()\n{\n\n}",
 890       "static" : false,
 891       "memberOf" : "Roo.bootstrap.Component",
 892       "isStatic" : false,
 893       "isConstructor" : false,
 894       "isPrivate" : false,
 895       "example" : "",
 896       "deprecated" : "",
 897       "since" : "",
 898       "see" : "",
 899       "exceptions" : "",
 900       "requires" : "",
 901       "params" : [],
 902       "returns" : []
 903     },
 904     {
 905       "name" : "getChildContainer",
 906       "type" : "function",
 907       "desc" : "Fetch the element to add children to",
 908       "sig" : "()\n{\n\n}",
 909       "static" : false,
 910       "memberOf" : "Roo.bootstrap.Component",
 911       "isStatic" : false,
 912       "isConstructor" : false,
 913       "isPrivate" : false,
 914       "example" : "",
 915       "deprecated" : "",
 916       "since" : "",
 917       "see" : "",
 918       "exceptions" : "",
 919       "requires" : "",
 920       "params" : [],
 921       "returns" : [
 922         {
 923           "name" : "",
 924           "type" : "Roo.Element",
 925           "desc" : "defaults to this.el"
 926         }
 927       ]
 928     },
 929     {
 930       "name" : "getId",
 931       "type" : "function",
 932       "desc" : "Returns the id of this component.",
 933       "sig" : "()\n{\n\n}",
 934       "static" : false,
 935       "memberOf" : "Roo.Component",
 936       "isStatic" : false,
 937       "isConstructor" : false,
 938       "isPrivate" : false,
 939       "example" : "",
 940       "deprecated" : "",
 941       "since" : "",
 942       "see" : "",
 943       "exceptions" : "",
 944       "requires" : "",
 945       "params" : [],
 946       "returns" : [
 947         {
 948           "name" : "",
 949           "type" : "String",
 950           "desc" : ""
 951         }
 952       ]
 953     },
 954     {
 955       "name" : "render",
 956       "type" : "function",
 957       "desc" : "If this is a lazy rendering component, render it to its container element.",
 958       "sig" : "(container)",
 959       "static" : false,
 960       "memberOf" : "Roo.Component",
 961       "isStatic" : false,
 962       "isConstructor" : false,
 963       "isPrivate" : false,
 964       "example" : "",
 965       "deprecated" : "",
 966       "since" : "",
 967       "see" : "",
 968       "exceptions" : "",
 969       "requires" : "",
 970       "params" : [
 971         {
 972           "name" : "container",
 973           "type" : "String/HTMLElement/Element",
 974           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 975           "isOptional" : false
 976         }
 977       ],
 978       "returns" : []
 979     },
 980     {
 981       "name" : "destroy",
 982       "type" : "function",
 983       "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}.",
 984       "sig" : "()\n{\n\n}",
 985       "static" : false,
 986       "memberOf" : "Roo.Component",
 987       "isStatic" : false,
 988       "isConstructor" : false,
 989       "isPrivate" : false,
 990       "example" : "",
 991       "deprecated" : "",
 992       "since" : "",
 993       "see" : "",
 994       "exceptions" : "",
 995       "requires" : "",
 996       "params" : [],
 997       "returns" : []
 998     },
 999     {
1000       "name" : "isVisible",
1001       "type" : "function",
1002       "desc" : "Returns true if this component is visible.",
1003       "sig" : "()\n{\n\n}",
1004       "static" : false,
1005       "memberOf" : "Roo.Component",
1006       "isStatic" : false,
1007       "isConstructor" : false,
1008       "isPrivate" : false,
1009       "example" : "",
1010       "deprecated" : "",
1011       "since" : "",
1012       "see" : "",
1013       "exceptions" : "",
1014       "requires" : "",
1015       "params" : [],
1016       "returns" : []
1017     },
1018     {
1019       "name" : "setDisabled",
1020       "type" : "function",
1021       "desc" : "Convenience function for setting disabled/enabled by boolean.",
1022       "sig" : "(disabled)",
1023       "static" : false,
1024       "memberOf" : "Roo.Component",
1025       "isStatic" : false,
1026       "isConstructor" : false,
1027       "isPrivate" : false,
1028       "example" : "",
1029       "deprecated" : "",
1030       "since" : "",
1031       "see" : "",
1032       "exceptions" : "",
1033       "requires" : "",
1034       "params" : [
1035         {
1036           "name" : "disabled",
1037           "type" : "Boolean",
1038           "desc" : "",
1039           "isOptional" : false
1040         }
1041       ],
1042       "returns" : []
1043     },
1044     {
1045       "name" : "focus",
1046       "type" : "function",
1047       "desc" : "Try to focus this component.",
1048       "sig" : "(selectText)",
1049       "static" : false,
1050       "memberOf" : "Roo.Component",
1051       "isStatic" : false,
1052       "isConstructor" : false,
1053       "isPrivate" : false,
1054       "example" : "",
1055       "deprecated" : "",
1056       "since" : "",
1057       "see" : "",
1058       "exceptions" : "",
1059       "requires" : "",
1060       "params" : [
1061         {
1062           "name" : "selectText",
1063           "type" : "Boolean",
1064           "desc" : "True to also select the text in this component (if applicable)",
1065           "isOptional" : false
1066         }
1067       ],
1068       "returns" : [
1069         {
1070           "name" : "",
1071           "type" : "Roo.Component",
1072           "desc" : "this"
1073         }
1074       ]
1075     },
1076     {
1077       "name" : "enable",
1078       "type" : "function",
1079       "desc" : "Enable this component.",
1080       "sig" : "()\n{\n\n}",
1081       "static" : false,
1082       "memberOf" : "Roo.Component",
1083       "isStatic" : false,
1084       "isConstructor" : false,
1085       "isPrivate" : false,
1086       "example" : "",
1087       "deprecated" : "",
1088       "since" : "",
1089       "see" : "",
1090       "exceptions" : "",
1091       "requires" : "",
1092       "params" : [],
1093       "returns" : [
1094         {
1095           "name" : "",
1096           "type" : "Roo.Component",
1097           "desc" : "this"
1098         }
1099       ]
1100     },
1101     {
1102       "name" : "setVisible",
1103       "type" : "function",
1104       "desc" : "Convenience function to hide or show this component by boolean.",
1105       "sig" : "(visible)",
1106       "static" : false,
1107       "memberOf" : "Roo.Component",
1108       "isStatic" : false,
1109       "isConstructor" : false,
1110       "isPrivate" : false,
1111       "example" : "",
1112       "deprecated" : "",
1113       "since" : "",
1114       "see" : "",
1115       "exceptions" : "",
1116       "requires" : "",
1117       "params" : [
1118         {
1119           "name" : "visible",
1120           "type" : "Boolean",
1121           "desc" : "True to show, false to hide",
1122           "isOptional" : false
1123         }
1124       ],
1125       "returns" : [
1126         {
1127           "name" : "",
1128           "type" : "Roo.Component",
1129           "desc" : "this"
1130         }
1131       ]
1132     },
1133     {
1134       "name" : "disable",
1135       "type" : "function",
1136       "desc" : "Disable this component.",
1137       "sig" : "()\n{\n\n}",
1138       "static" : false,
1139       "memberOf" : "Roo.Component",
1140       "isStatic" : false,
1141       "isConstructor" : false,
1142       "isPrivate" : false,
1143       "example" : "",
1144       "deprecated" : "",
1145       "since" : "",
1146       "see" : "",
1147       "exceptions" : "",
1148       "requires" : "",
1149       "params" : [],
1150       "returns" : [
1151         {
1152           "name" : "",
1153           "type" : "Roo.Component",
1154           "desc" : "this"
1155         }
1156       ]
1157     },
1158     {
1159       "name" : "getEl",
1160       "type" : "function",
1161       "desc" : "Returns the underlying {@link Roo.Element}.",
1162       "sig" : "()\n{\n\n}",
1163       "static" : false,
1164       "memberOf" : "Roo.Component",
1165       "isStatic" : false,
1166       "isConstructor" : false,
1167       "isPrivate" : false,
1168       "example" : "",
1169       "deprecated" : "",
1170       "since" : "",
1171       "see" : "",
1172       "exceptions" : "",
1173       "requires" : "",
1174       "params" : [],
1175       "returns" : [
1176         {
1177           "name" : "",
1178           "type" : "Roo.Element",
1179           "desc" : "The element"
1180         }
1181       ]
1182     },
1183     {
1184       "name" : "purgeListeners",
1185       "type" : "function",
1186       "desc" : "Removes all listeners for this object",
1187       "sig" : "()\n{\n\n}",
1188       "static" : false,
1189       "memberOf" : "Roo.util.Observable",
1190       "isStatic" : false,
1191       "isConstructor" : false,
1192       "isPrivate" : false,
1193       "example" : "",
1194       "deprecated" : "",
1195       "since" : "",
1196       "see" : "",
1197       "exceptions" : "",
1198       "requires" : "",
1199       "params" : [],
1200       "returns" : []
1201     },
1202     {
1203       "name" : "on",
1204       "type" : "function",
1205       "desc" : "Appends an event handler to this element (shorthand for addListener)",
1206       "sig" : "(eventName, handler, scope, options)",
1207       "static" : false,
1208       "memberOf" : "Roo.util.Observable",
1209       "isStatic" : false,
1210       "isConstructor" : false,
1211       "isPrivate" : false,
1212       "example" : "",
1213       "deprecated" : "",
1214       "since" : "",
1215       "see" : "",
1216       "exceptions" : "",
1217       "requires" : "",
1218       "params" : [
1219         {
1220           "name" : "eventName",
1221           "type" : "String",
1222           "desc" : "The type of event to listen for",
1223           "isOptional" : false
1224         },
1225         {
1226           "name" : "handler",
1227           "type" : "Function",
1228           "desc" : "The method the event invokes",
1229           "isOptional" : false
1230         },
1231         {
1232           "name" : "scope",
1233           "type" : "Object",
1234           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1235           "isOptional" : false
1236         },
1237         {
1238           "name" : "options",
1239           "type" : "Object",
1240           "desc" : "(optional)",
1241           "isOptional" : false
1242         }
1243       ],
1244       "returns" : []
1245     },
1246     {
1247       "name" : "un",
1248       "type" : "function",
1249       "desc" : "Removes a listener (shorthand for removeListener)",
1250       "sig" : "(eventName, handler, scope)",
1251       "static" : false,
1252       "memberOf" : "Roo.util.Observable",
1253       "isStatic" : false,
1254       "isConstructor" : false,
1255       "isPrivate" : false,
1256       "example" : "",
1257       "deprecated" : "",
1258       "since" : "",
1259       "see" : "",
1260       "exceptions" : "",
1261       "requires" : "",
1262       "params" : [
1263         {
1264           "name" : "eventName",
1265           "type" : "String",
1266           "desc" : "The type of event to listen for",
1267           "isOptional" : false
1268         },
1269         {
1270           "name" : "handler",
1271           "type" : "Function",
1272           "desc" : "The handler to remove",
1273           "isOptional" : false
1274         },
1275         {
1276           "name" : "scope",
1277           "type" : "Object",
1278           "desc" : "(optional) The scope (this object) for the handler",
1279           "isOptional" : false
1280         }
1281       ],
1282       "returns" : []
1283     },
1284     {
1285       "name" : "addEvents",
1286       "type" : "function",
1287       "desc" : "Used to define events on this Observable",
1288       "sig" : "(object)",
1289       "static" : false,
1290       "memberOf" : "Roo.util.Observable",
1291       "isStatic" : false,
1292       "isConstructor" : false,
1293       "isPrivate" : false,
1294       "example" : "",
1295       "deprecated" : "",
1296       "since" : "",
1297       "see" : "",
1298       "exceptions" : "",
1299       "requires" : "",
1300       "params" : [
1301         {
1302           "name" : "object",
1303           "type" : "Object",
1304           "desc" : "The object with the events defined",
1305           "isOptional" : false
1306         }
1307       ],
1308       "returns" : []
1309     },
1310     {
1311       "name" : "releaseCapture",
1312       "type" : "function",
1313       "desc" : "Removes <b>all</b> added captures from the Observable.",
1314       "sig" : "(o)",
1315       "static" : true,
1316       "memberOf" : "Roo.util.Observable",
1317       "isStatic" : true,
1318       "isConstructor" : false,
1319       "isPrivate" : false,
1320       "example" : "",
1321       "deprecated" : "",
1322       "since" : "",
1323       "see" : "",
1324       "exceptions" : "",
1325       "requires" : "",
1326       "params" : [
1327         {
1328           "name" : "o",
1329           "type" : "Observable",
1330           "desc" : "The Observable to release",
1331           "isOptional" : false
1332         }
1333       ],
1334       "returns" : []
1335     },
1336     {
1337       "name" : "removeListener",
1338       "type" : "function",
1339       "desc" : "Removes a listener",
1340       "sig" : "(eventName, handler, scope)",
1341       "static" : false,
1342       "memberOf" : "Roo.util.Observable",
1343       "isStatic" : false,
1344       "isConstructor" : false,
1345       "isPrivate" : false,
1346       "example" : "",
1347       "deprecated" : "",
1348       "since" : "",
1349       "see" : "",
1350       "exceptions" : "",
1351       "requires" : "",
1352       "params" : [
1353         {
1354           "name" : "eventName",
1355           "type" : "String",
1356           "desc" : "The type of event to listen for",
1357           "isOptional" : false
1358         },
1359         {
1360           "name" : "handler",
1361           "type" : "Function",
1362           "desc" : "The handler to remove",
1363           "isOptional" : false
1364         },
1365         {
1366           "name" : "scope",
1367           "type" : "Object",
1368           "desc" : "(optional) The scope (this object) for the handler",
1369           "isOptional" : false
1370         }
1371       ],
1372       "returns" : []
1373     },
1374     {
1375       "name" : "fireEvent",
1376       "type" : "function",
1377       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1378       "sig" : "(eventName, args)",
1379       "static" : false,
1380       "memberOf" : "Roo.util.Observable",
1381       "isStatic" : false,
1382       "isConstructor" : false,
1383       "isPrivate" : false,
1384       "example" : "",
1385       "deprecated" : "",
1386       "since" : "",
1387       "see" : "",
1388       "exceptions" : "",
1389       "requires" : "",
1390       "params" : [
1391         {
1392           "name" : "eventName",
1393           "type" : "String",
1394           "desc" : "",
1395           "isOptional" : false
1396         },
1397         {
1398           "name" : "args",
1399           "type" : "Object...",
1400           "desc" : "Variable number of parameters are passed to handlers",
1401           "isOptional" : false
1402         }
1403       ],
1404       "returns" : [
1405         {
1406           "name" : "",
1407           "type" : "Boolean",
1408           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1409         }
1410       ]
1411     },
1412     {
1413       "name" : "hasListener",
1414       "type" : "function",
1415       "desc" : "Checks to see if this object has any listeners for a specified event",
1416       "sig" : "(eventName)",
1417       "static" : false,
1418       "memberOf" : "Roo.util.Observable",
1419       "isStatic" : false,
1420       "isConstructor" : false,
1421       "isPrivate" : false,
1422       "example" : "",
1423       "deprecated" : "",
1424       "since" : "",
1425       "see" : "",
1426       "exceptions" : "",
1427       "requires" : "",
1428       "params" : [
1429         {
1430           "name" : "eventName",
1431           "type" : "String",
1432           "desc" : "The name of the event to check for",
1433           "isOptional" : false
1434         }
1435       ],
1436       "returns" : [
1437         {
1438           "name" : "",
1439           "type" : "Boolean",
1440           "desc" : "True if the event is being listened for, else false"
1441         }
1442       ]
1443     },
1444     {
1445       "name" : "capture",
1446       "type" : "function",
1447       "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.",
1448       "sig" : "(o, fn, scope)",
1449       "static" : true,
1450       "memberOf" : "Roo.util.Observable",
1451       "isStatic" : true,
1452       "isConstructor" : false,
1453       "isPrivate" : false,
1454       "example" : "",
1455       "deprecated" : "",
1456       "since" : "",
1457       "see" : "",
1458       "exceptions" : "",
1459       "requires" : "",
1460       "params" : [
1461         {
1462           "name" : "o",
1463           "type" : "Observable",
1464           "desc" : "The Observable to capture",
1465           "isOptional" : false
1466         },
1467         {
1468           "name" : "fn",
1469           "type" : "Function",
1470           "desc" : "The function to call",
1471           "isOptional" : false
1472         },
1473         {
1474           "name" : "scope",
1475           "type" : "Object",
1476           "desc" : "(optional) The scope (this object) for the fn",
1477           "isOptional" : false
1478         }
1479       ],
1480       "returns" : []
1481     },
1482     {
1483       "name" : "addListener",
1484       "type" : "function",
1485       "desc" : "Appends an event handler to this component",
1486       "sig" : "(eventName, handler, scope, options)",
1487       "static" : false,
1488       "memberOf" : "Roo.util.Observable",
1489       "isStatic" : false,
1490       "isConstructor" : false,
1491       "isPrivate" : false,
1492       "example" : "",
1493       "deprecated" : "",
1494       "since" : "",
1495       "see" : "",
1496       "exceptions" : "",
1497       "requires" : "",
1498       "params" : [
1499         {
1500           "name" : "eventName",
1501           "type" : "String",
1502           "desc" : "The type of event to listen for",
1503           "isOptional" : false
1504         },
1505         {
1506           "name" : "handler",
1507           "type" : "Function",
1508           "desc" : "The method the event invokes",
1509           "isOptional" : false
1510         },
1511         {
1512           "name" : "scope",
1513           "type" : "Object",
1514           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1515           "isOptional" : false
1516         },
1517         {
1518           "name" : "options",
1519           "type" : "Object",
1520           "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>",
1521           "isOptional" : false
1522         }
1523       ],
1524       "returns" : []
1525     }
1526   ],
1527   "events" : [
1528     {
1529       "name" : "paste",
1530       "type" : "function",
1531       "desc" : "Fires after the user pastes into input",
1532       "sig" : "function (_self, e)\n{\n\n}",
1533       "memberOf" : "Roo.bootstrap.form.Input",
1534       "example" : "",
1535       "deprecated" : "",
1536       "since" : "",
1537       "see" : "",
1538       "params" : [
1539         {
1540           "name" : "this",
1541           "type" : "Roo.form.Field",
1542           "desc" : "",
1543           "isOptional" : false
1544         },
1545         {
1546           "name" : "e",
1547           "type" : "Roo.EventObject",
1548           "desc" : "The event Object",
1549           "isOptional" : false
1550         }
1551       ],
1552       "returns" : []
1553     },
1554     {
1555       "name" : "change",
1556       "type" : "function",
1557       "desc" : "Fires just before the field blurs if the field value has changed.",
1558       "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
1559       "memberOf" : "Roo.bootstrap.form.Input",
1560       "example" : "",
1561       "deprecated" : "",
1562       "since" : "",
1563       "see" : "",
1564       "params" : [
1565         {
1566           "name" : "this",
1567           "type" : "Roo.form.Field",
1568           "desc" : "",
1569           "isOptional" : false
1570         },
1571         {
1572           "name" : "newValue",
1573           "type" : "Mixed",
1574           "desc" : "The new value",
1575           "isOptional" : false
1576         },
1577         {
1578           "name" : "oldValue",
1579           "type" : "Mixed",
1580           "desc" : "The original value",
1581           "isOptional" : false
1582         }
1583       ],
1584       "returns" : []
1585     },
1586     {
1587       "name" : "valid",
1588       "type" : "function",
1589       "desc" : "Fires after the field has been validated with no errors.",
1590       "sig" : "function (_self)\n{\n\n}",
1591       "memberOf" : "Roo.bootstrap.form.Input",
1592       "example" : "",
1593       "deprecated" : "",
1594       "since" : "",
1595       "see" : "",
1596       "params" : [
1597         {
1598           "name" : "this",
1599           "type" : "Roo.form.Field",
1600           "desc" : "",
1601           "isOptional" : false
1602         }
1603       ],
1604       "returns" : []
1605     },
1606     {
1607       "name" : "specialkey",
1608       "type" : "function",
1609       "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.  You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
1610       "sig" : "function (_self, e)\n{\n\n}",
1611       "memberOf" : "Roo.bootstrap.form.Input",
1612       "example" : "",
1613       "deprecated" : "",
1614       "since" : "",
1615       "see" : "",
1616       "params" : [
1617         {
1618           "name" : "this",
1619           "type" : "Roo.form.Field",
1620           "desc" : "",
1621           "isOptional" : false
1622         },
1623         {
1624           "name" : "e",
1625           "type" : "Roo.EventObject",
1626           "desc" : "The event object",
1627           "isOptional" : false
1628         }
1629       ],
1630       "returns" : []
1631     },
1632     {
1633       "name" : "focus",
1634       "type" : "function",
1635       "desc" : "Fires when this field receives input focus.",
1636       "sig" : "function (_self)\n{\n\n}",
1637       "memberOf" : "Roo.bootstrap.form.Input",
1638       "example" : "",
1639       "deprecated" : "",
1640       "since" : "",
1641       "see" : "",
1642       "params" : [
1643         {
1644           "name" : "this",
1645           "type" : "Roo.form.Field",
1646           "desc" : "",
1647           "isOptional" : false
1648         }
1649       ],
1650       "returns" : []
1651     },
1652     {
1653       "name" : "keyup",
1654       "type" : "function",
1655       "desc" : "Fires after the key up",
1656       "sig" : "function (_self, e)\n{\n\n}",
1657       "memberOf" : "Roo.bootstrap.form.Input",
1658       "example" : "",
1659       "deprecated" : "",
1660       "since" : "",
1661       "see" : "",
1662       "params" : [
1663         {
1664           "name" : "this",
1665           "type" : "Roo.form.Field",
1666           "desc" : "",
1667           "isOptional" : false
1668         },
1669         {
1670           "name" : "e",
1671           "type" : "Roo.EventObject",
1672           "desc" : "The event Object",
1673           "isOptional" : false
1674         }
1675       ],
1676       "returns" : []
1677     },
1678     {
1679       "name" : "blur",
1680       "type" : "function",
1681       "desc" : "Fires when this field loses input focus.",
1682       "sig" : "function (_self)\n{\n\n}",
1683       "memberOf" : "Roo.bootstrap.form.Input",
1684       "example" : "",
1685       "deprecated" : "",
1686       "since" : "",
1687       "see" : "",
1688       "params" : [
1689         {
1690           "name" : "this",
1691           "type" : "Roo.form.Field",
1692           "desc" : "",
1693           "isOptional" : false
1694         }
1695       ],
1696       "returns" : []
1697     },
1698     {
1699       "name" : "invalid",
1700       "type" : "function",
1701       "desc" : "Fires after the field has been marked as invalid.",
1702       "sig" : "function (_self, msg)\n{\n\n}",
1703       "memberOf" : "Roo.bootstrap.form.Input",
1704       "example" : "",
1705       "deprecated" : "",
1706       "since" : "",
1707       "see" : "",
1708       "params" : [
1709         {
1710           "name" : "this",
1711           "type" : "Roo.form.Field",
1712           "desc" : "",
1713           "isOptional" : false
1714         },
1715         {
1716           "name" : "msg",
1717           "type" : "String",
1718           "desc" : "The validation message",
1719           "isOptional" : false
1720         }
1721       ],
1722       "returns" : []
1723     },
1724     {
1725       "name" : "childrenrendered",
1726       "type" : "function",
1727       "desc" : "Fires when the children have been rendered..",
1728       "sig" : "function (_self)\n{\n\n}",
1729       "memberOf" : "Roo.bootstrap.Component",
1730       "example" : "",
1731       "deprecated" : "",
1732       "since" : "",
1733       "see" : "",
1734       "params" : [
1735         {
1736           "name" : "this",
1737           "type" : "Roo.bootstrap.Component",
1738           "desc" : "",
1739           "isOptional" : false
1740         }
1741       ],
1742       "returns" : []
1743     },
1744     {
1745       "name" : "beforerender",
1746       "type" : "function",
1747       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1748       "sig" : "function (_self)\n{\n\n}",
1749       "memberOf" : "Roo.Component",
1750       "example" : "",
1751       "deprecated" : "",
1752       "since" : "",
1753       "see" : "",
1754       "params" : [
1755         {
1756           "name" : "this",
1757           "type" : "Roo.Component",
1758           "desc" : "",
1759           "isOptional" : false
1760         }
1761       ],
1762       "returns" : []
1763     },
1764     {
1765       "name" : "disable",
1766       "type" : "function",
1767       "desc" : "Fires after the component is disabled.",
1768       "sig" : "function (_self)\n{\n\n}",
1769       "memberOf" : "Roo.Component",
1770       "example" : "",
1771       "deprecated" : "",
1772       "since" : "",
1773       "see" : "",
1774       "params" : [
1775         {
1776           "name" : "this",
1777           "type" : "Roo.Component",
1778           "desc" : "",
1779           "isOptional" : false
1780         }
1781       ],
1782       "returns" : []
1783     },
1784     {
1785       "name" : "render",
1786       "type" : "function",
1787       "desc" : "Fires after the component is rendered.",
1788       "sig" : "function (_self)\n{\n\n}",
1789       "memberOf" : "Roo.Component",
1790       "example" : "",
1791       "deprecated" : "",
1792       "since" : "",
1793       "see" : "",
1794       "params" : [
1795         {
1796           "name" : "this",
1797           "type" : "Roo.Component",
1798           "desc" : "",
1799           "isOptional" : false
1800         }
1801       ],
1802       "returns" : []
1803     },
1804     {
1805       "name" : "destroy",
1806       "type" : "function",
1807       "desc" : "Fires after the component is destroyed.",
1808       "sig" : "function (_self)\n{\n\n}",
1809       "memberOf" : "Roo.Component",
1810       "example" : "",
1811       "deprecated" : "",
1812       "since" : "",
1813       "see" : "",
1814       "params" : [
1815         {
1816           "name" : "this",
1817           "type" : "Roo.Component",
1818           "desc" : "",
1819           "isOptional" : false
1820         }
1821       ],
1822       "returns" : []
1823     },
1824     {
1825       "name" : "hide",
1826       "type" : "function",
1827       "desc" : "Fires after the component is hidden.",
1828       "sig" : "function (_self)\n{\n\n}",
1829       "memberOf" : "Roo.Component",
1830       "example" : "",
1831       "deprecated" : "",
1832       "since" : "",
1833       "see" : "",
1834       "params" : [
1835         {
1836           "name" : "this",
1837           "type" : "Roo.Component",
1838           "desc" : "",
1839           "isOptional" : false
1840         }
1841       ],
1842       "returns" : []
1843     },
1844     {
1845       "name" : "beforehide",
1846       "type" : "function",
1847       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1848       "sig" : "function (_self)\n{\n\n}",
1849       "memberOf" : "Roo.Component",
1850       "example" : "",
1851       "deprecated" : "",
1852       "since" : "",
1853       "see" : "",
1854       "params" : [
1855         {
1856           "name" : "this",
1857           "type" : "Roo.Component",
1858           "desc" : "",
1859           "isOptional" : false
1860         }
1861       ],
1862       "returns" : []
1863     },
1864     {
1865       "name" : "show",
1866       "type" : "function",
1867       "desc" : "Fires after the component is shown.",
1868       "sig" : "function (_self)\n{\n\n}",
1869       "memberOf" : "Roo.Component",
1870       "example" : "",
1871       "deprecated" : "",
1872       "since" : "",
1873       "see" : "",
1874       "params" : [
1875         {
1876           "name" : "this",
1877           "type" : "Roo.Component",
1878           "desc" : "",
1879           "isOptional" : false
1880         }
1881       ],
1882       "returns" : []
1883     },
1884     {
1885       "name" : "beforeshow",
1886       "type" : "function",
1887       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1888       "sig" : "function (_self)\n{\n\n}",
1889       "memberOf" : "Roo.Component",
1890       "example" : "",
1891       "deprecated" : "",
1892       "since" : "",
1893       "see" : "",
1894       "params" : [
1895         {
1896           "name" : "this",
1897           "type" : "Roo.Component",
1898           "desc" : "",
1899           "isOptional" : false
1900         }
1901       ],
1902       "returns" : []
1903     },
1904     {
1905       "name" : "enable",
1906       "type" : "function",
1907       "desc" : "Fires after the component is enabled.",
1908       "sig" : "function (_self)\n{\n\n}",
1909       "memberOf" : "Roo.Component",
1910       "example" : "",
1911       "deprecated" : "",
1912       "since" : "",
1913       "see" : "",
1914       "params" : [
1915         {
1916           "name" : "this",
1917           "type" : "Roo.Component",
1918           "desc" : "",
1919           "isOptional" : false
1920         }
1921       ],
1922       "returns" : []
1923     },
1924     {
1925       "name" : "beforedestroy",
1926       "type" : "function",
1927       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1928       "sig" : "function (_self)\n{\n\n}",
1929       "memberOf" : "Roo.Component",
1930       "example" : "",
1931       "deprecated" : "",
1932       "since" : "",
1933       "see" : "",
1934       "params" : [
1935         {
1936           "name" : "this",
1937           "type" : "Roo.Component",
1938           "desc" : "",
1939           "isOptional" : false
1940         }
1941       ],
1942       "returns" : []
1943     }
1944   ]
1945 }