ASDoc

mx.formatters
NumberFormatter クラス

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

NumberFormatter クラスは、小数点以下の四捨五入や表示する桁数、桁切り記号、負符号などを調整して、有効な数値をフォーマットします。

MXML シンタックス

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

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

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

関連項目
NumberBase

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

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

format

プロパティ
	`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 - フォーマットする値を表します。

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

プロパティの詳細

decimalSeparatorFrom

decimalSeparatorFrom:String

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

decimalSeparatorTo

decimalSeparatorTo:String

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

precision

precision:Number

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

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 です。

例

NumberFormatterExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Number 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(priceUS.text.charAt(0) == '.')
                {
temp = "0" + priceUS.text;
                }
             
formattednumber.text= numberformatter.format(temp);
             }
else
formattednumber.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 Number to be validated and formatted:"color="#FFFFFF">
<mx:TextInput id="priceUS" text="Enter Number here " color="#000000"/>
</mx:FormItem>

<mx:FormItem label="Formatted Number:" color="#FFFFFF">
<mx:TextInput id="formattednumber" editable="false" color="#0000FF"/>
</mx:FormItem>

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

</mx:Form>

</mx:Panel>

<!-- 数の検証結果が NumberFormatter によってフォーマットされ表示されます。 -->
<mx:NumberFormatter id="numberformatter" precision="4" useThousandsSeparator="true" useNegativeSign="true"/>

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

</mx:Application>

mx.formatters NumberFormatter クラス