DateInputComponent

Description

Renders a date input box to collect user input from. This component fires a event change where we select older months using the mouse. That can be prevented using arrow keys. The component is fully localized according to the selected user locale.

Options

name
The name of the component
type
dateInputComponent
listeners
Array - Parameters who this component will react to
parameter
Variable where the input is stored
htmlObject
Id of the component (usually a div or a span tag) to be replaced by the result
refreshPeriod
Time in seconds for this component to refresh. Default is 0 (disabled)
dateFormat
String - Format used for date output and parsing (including startDate and endDate fields). Must be a jquery datePicker format string:
  • d - day of month (no leading zero)
  • dd - day of month (two digit)
  • D - day name short
  • DD - day name long
  • m - month of year (no leading zero)
  • mm - month of year (two digit)
  • M - month name short
  • MM - month name long
  • y - year (two digit)
  • yy - year (four digit)
  • @ - Unix timestamp (also known as epoch seconds or POSIX time) in milliseconds since 01/01/1970
  • '...' - literal text
  • '' - single quote
  • anything else - literal text
Default is 'yy-mm-dd'.
startDate
String - Component will only allow selection of dates after this value. Value is a string containing a date compliant to this component's dateFormat. Special value 'TODAY' will translate to current date whenever the component is updated. Empty by default (no restriction)
endDate
String - Component will only allow selection of dates before this value. Value is a string containing a date compliant to this component's dateFormat. Special value 'TODAY' will translate to current date whenever the component is updated. Empty by default (no restriction)
onOpenEvent
Function - Function to be called when the 'onOpen' event is triggered
onCloseEvent
Function - Function to be called when the 'onClose' event is triggered
executeAtStart
True to execute the component at start, false otherwise
tooltip
Tooltip to be displayed when mouse hovers
preExecution
Function - Function to be called before the component is executed
postExecution
Function - Function to be called after the component is executed
preChange
Function - Function to be called before the component is changed
postChange
Function - Function to be called after the component is changed

Sample