Package | spark.formatters |
Classe | public class NumberFormatter |
Héritage | NumberFormatter NumberFormatterBase GlobalizationBase AdvancedStyleClient EventDispatcher Object |
Implémente | IFormatter |
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 4.5 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2.5 |
int
, uint
et Number
.
Cette classe est une classe d’enveloppe autour de la classe flash.globalization.NumberFormatter. Par conséquent, le formatage spécifique aux paramètres régionaux est fourni par l’objet flash.globalization.NumberFormatter. Toutefois, cette classe NumberFormatter peut être utilisée dans les déclarations MXML, utilise le style de paramètres régionaux pour le nom d’ID de paramètres régionaux demandé, et possède des méthodes et des propriétés qui sont liables.
La classe flash.globalization.NumberFormatter utilise le système d’exploitation sous-jacent pour la fonctionnalité de formatage et pour fournir les données spécifiques aux paramètres régionaux. Sur certains systèmes d’exploitation, les classes flash.globalization ne sont pas prises en charge ; sur ces systèmes, cette classe d’enveloppe fournit des fonctionnalités de secours.
Syntaxe MXMLMasquer la syntaxe MXMLThe <s:NumberFormatter>
tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
<s:NumberFormatter Properties negativeNumberFormat="locale and OS dependent" />
Eléments de l’API associés
Propriété | Défini par | ||
---|---|---|---|
actualLocaleIDName : String [override] [lecture seule]
Nom de l’identificateur de paramètres régionaux utilisé par cet objet de classe. | NumberFormatter | ||
className : String [lecture seule]
Nom de la classe du composant. | AdvancedStyleClient | ||
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
decimalSeparator : String
Le séparateur décimal utilisé pour le formatage ou l’analyse des nombres ayant une partie décimale. | NumberFormatterBase | ||
digitsType : uint
Définit le jeu de caractères numériques à utiliser lors du formatage des nombres. | NumberFormatterBase | ||
errorText : String
Chaîne de remplacement renvoyée par la méthode format() lorsqu’une erreur se produit. | NumberFormatterBase | ||
fractionalDigits : int
Nombre maximal de chiffres pouvant apparaître après le séparateur décimal. | NumberFormatterBase | ||
groupingPattern : String
Décrit le placement des séparateurs de groupes dans la chaîne de nombres formatée. | NumberFormatterBase | ||
groupingSeparator : String
Caractère ou chaîne utilisé(e) pour le séparateur de groupes. | NumberFormatterBase | ||
id : String
Identité du composant. | AdvancedStyleClient | ||
inheritingStyles : Object
Objet contenant les styles héritables de cette instance de client de style non visuel. | AdvancedStyleClient | ||
lastOperationStatus : String [override] [lecture seule]
Etat de la dernière opération que cet objet de classe a effectuée. | NumberFormatterBase | ||
leadingZero : Boolean
Indique si un nombre est précédé d’un zéro lorsque celui-ci ne contient aucun nombre entier à gauche du séparateur décimal. | NumberFormatterBase | ||
moduleFactory : IFlexModuleFactory
Une fabrique de modules est utilisée comme contexte pour la recherche du gestionnaire de style qui contrôle les styles de cette instance de client de style non visuel. | AdvancedStyleClient | ||
negativeNumberFormat : uint
Valeur numérique qui indique un modèle de formatage pour les nombres négatifs. | NumberFormatter | ||
negativeSymbol : String
Symbole négatif à utiliser lors du formatage des valeurs négatives. | NumberFormatterBase | ||
nonInheritingStyles : Object
Début de la chaîne de styles non hérités de ce composant. | AdvancedStyleClient | ||
styleDeclaration : CSSStyleDeclaration
Déclaration de style contenant les styles en ligne déclarés par cet objet. | AdvancedStyleClient | ||
styleManager : IStyleManager2 [lecture seule]
Renvoie l’instance SystemManager utilisée par ce composant. | AdvancedStyleClient | ||
styleName : Object
Source des valeurs de style de cet objet. | AdvancedStyleClient | ||
styleParent : IAdvancedStyleClient
Le parent d’un composant permet d’évaluer les sélecteurs descendants. | AdvancedStyleClient | ||
trailingZeros : Boolean
Indique si un nombre formaté est précédé de zéros. | NumberFormatterBase | ||
useGrouping : Boolean
Permet l’utilisation du séparateur de groupes lors du formatage des nombres. | NumberFormatterBase |
Méthode | Défini par | ||
---|---|---|---|
Construit un nouvel objet NumberFormatter pour formater les numéros en fonction des conventions de paramètres régionaux donnés. | NumberFormatter | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | EventDispatcher | ||
Supprime une propriété de style de cette instance de composant. | AdvancedStyleClient | ||
Distribue un événement dans le flux d’événements. | EventDispatcher | ||
Formate un nombre. | NumberFormatter | ||
[statique]
Répertorie tous les noms des ID de paramètres régionaux pris en charge par cette classe. | NumberFormatter | ||
Renvoie un tableau d’objets CSSStyleDeclaration pour le sélecteur de type qui s’applique à ce composant. Renvoie la valeur null si aucun n’existe. | AdvancedStyleClient | ||
[override]
Extrait une propriété de style ayant été définie n’importe où dans la chaîne de recherche de style de ce composant. | GlobalizationBase | ||
Renvoie true si la valeur currentCSSState n’est pas nulle. | AdvancedStyleClient | ||
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
La méthode initialized est appelée lorsque cette classe ou une classe qui étend cette classe est utilisée dans une déclaration MXML. | AdvancedStyleClient | ||
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 | ||
Renvoie la valeur true si cssState correspond à currentCSSState. | AdvancedStyleClient | ||
Détermine si l’instance est identique au, ou est une sous-classe du, type donné. | AdvancedStyleClient | ||
Propage les changements de style aux enfants de cette instance du client de style. | AdvancedStyleClient | ||
Analyse une chaîne et renvoie un objet NumberParseResult contenant les éléments analysés. | NumberFormatter | ||
Analyse une chaîne qui contient uniquement des chiffres et des espaces blancs facultatifs, et renvoie un nombre. | NumberFormatter | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
Configure les valeurs de cache du style interne afin que la méthode getStyle() fonctionne. | AdvancedStyleClient | ||
Enregistre le gestionnaire EffectManager comme l’un des écouteurs d’événement pour chaque événement d’effet. | AdvancedStyleClient | ||
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Définit une propriété de style pour cette instance de composant. | AdvancedStyleClient | ||
Détecte les modifications apportées aux propriétés de style. | AdvancedStyleClient | ||
Flex() appelle la méthode stylesInitialized() lorsque les styles d’un composant sont d’abord initialisés. | AdvancedStyleClient | ||
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | ||
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | ||
Renvoie la valeur primitive de l’objet spécifié. | Object | ||
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | EventDispatcher |
Les styles sont soit communs soit associés à un thème spécifique. Si le style est commun, il peut être utilisé avec n’importe quel thème. Si un style est associé à un thème spécifique, il ne peut être utilisé que si votre application utilise ce thème.
actualLocaleIDName | propriété |
actualLocaleIDName:String
[lecture seule] [override] Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 4.5 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2.5 |
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
.
Implémentation
override public function get actualLocaleIDName():String
Eléments de l’API associés
NumberFormatter()
negativeNumberFormat | propriété |
negativeNumberFormat:uint
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 4.5 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2.5 |
Valeur numérique qui indique un modèle de formatage pour les nombres négatifs. Ce modèle définit l’emplacement du symbole négatif ou des parenthèses par rapport à la partie numérique du nombre formaté.
Le tableau suivant récapitule les formats disponibles pour les nombres négatifs. Lorsqu’un nombre négatif est formaté, le signe moins est remplacé par la valeur de la propriété negativeSymbol
et le caractère « n » par la valeur numérique formatée.
Type de format de nombre négatif | Format |
0 | (n) |
1 | -n |
2 | - n |
3 | n- |
4 | n - |
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
.
Implémentation
public function get negativeNumberFormat():uint
public function set negativeNumberFormat(value:uint):void
Valeur émise
ArgumentError — si la valeur assignée n’est pas un numéro compris entre 0 et 4.
|
Eléments de l’API associés
NumberFormatter | () | Constructeur |
public function NumberFormatter()
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 4.5 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2.5 |
Construit un nouvel objet NumberFormatter pour formater les numéros en fonction des conventions de paramètres régionaux donnés.
Les paramètres régionaux pour cette classe sont fournis par le style de paramètres régionaux. Le style de paramètres régionaux 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:NumberFormatter id="nf" /> </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:NumberFormatter id="nf_French_France" locale="fr_FR" /> </fx:Declarations>
-
L’appel de la méthode setStyle. Par exemple :
nf.setStyle("locale", "fr-FR")
-
En héritant le style à partir d’un composant
UIComponent
en appelant la méthodeaddStyleClient()
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.
Eléments de l’API associés
format | () | méthode |
public function format(value:Object):String
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 4.5 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2.5 |
Formate un nombre.
Cette fonction formate le nombre en fonction des valeurs de propriété de l’outil de formatage. Si les propriétés ne sont pas modifiées après la définition du style de paramètres régionaux
, les nombres sont formatés en fonction des conventions spécifiques aux paramètres régionaux fournies par le système d’exploitation pour les paramètres régionaux identifiés par la propriété actualLocaleIDName
. Pour personnaliser le format, les propriétés peuvent être modifiées en vue de contrôler certains aspects de formatage d’un nombre.
Les très grands nombres et les nombres à très petite amplitude peuvent être formatés avec cette fonction. Cependant, le nombre de chiffres significatifs est limité à la précision fournie par l’objet Number
. La notation scientifique n’est pas pris en charge.
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
sera définie pour indiquer l’erreur qui s’est produite.
Paramètres
value:Object — Objet contenant une valeur numérique à formater. Si l’objet n’est pas un nombre , il est converti en nombre à l’aide de la fonction de conversion Number() .
|
String — Chaîne numérique formatée.
|
Eléments de l’API associés
getAvailableLocaleIDNames | () | méthode |
public static function getAvailableLocaleIDNames():Vector.<String>
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 4.5 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2.5 |
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.
Valeur renvoyéeVector.<String> — Vecteur de chaînes contenant tous les noms des identificateurs de paramètres régionaux pris en charge par cette classe et ce système d’exploitation.
|
parse | () | méthode |
public function parse(inputString:String):NumberParseResult
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 4.5 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2.5 |
Analyse une chaîne et renvoie un objet NumberParseResult
contenant les éléments analysés.
L’objet NumberParseResult
contient la valeur du premier nombre détecté dans la chaîne saisie, l’index de début correspondant au nombre dans la chaîne, et l’index du premier caractère après le nombre dans la chaîne.
Si la chaîne ne contient pas de nombre, la propriété value de l’objet NumberParseResult est définie sur NaN
, et les propriétés startIndex
et endIndex
sont définies sur la valeur hexadécimale 0x7fffffff
.
Cette fonction utilise la valeur de la propriété decimalSeparator
pour déterminer la partie du nombre contenant les chiffres fractionnaires, la propriété groupingSeparator
pour identifier les caractères autorisés dans les chiffres d’un nombre, ainsi que la propriété negativeNumberFormat
pour gérer le mode de représentation des valeurs négatives.
Le tableau suivant identifie le résultat des chaînes analysées pour les différentes valeurs de la propriété NegativeNumberFormat
:
NegativeNumberFormat | Chaîne d’entrée | Résultat |
(n) | "(123)" ou "( 123 )" | "-123" |
-n | "-123" ou "- 123" | "-123" |
- n | "-123" ou "- 123" | "-123" |
n- | "123-" ou "123 -" | "-123" |
n - | "123-" ou "123 -" | "-123" |
Un seul espace blanc est autorisé entre le nombre et le signe moins ou la parenthèse. Un espace blanc est un caractère disposant d’une propriété de séparateur d’espace (Zs) dans la base de données des caractères Unicode. Pour plus d’informations, voir http://www.unicode.org/ucd/).
D’autres propriétés sont ignorées pour déterminer si un nombre est valide. Concrètement, la valeur de la propriété digitsType
est ignorée et les chiffres peuvent provenir de l’un quelconque des jeux de chiffres énumérés dans la classe NationalDigitsType
. Les valeurs des propriétés groupingPattern
et useGrouping
n’ont aucune incidence sur l’analyse du nombre.
Dans la chaîne, si les nombres sont précédés ou suivis d’un signe plus (+), ce signe est traité comme un caractère ne faisant pas partie du nombre.
Cette fonction n’analyse pas les chaînes contenant des nombres en notation scientifique (par exemple, 1.23e40).
Paramètres
inputString:String — Chaîne d’entrée à analyser.
|
NumberParseResult — Objet NumberParseResult contenant la valeur numérique et les index pour le début et la fin de la partie de la chaîne qui contient le nombre.
|
Valeur émise
TypeError — si le paramètre inputString est null.
|
Eléments de l’API associés
Exemple ( Comment utiliser cet exemple )
var nf:NumberFormatter = new NumberFormatter(); nf.setStyle("locale","fr-FR"); var str:String = "1,56 mètre" var result:NumberParseResult = nf.parse(str); trace(result.value) // 1.56 trace(str.substr(0,result.startIndex)); // "" trace(str.substr(result.startIndex, result.endIndex)); // "1,56" trace(str.substr(result.endIndex)); // " mètre"
parseNumber | () | méthode |
public function parseNumber(parseString:String):Number
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 4.5 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2.5 |
Analyse une chaîne qui contient uniquement des chiffres et des espaces facultatifs, et renvoie un nombre. Si la chaîne ne commence pas par un nombre ou contient des caractères autres que des espaces qui ne font pas partie du nombre, cette méthode renvoie NaN
. Les espaces blancs avant ou après les chiffres sont ignorés.
Si le chiffre est précédé ou suivi d’un signe plus « + », il est considéré comme un caractère autre qu’un espace blanc. La valeur renvoyée est NaN
.
Voir la description de la fonction d’analyse pour plus d’informations sur l’analyse des nombres et les caractéristiques d’un numéro valide.
Paramètres
parseString:String — Chaîne d’entrée à analyser.
|
Number — Un objet Number contenant la valeur numérique.
|
Valeur émise
TypeError — si parseString est null
|
Eléments de l’API associés
<?xml version="1.0" encoding="utf-8"?> <!-- Sample program for spark.formatters.NumberFormatter --> <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:Declarations> <s:NumberFormatter id="numberFormatter"/> </fx:Declarations> <fx:Script> <![CDATA[ [Bindable] private var number:Number = 123456789.123456789; ]]> </fx:Script> <mx:Form> <mx:FormItem label="Input Locale ID Name"> <mx:HBox> <s:TextInput id="inputLocaleIDName"/> <!-- Upon button click, sets the locale style on the document UI component. The formatter will inherit this style. --> <s:Button click="setStyle('locale', inputLocaleIDName.text);" label="Apply"/> </mx:HBox> <mx:Text text="Example: 'en-US', 'fr-FR', 'ja-JP', 'ar-SA'"/> </mx:FormItem> <mx:FormItem label="Use Grouping"> <mx:CheckBox id="useGrouping" change="numberFormatter.useGrouping= useGrouping.selected"/> </mx:FormItem> <mx:FormItem label="Fractional Digits"> <mx:TextInput id="fractionalDigits" change="numberFormatter.fractionalDigits = Number(fractionalDigits.text)"/> </mx:FormItem> <mx:FormItem label="Actual Locale ID Name"> <mx:Text text="{numberFormatter.actualLocaleIDName}"/> </mx:FormItem> <mx:FormItem label="Formatted Result"> <mx:Text text="{numberFormatter.format(number)}"/> </mx:FormItem> </mx:Form> </s:Application>
<?xml version="1.0" encoding="utf-8"?> <!-- Sample program for spark.formatters.NumberFormatter --> <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:Declarations> <s:NumberFormatter id="numberFormatter"/> </fx:Declarations> <mx:Form> <mx:FormItem label="Input Locale ID Name"> <mx:HBox> <s:TextInput id="inputLocaleIDName"/> <!-- Upon button click, sets the locale style on the document UI component. The formatter will inherit this style. --> <s:Button click="setStyle('locale', inputLocaleIDName.text);" label="Apply"/> </mx:HBox> <mx:Text text="Example: 'en-US', 'fr-FR', 'ja-JP', 'ar-SA'"/> </mx:FormItem> <mx:FormItem label="Input Number"> <s:TextInput id="inputNumber"/> <mx:Text text="Example: {numberFormatter.format(123456789.123)}"/> </mx:FormItem> <mx:FormItem label="Actual Locale ID Name"> <mx:Text text="{numberFormatter.actualLocaleIDName}"/> </mx:FormItem> <mx:FormItem label="Parsed Result"> <mx:Text text="{numberFormatter.parseNumber(inputNumber.text).toString()}"/> </mx:FormItem> </mx:Form> </s:Application>
Tue Jun 12 2018, 09:30 AM Z