| パッケージ | mx.formatters |
| クラス | public class CurrencyFormatter |
| 継承 | CurrencyFormatter  Formatter Object |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
 | Flex 4.5 以降では、このクラスの代わりとして spark.formatters.CurrencyFormatter クラスを使用することをお勧めします。 |
CurrencyFormatter クラスは有効な数値を通貨型としてフォーマットします。 小数点以下の四捨五入と表示する桁数、桁区切り記号および負符号を調整し、通貨記号を追加します。
alignSymbol プロパティを使用して、通貨記号を数値の左右どちらに置くかを指定します。 通貨記号には、スペースも含め、複数の文字を使用できます。
エラーが発生すると、空のストリングが返され、エラーを説明するストリングが error プロパティに保存されます。 この error プロパティに保存される可能性のある値は、次のうちのいずれかです。
-
"Invalid value"は、無効な数値がformat()メソッドに渡されたことを示します。 値は、Number 型 または String 型の有効な数値である必要があります。 -
"Invalid format"は、いずれかのパラメーターに、使用できない設定が含まれていることを示します。
MXML シンタックスを表示
MXML シンタックスを隠すThe <mx:CurrencyFormatter> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:CurrencyFormatter
alignSymbol="left|right"
currencySymbol="$"
decimalSeparatorFrom="."
decimalSeparatorTo="."
precision="-1"
rounding="none|up|down|nearest"
thousandsSeparatorFrom=","
thousandsSeparatorTo=","
useNegativeSign="true|false"
useThousandsSeparator="true|false"
/>
関連する API エレメント
パブリックプロパティ
| プロパティ | 定義元 | ||
|---|---|---|---|
| alignSymbol : String
通貨記号の位置を、フォーマット済み数値の左側または右側に設定します。 | CurrencyFormatter | ||
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| currencySymbol : String
フォーマットの対象となる数値の通貨記号として使用される文字を表します。 | CurrencyFormatter | ||
| decimalSeparatorFrom : String
入力ストリングを解析する際に使用する小数点の区切り記号文字を表します。 | CurrencyFormatter | ||
| decimalSeparatorTo : String
フォーマットした小数の値を出力するときに使用する小数点の区切り文字を表します。 | CurrencyFormatter | ||
| error : String
エラーが発生したときにフォーマッターによって保存される説明を表します。 | Formatter | |
| precision : Object
出力ストリングに含める小数の桁数を表します。 | CurrencyFormatter | ||
| rounding : String
数値を四捨五入する方法を表します。 | CurrencyFormatter | ||
| thousandsSeparatorFrom : String
入力ストリングで桁区切り記号として使用する文字を表します。 | CurrencyFormatter | ||
| thousandsSeparatorTo : String
出力ストリングで桁区切り記号として使用する文字を表します。 | CurrencyFormatter | ||
| useNegativeSign : Object
true の場合、負数の前にマイナス（"-"）記号が付けられてフォーマットされます。 | CurrencyFormatter | ||
| useThousandsSeparator : Object
true の場合、数値は 3 桁ごとに区切り文字で区切られます。 | CurrencyFormatter | ||
プロテクトプロパティ
パブリックメソッド
| メソッド | 定義元 | ||
|---|---|---|---|
コンストラクターです。 | CurrencyFormatter | ||
[オーバーライド]
value を通貨としてフォーマットします。 | CurrencyFormatter | ||
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
プロテクトメソッド
プロパティの詳細
alignSymbol | プロパティ |
currencySymbol | プロパティ |
currencySymbol:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
フォーマットの対象となる数値の通貨記号として使用される文字を表します。 "$" や "YEN" など、通貨記号を表す文字を使用できます。 さらに、通貨記号とフォーマット対象数値の間にスペースを挟むこともできます。 数値が負の値の場合、通貨記号は数値とマイナス記号の間、または数値と括弧の間に表示されます。
デフォルト値： "$"。
実装
public function get currencySymbol():String public function set currencySymbol(value:String):voiddecimalSeparatorFrom | プロパティ |
decimalSeparatorTo | プロパティ |
precision | プロパティ |
precision:Object| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
出力ストリングに含める小数の桁数を表します。 precision を -1 に設定すると precision を無効にできます。 値が -1 の場合、桁数は変更されません。 たとえば、入力値が 1.453 で、rounding が NumberBaseRoundType.NONE に設定されている場合、1.453 が返されます。 precision が -1 で、四捨五入の形式を設定している場合、その四捨五入の形式に基づいて値が返されます。
デフォルト値： -1。
実装
public function get precision():Object public function set precision(value:Object):voidrounding | プロパティ |
rounding:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
数値を四捨五入する方法を表します。 ActionScript では、値として NumberBaseRoundType.NONE、NumberBaseRoundType.UP、NumberBaseRoundType.DOWN または NumberBaseRoundType.NEAREST を指定できます。 MXML では、値として "none"、"up"、"down" または "nearest" を指定できます。
デフォルト値： NumberBaseRoundType.NONE。
実装
public function get rounding():String public function set rounding(value:String):void関連する API エレメント
thousandsSeparatorFrom | プロパティ |
thousandsSeparatorTo | プロパティ |
useNegativeSign | プロパティ |
useThousandsSeparator | プロパティ |
コンストラクターの詳細
CurrencyFormatter | () | コンストラクター |
public function CurrencyFormatter()| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
コンストラクターです。
メソッドの詳細
format | () | メソッド |
例 この例の使用方法
CurrencyFormatterExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the 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:Script>
<![CDATA[
import mx.events.ValidationResultEvent;
private var vResult:ValidationResultEvent;
// Event handler to validate and format input.
private function Format():void {
vResult = numVal.validate();
if (vResult.type==ValidationResultEvent.VALID) {
var temp:Number = Number(priceUS.text);
formattedUSPrice.text = usdFormatter.format(temp);
} else {
formattedUSPrice.text = "";
}
}
]]>
</fx:Script>
<fx:Declarations>
<mx:CurrencyFormatter id="usdFormatter" precision="2"
currencySymbol="$" decimalSeparatorFrom="."
decimalSeparatorTo="." useNegativeSign="true"
useThousandsSeparator="true" alignSymbol="left"/>
<mx:NumberValidator id="numVal" source="{priceUS}" property="text"
allowNegative="true" domain="real"/>
</fx:Declarations>
<s:Panel title="CurrencyFormatter Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<mx:Form left="10" right="10" top="10" bottom="10">
<mx:FormItem label="Enter U.S. dollar amount:">
<s:TextInput id="priceUS" text="" width="50%"/>
</mx:FormItem>
<mx:FormItem label="Formatted amount: ">
<s:TextInput id="formattedUSPrice" text="" width="50%" editable="false"/>
</mx:FormItem>
<mx:FormItem>
<s:Button label="Validate and Format" click="Format();"/>
</mx:FormItem>
</mx:Form>
</s:Panel>
</s:Application>
Tue Jun 12 2018, 10:34 AM Z