CurrencyFormatter

パッケージ	spark.formatters
クラス	public class CurrencyFormatter
継承	CurrencyFormatter NumberFormatterBase GlobalizationBase AdvancedStyleClient EventDispatcher Object
実装	IFormatter

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

CurrencyFormatter クラスは、ロケールに依存した、通貨値のフォーマットと解析を可能にします。

このクラスは flash.globalization.CurrencyFormatter のラッパークラスです。したがって、ロケール固有のフォーマットが flash.globalization.CurrencyFormatter によって提供されます。ただし、この CurrencyFormatter クラスは MXML 宣言で使用でき、要求されたロケール ID 名にロケールスタイルを使用し、バインド可能なメソッドおよびプロパティを持ちます。

flash.globalization.CurrencyFormatter クラスでは、フォーマット機能と、ロケール固有データの提供用に、基盤となるオペレーティングシステムを使用します。一部のオペレーティングシステムでは、flash.globalization クラスがサポートされておらず、これらのシステムではこのラッパークラスが代替機能を提供します。

MXML シンタックス expanded

MXML シンタックスを隠す

The <s:CurrencyFormatter> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

  <s:CurrencyFormatter 
    Properties
    currencyISOCode="locale and OS dependent"
    currencySymbol="locale and OS dependent"
    negativeCurrencyFormat="locale and OS dependent"
    positiveCurrencyFormat="locale and OS dependent"
    useCurrencySymbol="false"
  />

さらに例を参照

パブリックプロパティ

	プロパティ		定義元
		actualLocaleIDName : String [オーバーライド] [読み取り専用] このクラスオブジェクトで使用される実際のロケール ID の名前。	CurrencyFormatter
		className : String [読み取り専用] コンポーネントクラスの名前です。	AdvancedStyleClient
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		currencyISOCode : String 使用される実際のロケールの 3 文字の ISO 4217 通貨コード	CurrencyFormatter
		currencySymbol : String 使用される実際のロケールの通貨記号または文字列。	CurrencyFormatter
		decimalSeparator : String 小数部を持つ数字のフォーマットまたは解析に使用される小数点記号。	NumberFormatterBase
		digitsType : uint 数字をフォーマットするときに使用される数字のセットを定義します。	NumberFormatterBase
		errorText : String エラーが発生したときに format() メソッドによって返される置換文字列。	NumberFormatterBase
		fractionalDigits : int 小数点記号の後に表示できる最大桁数。	NumberFormatterBase
		groupingPattern : String フォーマットされた文字列内のグループ化区切り文字の配置を記述します。	NumberFormatterBase
		groupingSeparator : String グループ化区切りに使用される文字または文字列。	NumberFormatterBase
		id : String コンポーネントの ID です。	AdvancedStyleClient
		inheritingStyles : Object このビジュアルでないスタイルクライアントのインスタンスの継承可能なスタイルを含むオブジェクトです。	AdvancedStyleClient
		lastOperationStatus : String [オーバーライド] [読み取り専用] このクラスオブジェクトが実行した最新の操作のステータス。	NumberFormatterBase
		leadingZero : Boolean 小数点区切り文字の左側に整数がない場合に、フォーマットされた数値に先頭の 0 を含めるかどうかを指定します。	NumberFormatterBase
		moduleFactory : IFlexModuleFactory モジュールファクトリは、このビジュアルでないスタイルクライアントのインスタンスのスタイルを制御するスタイルマネージャーを検索するためのコンテキストとして使用されます。	AdvancedStyleClient
		negativeCurrencyFormat : uint 負の通貨額のフォーマットパターンを示す数値。	CurrencyFormatter
		negativeSymbol : String 負の値をフォーマットするときに使用されるマイナス記号。	NumberFormatterBase
		nonInheritingStyles : Object このコンポーネントの非継承スタイルのチェーンの始まりです。	AdvancedStyleClient
		positiveCurrencyFormat : uint 正の金額のフォーマットパターンを示す数値。	CurrencyFormatter
		styleDeclaration : CSSStyleDeclaration このオブジェクトで宣言されたインラインスタイルを保持するスタイル宣言です。	AdvancedStyleClient
		styleManager : IStyleManager2 [読み取り専用] このコンポーネントで使用する StyleManager インスタンスを返します。	AdvancedStyleClient
		styleName : Object オブジェクトのスタイル値のソースです。	AdvancedStyleClient
		styleParent : IAdvancedStyleClient コンポーネントの親は、下位要素のセレクターを評価するために使用されます。	AdvancedStyleClient
		trailingZeros : Boolean 末尾の 0 をフォーマットされた数値に含めるかどうかを指定します。	NumberFormatterBase
		useCurrencySymbol : Boolean 通貨額をフォーマットするときに currencySymbol プロパティを使用できるようにします。	CurrencyFormatter
		useGrouping : Boolean 数字をフォーマットするときに、グループ化区切りを使用できるようにします。	NumberFormatterBase

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		CurrencyFormatter() 所定のロケールの規則に従って通貨額を表す数字をフォーマットするために、新しい CurrencyFormatter オブジェクトを構築します。	CurrencyFormatter
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		clearStyle(styleProp:String):void このコンポーネントインスタンスからスタイルプロパティを削除します。	AdvancedStyleClient
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		format(value:Object):String locale、useCurrencySymbol、currencySymbol または currencyISOCode の各プロパティを含むこの CurrencyFormatter オブジェクトの現在のプロパティに従ってフォーマットされた通貨額を表す文字列を作成します。	CurrencyFormatter
		formattingWithCurrencySymbolIsSafe(requestedISOCode:String):Boolean 通貨額のフォーマット時に、現在指定されている通貨記号を使用できるかどうかを判別します。	CurrencyFormatter
		getAvailableLocaleIDNames():Vector.<String> [静的] このクラスでサポートされているすべてのロケール ID 名のリストが表示されます。	CurrencyFormatter
		getClassStyleDeclarations():Array このコンポーネントに適用されるタイプセレクターの CSSStyleDeclaration オブジェクトの配列を返します。何も存在しない場合は null を返します。	AdvancedStyleClient
		getStyle(styleProp:String):* [オーバーライド] このコンポーネントのスタイル参照チェーンのいずれかの場所に設定されたスタイルプロパティを取得します。	GlobalizationBase
		hasCSSState():Boolean currentCSSState が null でない場合、true を返します。	AdvancedStyleClient
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		initialized(document:Object, id:String):void initialized メソッドは、このクラスまたはこのクラスを拡張するクラスが MXML 宣言で使用されると呼び出されます。	AdvancedStyleClient
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		matchesCSSState(cssState:String):Boolean cssState が currentCSSState に一致した場合は、true を返します。	AdvancedStyleClient
		matchesCSSType(cssType:String):Boolean このインスタンスが、指定されたタイプと同じであるのか、それともそのサブクラスであるのかを判別します。	AdvancedStyleClient
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void スタイルの変更を、このスタイルクライアントのインスタンスの子に通知します。	AdvancedStyleClient
		parse(inputString:String):CurrencyParseResult 文字列を通貨額および通貨記号に解析します。	CurrencyFormatter
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		regenerateStyleCache(recursive:Boolean):void getStyle() メソッドが機能するように、内部のスタイルキャッシュ値を設定します。	AdvancedStyleClient
		registerEffects(effects:Array):void 各エフェクトイベントのイベントリスナーの 1 つとして、EffectManager を登録します。	AdvancedStyleClient
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		setStyle(styleProp:String, newValue:*):void このコンポーネントインスタンスのスタイルプロパティを設定します。	AdvancedStyleClient
		styleChanged(styleProp:String):void スタイルプロパティの変更を検出します。	AdvancedStyleClient
		stylesInitialized():void コンポーネントのスタイルを初めて初期化するとき、Flex は stylesInitialized() メソッドを呼び出します。	AdvancedStyleClient
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

イベント

イベントの詳細についてはここをクリックしてください

継承されるイベントを隠す

継承されるイベントを表示

	概要	定義元
activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
change	変更イベントは、ロケールスタイルが変更された場合、および、別のプロパティが設定されたことによって、数値のフォーマットが変更されたり、このクラスを通じて使用可能な他の値が更新されたりした場合に、常に生成されます。	GlobalizationBase
deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher

スタイル

スタイルには共通スタイルと特定のテーマに関連するスタイルがあります。共通スタイルは、任意のテーマと共に使用できます。特定のテーマに関連するスタイルは、アプリケーションがそのテーマを使用する場合にのみ使用できます。

共通スタイル

スタイルの詳細についてはここをクリックしてください

継承されるスタイルを隠す

継承されるスタイルを表示

	スタイル		説明	定義元
		locale	型: String CSS 継承: はい言語バージョン: ActionScript 3.0 製品バージョン: Flex 4.5 ランタイムバージョン: Flash10.1, AIR 2.5 言語、地域、スクリプトおよびオプションで他の関連するタグおよびキーを指定するロケール識別子です.	GlobalizationBase

プロパティの詳細

actualLocaleIDName

プロパティ

actualLocaleIDName:String [読み取り専用] [オーバーライド]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

このクラスオブジェクトで使用される実際のロケール ID の名前。これはフォーマットするデータと機能にオペレーティングシステムからアクセスするために使用されるロケールです。

locale スタイルによって設定されたロケールが使用できない場合、actualLocaleIDName の値は locale スタイルの値とは異なります。この値は使用中の代替ロケールを示します。 locale スタイルが LocaleID.DEFAULT に設定された場合、ユーザーのオペレーティングシステムによって指定されたロケールの名前が使用されます。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 change イベントが送出されます。

実装
override public function get actualLocaleIDName():String

currencyISOCode

プロパティ

currencyISOCode:String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

使用される実際のロケールの 3 文字の ISO 4217 通貨コード（USD、EUR、JPY、CNY など）。

useCurrencySymbol プロパティが false に設定されると、format() メソッドを使用して通貨額をフォーマットするとき、このコードは通貨タイプを示すために使用されます。

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

デフォルト値は実際のロケールおよびオペレーティングシステムによって異なります。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 change イベントが送出されます。

実装
public function get currencyISOCode():String
public function set currencyISOCode(value:String):void

例外

TypeError — このプロパティに null 値が割り当てられている場合。

currencySymbol

プロパティ

currencySymbol:String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

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

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

このプロパティは、使用される実際のロケールに基づいてロケールスタイルが設定されるときに初期化されます。代替のロケールが使用される場合、このプロパティは、代替のロケールで優先されるデフォルトの通貨記号を反映します（ロケールスタイルと異なる場合があります）。

デフォルト値は実際のロケールおよびオペレーティングシステムによって異なります。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 change イベントが送出されます。

実装
public function get currencySymbol():String
public function set currencySymbol(value:String):void

例外

TypeError — このプロパティに null 値が割り当てられている場合。

negativeCurrencyFormat

プロパティ

negativeCurrencyFormat:uint

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

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

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

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

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

負の金額のフォーマットの種類	フォーマットパターン
0	(¤n)
1	-¤n
2	¤-n
3	¤n-
4	(n¤)
5	-n¤
6	n-¤
7	n¤-
8	-n ¤
9	-¤ n
10	n ¤-
11	¤ n-
12	¤ -n
13	n- ¤
14	(¤ n)
15	(n ¤)

デフォルト値は実際のロケールおよびオペレーティングシステムによって異なります。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 change イベントが送出されます。

実装
public function get negativeCurrencyFormat():uint
public function set negativeCurrencyFormat(value:uint):void

例外

ArgumentError — 割り当てられた値が 0～15 の場合。

関連する API エレメント

format()
currencySymbol
negativeSymbol

positiveCurrencyFormat

プロパティ

positiveCurrencyFormat:uint

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

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

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

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

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

正の金額のフォーマットの種類	フォーマットパターン
0	¤n
1	n¤
2	¤ n
3	n ¤

デフォルト値は実際のロケールおよびオペレーティングシステムによって異なります。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 change イベントが送出されます。

実装
public function get positiveCurrencyFormat():uint
public function set positiveCurrencyFormat(value:uint):void

例外

ArgumentError — 割り当てられた値が 0～3 の場合。

関連する API エレメント

currencySymbol
format()

useCurrencySymbol

プロパティ

useCurrencySymbol:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

通貨額をフォーマットするときに currencySymbol プロパティを使用できるようにします。

useCurrencySymbol プロパティが true に設定される場合、currencySymbol プロパティの値が format メソッドによって返されるストリング内で使用されます。例：$123,456,789.22

useCurrencySymbol プロパティが false に設定される場合、currencyISOCode プロパティの値が format メソッドによって返されるストリング内で使用されます。例：USD 123,456,789.22

デフォルト値： false。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 change イベントが送出されます。

実装
public function get useCurrencySymbol():Boolean
public function set useCurrencySymbol(value:Boolean):void

コンストラクターの詳細

()

コンストラクター

public function CurrencyFormatter()

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

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

このクラスのロケールは locale スタイルによって提供されます。 locale スタイルは、次のいくつかの方法で設定できます。

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 エレメント

actualLocaleIDName
lastOperationsStatus

メソッドの詳細

format

()

メソッド

public function format(value:Object):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

locale、useCurrencySymbol、currencySymbol または currencyISOCode の各プロパティを含むこの CurrencyFormatter オブジェクトの現在のプロパティに従ってフォーマットされた通貨額を表す文字列を作成します。

useCurrencySymbol プロパティは、format メソッドが通貨額のフォーマットで currencySymbol または currencyISOCode のどちらを使用するかを判別します。 useCurrencySymbol のデフォルト値は false であるため、通貨額は currencyISOCode を使用してフォーマットされます。

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

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

不正な入力値またはその他のエラーによりフォーマット中にエラーが発生した場合、format() メソッドはデフォルトで null を返します。ただし、errorText プロパティが null 以外の場合、errorText プロパティの値が返されます。 lastOperationStatus プロパティが、発生したエラーを示すように設定されます。

パラメーター

value:Object — 通貨ストリングにフォーマットされる数値を格納するオブジェクト。オブジェクトが Number でない場合、オブジェクトは Number() 変換機能を使用して数値に変換されます。

戻り値

String — フォーマットされた通貨値を含む文字列。

例 ( この例の使用方法 )

この例では、locale スタイルは fr-CA（フランス語（カナダ））に設定されます。この例は、このロケールがユーザーのオペレーティングシステムでサポートされており、したがって、代替のロケールは使用されないことを前提にしています。「fr-CA」の場合、デフォルトの通貨は ISO コードが CAD のカナダドルです。したがって、デフォルト値で通貨をフォーマットすると、CAD が通貨記号として使用されます。ただし、useCurrencySymbol プロパティが true に設定されている場合、currencySymbol を使用して通貨額がフォーマットされます。

      <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>

2 番目の例は、デフォルトのユーザーのロケールを使用して、カナダドルで通貨額をフォーマットするメソッドを示しています。formattingWithCurrencySymbolIsSafe() メソッドは、useCurrencySymbol プロパティの値を設定するために使用されます。ユーザーのデフォルトのロケールがカナダの場合（fr-CA または en-CA など）、カナダのデフォルトの通貨記号が使用されます。デフォルトとなっているロケールがある場合、フォーマットされた通貨額には currencyISOCode の CAD が使用されます。

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

formattingWithCurrencySymbolIsSafe

()

メソッド

public function formattingWithCurrencySymbolIsSafe(requestedISOCode:String):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

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

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

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

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

パラメーター

requestedISOCode:String — 3 文字の ISO 4217 通貨コード（米ドルは USD、ユーロは EUR など）。A～Z の 3 文字の大文字を含む必要があります。

戻り値

Boolean — actualLocaleIDName に対応するロケールのデフォルトの currencyISOCode が requestedISOCode パラメーターに一致する場合は true で、それ以外の場合は false です。

例外

TypeError — requestedISOCode パラメーターが null の場合。

getAvailableLocaleIDNames

()

メソッド

public static function getAvailableLocaleIDNames():Vector.<String>

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

このクラスでサポートされているすべてのロケール ID 名のリストが表示されます。これはオペレーティングシステムでサポートされているロケールのリストです。ResourceManager にリソースがあるロケールのリストではありません。

戻り値

Vector.<String> — このクラスおよびオペレーティングシステムでサポートされているすべてのロケール ID 名を含む文字列のベクトル。

parse

()

メソッド

public function parse(inputString:String):CurrencyParseResult

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

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

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

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

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

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

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

パラメーター

inputString:String — 解析する入力文字列。

戻り値

CurrencyParseResult — 数値および通貨記号または文字列を含む CurrencyParseResult オブジェクト。

例外

TypeError — inputString パラメーターが null の場合。

例この例の使用方法

CurrencyFormatterExample1.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Sample program for spark.formatters.CurrencyFormatter -->
<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:CurrencyFormatter id="currencyFormatter"/>
    </fx:Declarations>

    <fx:Script>
        <![CDATA[
            import flash.globalization.CurrencyParseResult;

            private function localeChange():void
            {
                // Sets the locale style on the document UI component.
                // The formatter will inherit this style.
                setStyle('locale', inputLocaleIDName.text);
                inputCurrencyChange();
            }

            private function inputCurrencyChange():void
            {
                const cpr:CurrencyParseResult
                                = currencyFormatter.parse(inputCurrency.text);
                parsedResult.text = "Currency String: [" + cpr.currencyString
                    + "], Amount: [" + cpr.value.toString() + "]";
            }
        ]]>
    </fx:Script>

    <mx:Form>
        <mx:FormItem label="Input Locale ID Name">
            <mx:HBox>
                <s:TextInput id="inputLocaleIDName"/>
                <s:Button click="localeChange()" label="Apply"/>
            </mx:HBox>
            <mx:Text text="Example: 'en-US', 'fr-FR', 'ja-JP', 'ar-SA'"/>
        </mx:FormItem>
        <mx:FormItem label="Input Currency Amount">
            <s:TextInput id="inputCurrency" change="inputCurrencyChange()"/>
            <mx:Text text="Example: {currencyFormatter.format(123456789.123)}"/>
        </mx:FormItem>
        <mx:FormItem label="Actual Locale ID Name">
            <mx:Text text="{currencyFormatter.actualLocaleIDName}"/>
        </mx:FormItem>
        <mx:FormItem label="Parsed Result">
            <mx:Text id="parsedResult"/>
        </mx:FormItem>
    </mx:Form>
</s:Application>

CurrencyFormatterExample2.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the Spark CurrencyFormatter. -->
<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:CurrencyFormatter id="currencyFormatter"/>
    </fx:Declarations>

    <fx:Script>
        <![CDATA[
            [Bindable]
            private var currencyAmount:Number = 123456.789;
        ]]>
    </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 Currency Symbol">
            <s:CheckBox id="useSymbol"
                click="currencyFormatter.useCurrencySymbol = useSymbol.selected"/>
        </mx:FormItem>
        <mx:FormItem label="Actual Locale ID Name">
            <s:Label text="{currencyFormatter.actualLocaleIDName}"/>
        </mx:FormItem>
        <mx:FormItem label="Formatted Result">
            <s:Label text="{currencyFormatter.format(currencyAmount)}"/>
        </mx:FormItem>
    </mx:Form>
</s:Application>

法律上の注意 | プライバシーポリシー

CurrencyFormatter - AS3 Flex

クラス x

actualLocaleIDName

currencyISOCode

currencySymbol

negativeCurrencyFormat

positiveCurrencyFormat

useCurrencySymbol