Guide de référence ActionScript® 3.0 pour la plate-forme Adobe® Flash®
Accueil  |  Masquer la liste des packages et des classes |  Packages  |  Classes  |  Nouveautés  |  Index  |  Annexes  |  Pourquoi existe-t-il du contenu en anglais ?
Filtres : Récupération des données du serveur...
Récupération des données du serveur...
mx.formatters 

ZipCodeFormatter  - AS3 Flex

Packagemx.formatters
Classepublic class ZipCodeFormatter
HéritageZipCodeFormatter Inheritance Formatter Inheritance Object

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

La classe ZipCodeFormatter formate un nombre valide en utilisant l’un des formats suivants, basés sur une propriété formatString définie par l’utilisateur.
  • #####-####
  • ##### ####
  • #####
  • ### ### (Canada)

Un nombre à six chiffres doit être fourni pour un modèle à six chiffres. Si vous utilisez un modèle composé de cinq ou neuf chiffres, vous pouvez utiliser un nombre à cinq ou neuf chiffres pour le formatage.

Si une erreur se produit, une chaîne vide est renvoyée et une chaîne décrivant l’erreur est enregistrée dans la propriété error. La propriété error peut prendre l’une des valeurs suivantes :

  • "Invalid value" signifie qu’une valeur numérique non valide a été transmise à la méthode format(). La valeur doit être un nombre valide sous forme de nombre ou de chaîne (sauf pour les codes postaux canadiens, qui autorisent les valeurs alphanumériques), ou le nombre de chiffres ne correspond pas au nombre de chiffres autorisés par la propriété formatString.
  • "Invalid format" signifie qu’au moins un des caractères de la propriété formatString ne correspond pas aux caractères autorisés spécifiés dans la propriété validFormatChars ou que le nombre d’espaces réservés numériques est différent de neuf, cinq ou six.

Syntaxe MXMLexpandedMasquer la syntaxe MXML

The <mx:ZipCodeFormatter> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:ZipCodeFormatter
    formatString="#####|#####-####|### ###"
  />
  

Consulter les exemples

Eléments de l’API associés



Propriétés publiques
 PropriétéDéfini par
 Inheritedconstructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
Object
 Inheritederror : String
Description enregistrée par la classe de formatage lorsqu’une erreur survient.
Formatter
  formatString : String
Modèle de masque.
ZipCodeFormatter
Propriétés protégées
 PropriétéDéfini par
 InheritedresourceManager : IResourceManager
[lecture seule] Référence à l’objet qui gère toutes les ressources localisées de l’application.
Formatter
Méthodes publiques
 MéthodeDéfini par
  
Constructeur.
ZipCodeFormatter
  
[override] Formate la chaîne en utilisant le format spécifié.
ZipCodeFormatter
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
 Inherited
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre.
Object
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
Object
 Inherited
Renvoie la représentation sous forme de chaîne de l’objet spécifié.
Object
 Inherited
Renvoie la valeur primitive de l’objet spécifié.
Object
Méthodes protégées
 MéthodeDéfini par
 Inherited
Cette méthode est appelée lors de la construction d’une classe Formatter, puis chaque fois que ResourceManager envoie un événement "change" pour indiquer que les ressources localisées ont subi une modification.
Formatter
Détails de la propriété

formatString

propriété
formatString:String

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Modèle de masque. Valeurs possibles : "#####-####", "##### ####", "#####", "###-###" et "### ###".

La valeur par défaut est "#####".



Implémentation
    public function get formatString():String
    public function set formatString(value:String):void
Détails du constructeur

ZipCodeFormatter

()Constructeur
public function ZipCodeFormatter()

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Constructeur.

Détails de la méthode

format

()méthode
override public function format(value:Object):String

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Formate la chaîne en utilisant le format spécifié. S’il est impossible de formater la valeur, une chaîne vide est renvoyée et une description de l’erreur est écrite dans la propriété error.

Paramètres

value:Object — Valeur à formater.

Valeur renvoyée
String — Chaîne formatée. Vide si une erreur se produit. Une description de la condition d’erreur est écrite dans la propriété error.
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>




[ X ]Pourquoi existe-t-il du contenu en anglais ?
Certaines parties du Guide de référence ActionScript 3.0 sont en anglais

Tout le contenu du Guide de référence ActionScript 3.0 n’a pas été traduit dans toutes les langues. Si un élément de langage n’est pas traduit, il s’affiche en anglais. Par exemple, la classe ga.controls.HelpBox n’est traduite dans aucune langue. Ainsi, dans la version française du guide de référence, la classe ga.controls.HelpBox apparaît en anglais.