| Package | mx.formatters |
| Class | public class ZipCodeFormatter |
| Inheritance | ZipCodeFormatter  Formatter Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 theformatStringproperty. -
"Invalid format"means any of the characters in theformatStringproperty do not match the allowed characters specified in thevalidFormatCharsproperty, or the number of numeric placeholders does not equal 9, 5, or 6.
Show MXML Syntax
Hide MXML SyntaxThe <mx:ZipCodeFormatter> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:ZipCodeFormatter
formatString="#####|#####-####|### ###"
/>
More examples
Formatter example
Writing an error handler function for an MX formatter
Formatting zip codes with an MX formatter
Writing an error handler function for an MX formatter
Formatting zip codes with an MX formatter
Learn more
Related API Elements
Public Properties
| 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 | |
Protected Properties
Public Methods
| 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 | |
Protected Methods
Property Detail
formatString | property |
formatString:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The mask pattern.
Possible values are "#####-####",
"##### ####", "#####",
"###-###" and "### ###".
The default value is "#####".
Implementation
public function get formatString():String public function set formatString(value:String):voidConstructor Detail
ZipCodeFormatter | () | Constructor |
public function ZipCodeFormatter()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Method Detail
format | () | method |
override public function format(value:Object):String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
|
Examples How to use this example
ZipCodeFormatterExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate ZipCodeFormatter. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx">
<fx: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 = "";
}
}
]]>
</fx:Script>
<fx:Declarations>
<mx:ZipCodeFormatter id="zipFormatter" formatString="#####-####"/>
<mx:ZipCodeValidator id="zcVal" source="{zip}" property="text" allowedFormatChars=""/>
</fx:Declarations>
<s:Panel title="ZipCodeFormatter Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<mx:Form left="10" right="10" top="10" bottom="10">
<mx:FormItem label="Enter a 5 or 9 digit U.S. ZIP code:" width="100%">
<s:TextInput id="zip" text=""/>
</mx:FormItem>
<mx:FormItem label="Formatted ZIP code: " width="100%">
<s:TextInput id="formattedZipcode" text="" editable="false"/>
</mx:FormItem>
<mx:FormItem>
<s:Button label="Validate and Format" click="Format();"/>
</mx:FormItem>
</mx:Form>
</s:Panel>
</s:Application>
Mon Nov 28 2011, 06:48 AM -08:00