Date text box (Dojo) Web-only

The Date text box widget is responsible for rendering a Dojo date text box with a pop-up calendar date picker.

This widget renders data supplied by the following component:

Input field

The following figure shows how a Date text box widget appears on a transformation.

Figure 1. Dojo Date text box widget example

The following settings can be configured for this widget:

Pattern

Required. When the user selects a date from the pop-up calendar, the selected date must be formatted to map correctly to what is expected in the host application's input field. This setting specifies the pattern HATS uses to correctly format the selected date. For information about the meaning of symbols in the pattern, see http://docs.dojocampus.org/dojo/date/locale/format.

When you enter a pattern and save it, the HATS Toolkit performs the following conversions to ensure correct symbols are used:

Uppercase D to lowercase d
Uppercase Y to lowercase y
Lowercase m to uppercase M
Lowercase e to uppercase E

Restrict earliest selectable date

If selected, the value specified in the Date field is the earliest date the user can select from the pop-up calendar. The user is not prevented from manually entering an earlier date directly into the associated input field because of this setting.

Note: If the user enters a date outside this range, a warning symbol is displayed. If a range message (default or user-supplied) is defined, then it is displayed.

Date: Enter the date in format MM/DD/YYYY for all locales.

Restrict latest selectable date

If selected, the value specified in the Date field is the latest date the user can select from the pop-up calendar. The user is not prevented from manually entering a later date directly into the associated input field because of this setting.

Note: If the user enters a date outside this range, a warning symbol is displayed. If a range message (default or user-supplied) is defined, then it is displayed.

Date: Enter the date in format MM/DD/YYYY for all locales.

Default value

Optional. This field represents the initial date selected on the pop-up calendar when the host application does not pre-fill the associated input field with a valid date between the specified restricted dates. The interaction between this field and the associated host input field is handled as follows:

If the host application pre-fills the input field with zeros or an incorrect date format, the default value does not overwrite the host field data. To update the associated input field, the user must either manually enter a date, or select a date with the pop-up calendar.
If the default value is not specified or is in an incorrect format, today's date will be initially selected on the pop-up calendar.
If you want to pre-fill the associated input field, add an Insert Data action to your screen customization event before applying the transformation.

Note: The date pattern is MM/DD/YYYY for all locales.

Use default invalid message

Select this box to display the default Dojo invalid message when the user enters an invalid date. Clear this box to supply your own invalid message to display.

Invalid message: Use this field to supply your own invalid message. If you leave this field empty, no message is displayed and only the input field is highlighted.

Note: If you supply your own invalid message, it is displayed to the user in the language you supply. No translation is performed.

Use default range message

Select this box to display the default Dojo range message when the user enters an out-of-range date. Clear this box to supply your own range message to display.

Range message: Use this field to supply your own range message. If you leave this field empty, no message is displayed and only the input field is highlighted.

Note: If you supply your own range message, it is displayed to the user in the language you supply. No translation is performed.

Prompt message: Use this field to supply a prompt message to display when the user selects the text box. For example, you could remind the user of the correct date format to use or to select a date from the pop-up calendar.
Note: If you supply your own prompt message, it is displayed to the user in the language you supply. No translation is performed.

Re-validate on submit: Select this box to prevent page submission when the user enters an invalid date. If not selected, an invalid date is flagged, but still can be submitted to the host.