パッケージmx.formatters
クラスpublic class NumberFormatter
継承NumberFormatter Inheritance Formatter Inheritance Object

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

roundingprecision の両方のプロパティを使用した場合、最初に rounding が適用され、次に precision に指定された値を使用して小数点以下の桁数が設定されます。 そのため、たとえば 303.99 = 304.00 のように、数値を丸めながら、小数点以下の桁を残すことができます。

エラーが発生すると、空のストリングが返され、エラーを説明するストリングが error プロパティに保存されます。 この error プロパティに保存される可能性のある値は、次のうちのいずれかです。

MXML のシンタックスexpandedMXML シンタックスを隠す

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"/>  
  

例を表示

関連項目

mx.formatters.NumberBase
mx.formatters.NumberBaseRoundType


パブリックプロパティ
 プロパティ定義元
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  decimalSeparatorFrom : String
入力ストリングを解析する際に使用する小数点の区切り記号文字です。
NumberFormatter
  decimalSeparatorTo : String
フォーマットした小数の値を出力するときに使用する小数点の区切り文字を表します。
NumberFormatter
 InheriteddefaultInvalidFormatError : String
[静的] 無効なフォーマットストリングがフォーマッタに指定されたことを示すエラーメッセージです。
Formatter
 InheriteddefaultInvalidValueError : String
[静的] 無効な値がフォーマッタに指定されたことを示すエラーメッセージです。
Formatter
 Inheritederror : String
エラーが発生したときにフォーマッタによって保存される説明を表します。
Formatter
  precision : Object
出力ストリングに含める小数の桁数を表します。
NumberFormatter
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  rounding : String
数値を四捨五入する方法を指定します。
NumberFormatter
  thousandsSeparatorFrom : String
入力ストリングで桁区切り記号として使用する文字を表します。
NumberFormatter
  thousandsSeparatorTo : String
出力ストリングで桁区切り記号として使用する文字を表します。
NumberFormatter
  useNegativeSign : Object
true の場合、負数の前にマイナス("-")記号が付けられてフォーマットされます。
NumberFormatter
  useThousandsSeparator : Object
true の場合、数値は 3 桁ごとに区切り文字で区切られます。
NumberFormatter
プロテクトプロパティ
 プロパティ定義元
 InheritedresourceManager : IResourceManager
[読み取り専用] アプリケーションのローカライズされたすべてのリソースを管理するオブジェクトへの参照です。
Formatter
パブリックメソッド
 メソッド定義元
  
コンストラクタです。
NumberFormatter
  
[override] 数値をストリングとしてフォーマットします。
NumberFormatter
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
プロテクトメソッド
 メソッド定義元
 Inherited
このメソッドは、Formatter の作成時に呼び出されます。また、ローカライズされたリソースが何らかの方法で変更されたことを示すために、ResourceManager が "change" イベントを送出した時点で常に呼び出されます。
Formatter
プロパティの詳細
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 で、roundingNumberBaseRoundType.NONE に設定されている場合、戻り値は 1.453 です。 precision-1 で、四捨五入の形式を設定している場合、その四捨五入の形式に基づいて値が返されます。

デフォルト値 : -1.



実装
    public function get precision():Object
    public function set precision(value:Object):void
roundingプロパティ 
rounding:String

数値を四捨五入する方法を指定します。

ActionScript では、定数 NumberBaseRoundType.NONENumberBaseRoundType.UPNumberBaseRoundType.DOWN または NumberBaseRoundType.NEAREST を使用してこのプロパティを設定できます。有効な MXML 値は、"down"、"nearest"、"up" および "none" です。

デフォルト値 : 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
コンストラクタの詳細
NumberFormatter()コンストラクタ
public function NumberFormatter()

コンストラクタです。

メソッドの詳細
format()メソッド
override public function format(value:Object):String

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

パラメータ

value:Object — フォーマットする値を表します。

戻り値
String — フォーマットしたストリングを表します。 エラーが発生した場合は空です。
例の使用法
NumberFormatterExample.mxml
<?xml version="1.0"?>
<!-- Simple example to demonstrate NumberFormatter. -->
<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) {
             
                formattedNumber.text= numberFormatter.format(inputVal.text);
             }
             
             else {
                formattedNumber.text= "";
             }
          }
      ]]>      
    </mx:Script>

    <mx:NumberFormatter id="numberFormatter" precision="4" 
        useThousandsSeparator="true" useNegativeSign="true"/>

    <mx:NumberValidator id="numVal" source="{inputVal}" property="text" 
        allowNegative="true" domain="real"/>

    <mx:Panel title="NumberFormatter Example" width="75%" height="75%" 
            paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">

        <mx:Form>
            <mx:FormItem label="Enter number:">
                <mx:TextInput id="inputVal" text="" width="50%"/>
            </mx:FormItem>

            <mx:FormItem label="Formatted number (precision=4): ">
                <mx:TextInput id="formattedNumber" editable="false" width="50%"/>
            </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/NumberFormatter.html