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