CurrencyFormatter  - AS3 Flex

Nom de l’identificateur de paramètres régionaux utilisé par cet objet de classe. Il s’agit des paramètres régionaux qui sont utilisés pour accéder à la fonctionnalité et aux données de formatage à partir du système d’exploitation.

Si les paramètres régionaux définis par le style des paramètres régionaux ne sont pas disponibles, la valeur de la propriété actualLocaleIDName est différente de la valeur du style des paramètres régionaux. Elle indique les paramètres régionaux de secours qui sont utilisés. Si le style de paramètres régionaux a été défini sur LocaleID.DEFAULT, le nom des paramètres régionaux spécifié par le système d’exploitation de l’utilisateur est utilisé.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement change .

Eléments de l’API associés

Le code de devise ISO 4217 à trois lettres correspondant aux paramètres régionaux en cours d’utilisation (par ex., USD, EUR, JPY, CNY).

Lorsque la propriété useCurrencySymbol est définie sur false, ce code est utilisé pour indiquer le type de devise lors du formatage des montants en devise à l’aide de la méthode format().

Cette propriété est initialisée lorsque le style de paramètres régionaux est défini en fonction des paramètres régionaux utilisés. En cas d’utilisation de paramètres régionaux de secours, cette propriété reflète le code de devise préféré/par défaut correspondant à ces paramètres.

La valeur par défaut dépend des paramètres régionaux et du système d’exploitation.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement change .

Eléments de l’API associés

Chaîne ou symbole de devise correspondant aux paramètres régionaux actuellement spécifiés.

Cette propriété est utilisée en tant que symbole de devise lors du formatage des montants en devise à l’aide de la méthode format() avec le paramètre withCurrencySymbol défini sur true.

Cette propriété est initialisée lorsque le style de paramètres régionaux est défini en fonction des paramètres régionaux utilisés. En cas d’utilisation de paramètres régionaux de secours, cette propriété reflète le code de devise préféré/par défaut correspondant à ces paramètres, lequel peut être différent de celui du style de paramètres régionaux.

La valeur par défaut dépend des paramètres régionaux et du système d’exploitation.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement change .

Eléments de l’API associés

Valeur numérique qui indique un modèle de formatage pour les montants en devise négatifs. Ce modèle définit l’emplacement du symbole de devise et du symbole négatif ou des parenthèses par rapport à la partie numérique du montant en devise.

La valeur de cette propriété doit être l’une des constantes définies dans le tableau ci-dessous.

Le tableau ci-dessous récapitule les modèles de formatage disponibles pour les montants en devise négatifs. Lorsqu’un montant en devise est formaté avec la méthode format() :

• Le symbole « ¤ » est remplacé par la valeur de la propriété currencyISOCode ou currencySymbol, selon la valeur du paramètre withCurrencySymbol transmis à la méthode format() ;
• Le caractère « - » est remplacé par la valeur de la propriété negativeNumberSymbol ;
• Le caractère « n » est remplacé par le montant en devise transmis à la méthode format().

La valeur par défaut dépend des paramètres régionaux et du système d’exploitation.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement change .

Eléments de l’API associés

Valeur numérique qui indique un modèle de formatage pour les montants en devise positifs. Ce format définit l’emplacement du symbole de devise par rapport à la partie numérique du montant en devise.

La valeur de cette propriété doit être l’une des constantes définies dans le tableau ci-dessous.

Le tableau ci-dessous récapitule les modèles de formatage disponibles pour les montants en devise positifs. Lorsqu’un montant en devise est formaté avec la méthode format() :

• Le symbole « ¤ » est remplacé par la valeur de la propriété currencyISOCode ou currencySymbol, selon la valeur du paramètre withCurrencySymbol transmis à la méthode format() ;
• Le caractère « n » est remplacé par le montant en devise transmis à la méthode format().

La valeur par défaut dépend des paramètres régionaux et du système d’exploitation.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement change .

Eléments de l’API associés

Permet l’utilisation de la propriété currencySymbol lors du formatage de montants en devise.

Lorsque la propriété useCurrencySymbol est définie sur true, la valeur de la propriété currencySymbol est utilisée dans la chaîne renvoyée par la méthode format. Par exemple : $123,456,789.22

Lorsque la propriété useCurrencySymbol est définie sur false, la valeur de la propriété currencyISOCode est utilisée dans la chaîne renvoyée par la méthode format. Par exemple : USD 123,456,789.22

La valeur par défaut est false.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement change .

Eléments de l’API associés

Construit un nouvel objet CurrencyFormatter pour formater les nombres représentant des montants en devise en fonction des conventions des paramètres régionaux en vigueur.

Les paramètres régionaux pour cette classe sont fournis par le style locale. Le style locale peut être défini de plusieurs manières :

• En utilisant la classe dans une déclaration MXML et en héritant les paramètres régionaux à partir du document qui contient la déclaration.
Exemple :

      <fx:Declarations> 
             <s:CurrencyFormatter id="cf" /> 
      </fx:Declarations>
      

• En utilisant une déclaration MXML et en spécifiant la valeur des paramètres régionaux dans la liste des affectations.
Exemple :

      <fx:Declarations> 
          <s:CurrencyFormatter id="cf_Japanese" locale="ja-JP" /> 
      </fx:Declarations>
      

• En appelant la méthode setStyle, par ex. cf. setStyle("locale", "ja-JP")
• En héritant le style à partir d’un composant UIComponent en appelant la méthode addStyleClient() du composant UIComponent.

Si le style locale n’est défini par aucune des techniques ci-dessus, l’instance de cette classe sera ajoutée comme StyleClient à topLevelApplication. Elle hérite par conséquent du style locale de l’objet topLevelApplication lors de l’appel de l’accesseur de lecture de la propriété dépendante de locale ou de la méthode dépendante de locale.

La plupart des propriétés de cette classe sont définies automatiquement en fonction du style de paramètres régionaux. Si le style des paramètres régionaux est modifié, toutes les propriétés qui n’ont pas été explicitement définies seront également mises à jour en fonction des nouveaux paramètres régionaux. Notez que les véritables paramètres régionaux utilisés sont spécifiés par la propriété actualLocaleIDName.

REMARQUE : en cas d’utilisation de paramètres régionaux de secours, les propriétés de devise sont définies sur les valeurs par défaut. Par conséquent, il est possible que les propriétés currencySymbol et currencyISOCode se voient attribuer des valeurs inattendues. Il est conseillé d’examiner les valeurs des propriétés currencySymbol et currencyISOCode avant de formater un montant en devise.

Eléments de l’API associés

Crée une chaîne représentant un montant en devise formaté selon les propriétés actuelles de cet objet CurrencyFormatter, y compris les propriétés locale, useCurrencySymbol, currencySymbol ou currencyISOCode.

La propriété useCurrencySymbol détermine si la méthode format utilise la propriété currencySymbol ou currencyISOCode dans le montant en devise formaté. La valeur par défaut de la propriété useCurrencySymbolest false, si bien que, par défaut, les montants en devise seront formatés à l’aide de la propriété currencyISOCode.

De nombreux pays et régions utilisent les mêmes symboles de devise pour différentes devises. Par exemple, les Etats-Unis, l’Australie, la Nouvelle-Zélande, le Canada et le Mexique utilisent tous le même symbole du dollar ($) pour différentes valeurs monétaires. Lorsque la devise de formatage diffère de la devise locale de l’utilisateur, il est préférable d’utiliser le code ISO comme chaîne de devise. Vous pouvez utiliser la méthode formattingWithCurrencySymbolIsSafe() pour vérifier si le code ISO de la devise à formater correspond au code ISO de devise par défaut pour les paramètres régionaux utilisés par le formateur.

Cette méthode permet de formater les nombres de grandes et de petites amplitudes. Cependant, le nombre de chiffres significatifs est limité à la précision fournie par le type de données Number.

S’il se produit une erreur lors du formatage, en raison d’une valeur en entrée non valide ou d’une autre erreur, par défaut, la méthode format() renvoie null. Cependant, si la propriété errorText n’a pas la valeur null, la valeur de la propriété errorText est renvoyée. La propriété lastOperationStatus est définie pour indiquer l’erreur qui s’est produite.

Paramètres

Eléments de l’API associés

      <fx:Declarations>
        <s:CurrencyFormatter id="cf_use_ISOCode" locale="fr-CA" />
        <s:CurrencyFormatter id="cf_use_Symbol" locale="fr-CA" 
                           useCurrencySymbol="true" />
      </fx:Declarations>
      
      <s:VGroup>
        <!-- label will use ISO code: 1,234,567.89 CAD -->
        <s:Label text="{cf_use_ISOCode.format(1234567.89)}" /> 
        <!-- label will use currency symbol: 1,234,567.89 $ -->
        <s:Label text="{cf_use_Symbol.format(1234567.89)}" /> 
      </s:VGroup>
     
      

      <fx:Declarations>
       <s:CurrencyFormatter id="cf_CAD" locale="{LocaleID.DEFAULT}"
        currencyISOCode="CAD"
        useCurrencySymbol="{cf_CAD.formattingWithCurrencySymbolIsSafe('CAD')}"
       />
      </fx:Declarations>
      
      <fx:Script>
      <![CDATA[
          import flash.globalization.LocaleID;
      ]]>
      </fx:Script>
      
      <!-- label will use ISO code or currency symbol depending on
              user's default locale -->
      <s:Label text="{cf_CAD.format(1234567.89)}" />
      

Détermine si le symbole de devise actuellement spécifié peut être utilisé lors du formatage des montants en devise.

De nombreux pays et régions utilisent les mêmes symboles de devise. Il est possible d’utiliser cette méthode pour empêcher l’utilisation d’un symbole de devise ambigu, ou d’un symbole de devise ou d’un code ISO différent de celui attendu en raison de l’utilisation de paramètres régionaux par défaut.

Cette méthode est généralement utilisée pour déterminer s’il est nécessaire ou non d’afficher un symbole de devise local (si le montant est formaté en fonction de la devise par défaut de l’utilisateur) ou une chaîne de code ISO plus spécifique (si le montant est formaté en fonction d’une devise différente de la devise par défaut de l’utilisateur).

Cette méthode compare le paramètre requestedISOCode à la propriété currencyISOCode par défaut des paramètres régionaux, et renvoie true si les chaînes sont égales ou false si elles ne le sont pas. Lorsque les chaînes sont égales, si vous utilisez la méthode format() avec la propriété useCurrencySymbol définie sur true, vous obtenez une chaîne de valeur monétaire formatée avec un symbole de devise qui est utilisé dans les paramètres régionaux actuels. Si cette méthode renvoie false, l’utilisation de la méthode format() avec la propriété useCurrencySymbol définie sur true peut entraîner l’utilisation d’un symbole de devise incorrect ou ambigu.

Paramètres

Eléments de l’API associés

Répertorie tous les noms des ID de paramètres régionaux pris en charge par cette classe. Il s’agit de la liste des paramètres régionaux pris en charge par le système d’exploitation, et non d’une liste de paramètres régionaux pour laquelle la classe ResourceManager dispose de ressources.

Analyse une chaîne en un montant en devise et un symbole de devise.

L’algorithme d’analyse utilise la valeur de la propriété decimalSeparator pour déterminer la partie intégrale et fractionnaire du nombre. Il utilise les valeurs des propriétés negativeCurrencyFormat et positiveCurrencyFormat pour déterminer l’emplacement du symbole ou de la chaîne de devise par rapport au montant en devise. En cas de montants négatifs, la valeur de la propriété negativeCurrencyFormat détermine l’emplacement du symbole négatif et indique si des parenthèses sont utilisées.

Si l’ordre du symbole de devise, le signe moins et le nombre dans la chaîne saisie ne correspondent pas au modèle identifié par les propriétés negativeCurrencyFormat et positiveCurrencyFormat, alors :

1. La propriété value de l’objet CurrencyParseResult renvoyé est définie sur NaN.
2. La propriété currencyString de l’objet CurrencyParseResult renvoyé est définie sur null.
3. La propriété lastOperationStatus est définie sur LastOperationStatus.PARSE_ERROR pour indiquer que l’analyse a échoué.

La chaîne saisie peut comporter des espaces, qui sont ignorés durant l’analyse.

L’analyse peut aboutir même en cas d’absence de symbole de devise. La partie de la chaîne correspondant au symbole de devise n’est pas validée. En cas d’absence de chaîne ou de symbole de devise, la propriété currencyString de l’objet CurrencyParseResult renvoyé est définie sur une chaîne vide.

Paramètres

Eléments de l’API associés