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

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