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