CurrencyFormatter  - AS3 Flex

The name of the actual locale ID used by this class object. This is the locale that is used to access the formatting data and functionality from the operating system.

If the locale that was set by the locale style is not available, then the value of the actualLocaleIDName is different from the value of the locale style. It indicates the fallback locale that is being used. If the locale style was set to LocaleID.DEFAULT the name of the locale specified by the user's operating system is used.

This property can be used as the source for data binding. When this property is modified, it dispatches the change event.

Related API Elements

The three letter ISO 4217 currency code for the actual locale being used (e.g. USD, EUR, JPY, CNY).

When the useCurrencySymbol property is set to false, this code is used to indicate the currency type when formatting currency amounts using the format() method.

This property is initialized when the locale style is set based on the actual locale that is used. When a fallback locale is used, this property reflects the preferred/default currency code for the fallback locale.

The default value is dependent on the actual locale and operating system.

This property can be used as the source for data binding. When this property is modified, it dispatches the change event.

Related API Elements

The currency symbol or string for the actual locale being used.

This property is used as the currency symbol when formatting currency amounts using the format() method with the withCurrencySymbol parameter set to true.

This property is initialized when the locale style is set based on the actual locale that is used. When a fallback locale is used, this property reflects the preferred/default currency symbol for the fallback locale which may be different then the locale style.

The default value is dependent on the actual locale and operating system.

This property can be used as the source for data binding. When this property is modified, it dispatches the change event.

Related API Elements

A numeric value that indicates a formatting pattern for negative currency amounts. This pattern defines the location of the currency symbol and the negative symbol or parentheses in relation to the numeric portion of the currency amount.

The value of this property must be one of the constants defined in the table below.

The table below summarizes the possible formatting patterns for negative currency amounts. When a currency amount is formatted with the format() method:

• The '¤' symbol is replaced with the value of the currencyISOCode or the currencySymbol property, depending on the value of the withCurrencySymbol parameter passed to the format() method;
• The '-' character is replaced with the value of the negativeNumberSymbol property;
• The 'n' character is replaced with the currency amount value that is passed to the format() method.

The default value is dependent on the actual locale and operating system.

This property can be used as the source for data binding. When this property is modified, it dispatches the change event.

Related API Elements

A numeric value that indicates a formatting pattern for positive currency amounts. This format defines the location of the currency symbol relative to the numeric portion of the currency amount.

The value of this property must be one of the constants defined in the table below.

The table below summarizes the possible formatting patterns for positive currency amounts. When a currency amount is formatted with the format() method:

• The '¤' symbol is replaced with the value of the currencyISOCode or the currencySymbol property, depending on the value of the withCurrencySymbol parameter passed to the format() method;
• The 'n' character is replaced with the currency amount value that is passed to the format() method.

The default value is dependent on the actual locale and operating system.

This property can be used as the source for data binding. When this property is modified, it dispatches the change event.

Related API Elements

Enables the use of the currencySymbol property when formatting currency amounts.

When the useCurrencySymbol property is set to true, the value of the currencySymbol property is used in the string returned by the format method. For example: $123,456,789.22

When the useCurrencySymbol property is set to false, the value of the currencyISOCode property is used in the string returned by the format method. For example: USD123,456,789.22

The default value is false.

This property can be used as the source for data binding. When this property is modified, it dispatches the change event.

Related API Elements

Constructs a new CurrencyFormatter object to format numbers representing currency amounts according to the conventions of a given locale.

The locale for this class is supplied by the locale style. The locale style can be set in several ways:

• By using the class in an MXML declaration and inheriting the locale from the document that contains the declaration.
Example:

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

• By using an MXML declaration and specifying the locale value in the list of assignments.
Example:

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

• Calling the setStyle() method, e.g. cf.setStyle("locale", "ja-JP")
• Inheriting the style from a UIComponent by calling the UIComponent's addStyleClient() method.

If the locale style is not set by one of the above techniques, the instance of this class will be added as a StyleClient to the topLevelApplication and will therefore inherit the locale style from the topLevelApplication object when the locale dependent property getter or locale dependent method is called.

Most of the properties of this class are automatically set based on the locale style. If the locale style is changed, any properties that have not been explicitly set will also be updated based on the new locale. Note that the actual locale that is used is specified by the actualLocaleIDName property.

NOTE: When a fallback locale is used, the currency properties are set to default values, and therefore the currencySymbol or currencyISOCode properties might be given unexpected values. It is a good idea to examine the currencySymbol and currencyISOCode property values before formatting a currency amount.

Related API Elements

Creates a string representing a currency amount formatted according to the current properties of this CurrencyFormatter object, including the locale, useCurrencySymbol, the currencySymbol, or the currencyISOCode properties.

The useCurrencySymbol property determines whether the format method uses the currencySymbol or the currencyISOCode in the formatted currency amount. The default value for useCurrencySymobl is false and thus by default currency amounts will be formatted with the currencyISOCode

Many countries and regions use the same currency symbols for different currencies. For example, the United States, Australia, New Zealand, Canada, and Mexico all use the same dollar sign symbol ($) for local currency values. When the formatting currency differs from the user's local currency it is best to use the ISO code as the currency string. You can use the formattingWithCurrencySymbolIsSafe() method to test whether or the ISO code of the currency to be formatted matches the default currency ISO code for the actual local used by the formatter.

This method can format numbers of very large and very small magnitudes. However, the number of significant digits is limited to the precision provided by the Number data type.

If there is an error when formatting, due to an illegal input value or other error, by default the format() method returns null. However if the errorText property is non-null, then the value of the errorText property is returned. The lastOperationStatus property is set to indicate the error that occurred.

Parameters

Related API Elements

      <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)}" />
      

Determines whether the currently specified currency symbol can be used when formatting currency amounts.

Many regions and countries use the same currency symbols. This method can be used to safeguard against the use of an ambiguous currency symbol, or a currency symbol or ISO code that is different than expected due to the use of a fallback locale.

A common use case for this method is to determine whether to show a local currency symbol (if the amount is formatted in the user's default currency), or a more specific ISO code string (if the amount is formatted in a currency different from the user's default).

This method compares the requestedISOCode parameter against the actual locale's default currencyISOCode, returning true if the strings are equal and false if they are not. When the strings are equal, using the format() method with the useCurrencySymbol property set to true results in a formatted currency value string with a currency symbol that is used in the current locale. If this method returns false, then using the format() method with the useCurrencySymbol property set to true could result in the use of an ambiguous or incorrect currency symbol.

Parameters

Related API Elements

Lists all of the locale ID names supported by this class. This is a list of locales supported by the operating system, not a list of locales that the ResourceManager has resources for.

Parses a string into a currency amount and a currency symbol.

The parsing algorithm uses the value of the decimalSeparator property to determine the integral and fractional portion of the number. It uses the values of the negativeCurrencyFormat and positiveCurrencyFormat properties to determine the location of the currency symbol or string relative to the currency amount. For negative amounts the value of the negativeCurrencyFormat property determines the location of the negative symbol and whether parentheses are used.

If the order of the currency symbol, minus sign, and number in the input string does not match the pattern identified by the negativeCurrencyFormat and positiveCurrencyFormat properties, then:

1. The value property of the returned CurrencyParseResult object is set to NaN.
2. The currencyString property of the returned CurrencyParseResult object is set to null.
3. The lastOperationStatus property is set to LastOperationStatus.PARSE_ERROR indicate that parsing failed.

The input string may include space characters, which are ignored during the parsing.

Parsing can succeed even if there is no currency symbol. No validation is done of the portion of the string corresponding to the currency symbol. If there is no currency symbol or string, the currencyString property in the returned CurrencyParseResult object is set to an empty string.

Parameters

Related API Elements