| パッケージ | mx.formatters |
| クラス | public class CurrencyFormatter |
| 継承 | CurrencyFormatter Formatter Object |
alignSymbol プロパティを使用して、通貨記号を数値の左右どちらに置くかを指定します。 通貨記号には、スペースも含め、複数の文字を使用できます。
エラーが発生すると、空のストリングが返され、エラーを説明するストリングが error プロパティに保存されます。 この error プロパティに保存される可能性のある値は、次のうちのいずれかです。
"Invalid value"は、無効な数値が format() メソッドに渡されたことを示します。値は、Number 型 または String 型の有効な数値である必要があります。"Invalid format"は、いずれかのパラメータに、使用できない設定が含まれていることを示します。
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"
/>
関連項目
| プロパティ | 定義元 | ||
|---|---|---|---|
| alignSymbol : String
通貨記号の位置を、フォーマット済み数値の左側または右側に設定します。 | CurrencyFormatter | ||
![]() | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。 | Object | |
| currencySymbol : String
フォーマットの対象となる数値の通貨記号として使用される文字を表します。 | CurrencyFormatter | ||
| decimalSeparatorFrom : String
入力ストリングを解析する際に使用する小数点の区切り記号文字を表します。 | CurrencyFormatter | ||
| decimalSeparatorTo : String
フォーマットした小数の値を出力するときに使用する小数点の区切り文字を表します。 | CurrencyFormatter | ||
![]() | defaultInvalidFormatError : String [静的]
無効なフォーマットストリングがフォーマッタに指定されたことを示すエラーメッセージです。 | Formatter | |
![]() | defaultInvalidValueError : String [静的]
無効な値がフォーマッタに指定されたことを示すエラーメッセージです。 | Formatter | |
![]() | error : String
エラーが発生したときにフォーマッタによって保存される説明を表します。 | Formatter | |
| precision : Object
出力ストリングに含める小数の桁数を表します。 | CurrencyFormatter | ||
![]() | prototype : Object [静的]
クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。 | Object | |
| rounding : String
数値を四捨五入する方法を表します。 | CurrencyFormatter | ||
| thousandsSeparatorFrom : String
入力ストリングで桁区切り記号として使用する文字を表します。 | CurrencyFormatter | ||
| thousandsSeparatorTo : String
出力ストリングで桁区切り記号として使用する文字を表します。 | CurrencyFormatter | ||
| useNegativeSign : Object
true の場合、負数の前にマイナス("-")記号が付けられてフォーマットされます。 | CurrencyFormatter | ||
| useThousandsSeparator : Object
true の場合、数値は 3 桁ごとに区切り文字で区切られます。 | CurrencyFormatter | ||
| メソッド | 定義元 | ||
|---|---|---|---|
コンストラクタです。 | CurrencyFormatter | ||
[override]
value を通貨としてフォーマットします。 | CurrencyFormatter | ||
![]() |
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
![]() |
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
![]() |
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
![]() |
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
![]() |
指定されたオブジェクトのストリング表現を返します。 | Object | |
![]() |
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
| alignSymbol | プロパティ |
alignSymbol:String
通貨記号の位置を、フォーマット済み数値の左側または右側に設定します。 指定できる値は、"left" および "right" です。
デフォルト値 : "left".
public function get alignSymbol():String public function set alignSymbol(value:String):void| currencySymbol | プロパティ |
currencySymbol:Stringフォーマットの対象となる数値の通貨記号として使用される文字を表します。 "$" や "YEN" など、通貨記号を表す文字を使用できます。 さらに、通貨記号とフォーマット対象数値の間にスペースを挟むこともできます。 数値が負の値の場合、通貨記号は数値とマイナス記号の間、または数値と括弧の間に表示されます。
デフォルト値 : "$".
public function get currencySymbol():String public function set currencySymbol(value:String):void| decimalSeparatorFrom | プロパティ |
decimalSeparatorFrom:String入力ストリングを解析する際に使用する小数点の区切り記号文字を表します。
デフォルト値 : ".".
public function get decimalSeparatorFrom():String public function set decimalSeparatorFrom(value:String):void| decimalSeparatorTo | プロパティ |
decimalSeparatorTo:Stringフォーマットした小数の値を出力するときに使用する小数点の区切り文字を表します。
デフォルト値 : ".".
public function get decimalSeparatorTo():String public function set decimalSeparatorTo(value:String):void| precision | プロパティ |
precision:Object
出力ストリングに含める小数の桁数を表します。 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):void| rounding | プロパティ |
rounding:String
数値を四捨五入する方法を表します。 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関連項目
| thousandsSeparatorFrom | プロパティ |
thousandsSeparatorFrom:String入力ストリングで桁区切り記号として使用する文字を表します。
デフォルト値 : ",".
public function get thousandsSeparatorFrom():String public function set thousandsSeparatorFrom(value:String):void| thousandsSeparatorTo | プロパティ |
thousandsSeparatorTo:String出力ストリングで桁区切り記号として使用する文字を表します。
デフォルト値 : ",".
public function get thousandsSeparatorTo():String public function set thousandsSeparatorTo(value:String):void| useNegativeSign | プロパティ |
useNegativeSign:Object
true の場合、負数の前にマイナス("-")記号が付けられてフォーマットされます。 false の場合、数値は、(400)のように括弧で囲まれてフォーマットされます。
デフォルト値 : true.
public function get useNegativeSign():Object public function set useNegativeSign(value:Object):void| useThousandsSeparator | プロパティ |
useThousandsSeparator:Object
true の場合、数値は 3 桁ごとに区切り文字で区切られます。
デフォルト値 : true.
public function get useThousandsSeparator():Object public function set useThousandsSeparator(value:Object):void| CurrencyFormatter | () | コンストラクタ |
public function CurrencyFormatter()コンストラクタです。
| format | () | メソッド |
override public function format(value:Object):String
value を通貨としてフォーマットします。 value をフォーマットできない場合、空のストリングが返され、error プロパティにエラーの説明が書き込まれます。
パラメータ
value:Object — フォーマットする値を表します。
|
String — フォーマットしたストリング。 エラーが発生した場合は空です。
|
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the CurrencyFormatter. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx: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="";
}
}
]]>
</mx:Script>
<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"/>
<mx:Panel title="CurrencyFormatter Example" width="75%" height="75%"
paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">
<mx:Form>
<mx:FormItem label="Enter U.S. dollar amount:">
<mx:TextInput id="priceUS" text="" width="50%"/>
</mx:FormItem>
<mx:FormItem label="Formatted amount: ">
<mx:TextInput id="formattedUSPrice" text="" width="50%" editable="false"/>
</mx:FormItem>
<mx:FormItem>
<mx:Button label="Validate and Format" click="Format();"/>
</mx:FormItem>
</mx:Form>
</mx:Panel>
</mx:Application>
このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート
現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/formatters/CurrencyFormatter.html