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

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