git.roojs.org Git - roojs1/blob - docs2/symbols/Roo.Editor.json

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