Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: 36ee29d2cf
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 119 lines (96 sloc) 8.408 kb

Parsing, Formatting, and Validating: Dates and Numbers

Status: Draft
Version: 1.0
Author: CraigRiecke, AdamPeller

These widgets augment the functionality of the <INPUT type="text"> tag. The base widget dijit.form.Textbox by itself can trim, change case, and require input. dijit.form.ValidationTextbox extends this by validating the input when the box loses focus. The other widgets further extend the validation function with range and format checking. Internal to the MappedTextBox widget subclass are two INPUT elements. One interacts with the user obeying local customs, the other is hidden and represents the named form element to submit data to the server using a normalized serialization. By default, the widget will discover the appropriate locale and behavior as specified by Dojo.

For example, when using a NumberTextBox in the United States, an optional comma is used for the thousands separator and a period for a decimal separator when interacting with the user. For German users, a period is used for the thousands separator and a comma for the decimal separator. Other locales may have different conventions. When using currencies, the currency type must be specified, but it may be represented differently according to locale. The US Dollar (USD) will simply have a "$" symbol when used in the United States, but that would be ambiguous in Canada, so US$ is used instead.

When sending data to the server or interpreting the "value" attribute, numbers are represented simply as JavaScript formats them with a period for decimal and no thousands separators. This representation is unambiguous, so other applications may interact with this data without assuming any locale-specific behavior. With DateTextBox, a subset of the ISO-8601 format (e.g. 12-31-2006) is used for the value attribute. For CurrencyTextBox, a number is transmitted, and it is the responsibility of the developer to associate the ISO-4217 country code with the amount to qualify what type of currency is indicated. All of these behaviors are considered Dojo and JSON best practices, but may be customized as described below.

Constraints

To override the defaults, you can use the "constraints" attribute. "constraints" is an object passed to functions responsible for validating, parsing, and formatting the data in the box, and various properties may be provided to override system or locale-specific defaults. Constraints are handled in Dojo low-level routines in :ref:`dojo.date <dojo/date>`, dojo.currency and dojo.number, and you can refer to the API documentation for complete details. We summarize them here for convenience:

System Message: ERROR/3 (<string>, line 22); backlink

Unknown interpreted text role "ref".

Number Constraints

  • currency: (currency only) the ISO-4217 currency code, a three letter sequence like "USD" See http://en.wikipedia.org/wiki/ISO_4217 for a current list.
  • fractional: (currency only) where places are implied by pattern or explicit 'places' parameter, whether to include the fractional portion.
  • locale: override the locale on this widget only, choosing from dojoConfig.extraLocale
  • pattern: override localized convention with this pattern. As a result, all users will see the same behavior, regardless of locale, and your application may not be globalized. See http://www.unicode.org/reports/tr35/#Number_Format_Patterns.
  • places: number of decimal places to accept.
  • strict: strict parsing, false by default. When strict mode is false, certain allowances are made to be more tolerant of user input, such as 'am' instead of 'a.m.', some white space may be optional, etc.
  • symbol: (currency only) override currency symbol. Normally, will be looked up in localized table of supported currencies (dojo.cldr) 3-letter ISO 4217 currency code will be used if not found.
  • type: choose a format type based on the locale from the following: decimal, scientific (not yet supported), percent, currency. decimal by default.

Number Pattern Characters

Number Pattern Characters
Symbol Location Localized? Meaning
0 Number Yes Digit
1-9 Number Yes '1' through '9' indicate rounding.
@ Number No Significant digit
# Number Yes Digit, zero shows as absent
. Number Yes Decimal separator or monetary decimal separator
Number Yes Minus sign
, Number Yes Grouping separator
E Number Yes Separates mantissa and exponent in scientific notation. Need not be quoted in prefix or suffix.
Exponent Yes Prefix positive exponents with localized plus sign. Need not be quoted in prefix or suffix.
; Subpattern boundary Yes Separates positive and negative subpatterns
% Prefix or suffix Yes Multiply by 100 and show as percentage
Prefix/suffix boundary Yes Pad escape, precedes pad character

Examples

Date Constraints

  • am,pm: override strings for am/pm in times
  • clickableIncrement (TimeTextBox): ISO-8601 string representing the amount by which every clickable element in the time picker increases. Set in non-Zulu time, without a time zone. Example: "T00:15:00" creates 15 minute increments. Must divide visibleIncrement evenly.
  • datePattern,timePattern: override localized convention with this pattern. As a result, all users will see the same behavior, regardless of locale, and your application may not be globalized. See http://www.unicode.org/reports/tr35/#Date_Format_Patterns
  • formatLength: choose from formats appropriate to the locale -- long, short, medium or full (plus any custom additions). Defaults to 'short'
  • locale: override the locale on this widget only, choosing from dojoConfig.extraLocale
  • selector: choice of 'time', 'date' (default: date and time)
  • strict: false by default. If true, parsing matches exactly by regular expression. If false, more tolerant matching is used for abbreviations and some white space.
  • visibleIncrement (TimeTextBox): ISO-8601-style string representing the amount by which every element with a visible time in the time picker increases. Set in non Zulu time, without a time zone or date. Example: "T01:00:00" creates text in every 1 hour increment.
  • visibleRange (TimeTextBox): ISO-8601 string representing the range of this time picker. The time picker will only display times in this range. Example: "T05:00:00" displays 5 hours of options
Date Pattern Characters
Letter Date or Time Component Presentation Examples
G Era designator Text AD
y Year Year 1996; 96
M Month in year Month July; Jul; 07
w Week in year Number 27
W Week in month Number 2
D Day in year Number 189
d Day in month Number 10
F Day of week in month Number 2
E Day in week Text Tuesday; Tue
a Am/pm marker Text PM
H Hour in day (0-23) Number 0
k Hour in day (1-24) Number 24
K Hour in am/pm (0-11) Number 0
h Hour in am/pm (1-12) Number 12
m Minute in hour Number 30
s Second in minute Number 55
S Millisecond Number 978
z Time zone General time zone Pacific Standard Time; PST; GMT-08:00
Z Time zone RFC 822 time zone -0800

Examples

The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.

Examples
Date and Time Pattern Result
yyyy.MM.dd G 'at' HH:mm:ss
2001.07.04 AD at 12:08:56 PDT
EEE, MMM d, ''y
Wed, Jul 4, '01
h:mm
12:08 PM
hh 'o''clock' a, zzz
12 o'clock PM, Pacific Daylight Time
K:mm a,
0:08 PM, PDT
yyyyy.MMMMM.dd GGG hh:mm aa
02001.July.04 AD 12:08 PM
EEE, d MMM yyyy HH:mm:ss
Wed, 4 Jul 2001 12:08:56 -0700
yyMMddHHmmss
010704120856-0700
yyyy-MM-dd'T'HH:mm:ss.SSS
2001-07-04T12:08:56.235-0700
Something went wrong with that request. Please try again.