ASDoc

mx.formatters
CurrencyFormatter クラス

CurrencyFormatter クラス
mx.formatters.Formatter の拡張

CurrencyFormatter クラスは有効な数値をフォーマットします。小数点以下の四捨五入や表示する桁数、桁区切り記号、および負符号を調整したり、通貨記号も追加します。alignSymbol プロパティを使用して、通貨記号を数値の左右どちらに置くかを指定します。通貨記号には、スペースも含め、複数の文字を使用できます。

MXML シンタックス

<mx:CurrencyFormatter> タグには、次のプロパティを使用できます。

 <mx:CurrencyFormatter
   id="No default."
   precision="2"
   rounding="none|up|down|nearest"
   decimalSeparatorFrom="."
   decimalSeparatorTo="."
   thousandsSeparatorFrom=","
   thousandsSeparatorTo=","
   useThousandsSeparator="true|false"
   useNegativeSign="true|false"
   currencySymbol="$"
   alignSymbol="left|right" 
 />

例を参照するにはここをクリックしてください

関連項目
NumberBase

メソッド
	`format( value) : String` 数値を通貨としてフォーマットします。

mx.formatters.Formatter クラスから継承されるメソッド

format

プロパティ
	`alignSymbol:String` 通貨記号を、フォーマットした数値の左側または右側に揃えます。
	`currencySymbol:String` フォーマットした数値に通貨記号として使用する、ユーザー定義可能な文字を表します。
	`decimalSeparatorFrom:String` 入力時にストリング数値の解析に使用する、ユーザー定義可能な区切り文字を表します。
	`decimalSeparatorTo:String` フォーマットした小数の値を出力するときに使用する、ユーザー定義可能な区切り文字を表します。
	`precision:Number` フォーマットに含める小数の桁数を表します。
	`rounding:String`数値を四捨五入する方法を表します。
	`thousandsSeparatorFrom:String` 数値ストリングの解析時に桁区切り記号として使用する、ユーザー定義可能な文字を表します。
	`thousandsSeparatorTo:String` 出力ストリングをフォーマットするときに桁区切り記号として使用する、ユーザー定義可能な文字を表します。
	`useNegativeSign:Booleantrue` の場合、負の数値はマイナス記号を付けてフォーマットされます。
	`useThousandsSeparator:Booleantrue` の場合、数値は 3 桁ごとに区切り文字で区切られます。

mx.formatters.Formatter クラスから継承されるプロパティ

error

メソッドの詳細

format

format( value)
										
													 :  String

数値を通貨としてフォーマットします。値をフォーマットできない場合は、空のストリングが返され、error プロパティにはエラーの説明が格納されます。

パラメータ
value - フォーマットする値を表します。

戻り値
フォーマットしたストリング。エラーが発生した場合は空です。

プロパティの詳細

alignSymbol

alignSymbol:String

通貨記号を、フォーマットした数値の左側または右側に揃えます。使用できる値は、left および right です。デフォルト値は left です。

currencySymbol

currencySymbol:String

フォーマットした数値に通貨記号として使用する、ユーザー定義可能な文字を表します。& や YEN など、通貨記号を表す文字を使用できます。また、空白を使用して、フォーマットした数値と通貨文字との間にスペースを追加することもできます。数値が負の値の場合、通貨記号は数値とマイナス記号の間、または数値と括弧の間に出現します。デフォルト値は "$" です。

decimalSeparatorFrom

decimalSeparatorFrom:String

入力時にストリング数値の解析に使用する、ユーザー定義可能な区切り文字を表します。デフォルト値は "." です。

decimalSeparatorTo

decimalSeparatorTo:String

フォーマットした小数の値を出力するときに使用する、ユーザー定義可能な区切り文字を表します。precision が調整されたときも、decimalSeparatorTo の値が設定されます。デフォルト値は "." です。

precision

precision:Number

フォーマットに含める小数の桁数を表します。precision を 0 に設定すると precision を無効にできます。デフォルト値は定義されていません。

rounding

rounding:String

数値を四捨五入する方法を表します。none、up、down、または nearest のいずれかの値を指定できます。デフォルト値は none です。

thousandsSeparatorFrom

thousandsSeparatorFrom:String

数値ストリングの解析時に桁区切り記号として使用する、ユーザー定義可能な文字を表します。デフォルト値は "." です。

thousandsSeparatorTo

thousandsSeparatorTo:String

出力ストリングをフォーマットするときに桁区切り記号として使用する、ユーザー定義可能な文字を表します。デフォルト値は "," です。

useNegativeSign

useNegativeSign:Boolean

true の場合、負の数値はマイナス記号を付けてフォーマットされます。false の場合、数値は、(400) のように括弧で囲まれてフォーマットされます。デフォルト値は true です。

useThousandsSeparator

useThousandsSeparator:Boolean

true の場合、数値は 3 桁ごとに区切り文字で区切られます。デフォルト値は true です。

例

CurrencyFormatterExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Currency formatter の使用方法を示す簡単な例 -->
<mx:Application xmlns:mx="http://www.macromedia.com/2003/mxml" backgroundColor="#FFFFFF">

<mx:Script>
<![CDATA[

function Format()
          {
if(mx.validators.Validator.isValid(this,'US.currency'))
             {
var temp= US.currency;
                                    
if(formattedUSprice.text.charAt(0) == '.')
                {
temp = "0" + formattedUSprice.text;
                }
                  
formattedUSprice.text= USDformatter.format(temp);
temp = temp * 0.821423;
formattedEuroprice.text= Euroformatter.format(temp);
             }
else
             {
formattedUSprice.text="";
formattedEuroprice.text="";
             }
          }

      ]]>
</mx:Script>
<mx:Panel title="Validate and Format Panel" backgroundColor="#0C8BF3">

<mx:Model id="US">
<currency>{priceUS.text}</currency>
</mx:Model>

<mx:Form>

<mx:FormItem label="Enter US amount to be validated and formatted:"color="#FFFFFF">
<mx:TextInput id="priceUS" text="Enter amount here and click button." color="#000000"/>
</mx:FormItem>

<mx:FormItem label="Formatted US amount:" color="#FFFFFF">
<mx:TextInput id="formattedUSprice" editable="false" color="#0000FF"/>
</mx:FormItem>

<mx:FormItem label="Formatted and Converted Euro amount:"color="#FFFFFF">
<mx:TextInput id="formattedEuroprice" editable="false" color="#0000FF"/>
</mx:FormItem>

<mx:FormItem>
<mx:Button label="Validate and Format" click="Format();" width="160"/>
</mx:FormItem>

</mx:Form>

</mx:Panel>

<!-- 数の検証結果が CurrencyFormatter によってフォーマットされ表示されます。 -->
<mx:CurrencyFormatter id="USDformatter" precision="2" currencySymbol="$" decimalSeparatorFrom="."
decimalSeparatorTo="." useNegativeSign="true" useThousandsSeparator="true" alignSymbol="left"/>

<mx:CurrencyFormatter id="Euroformatter" precision="2" currencySymbol="€" decimalSeparatorFrom="."
decimalSeparatorTo="." useNegativeSign="true" useThousandsSeparator="true" alignSymbol="left"/>

<!-- NumberValidator がユーザー入力を検証します。 -->
<mx:NumberValidator field="US.currency" allowNegative="true" domain="real"/>

</mx:Application>

mx.formatters CurrencyFormatter クラス