The ZipCodeFormatter class formats a valid number
into one of the following formats, based on a
user-supplied formatString
property.
-
-####
-
### (Canadian)
A six-digit number must be supplied for a six-digit mask. If you use a five-digit or a nine-digit mask, you can use either a five-digit or a nine-digit number for formatting.
If an error occurs, an empty String is returned and a String that
describes the error is saved to the error
property.
The error
property can have one of the following values:
"Invalid value"
means an invalid numeric value is passed to theformat()
method. The value should be a valid number in the form of a Number or a String, except for Canadian postal code, which allows alphanumeric values, or the number of digits does not match the allowed digits from theformatString
property."Invalid format"
means any of the characters in theformatString
property do not match the allowed characters specified in thevalidFormatChars
property, or the number of numeric placeholders does not equal 9, 5, or 6.
See also:
Constructor
Variables
formatString:String
The mask pattern.
Possible values are "#####-####"
,
"##### ####"
, "#####"
,
"###-###"
and "### ###"
.
Methods
format(value:Dynamic):String
Formats the String by using the specified format.
If the value cannot be formatted, return an empty String
and write a description of the error to the error
property.
Parameters:
value | Value to format. |
---|
Returns:
Formatted String. Empty if an error occurs. A description
of the error condition is written to the error
property.