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

   1 {
   2   "name" : "Roo.DatePicker",
   3   "augments" : [
   4     "Roo.Component",
   5     "Roo.util.Observable"
   6   ],
   7   "desc" : "Simple date picker class.",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "memberOf" : "DatePicker",
  12   "example" : "",
  13   "deprecated" : "",
  14   "since" : "",
  15   "see" : "",
  16   "params" : [
  17     {
  18       "name" : "config",
  19       "type" : "Object",
  20       "desc" : "The config object",
  21       "isOptional" : false
  22     }
  23   ],
  24   "returns" : [
  25   ],
  26   "config" : [
  27     {
  28       "name" : "startDay",
  29       "type" : "Number",
  30       "desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)",
  31       "memberOf" : "Roo.DatePicker",
  32       "values" : [
  33       ]
  34     },
  35     {
  36       "name" : "monthYearText",
  37       "type" : "String",
  38       "desc" : "The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)')",
  39       "memberOf" : "Roo.DatePicker",
  40       "values" : [
  41       ]
  42     },
  43     {
  44       "name" : "monthNames",
  45       "type" : "Array",
  46       "desc" : "An array of textual month names which can be overriden for localization support (defaults to Date.monthNames)",
  47       "memberOf" : "Roo.DatePicker",
  48       "values" : [
  49       ]
  50     },
  51     {
  52       "name" : "listeners",
  53       "type" : "Object",
  54       "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>",
  55       "memberOf" : "Roo.util.Observable",
  56       "values" : [
  57       ]
  58     },
  59     {
  60       "name" : "format",
  61       "type" : "String",
  62       "desc" : "The default date format string which can be overriden for localization support.  The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
  63       "memberOf" : "Roo.DatePicker",
  64       "values" : [
  65       ]
  66     },
  67     {
  68       "name" : "nextText",
  69       "type" : "String",
  70       "desc" : "The next month navigation button tooltip (defaults to 'Next Month (Control+Right)')",
  71       "memberOf" : "Roo.DatePicker",
  72       "values" : [
  73       ]
  74     },
  75     {
  76       "name" : "maxText",
  77       "type" : "String",
  78       "desc" : "The error text to display if the maxDate validation fails (defaults to \"This date is after the maximum date\")",
  79       "memberOf" : "Roo.DatePicker",
  80       "values" : [
  81       ]
  82     },
  83     {
  84       "name" : "constrainToViewport",
  85       "type" : "Boolean",
  86       "desc" : "True to constrain the date picker to the viewport (defaults to true)",
  87       "memberOf" : "Roo.DatePicker",
  88       "values" : [
  89       ]
  90     },
  91     {
  92       "name" : "minText",
  93       "type" : "String",
  94       "desc" : "The error text to display if the minDate validation fails (defaults to \"This date is before the minimum date\")",
  95       "memberOf" : "Roo.DatePicker",
  96       "values" : [
  97       ]
  98     },
  99     {
 100       "name" : "disabledDatesText",
 101       "type" : "String",
 102       "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to \"\")",
 103       "memberOf" : "Roo.DatePicker",
 104       "values" : [
 105       ]
 106     },
 107     {
 108       "name" : "todayTip",
 109       "type" : "String",
 110       "desc" : "The tooltip to display for the button that selects the current date (defaults to \"{current date} (Spacebar)\")",
 111       "memberOf" : "Roo.DatePicker",
 112       "values" : [
 113       ]
 114     },
 115     {
 116       "name" : "hideMode",
 117       "type" : "String",
 118       "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\".",
 119       "memberOf" : "Roo.Component",
 120       "values" : [
 121         "(display",
 122         "visibility)"
 123       ]
 124     },
 125     {
 126       "name" : "todayText",
 127       "type" : "String",
 128       "desc" : "The text to display on the button that selects the current date (defaults to \"Today\")",
 129       "memberOf" : "Roo.DatePicker",
 130       "values" : [
 131       ]
 132     },
 133     {
 134       "name" : "cancelText",
 135       "type" : "String",
 136       "desc" : "The text to display on the cancel button",
 137       "memberOf" : "Roo.DatePicker",
 138       "values" : [
 139       ]
 140     },
 141     {
 142       "name" : "allowDomMove",
 143       "type" : "Boolean",
 144       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 145       "memberOf" : "Roo.Component",
 146       "values" : [
 147       ]
 148     },
 149     {
 150       "name" : "showClear",
 151       "type" : "Bool",
 152       "desc" : "Show a clear button (usefull for date form elements that can be blank.)",
 153       "memberOf" : "Roo.DatePicker",
 154       "values" : [
 155       ]
 156     },
 157     {
 158       "name" : "prevText",
 159       "type" : "String",
 160       "desc" : "The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)')",
 161       "memberOf" : "Roo.DatePicker",
 162       "values" : [
 163       ]
 164     },
 165     {
 166       "name" : "dayNames",
 167       "type" : "Array",
 168       "desc" : "An array of textual day names which can be overriden for localization support (defaults to Date.dayNames)",
 169       "memberOf" : "Roo.DatePicker",
 170       "values" : [
 171       ]
 172     },
 173     {
 174       "name" : "actionMode",
 175       "type" : "String",
 176       "desc" : "which property holds the element that used for  hide() / show() / disable() / enable()\ndefault is 'el'",
 177       "memberOf" : "Roo.Component",
 178       "values" : [
 179       ]
 180     },
 181     {
 182       "name" : "disabledDaysText",
 183       "type" : "String",
 184       "desc" : "The tooltip to display when the date falls on a disabled day (defaults to \"\")",
 185       "memberOf" : "Roo.DatePicker",
 186       "values" : [
 187       ]
 188     },
 189     {
 190       "name" : "disabledDatesRE",
 191       "type" : "RegExp",
 192       "desc" : "JavaScript regular expression used to disable a pattern of dates (defaults to null)",
 193       "memberOf" : "Roo.DatePicker",
 194       "values" : [
 195       ]
 196     },
 197     {
 198       "name" : "minDate",
 199       "type" : "Date",
 200       "desc" : "Minimum allowable date (JavaScript date object, defaults to null)",
 201       "memberOf" : "Roo.DatePicker",
 202       "values" : [
 203       ]
 204     },
 205     {
 206       "name" : "disabledDays",
 207       "type" : "Array",
 208       "desc" : "An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
 209       "memberOf" : "Roo.DatePicker",
 210       "values" : [
 211       ]
 212     },
 213     {
 214       "name" : "okText",
 215       "type" : "String",
 216       "desc" : "The text to display on the ok button",
 217       "memberOf" : "Roo.DatePicker",
 218       "values" : [
 219       ]
 220     },
 221     {
 222       "name" : "maxDate",
 223       "type" : "Date",
 224       "desc" : "Maximum allowable date (JavaScript date object, defaults to null)",
 225       "memberOf" : "Roo.DatePicker",
 226       "values" : [
 227       ]
 228     },
 229     {
 230       "name" : "disableClass",
 231       "type" : "String",
 232       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 233       "memberOf" : "Roo.Component",
 234       "values" : [
 235       ]
 236     }
 237   ],
 238   "methods" : [
 239     {
 240       "name" : "getValue",
 241       "desc" : "Gets the current selected value of the date field",
 242       "isStatic" : false,
 243       "isConstructor" : false,
 244       "isPrivate" : false,
 245       "memberOf" : "Roo.DatePicker",
 246       "example" : "",
 247       "deprecated" : "",
 248       "since" : "",
 249       "see" : "",
 250       "params" : [
 251       ],
 252       "returns" : [
 253         {
 254           "name" : "",
 255           "type" : "Date",
 256           "desc" : "The selected date"
 257         }
 258       ]
 259     },
 260     {
 261       "name" : "setValue",
 262       "desc" : "Sets the value of the date field",
 263       "isStatic" : false,
 264       "isConstructor" : false,
 265       "isPrivate" : false,
 266       "memberOf" : "Roo.DatePicker",
 267       "example" : "",
 268       "deprecated" : "",
 269       "since" : "",
 270       "see" : "",
 271       "params" : [
 272         {
 273           "name" : "value",
 274           "type" : "Date",
 275           "desc" : "The date to set",
 276           "isOptional" : false
 277         }
 278       ],
 279       "returns" : [
 280       ]
 281     },
 282     {
 283       "name" : "getId",
 284       "desc" : "Returns the id of this component.",
 285       "isStatic" : false,
 286       "isConstructor" : false,
 287       "isPrivate" : false,
 288       "memberOf" : "Roo.Component",
 289       "example" : "",
 290       "deprecated" : "",
 291       "since" : "",
 292       "see" : "",
 293       "params" : [
 294       ],
 295       "returns" : [
 296         {
 297           "name" : "",
 298           "type" : "String",
 299           "desc" : ""
 300         }
 301       ]
 302     },
 303     {
 304       "name" : "render",
 305       "desc" : "If this is a lazy rendering component, render it to its container element.",
 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           "name" : "container",
 317           "type" : "String/HTMLElement/Element",
 318           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 319           "isOptional" : false
 320         }
 321       ],
 322       "returns" : [
 323       ]
 324     },
 325     {
 326       "name" : "destroy",
 327       "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}.",
 328       "isStatic" : false,
 329       "isConstructor" : false,
 330       "isPrivate" : false,
 331       "memberOf" : "Roo.Component",
 332       "example" : "",
 333       "deprecated" : "",
 334       "since" : "",
 335       "see" : "",
 336       "params" : [
 337       ],
 338       "returns" : [
 339       ]
 340     },
 341     {
 342       "name" : "isVisible",
 343       "desc" : "Returns true if this component is visible.",
 344       "isStatic" : false,
 345       "isConstructor" : false,
 346       "isPrivate" : false,
 347       "memberOf" : "Roo.Component",
 348       "example" : "",
 349       "deprecated" : "",
 350       "since" : "",
 351       "see" : "",
 352       "params" : [
 353       ],
 354       "returns" : [
 355       ]
 356     },
 357     {
 358       "name" : "setDisabled",
 359       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 360       "isStatic" : false,
 361       "isConstructor" : false,
 362       "isPrivate" : false,
 363       "memberOf" : "Roo.Component",
 364       "example" : "",
 365       "deprecated" : "",
 366       "since" : "",
 367       "see" : "",
 368       "params" : [
 369         {
 370           "name" : "disabled",
 371           "type" : "Boolean",
 372           "desc" : "",
 373           "isOptional" : false
 374         }
 375       ],
 376       "returns" : [
 377       ]
 378     },
 379     {
 380       "name" : "hide",
 381       "desc" : "Hide this component.",
 382       "isStatic" : false,
 383       "isConstructor" : false,
 384       "isPrivate" : false,
 385       "memberOf" : "Roo.Component",
 386       "example" : "",
 387       "deprecated" : "",
 388       "since" : "",
 389       "see" : "",
 390       "params" : [
 391       ],
 392       "returns" : [
 393         {
 394           "name" : "",
 395           "type" : "Roo.Component",
 396           "desc" : "this"
 397         }
 398       ]
 399     },
 400     {
 401       "name" : "focus",
 402       "desc" : "Try to focus 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           "name" : "selectText",
 414           "type" : "Boolean",
 415           "desc" : "True to also select the text in this component (if applicable)",
 416           "isOptional" : false
 417         }
 418       ],
 419       "returns" : [
 420         {
 421           "name" : "",
 422           "type" : "Roo.Component",
 423           "desc" : "this"
 424         }
 425       ]
 426     },
 427     {
 428       "name" : "show",
 429       "desc" : "Show this component.",
 430       "isStatic" : false,
 431       "isConstructor" : false,
 432       "isPrivate" : false,
 433       "memberOf" : "Roo.Component",
 434       "example" : "",
 435       "deprecated" : "",
 436       "since" : "",
 437       "see" : "",
 438       "params" : [
 439       ],
 440       "returns" : [
 441         {
 442           "name" : "",
 443           "type" : "Roo.Component",
 444           "desc" : "this"
 445         }
 446       ]
 447     },
 448     {
 449       "name" : "enable",
 450       "desc" : "Enable 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" : "setVisible",
 471       "desc" : "Convenience function to hide or show this component by boolean.",
 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           "name" : "visible",
 483           "type" : "Boolean",
 484           "desc" : "True to show, false to hide",
 485           "isOptional" : false
 486         }
 487       ],
 488       "returns" : [
 489         {
 490           "name" : "",
 491           "type" : "Roo.Component",
 492           "desc" : "this"
 493         }
 494       ]
 495     },
 496     {
 497       "name" : "disable",
 498       "desc" : "Disable this component.",
 499       "isStatic" : false,
 500       "isConstructor" : false,
 501       "isPrivate" : false,
 502       "memberOf" : "Roo.Component",
 503       "example" : "",
 504       "deprecated" : "",
 505       "since" : "",
 506       "see" : "",
 507       "params" : [
 508       ],
 509       "returns" : [
 510         {
 511           "name" : "",
 512           "type" : "Roo.Component",
 513           "desc" : "this"
 514         }
 515       ]
 516     },
 517     {
 518       "name" : "getEl",
 519       "desc" : "Returns the underlying {@link Roo.Element}.",
 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.Element",
 534           "desc" : "The element"
 535         }
 536       ]
 537     },
 538     {
 539       "name" : "purgeListeners",
 540       "desc" : "Removes all listeners for this object",
 541       "isStatic" : false,
 542       "isConstructor" : false,
 543       "isPrivate" : false,
 544       "memberOf" : "Roo.util.Observable",
 545       "example" : "",
 546       "deprecated" : "",
 547       "since" : "",
 548       "see" : "",
 549       "params" : [
 550       ],
 551       "returns" : [
 552       ]
 553     },
 554     {
 555       "name" : "on",
 556       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 557       "isStatic" : false,
 558       "isConstructor" : false,
 559       "isPrivate" : false,
 560       "memberOf" : "Roo.util.Observable",
 561       "example" : "",
 562       "deprecated" : "",
 563       "since" : "",
 564       "see" : "",
 565       "params" : [
 566         {
 567           "name" : "eventName",
 568           "type" : "String",
 569           "desc" : "The type of event to listen for",
 570           "isOptional" : false
 571         },
 572         {
 573           "name" : "handler",
 574           "type" : "Function",
 575           "desc" : "The method the event invokes",
 576           "isOptional" : false
 577         },
 578         {
 579           "name" : "scope",
 580           "type" : "Object",
 581           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 582           "isOptional" : false
 583         },
 584         {
 585           "name" : "options",
 586           "type" : "Object",
 587           "desc" : "(optional)",
 588           "isOptional" : false
 589         }
 590       ],
 591       "returns" : [
 592       ]
 593     },
 594     {
 595       "name" : "un",
 596       "desc" : "Removes a listener (shorthand for removeListener)",
 597       "isStatic" : false,
 598       "isConstructor" : false,
 599       "isPrivate" : false,
 600       "memberOf" : "Roo.util.Observable",
 601       "example" : "",
 602       "deprecated" : "",
 603       "since" : "",
 604       "see" : "",
 605       "params" : [
 606         {
 607           "name" : "eventName",
 608           "type" : "String",
 609           "desc" : "The type of event to listen for",
 610           "isOptional" : false
 611         },
 612         {
 613           "name" : "handler",
 614           "type" : "Function",
 615           "desc" : "The handler to remove",
 616           "isOptional" : false
 617         },
 618         {
 619           "name" : "scope",
 620           "type" : "Object",
 621           "desc" : "(optional) The scope (this object) for the handler",
 622           "isOptional" : false
 623         }
 624       ],
 625       "returns" : [
 626       ]
 627     },
 628     {
 629       "name" : "addEvents",
 630       "desc" : "Used to define events on this Observable",
 631       "isStatic" : false,
 632       "isConstructor" : false,
 633       "isPrivate" : false,
 634       "memberOf" : "Roo.util.Observable",
 635       "example" : "",
 636       "deprecated" : "",
 637       "since" : "",
 638       "see" : "",
 639       "params" : [
 640         {
 641           "name" : "object",
 642           "type" : "Object",
 643           "desc" : "The object with the events defined",
 644           "isOptional" : false
 645         }
 646       ],
 647       "returns" : [
 648       ]
 649     },
 650     {
 651       "name" : "releaseCapture",
 652       "desc" : "Removes <b>all</b> added captures from the Observable.",
 653       "isStatic" : true,
 654       "isConstructor" : false,
 655       "isPrivate" : false,
 656       "memberOf" : "Roo.util.Observable",
 657       "example" : "",
 658       "deprecated" : "",
 659       "since" : "",
 660       "see" : "",
 661       "params" : [
 662         {
 663           "name" : "o",
 664           "type" : "Observable",
 665           "desc" : "The Observable to release",
 666           "isOptional" : false
 667         }
 668       ],
 669       "returns" : [
 670       ]
 671     },
 672     {
 673       "name" : "removeListener",
 674       "desc" : "Removes a listener",
 675       "isStatic" : false,
 676       "isConstructor" : false,
 677       "isPrivate" : false,
 678       "memberOf" : "Roo.util.Observable",
 679       "example" : "",
 680       "deprecated" : "",
 681       "since" : "",
 682       "see" : "",
 683       "params" : [
 684         {
 685           "name" : "eventName",
 686           "type" : "String",
 687           "desc" : "The type of event to listen for",
 688           "isOptional" : false
 689         },
 690         {
 691           "name" : "handler",
 692           "type" : "Function",
 693           "desc" : "The handler to remove",
 694           "isOptional" : false
 695         },
 696         {
 697           "name" : "scope",
 698           "type" : "Object",
 699           "desc" : "(optional) The scope (this object) for the handler",
 700           "isOptional" : false
 701         }
 702       ],
 703       "returns" : [
 704       ]
 705     },
 706     {
 707       "name" : "fireEvent",
 708       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 709       "isStatic" : false,
 710       "isConstructor" : false,
 711       "isPrivate" : false,
 712       "memberOf" : "Roo.util.Observable",
 713       "example" : "",
 714       "deprecated" : "",
 715       "since" : "",
 716       "see" : "",
 717       "params" : [
 718         {
 719           "name" : "eventName",
 720           "type" : "String",
 721           "desc" : "",
 722           "isOptional" : false
 723         },
 724         {
 725           "name" : "args",
 726           "type" : "Object...",
 727           "desc" : "Variable number of parameters are passed to handlers",
 728           "isOptional" : false
 729         }
 730       ],
 731       "returns" : [
 732         {
 733           "name" : "",
 734           "type" : "Boolean",
 735           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 736         }
 737       ]
 738     },
 739     {
 740       "name" : "hasListener",
 741       "desc" : "Checks to see if this object has any listeners for a specified event",
 742       "isStatic" : false,
 743       "isConstructor" : false,
 744       "isPrivate" : false,
 745       "memberOf" : "Roo.util.Observable",
 746       "example" : "",
 747       "deprecated" : "",
 748       "since" : "",
 749       "see" : "",
 750       "params" : [
 751         {
 752           "name" : "eventName",
 753           "type" : "String",
 754           "desc" : "The name of the event to check for",
 755           "isOptional" : false
 756         }
 757       ],
 758       "returns" : [
 759         {
 760           "name" : "",
 761           "type" : "Boolean",
 762           "desc" : "True if the event is being listened for, else false"
 763         }
 764       ]
 765     },
 766     {
 767       "name" : "capture",
 768       "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.",
 769       "isStatic" : true,
 770       "isConstructor" : false,
 771       "isPrivate" : false,
 772       "memberOf" : "Roo.util.Observable",
 773       "example" : "",
 774       "deprecated" : "",
 775       "since" : "",
 776       "see" : "",
 777       "params" : [
 778         {
 779           "name" : "o",
 780           "type" : "Observable",
 781           "desc" : "The Observable to capture",
 782           "isOptional" : false
 783         },
 784         {
 785           "name" : "fn",
 786           "type" : "Function",
 787           "desc" : "The function to call",
 788           "isOptional" : false
 789         },
 790         {
 791           "name" : "scope",
 792           "type" : "Object",
 793           "desc" : "(optional) The scope (this object) for the fn",
 794           "isOptional" : false
 795         }
 796       ],
 797       "returns" : [
 798       ]
 799     },
 800     {
 801       "name" : "addListener",
 802       "desc" : "Appends an event handler to this component",
 803       "isStatic" : false,
 804       "isConstructor" : false,
 805       "isPrivate" : false,
 806       "memberOf" : "Roo.util.Observable",
 807       "example" : "",
 808       "deprecated" : "",
 809       "since" : "",
 810       "see" : "",
 811       "params" : [
 812         {
 813           "name" : "eventName",
 814           "type" : "String",
 815           "desc" : "The type of event to listen for",
 816           "isOptional" : false
 817         },
 818         {
 819           "name" : "handler",
 820           "type" : "Function",
 821           "desc" : "The method the event invokes",
 822           "isOptional" : false
 823         },
 824         {
 825           "name" : "scope",
 826           "type" : "Object",
 827           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 828           "isOptional" : false
 829         },
 830         {
 831           "name" : "options",
 832           "type" : "Object",
 833           "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>",
 834           "isOptional" : false
 835         }
 836       ],
 837       "returns" : [
 838       ]
 839     }
 840   ],
 841   "events" : [
 842     {
 843       "name" : "select",
 844       "desc" : "Fires when a date is selected",
 845       "memberOf" : "Roo.DatePicker",
 846       "example" : "",
 847       "deprecated" : "",
 848       "since" : "",
 849       "see" : "",
 850       "params" : [
 851         {
 852           "name" : "this",
 853           "type" : "DatePicker",
 854           "desc" : "",
 855           "isOptional" : false
 856         },
 857         {
 858           "name" : "date",
 859           "type" : "Date",
 860           "desc" : "The selected date",
 861           "isOptional" : false
 862         }
 863       ],
 864       "returns" : [
 865       ]
 866     },
 867     {
 868       "name" : "monthchange",
 869       "desc" : "Fires when the displayed month changes",
 870       "memberOf" : "Roo.DatePicker",
 871       "example" : "",
 872       "deprecated" : "",
 873       "since" : "",
 874       "see" : "",
 875       "params" : [
 876         {
 877           "name" : "this",
 878           "type" : "DatePicker",
 879           "desc" : "",
 880           "isOptional" : false
 881         },
 882         {
 883           "name" : "date",
 884           "type" : "Date",
 885           "desc" : "The selected month",
 886           "isOptional" : false
 887         }
 888       ],
 889       "returns" : [
 890       ]
 891     },
 892     {
 893       "name" : "beforerender",
 894       "desc" : "Fires before the component is rendered. Return false to stop the render.",
 895       "memberOf" : "Roo.Component",
 896       "example" : "",
 897       "deprecated" : "",
 898       "since" : "",
 899       "see" : "",
 900       "params" : [
 901         {
 902           "name" : "this",
 903           "type" : "Roo.Component",
 904           "desc" : "",
 905           "isOptional" : false
 906         }
 907       ],
 908       "returns" : [
 909       ]
 910     },
 911     {
 912       "name" : "disable",
 913       "desc" : "Fires after the component is disabled.",
 914       "memberOf" : "Roo.Component",
 915       "example" : "",
 916       "deprecated" : "",
 917       "since" : "",
 918       "see" : "",
 919       "params" : [
 920         {
 921           "name" : "this",
 922           "type" : "Roo.Component",
 923           "desc" : "",
 924           "isOptional" : false
 925         }
 926       ],
 927       "returns" : [
 928       ]
 929     },
 930     {
 931       "name" : "render",
 932       "desc" : "Fires after the component is rendered.",
 933       "memberOf" : "Roo.Component",
 934       "example" : "",
 935       "deprecated" : "",
 936       "since" : "",
 937       "see" : "",
 938       "params" : [
 939         {
 940           "name" : "this",
 941           "type" : "Roo.Component",
 942           "desc" : "",
 943           "isOptional" : false
 944         }
 945       ],
 946       "returns" : [
 947       ]
 948     },
 949     {
 950       "name" : "destroy",
 951       "desc" : "Fires after the component is destroyed.",
 952       "memberOf" : "Roo.Component",
 953       "example" : "",
 954       "deprecated" : "",
 955       "since" : "",
 956       "see" : "",
 957       "params" : [
 958         {
 959           "name" : "this",
 960           "type" : "Roo.Component",
 961           "desc" : "",
 962           "isOptional" : false
 963         }
 964       ],
 965       "returns" : [
 966       ]
 967     },
 968     {
 969       "name" : "hide",
 970       "desc" : "Fires after the component is hidden.",
 971       "memberOf" : "Roo.Component",
 972       "example" : "",
 973       "deprecated" : "",
 974       "since" : "",
 975       "see" : "",
 976       "params" : [
 977         {
 978           "name" : "this",
 979           "type" : "Roo.Component",
 980           "desc" : "",
 981           "isOptional" : false
 982         }
 983       ],
 984       "returns" : [
 985       ]
 986     },
 987     {
 988       "name" : "beforehide",
 989       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
 990       "memberOf" : "Roo.Component",
 991       "example" : "",
 992       "deprecated" : "",
 993       "since" : "",
 994       "see" : "",
 995       "params" : [
 996         {
 997           "name" : "this",
 998           "type" : "Roo.Component",
 999           "desc" : "",
1000           "isOptional" : false
1001         }
1002       ],
1003       "returns" : [
1004       ]
1005     },
1006     {
1007       "name" : "show",
1008       "desc" : "Fires after the component is shown.",
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" : "beforeshow",
1027       "desc" : "Fires before the component is shown.  Return false to stop the show.",
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" : "enable",
1046       "desc" : "Fires after the component is enabled.",
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" : "beforedestroy",
1065       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
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 }