| パッケージ | mx.formatters |
| クラス | public class NumberFormatter |
| 継承 | NumberFormatter  Formatter Object |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
 | Flex 4.5 以降では、このクラスの代わりとして spark.formatters.NumberFormatter クラスを使用することをお勧めします。 |
NumberFormatter クラスは、小数点以下の四捨五入や表示桁数、桁区切り記号、負符号などを調整して、有効な数値をフォーマットします。
rounding と precision の両方のプロパティを使用した場合、最初に rounding が適用され、次に precision に指定された値を使用して小数点以下の桁数が設定されます。 そのため、たとえば 303.99 = 304.00 のように、数値を丸めながら、小数点以下の桁を残すことができます。
エラーが発生すると、空のストリングが返され、エラーを説明するストリングが error プロパティに保存されます。 この error プロパティに保存される可能性のある値は、次のうちのいずれかです。
-
"Invalid value"は、無効な数値がformat()メソッドに渡されたことを示します。 値は、Number 型 または String 型の有効な数値である必要があります。 -
"Invalid format"は、いずれかのパラメーターに、使用できない設定が含まれていることを示します。
MXML シンタックスを表示
MXML シンタックスを隠すThe <mx:NumberFormatter> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:NumberFormatter
decimalSeparatorFrom="."
decimalSeparatorTo="."
precision="-1"
rounding="none|up|down|nearest"
thousandsSeparatorFrom=","
thousandsSeparatorTo=","
useNegativeSign="true|false"
useThousandsSeparator="true|false"/>
関連する API エレメント
| プロパティ | 定義元 | ||
|---|---|---|---|
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| decimalSeparatorFrom : String
入力ストリングを解析する際に使用する小数点の区切り記号文字です。 | NumberFormatter | ||
| decimalSeparatorTo : String
フォーマットした小数の値を出力するときに使用する小数点の区切り文字を表します。 | NumberFormatter | ||
| error : String
エラーが発生したときにフォーマッターによって保存される説明を表します。 | Formatter | |
| precision : Object
出力ストリングに含める小数の桁数を表します。 | NumberFormatter | ||
| rounding : String
数値を四捨五入する方法を指定します。 | NumberFormatter | ||
| thousandsSeparatorFrom : String
入力ストリングで桁区切り記号として使用する文字を表します。 | NumberFormatter | ||
| thousandsSeparatorTo : String
出力ストリングで桁区切り記号として使用する文字を表します。 | NumberFormatter | ||
| useNegativeSign : Object
true の場合、負数の前にマイナス（"-"）記号が付けられてフォーマットされます。 | NumberFormatter | ||
| useThousandsSeparator : Object
true の場合、数値は 3 桁ごとに区切り文字で区切られます。 | NumberFormatter | ||
| メソッド | 定義元 | ||
|---|---|---|---|
コンストラクターです。 | NumberFormatter | ||
[オーバーライド]
数値をストリングとしてフォーマットします。 | NumberFormatter | ||
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
decimalSeparatorFrom | プロパティ |
decimalSeparatorFrom:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
入力ストリングを解析する際に使用する小数点の区切り記号文字です。
このプロパティを設定するときは、thousandsSeparatorFrom プロパティの値がこのプロパティと同じでないことを確認してください。そうしないと、値のフォーマット時にエラーが発生します。
デフォルト値： "."。
実装
public function get decimalSeparatorFrom():String public function set decimalSeparatorFrom(value:String):void関連する API エレメント
decimalSeparatorTo | プロパティ |
decimalSeparatorTo:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
フォーマットした小数の値を出力するときに使用する小数点の区切り文字を表します。
このプロパティを設定するときは、thousandsSeparatorTo プロパティの値がこのプロパティと同じでないことを確認してください。そうしないと、値のフォーマット時にエラーが発生します。
デフォルト値： "."。
実装
public function get decimalSeparatorTo():String public function set decimalSeparatorTo(value:String):void関連する API エレメント
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 値は、"down"、"nearest"、"up" および "none" です。
デフォルト値： NumberBaseRoundType.NONE。
実装
public function get rounding():String public function set rounding(value:String):void関連する API エレメント
thousandsSeparatorFrom | プロパティ |
thousandsSeparatorFrom:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
入力ストリングで桁区切り記号として使用する文字を表します。
このプロパティを設定するときは、decimalSeparatorFrom プロパティの値がこのプロパティと同じでないことを確認してください。そうしないと、値のフォーマット時にエラーが発生します。
デフォルト値： ","。
実装
public function get thousandsSeparatorFrom():String public function set thousandsSeparatorFrom(value:String):void関連する API エレメント
thousandsSeparatorTo | プロパティ |
thousandsSeparatorTo:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
出力ストリングで桁区切り記号として使用する文字を表します。
このプロパティを設定するときは、decimalSeparatorTo プロパティの値がこのプロパティと同じでないことを確認してください。そうしないと、値のフォーマット時にエラーが発生します。
デフォルト値： ","。
実装
public function get thousandsSeparatorTo():String public function set thousandsSeparatorTo(value:String):void関連する API エレメント
useNegativeSign | プロパティ |
useThousandsSeparator | プロパティ |
NumberFormatter | () | コンストラクター |
public function NumberFormatter()| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
コンストラクターです。
format | () | メソッド |
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate NumberFormatter. -->
<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) {
formattedNumber.text = numberFormatter.format(inputVal.text);
} else {
formattedNumber.text = "";
}
}
]]>
</fx:Script>
<fx:Declarations>
<mx:NumberFormatter id="numberFormatter" precision="4"
useThousandsSeparator="true" useNegativeSign="true"/>
<mx:NumberValidator id="numVal" source="{inputVal}" property="text"
allowNegative="true" domain="real"/>
</fx:Declarations>
<s:Panel title="NumberFormatter Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<mx:Form left="10" right="10" top="10" bottom="10">
<mx:FormItem label="Enter number:">
<s:TextInput id="inputVal" text="" width="50%"/>
</mx:FormItem>
<mx:FormItem label="Formatted number (precision=4): ">
<s:TextInput id="formattedNumber" editable="false" width="50%"/>
</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