CurrencyFormatter  - AS3 Flex

由该类对象使用的实际区域设置 ID 的名称。这是用于从操作系统访问格式化数据和功能的区域设置。

如果由 locale 样式所设置的区域设置不可用，则 actualLocaleIDName 的值将不同于 locale 样式的值。它指明正在使用的回退区域设置。如果区域设置样式设置为 LocaleID.DEFAULT，将使用由用户的操作系统指定的区域设置的名称。

此属性可用作数据绑定的源。修改此属性后，将调度 change 事件。

相关 API 元素

正在使用的实际区域设置的三字母 ISO 4217 币种代码（例如，USD、EUR、JPY、CNY）。

当 useCurrencySymbol 属性设置为 false 时，此代码将用于在使用 format() 方法设置货币金额格式时指示货币类型。

在基于正在使用的实际区域设置来设置区域设置样式时，将初始化此属性。当使用回退区域设置时，此属性反映回退区域设置的首选/默认币种代码。

默认值取决于实际区域设置和操作系统。

此属性可用作数据绑定的源。修改此属性后，将调度 change 事件。

相关 API 元素

正在使用的实际区域设置的货币符号或字符串。

使用 withCurrencySymbol 参数设置为 true 的 format() 方法设置货币金额格式时，此属性用作货币符号。

在基于正在使用的实际区域设置来设置区域设置样式时，将初始化此属性。当使用回退区域设置时，此属性反映回退区域设置的首选/默认货币符号，此符号可能不同于区域设置样式。

默认值取决于实际区域设置和操作系统。

此属性可用作数据绑定的源。修改此属性后，将调度 change 事件。

相关 API 元素

表示负值货币金额的格式设置模式的数值。此模式定义货币符号和负号或圆括号相对于货币金额的数字部分的位置。

此属性的值必须是在下表中定义的常量之一。

下表总结了负值货币金额的可能的格式设置模式。在使用 format() 方法为货币金额设置格式时：

• “¤”符号由 currencyISOCode 或 currencySymbol 属性的值替换，视传递到 format() 方法的 withCurrencySymbol 参数值而定；
• “-”字符由 negativeNumberSymbol 属性的值替换；
• “n”字符由传递到 format() 方法的货币金额值替换。

默认值取决于实际区域设置和操作系统。

此属性可用作数据绑定的源。修改此属性后，将调度 change 事件。

相关 API 元素

表示正值货币金额的格式设置模式的数值。此格式定义货币符号相对于货币金额数值部分的位置。

此属性的值必须是在下表中定义的常量之一。

下表总结了正值货币金额的可能的格式设置模式。在使用 format() 方法为货币金额设置格式时：

• “¤”符号由 currencyISOCode 或 currencySymbol 属性的值替换，视传递到 format() 方法的 withCurrencySymbol 参数值而定；
• “n”字符由传递到 format() 方法的货币金额值替换。

默认值取决于实际区域设置和操作系统。

此属性可用作数据绑定的源。修改此属性后，将调度 change 事件。

相关 API 元素

当设置货币金额格式时，启用对 currencySymbol 属性的使用。

当 useCurrencySymbol 属性设置为 true 时，将在 format 方法返回的字符串中使用 currencySymbol 属性的值。例如：$123,456,789.22

当 useCurrencySymbol 属性设置为 false 时，将在 format 方法返回的字符串中使用 currencyISOCode 属性的值。例如：USD 123,456,789.22

默认值为 false。

此属性可用作数据绑定的源。修改此属性后，将调度 change 事件。

相关 API 元素

构造新的 CurrencyFormatter 对象以根据给定区域设置的约定设置表示货币金额的数字格式。

此类的区域设置由区域设置样式提供。可以使用下列方法来设置区域设置样式：

• 在 MXML 声明中使用该类，并从包含声明的文档中继承区域设置。
示例：

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

• 使用 MXML 声明并在赋值列表中指定区域设置值。
示例：

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

• 调用 setStyle() 方法，如 cf.setStyle("locale", "ja-JP")
• 调用 UIComponent 的 addStyleClient() 方法来继承 UIComponent 的样式。

如果 locale 样式不是由以上方式之一设置的，则该类的实例会作为 StyleClient 添加至 topLevelApplication 中，并因此在调用 locale 从属属性 getter 或 locale 从属方法时，会从 topLevelApplication 对象中继承 locale 样式。

此类的大部分属性将自动根据 locale 样式来设置。如果 locale 样式发生改变，则任何未明确设置的属性也都会根据新的区域设置来进行更新。请注意，正在使用的实际区域设置是由 actualLocaleIDName 属性来指定的。

注意：当使用回退区域设置时，货币属性设置为默认值，因此 currencySymbol 或 currencyISOCode 属性可能被设为意外的值。在为货币金额设置格式前，最好先检查 currencySymbol 和 currencyISOCode 属性值。

相关 API 元素

创建字符串，该字符串表示根据此 CurrencyFormatter 对象的当前属性（包括 locale、useCurrencySymbol、currencySymbol 或 currencyISOCode 属性）设置格式的货币金额。

useCurrencySymbol 属性决定了 format 方法是否在设置了格式的货币金额中使用 currencySymbol 或 currencyISOCode。useCurrencySymobl 的默认值为 false，因此，默认情况下，将以 currencyISOCode 来设置货币金额的格式

许多国家/地区和区域使用同一货币符号来表示不同币种。例如，美国、澳大利亚、新西兰、加拿大和墨西哥对于本地货币值都使用同一种美元符号 ($)。当设置格式的货币与用户的本地货币不同时，最好使用 ISO 代码作为货币字符串。您可以使用 formattingWithCurrencySymbolIsSafe 方法来测试要设置格式的货币的 ISO 代码是否与格式化程序所使用的实际区域设置的默认货币 ISO 代码相匹配。

此方法可为极大数量级和极小数量级的数字设置格式。但有效位数不得超过 Number 数据类型提供的精度。

如果由于非法输入值或其它错误在设置格式时发生了错误，则默认情况下 format() 方法将返回 null。但是，如果 errorText 属性为非 null，则将返回 errorText 属性的值。设置 lastOperationStatus 属性以指明发生的错误。

参数

相关 API 元素

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

确定是否可使用当前指定的货币符号为货币金额设置格式。

许多区域和国家/地区使用同一货币符号。此方法可用于确保避免使用存在歧义的货币符号，或使用由于使用回退区域设置而导致的与预期不同的货币符号或 ISO 代码。

此方法的一个常见用例是确定显示本地货币符号（如果将金额的格式设置为用户的默认货币）还是显示更加具体的 ISO 代码字符串（如果将金额的格式设置为与用户的默认货币不同的货币）。

此方法将 requestedISOCode 参数与实际区域设置的默认 currencyISOCode 做比较，当两个字符串相等时返回 true，否则返回 false。当两个字符串相等时，使用 format() 方法并将 useCurrencySymbol 属性设置为 true 会导致设置了格式的货币值字符串具有该当前区域设置中使用的货币符号。如果该方法返回 false，则使用 format() 方法并将 useCurrencySymbol 属性设置为 true 会导致使用存在歧义或不正确的货币符号。

参数

相关 API 元素

列出此类支持的所有区域设置 ID 名称。这是操作系统所支持的区域设置列表，而不是 ResourceManager 拥有其资源的区域设置列表。

将字符串解析为货币金额和货币符号。

此解析算法使用 decimalSeparator 属性的值确定数值的整数部分和小数部分。它使用 negativeCurrencyFormat 和 positiveCurrencyFormat 属性的值确定与货币金额相关的货币符号或字符串的位置。对于负数金额，negativeCurrencyFormat 属性的值确定负号的位置以及是否使用圆括号。

如果输入字符串中的货币符号、负号和数字的顺序与 negativeCurrencyFormat 和 positiveCurrencyFormat 属性标识的模式不匹配，则：

1. 返回的 CurrencyParseResult 对象的 value 属性设置为 NaN。
2. 返回的 CurrencyParseResult 对象的 currencyString 属性设置为 null。
3. lastOperationStatus 属性的值设置为 LastOperationStatus.PARSE_ERROR，表示解析失败。

输入字符串中可以包括空格字符，解析期间将忽略空格字符。

即使没有货币符号解析也可成功。没有验证与货币符号对应的字符串部分。如果没有货币符号或字符串，返回的 CurrencyParseResult 对象中的 currencyString 属性设置为空字符串。

参数

相关 API 元素