CurrencyFormatter  - AS3

この CurrencyFormatter オブジェクトで使用される実際のロケール ID の名前。

オペレーティングシステムおよび CurrencyFormatter() コンストラクターに渡される requestedLocaleIDName パラメーターの値に応じて、この名前は、次の 3 つの値になる可能性があります。

1. 要求されたロケールが LocaleID.DEFAULT ではなく、要求されたロケールをオペレーティングシステムがサポートする場合、返される名前は requestedLocaleIDName プロパティと同じです。
2. LocaleID.DEFAULT がコンストラクターに対する requestedLocaleIDName パラメーターの値として使用された場合、ユーザーのオペレーティングシステムによって指定された現在のロケールの名前が使用されます。LocaleID.DEFAULT 値により、ユーザーのカスタマイズした設定が OS に保持されます。requestedLocaleIDName パラメーターとして明示的な値を渡した場合に、2 つのロケール ID 名が同じでも LocaleID.DEFAULT を使用する場合と同じ結果になるとは限りません。ユーザーがマシンのロケール設定をカスタマイズし、LocaleID.DEFAULT を使用するのではなく、明示的なロケール ID 名を要求した場合、アプリケーションがそれらのカスタマイズされた設定を取得しない場合があります。
3. システムがコンストラクターで指定された requestedLocaleIDName をサポートしていない場合、代替のロケール ID 名が提供されます。

関連する API エレメント

使用される実際のロケールの 3 文字の ISO 4217。

このコードは、false に設定した withCurr ncySymbol パラメーターで format() メソッドを使用して金額をフォーマットするとき、通貨記号または通貨ストリングを判別するために使用されます。

このプロパティは、使用される実際のロケールに基づいて、コンストラクターによって初期化されます。代替のロケールが使用される場合、このプロパティは、代替のロケールで優先されるデフォルトの通貨コードを反映します。

デフォルト値： dependent on the actual locale and operating system。

関連する API エレメント

使用される実際のロケールの通貨記号または文字列。

このプロパティは、withCurrencySymbol パラメーターを true に設定して、format() を使用して金額をフォーマットするときに通貨記号として使用されます。

このプロパティは、使用される実際のロケールに基づいて、コンストラクターによって初期化されます。代替のロケールが使用される場合、このプロパティは、代替のロケールで優先されるデフォルトの通貨記号を反映します。

デフォルト値： dependent on the actual locale and operating system。

関連する API エレメント

小数部を持つ通貨額のフォーマットまたは解析に使用される小数点記号。

このプロパティは最初、formatter オブジェクトを構築するときに選択したロケールに基づいて設定されます。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： dependent on the actual locale and operating system。

関連する API エレメント

通貨額をフォーマットするときに使用される数字のセットを定義します。

さまざまな言語と地域で使用されるさまざまな文字セットを、0～9 の数字で表します。 このプロパティは、使用される数字のセットを定義します。

このプロパティの値は、10 進数字セットのゼロ桁の Unicode 値を表しています。このプロパティの有効な値は NationalDigitsType クラスで定義されています。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： dependent on the actual locale and operating system。

関連する API エレメント

小数点記号の後に表示できる最大桁数。

数字はこのプロパティによって指定された桁数に丸められます。丸めのスキームは、ユーザーのオペレーティングシステムによって異なります。

trailingZeros プロパティが true に設定されると、数字の小数部分（小数点の後）にこの fractionalDigits プロパティの値に一致する長さまで、0 が置かれます。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： 0。

関連する API エレメント

フォーマットされた通貨額文字列内のグループ化区切り文字の配置を記述します。

useGrouping プロパティが true に設定されると、groupingPattern プロパティを使用して、グループ化区切り文字に使用される配置とパターンが定義されます。

グループ化パターンはセミコロンで区切られ、場合によっては最後にアスタリスクが付く数字を含む文字列として定義されます。例： "3;2;*"文字列内のそれぞれの数字は、グループ内の桁数を表しています。グループセパレーターは、各数字グループの前に置かれます。ストリングの最後のアスタリスクは、その桁数を持つグループが、フォーマットされた残りのストリングで繰り返されることを示しています。アスタリスクがない場合、フォーマットされた残りのストリングに追加のグループやセパレーターはありません。

文字列内の最初の数字は、小数点の左側の数字の最初のグループに対応しています。その後に続く数字は、左側の後続のグループの桁数を定義します。 このため、文字列「3;2;*」はグループ化区切り文字が最初の 3 桁のグループの後に置かれ、その後に 2 桁のグループが続くことを示しています。例： 98,76,54,321

次の表は、さまざまなグループ化パターンによる通貨額 123456789.12 のフォーマットの例を示しています。グループ化区切りはカンマ、小数点はピリオド、ドル記号（$）は通貨記号です。

限定された数のグループ化サイズのみ定義できます。一部のオペレーティングシステムは、グループ化パターンに 2 つの数字とアスタリスクのみ含むことができます。 その他のオペレーティングシステムは、4 つまでの数字とアスタリスクを含むことができます。アスタリスクがないパターンの場合、一部のオペレーティングシステムは 1 つの数字のみサポートし、その他のオペレーティングシステムは 3 つまでの数字をサポートします。グループ化パターン要素の最大数を超えると、追加の要素は無視され、lastOperationStatus プロパティは以下で説明するように設定されます。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

関連する API エレメント

グループ化区切りに使用される文字または文字列。

useGrouping プロパティが true に設定されている場合、通貨額をフォーマットするときにこのプロパティの値がグループ化区切り文字として使用されます。 このプロパティは最初、formatter オブジェクトを構築するときに選択したロケールに基づいて設定されます。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： dependent on the actual locale and operating system。

関連する API エレメント

この CurrencyFormatter オブジェクトが実行した最新の操作のステータス。コンストラクターまたはこのクラスのメソッドが呼び出されたり、別のプロパティが設定されたりすると、必ず lastOperationStatus プロパティが設定されます。有効な値については、各メソッドの説明を参照してください。

関連する API エレメント

小数点区切り文字の左側に整数がない場合に、フォーマットされた金額に先頭の 0 を含めるかどうかを指定します。

このプロパティが true に設定されている場合、-1.0～1.0 の数値をフォーマットするときに、小数点区切り文字の左側に先頭の 0 が含まれます。このプロパティが false に設定されている場合、0 は含まれません。

例えば、金額が 0.321 でこのプロパティが true に設定されている場合、フォーマットされたストリングに先頭の 0 が含まれます。プロパティが false に設定されている場合、先頭の 0 は含まれません。その場合、文字列には、$.321 のように小数点とそれに続く 10 進数の数字のみが含まれます。

次の表は、このプロパティと fractionalDigits および trailingZeros の関連プロパティの値に基づいて通貨額をフォーマットする方法の例を示しています。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： dependent on the actual locale and operating system。

関連する API エレメント

負の通貨額のフォーマットパターンを示す数値。このパターンは、通貨額の数値部分に関連する通貨記号とマイナス記号または括弧の位置を定義します。

このプロパティの値は、下の表で定義された定数のいずれかになります。

下の表は負の通貨額の有効なフォーマットパターンの概要を示しています。通貨額が format() メソッドでフォーマットされる場合：

• 「¤」記号は、format() メソッドに渡される withCurrencySymbol パラメーターに応じて、currencyISOCode または currencySymbol プロパティの値に置き換えられます。
• 「-」記号は、negativeNumberSymbol プロパティの値に置き換えられます。
• 「n」文字は、format() メソッドに渡される通貨額の値に置き換えられます。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： dependent on the actual locale and operating system。

関連する API エレメント

負の通貨額をフォーマットするときに使用されるマイナス記号。

この記号は、0 よりも小さい金額をフォーマットするときに、負の金額のフォーマットと組み合わせて使用されます。マイナス記号を含まない負の金額のフォーマットでは使用されません（例えば、負の金額が括弧で囲まれている場合）。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： dependent on the actual locale and operating system。

関連する API エレメント

正の金額のフォーマットパターンを示す数値。このフォーマットは、通貨額の数値部分に関連する通貨記号の位置を定義します。

このプロパティの値は、下の表で定義された定数のいずれかになります。

下の表は正の通貨額の有効なフォーマットパターンの概要を示しています。通貨額が format() メソッドでフォーマットされる場合：

• 「¤」記号は、format() メソッドに渡される withCurrencySymbol パラメーターに応じて、currencyISOCode または currencySymbol プロパティの値に置き換えられます。
• 「n」文字は、format() メソッドに渡される通貨額の値に置き換えられます。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： dependent on the actual locale and operating system。

関連する API エレメント

この CurrencyFormatter オブジェクトのコンストラクターに渡された、要求されたロケール ID の名前。

LocaleID.DEFAULT 値が使用された場合、返される名前は「i-default」です。代替のロケールが適用される場合、実際に使用されるロケールは要求されたロケールと異なる場合があります。 実際のロケール名は actualLocaleIDName プロパティを使用して取得できます。

関連する API エレメント

末尾の 0 をフォーマットされた金額に含めるかどうかを指定します。

このプロパティが true に設定されている場合、末尾の 0 が fractionalDigits プロパティで指定された限界までフォーマットされた数字の小数部分に含まれます。このプロパティが false に設定されている場合、末尾の 0 は表示されません。

例えば、金額が 123.4 で、このプロパティが true に設定され、fractionalDigits プロパティが 3 に設定されている場合、フォーマットされたストリングには $123.400 のように 0 が表示されます。このプロパティが false の場合、末尾の 0 は含まれず、ストリングには $123.4 のように小数点区切り文字とその後に続く 0 以外の 10 進数の数字が表示されます。

次の表は、このプロパティと fractionalDigits および leadingZero の関連プロパティの値に基づいて通貨額をフォーマットする方法の例を示しています。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： dependent on the actual locale and operating system。

関連する API エレメント

通貨額をフォーマットするときにグループ化区切りを使用できるようにします。

useGrouping プロパティが true に設定されている場合、数字はグループ化され、グループセパレーター文字で区切られます。例：$123,456,789

useGrouping プロパティが false に設定されている場合、数字はグループ化されず、区切られません。例：$123456789

groupingSeparator プロパティでは、グループセパレーターとして使用するシンボルを定義します。groupingPattern プロパティでは、グループセパレーター間の桁数を定義します。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

関連する API エレメント

所定のロケールの規則に従って通貨額を表す数字をフォーマットするために、新しい CurrencyFormatter オブジェクトを構築します。

このコンストラクターは、現在のオペレーティングシステムが要求されたロケール ID 名をサポートしているかどうかを判別します。サポートされていない場合、代わりに代替のロケールが使用されます。代替のロケールが使用される場合、lastOperationStatus プロパティに代替ロケールの種類が表示され、actualLocaleIDName プロパティには代替ロケール ID の名前が表示されます。

currencySymbol や currencyISOCode などの一部のプロパティはロケールに基づいて自動的に設定されます。

注意：代替のロケールが使用されると、通貨プロパティがデフォルトの値に設定されます。そのため、currencySymbol または currencyISOCode プロパティに予期せぬ値が設定される場合があります。通貨額をフォーマットする前に、currencySymbol および currencyISOCode プロパティの値を調べることをお勧めします。

ユーザーの現在のオペレーティングシステムの環境設定に基づいてフォーマットするには、requestedLocaleIDName パラメーターの値 LocaleID.DEFAULT をコンストラクターに渡します。

コンストラクターが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

要求されたロケール ID 名を使用できない場合、lastOperationStatus は以下のいずれかに設定されます。

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

上記の警告および lastOperationStatus プロパティのその他の有効な値について詳しくは、LastOperationStatus クラスの説明を参照してください。

関連する API エレメント

ロケール、通貨記号および通貨 ISO コードを含むこの CurrencyFormatter オブジェクトの現在のプロパティに従ってフォーマットされた金額を表すストリングを作成します。

デフォルトでは、このメソッドは currencyISOCode プロパティを使用して、フォーマット時に使用する通貨記号やその他の設定を決めます。

多くの国や地域では、さまざまな通貨に同じ通貨記号を使用しています。例えば、米国、オーストラリア、ニュージーランド、カナダおよびメキシコはすべて、国内通貨の値に同じドル記号（$）を使用しています。通貨のフォーマットがユーザーの地域の通貨と異なる場合は、ISO コードを通貨ストリングとして使用することをお勧めします。formattingWithCurrencySymbolIsSafe() メソッドを使用して、フォーマットする通貨の ISO コードがフォーマッターの currencyISOCode プロパティと一致するかどうかをテストすることができます。

このメソッドで、多数の非常に高額の通貨および非常に小額の通貨をフォーマットできます。 ただし、有効桁数は Number データ型によって指定される精度に限定されます。

パラメーター

関連する API エレメント

 
         var cf:CurrencyFormatter = new CurrencyFormatter("fr-CA");  
         
         trace(cf.actualLocaleIDName);               // "fr-CA"  
         trace(cf.currencyISOCode);                // "CAD"
         trace(cf.currencySymbol);                // "$"
         
         trace(cf.format(1254.56));                // "1 254,56 CAD"
         trace(cf.format(1254.56, true));            // "1 254,56 $"
         

 
         var cf:CurrencyFormatter = new CurrencyFormatter(LocaleID.DEFAULT);  
         
         if (cf.formattingWithCurrencySymbolIsSafe("CAD")) {
           trace(cf.actualLocaleIDName);     // "fr-CA French (Canada)"
           trace(cf.format(1254.56, false)); // "1 254,56 $"
         }
         else {
           trace(cf.actualLocaleIDName);     // "en-US English (USA)"
           cf.setCurrency("CAD", "C$")
           trace(cf.format(1254.56, true));  // "C$ 1,254.56"
         }
         

通貨額のフォーマット時に、現在指定されている通貨記号を使用できるかどうかを判別します。

多くの地域や国で、同じ通貨記号が使用されています。このメソッドを使用して、あいまいな通貨記号、または代替のロケールの使用によって予期されるものとは異なる通貨記号や ISO コードが使用されるのを防ぐことができます。

このメソッドがよく使用されるのは、ロケールの通貨記号を表示するか（金額がユーザーのデフォルトの通貨でフォーマットされる場合）、またはさらに固有の ISO コード文字列を表示するか（金額がユーザーのデフォルトとは異なる通貨でフォーマットされる場合）を決めるために使用する場合です。

このメソッドは requestedISOCode パラメーターを現在の currencyISOCode プロパティと比較し、ストリングが等しい場合は true を返し、等しくない場合は false を返します。ストリングが等しい場合、withCurrencySymbol パラメーターを true に設定して format() メソッドを使用すると、ロケール固有の通貨記号を持つフォーマットされた通貨値ストリングになります。このメソッドが false を返す場合、withCurrencySymbol パラメーターを true に設定して format() メソッドを使用すると、あいまいな通貨記号または正しくない通貨記号を使用することになります。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

パラメーター

関連する API エレメント

このクラスでサポートされているすべてのロケール ID 名のリストが表示されます。

このクラスが現在のオペレーティングシステムでサポートされていない場合、このメソッドは null 値を返します。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

文字列を通貨額および通貨記号に解析します。

解析アルゴリズムは decimalSeparator プロパティの値を使用して、数字の整数部分と少数部分を判別します。このアルゴリズムは、negativeCurrencyFormat および positiveCurrencyFormat プロパティの値を使用して、通貨額との関連で通貨記号または文字列の位置を決めます。負の金額の場合、negativeCurrencyFormat プロパティの値によって、負の記号の位置と括弧を使用するかどうかが決まります。

入力ストリング内の通貨記号、負の記号および数字の順序が negativeCurrencyFormat および positiveCurrencyFormat プロパティによって識別されるパターンと一致しない場合、次のようになります。

1. 返された CurrencyParseResult オブジェクトの value プロパティが NaN に設定されます。
2. 返された CurrencyParseResult オブジェクトの currencyString プロパティが null に設定されます。
3. lastOperationStatus プロパティが解析の失敗を示すように設定されます。

入力ストリングには、解析中に無視される空白文字が含まれる場合があります。

通貨記号がない場合でも解析は成功します。文字列の通貨記号に該当する部分には検証は実行されませｎ。通貨記号またはストリングがない場合、返される CurrencyParseResult オブジェクト内の currencyString プロパティが空のストリングに設定されます。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

パラメーター

関連する API エレメント

CurrencyFormatter オブジェクトの currencyISOCode および currencySymbol プロパティを設定します。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、currencyISOCode および currencySymbol プロパティは変更されず、lastOperationStatus プロパティが LastOperationStatus クラスで定義された定数のいずれかに設定されます。

パラメーター

関連する API エレメント

この例では次のロケールを使用します。

• 通貨フォーマットに対するオペレーティングシステムのデフォルトのロケール（LocaleID.DEFAULT）
• 日本語（日本）
• 英語（米国）
• フランス語（フランス）

この例では、リストの各ロケールに対して、次の処理を行います。

1. CurrencyFormatter オブジェクトを作成します。
2. formattingWithCurrencySymbolIsSafe() メソッドを使用して、ロケールのデフォルトの通貨がユーロ（"EUR"）になっているかどうかを確認し、ユーロになっている場合は、通貨記号を使用して文字列をフォーマットします。 ユーロになっていない場合は、ISO コードを使用して文字列をフォーマットします。

  
package {
    import flash.display.Sprite;
    import flash.globalization.CurrencyFormatter;
    import flash.globalization.LocaleID;
    
    public class CurrencyFormatterExample1 extends Sprite
    {
        public function CurrencyFormatterExample1():void
        {
            var cf:CurrencyFormatter;
            var amountWithSymbol:String;
            var amountWithISOCode:String
            
            var localeNames:Array = [LocaleID.DEFAULT, "ja-JP", "en-US", "fr-FR"];
            
            for each (var localeName:String in localeNames) 
            {
                cf = new CurrencyFormatter(localeName);
                
                trace('\n' + "LocaleID requested=" + cf.requestedLocaleIDName 
                    + "; actual=" + cf.actualLocaleIDName);
                
                trace("Last Operation Status: " + cf.lastOperationStatus );
                
                trace("Currency ISO Code: " + cf.currencyISOCode);
                
                if (cf.formattingWithCurrencySymbolIsSafe("EUR")) 
                {
                    amountWithSymbol = cf.format(123456789.19, true);
                    trace("Format using Symbol: "+ amountWithSymbol);
                }
                else 
                {
                    amountWithISOCode = cf.format(123456789.19); 
                    trace("Format using ISO Code: " + amountWithISOCode);
                }
            }
        }
    }
}

この例では、次の手順が実行されます。

1. 英語（米国）ロケールの CurrencyFormatter オブジェクトを作成します。
2. parse() メソッドを使用して、入力文字列を解析します。
3. CurrencyParseResult オブジェクトの解析結果を基に、通貨額と通貨文字列の値を表示します。

 
package {
      import flash.display.Sprite;
      import flash.globalization.CurrencyFormatter;
      import flash.globalization.CurrencyParseResult;
      import flash.globalization.LastOperationStatus;
      import flash.globalization.LocaleID;

      public class CurrencyFormatterParseExample extends Sprite
      {
            public function CurrencyFormatterParseExample()
            {
                var cf:CurrencyFormatter = new CurrencyFormatter( "en_US" );
                
                trace("LocaleID requested=" + cf.requestedLocaleIDName 
                    + "; actual=" + cf.actualLocaleIDName);
                trace("Last Operation Status: " + cf.lastOperationStatus );

                var inputString:String = "Dollar 123,567,89,0.254";
                
                var result:CurrencyParseResult = cf.parse(inputString);
                
                if (cf.lastOperationStatus == LastOperationStatus.NO_ERROR ) {
                    trace("Amount value: " + result.value); 
                    trace("Currency string: " + result.currencyString); 
                }
            }
      }
}