| Package: | Ext |
| Class: | DatePicker |
| Extends: | Component |
| Defined In: | DatePicker.js |
| Property | Defined By | |
|---|---|---|
| disabled : Object | Component | |
| true if this component is disabled. Read-only. | ||
| disabledClass : Object | Component | |
| CSS class added to the component when it is disabled. | ||
| hidden : Object | Component | |
| true if this component is hidden. Read-only. | ||
| rendered : Object | Component | |
| true if this component has been rendered. Read-only. | ||
| Method | Defined By | |
|---|---|---|
DatePicker(Object config) |
DatePicker | |
| Create a new DatePicker | ||
addEvents(Object object) : void |
Observable | |
| Copies any events from the passed object onto this object if they do not already exist. The passed object must also ... | ||
addListener(String eventName, Function handler, [Object scope], [Object options]) : void |
Observable | |
| Appends an event handler to this component | ||
| disable() : void | Component | |
| Disable this component | ||
| enable() : void | Component | |
| Enable this component | ||
fireEvent(String eventName, Object... args) : Boolean |
Observable | |
| Fires the specified event with the passed parameters (minus the event name). | ||
focus(Boolean selectText) : void |
Component | |
| Try to focus this component | ||
| getEl() : Ext.Element | Component | |
| Returns the underlying Ext.Element | ||
| getId() : String | Component | |
| Returns the id of this component | ||
| getValue() : Date | DatePicker | |
| Gets the current selected value of the date field | ||
hasListener(String eventName) : Boolean |
Observable | |
| Checks to see if this object is currently listening for a specified event | ||
| hide() : void | Component | |
| Hide this component | ||
| isVisible() : void | Component | |
| Returns true if this component is visible | ||
on(String eventName, Function handler, [Object options]) : void |
Observable | |
| Appends an event handler to this element (shorthand for addListener) | ||
| purgeListeners() : void | Observable | |
| Removes all listeners for this object | ||
removeListener(String eventName, Function handler, [Object scope]) : void |
Observable | |
| Removes a listener | ||
render([String/HTMLElement/Element container]) : void |
Component | |
| If this is a lazy rendering component, render it to its container element | ||
setDisabled(Boolean disabled) : void |
Component | |
| Convenience function for setting disabled/enabled by boolean | ||
setValue(Date value) : void |
DatePicker | |
| Sets the value of the date field | ||
setVisible(Boolean visible) : void |
Component | |
| Convenience function to hide or show this component by boolean | ||
| show() : void | Component | |
| Show this component | ||
un(String eventName, Function handler, [Object scope]) : void |
Observable | |
| Removes a listener (shorthand for removeListener) | ||
| Event | Defined By | |
|---|---|---|
beforedestroy : (Ext.Component this) |
Component | |
| Fires before the component is destroyed | ||
beforehide : (Ext.Component this) |
Component | |
| Fires before the component is hidden | ||
beforerender : (Ext.Component this) |
Component | |
| Fires before the component is rendered | ||
beforeshow : (Ext.Component this) |
Component | |
| Fires before the component is shown | ||
destroy : (Ext.Component this) |
Component | |
| Fires after the component is destroyed | ||
disable : (Ext.Component this) |
Component | |
| Fires after the component is disabled | ||
enable : (Ext.Component this) |
Component | |
| Fires after the component is enabled | ||
hide : (Ext.Component this) |
Component | |
| Fires after the component is hidden | ||
render : (Ext.Component this) |
Component | |
| Fires after the component is rendered | ||
select : (DatePicker this, Date date) |
DatePicker | |
| Fires when a date is selected | ||
show : (Ext.Component this) |
Component | |
| Fires after the component is shown | ||
| Config Options | Defined By | |
|---|---|---|
| constrainToViewport : Boolean | DatePicker | |
| True to constrain the date picker to the viewport (defaults to true) | ||
| dayNames : Array | DatePicker | |
| An array of textual day names which can be overriden for localization support (defaults to Date.dayNames) | ||
| disabledDatesRE : RegExp | DatePicker | |
| JavaScript regular expression used to disable a pattern of dates (defaults to null) | ||
| disabledDatesText : String | DatePicker | |
| The tooltip text to display when the date falls on a disabled date (defaults to "") | ||
| disabledDays : Array | DatePicker | |
| An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday (defaults to null). | ||
| disabledDaysText : String | DatePicker | |
| The tooltip to display when the date falls on a disabled day (defaults to "") | ||
| format : String | DatePicker | |
| The default date format string which can be overriden for localization support. The format must be valid according to... | ||
| maxDate : Date | DatePicker | |
| Maximum allowable date (JavaScript date object, defaults to null) | ||
| maxText : String | DatePicker | |
| The error text to display if the maxDate validation fails (defaults to "This date is after the maximum date") | ||
| minDate : Date | DatePicker | |
| Minimum allowable date (JavaScript date object, defaults to null) | ||
| minText : String | DatePicker | |
| The error text to display if the minDate validation fails (defaults to "This date is before the minimum date") | ||
| monthNames : Array | DatePicker | |
| An array of textual month names which can be overriden for localization support (defaults to Date.monthNames) | ||
| monthYearText : String | DatePicker | |
| The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)') | ||
| nextText : String | DatePicker | |
| The next month navigation button tooltip (defaults to 'Next Month (Control+Right)') | ||
| prevText : String | DatePicker | |
| The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)') | ||
| startDay : Number | DatePicker | |
| Day index at which the week should begin, 0-based (defaults to 0, which is Sunday) | ||
| todayText : String | DatePicker | |
| The text to display on the button that selects the current date (defaults to "Today") | ||
| todayTip : String | DatePicker | |
| The tooltip to display for the button that selects the current date (defaults to "{current date} (Spacebar)") | ||
public Object disabled
public Object disabledClass
public Object hidden
public Object rendered
public function DatePicker(Object config)
config : Objectpublic function addEvents(Object object)
object : Objectvoidpublic function addListener(String eventName, Function handler, [Object scope], [Object options])
eventName : Stringhandler : Functionscope : Objectoptions : Object Combining Options
Using the options argument, it is possible to combine different types of listeners:
A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, forumId: 4 }); The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers.
Attaching multiple handlers in 1 call
Code:
el.on({ 'click' : { fn: this.onClick scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver scope: this }, 'mouseout' : { fn: this.onMouseOut scope: this } }); Or a shorthand syntax:
Code:
el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });voidpublic function disable()
voidpublic function enable()
voidpublic function fireEvent(String eventName, Object... args)
eventName : Stringargs : Object...Booleanpublic function focus(Boolean selectText)
selectText : Booleanvoidpublic function getEl()
Ext.Elementpublic function getId()
Stringpublic function getValue()
Datepublic function hasListener(String eventName)
eventName : StringBooleanpublic function hide()
voidpublic function isVisible()
voidpublic function on(String eventName, Function handler, [Object options])
eventName : Stringhandler : Functionoptions : Objectvoidpublic function purgeListeners()
voidpublic function removeListener(String eventName, Function handler, [Object scope])
eventName : Stringhandler : Functionscope : Objectvoidpublic function render([String/HTMLElement/Element container])
container : String/HTMLElement/Elementvoidpublic function setDisabled(Boolean disabled)
disabled : Booleanvoidpublic function setValue(Date value)
value : Datevoidpublic function setVisible(Boolean visible)
visible : Booleanvoidpublic function show()
voidpublic function un(String eventName, Function handler, [Object scope])
eventName : Stringhandler : Functionscope : Objectvoidpublic event beforedestroy
this : Ext.Componentpublic event beforehide
this : Ext.Componentpublic event beforerender
this : Ext.Componentpublic event beforeshow
this : Ext.Componentpublic event destroy
this : Ext.Componentpublic event disable
this : Ext.Componentpublic event enable
this : Ext.Componentpublic event hide
this : Ext.Componentpublic event render
this : Ext.Componentpublic event select
this : DatePickerdate : Datepublic event show
this : Ext.ComponentconstrainToViewport : Boolean
dayNames : Array
disabledDatesRE : RegExp
disabledDatesText : String
disabledDays : Array
disabledDaysText : String
format : String
maxDate : Date
maxText : String
minDate : Date
minText : String
monthNames : Array
monthYearText : String
nextText : String
prevText : String
startDay : Number
todayText : String
todayTip : String