| Pacchetto | mx.formatters |
| Classe | public class PhoneFormatter |
| Ereditarietà | PhoneFormatter  Formatter Object |
| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
A shortcut is provided for the United States seven-digit format.
If the areaCode property contains a value
and you use the seven-digit format string, (###-####),
a seven-digit value to format automatically adds the area code
to the returned String.
The default format for the area code is (###).
You can change this using the areaCodeFormat property.
You can format the area code any way you want as long as it contains
three number placeholders.
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, or the value contains a different number of digits than what is specified in the format String. -
"Invalid format"means any of the characters in theformatStringproperty do not match the allowed characters specified in thevalidPatternCharsproperty, or theareaCodeFormatproperty is specified but does not contain exactly three numeric placeholders.
Mostra sintassi MXML
Nascondi sintassi MXMLThe <mx:PhoneFormatter> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:PhoneFormatter
areaCode="-1"
areaCodeFormat="(###)"
formatString="(###) ###-####"
validPatternChars="+()#-. "
/>
Elementi API correlati
| Proprietà | Definito da | ||
|---|---|---|---|
| areaCode : Object
Area code number added to a seven-digit United States
format phone number to form a 10-digit phone number. | PhoneFormatter | ||
| areaCodeFormat : String
Default format for the area code when the areacode
property is rendered by a seven-digit format. | PhoneFormatter | ||
 | constructor : Object
Un riferimento all'oggetto classe o alla funzione di costruzione per una determinata istanza di oggetto. | Object | |
| error : String
Description saved by the formatter when an error occurs. | Formatter | |
| formatString : String
String that contains mask characters
that represent a specified phone number format. | PhoneFormatter | ||
| validPatternChars : String
List of valid characters that can be used
in the formatString property. | PhoneFormatter | ||
| Metodo | Definito da | ||
|---|---|---|---|
Constructor. | PhoneFormatter | ||
[override]
Formats the String as a phone number. | PhoneFormatter | ||
|
Indica se per un oggetto è definita una proprietà specifica. | Object | |
|
Indica se un'istanza della classe Object si trova nella catena di prototipi dell'oggetto specificato come parametro. | Object | |
|
Indica se la proprietà specificata esiste ed è enumerabile. | Object | |
|
Imposta la disponibilità di una proprietà dinamica per le operazioni cicliche. | Object | |
|
Restituisce la rappresentazione in formato stringa di questo oggetto, formattato in base alle convenzioni specifiche per le versioni localizzate. | Object | |
|
Restituisce la rappresentazione in formato stringa dell'oggetto specificato. | Object | |
|
Restituisce il valore di base dell'oggetto specificato. | Object | |
areaCode | proprietà |
areaCode:Object| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Area code number added to a seven-digit United States
format phone number to form a 10-digit phone number.
A value of -1 means do not
prepend the area code.
Il valore predefinito è -1.
Implementazione
public function get areaCode():Object public function set areaCode(value:Object):voidareaCodeFormat | proprietà |
areaCodeFormat:String| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Default format for the area code when the areacode
property is rendered by a seven-digit format.
Il valore predefinito è "(###) ".
Implementazione
public function get areaCodeFormat():String public function set areaCodeFormat(value:String):voidformatString | proprietà |
formatString:String| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
String that contains mask characters that represent a specified phone number format.
Il valore predefinito è "(###) ###-####".
Implementazione
public function get formatString():String public function set formatString(value:String):voidvalidPatternChars | proprietà |
validPatternChars:String| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
List of valid characters that can be used
in the formatString property.
This property is used during validation
of the formatString property.
Il valore predefinito è "+()#- .".
Implementazione
public function get validPatternChars():String public function set validPatternChars(value:String):voidPhoneFormatter | () | Funzione di costruzione |
public function PhoneFormatter()| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Constructor.
format | () | metodo |
override public function format(value:Object):String| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Formats the String as a phone number.
If the value cannot be formatted, return an empty String
and write a description of the error to the error property.
Parametri
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 PhoneFormatter. -->
<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 = pnVal.validate();
if (vResult.type == ValidationResultEvent.VALID) {
formattedPhone.text = phoneFormatter.format(phone.text);
} else {
formattedPhone.text = "";
}
}
]]>
</fx:Script>
<fx:Declarations>
<mx:PhoneFormatter id="phoneFormatter"
formatString="(###) ###-####" validPatternChars="#-() "/>
<mx:PhoneNumberValidator id="pnVal" source="{phone}" property="text"
allowedFormatChars=""/>
</fx:Declarations>
<s:Panel title="PhoneFormatter Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<mx:Form left="10" right="10" top="10" bottom="10">
<mx:FormItem label="Enter a 10-digit phone number:">
<s:TextInput id="phone" text="" width="75%"/>
</mx:FormItem>
<mx:FormItem label="Formatted phone number: ">
<s:TextInput id="formattedPhone" text="" width="75%" editable="false"/>
</mx:FormItem>
<mx:FormItem>
<s:Button label="Validate and Format" click="Format();"/>
</mx:FormItem>
</mx:Form>
</s:Panel>
</s:Application>
Tue Jun 12 2018, 02:44 PM Z