| Package | mx.formatters |
| Class | public class ZipCodeFormatter |
| Inheritance | ZipCodeFormatter  Formatter Object |
formatString property.
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 the format() 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 the formatString property."Invalid format" means any of the characters in the
formatString property do not match the allowed characters
specified in the validFormatChars property,
or the number of numeric placeholders does not equal 9, 5, or 6.
Hide MXML SyntaxThe <mx:ZipCodeFormatter> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
Show MXML Syntax
<mx:ZipCodeFormatter
formatString="#####|#####-####|### ###"
/>
See also
| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| defaultInvalidFormatError : String [static]
Error message for an invalid format string specified to the formatter. | Formatter | |
| defaultInvalidValueError : String [static]
Error messages for an invalid value specified to the formatter. | Formatter | |
| error : String
Description saved by the formatter when an error occurs. | Formatter | |
| formatString : String
The mask pattern. | ZipCodeFormatter | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | ZipCodeFormatter | ||
[override]
Formats the String by using the specified format. | ZipCodeFormatter | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
| formatString | property |
formatString:String
The mask pattern.
Possible values are "#####-####",
"##### ####", "#####",
"###-###" and "### ###".
The default value is "#####".
public function get formatString():String public function set formatString(value:String):void| ZipCodeFormatter | () | Constructor |
public function ZipCodeFormatter()Constructor.
| format | () | method |
override public function format(value:Object):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:Object — Value to format.
|
String — Formatted String. Empty if an error occurs. A description
of the error condition is written to the error property.
|
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate ZipCodeFormatter. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Script>
<![CDATA[
import mx.events.ValidationResultEvent;
private var vResult:ValidationResultEvent;
// Event handler to validate and format input.
private function Format():void
{
vResult = zcVal.validate();
if (vResult.type==ValidationResultEvent.VALID) {
formattedZipcode.text= zipFormatter.format(zip.text);
}
else {
formattedZipcode.text= "";
}
}
]]>
</mx:Script>
<mx:ZipCodeFormatter id="zipFormatter" formatString="#####-####"/>
<mx:ZipCodeValidator id="zcVal" source="{zip}" property="text" allowedFormatChars=""/>
<mx:Panel title="ZipCodeFormatter Example" width="75%" height="75%"
paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">
<mx:Form width="100%">
<mx:FormItem label="Enter a 5 or 9 digit U.S. ZIP code:" width="100%">
<mx:TextInput id="zip" text=""/>
</mx:FormItem>
<mx:FormItem label="Formatted ZIP code: " width="100%">
<mx:TextInput id="formattedZipcode" text="" editable="false"/>
</mx:FormItem>
<mx:FormItem>
<mx:Button label="Validate and Format" click="Format();"/>
</mx:FormItem>
</mx:Form>
</mx:Panel>
</mx:Application>
