メソッド | プロパティ フレームあり | フレームなし

mx.formatters
NumberBase クラス




NumberBase クラス

NumberBase クラスは、四捨五入、表示桁数、桁区切りフォーマット、負符号フォーマットなどの一般的な数値フォーマット機能を含むユーティリティクラスです。

関連項目
    NumberFormatter



コンストラクタ
NumberBase ( dSepFrom, tSepFrom, dSepTo, tSepTo)
NumberBase オブジェクトを作成します。



メソッド
       formatDecimal( value:String)
小数を "." としてストリングを受け取り、出力用に小数をフォーマットする文字を使用して値を返します。
       formatNegative( value, useSign)
マイナス記号 (-) か括弧 () のいずれかを使用して、負の数値をフォーマットします。
       formatPrecision( value, precision)
デフォルトまたはカスタムの記号を使用して、小数をフォーマットします。
       formatRounding( value, round)
数値を四捨五入します。
       formatThousands( value)
定義可能な桁区切り記号および小数点を使用して、数値をフォーマットします。
       parseNumberString( str)
フォーマットしたストリングから数値を抽出します。



プロパティ
       dSymbolFrom:String
小数点として使用する文字を含むストリングを表します。
       dSymbolTo:String
小数点として使用する文字を含むストリングを表します。
       isValid:Boolean
フォーマットの状態を表します。
       tSymbolFrom:String
桁区切り文字として使用する文字を含むストリングを表します。
       tSymbolTo:String
桁区切り文字として使用する文字を含むストリングを表します。



コンストラクタの詳細

NumberBase

NumberBase( dSepFrom, tSepFrom, dSepTo, tSepTo)

NumberBase オブジェクトを作成します。

パラメータ
    dSepFrom - ストリング解析の小数点の記号に使用する文字を表します。
    tSepFrom - ストリング解析の桁区切り記号に使用する文字を表します。
    dSepTo - 出力用にフォーマットする小数点の記号に使用する文字を表します。
    tSepTo - 出力用にフォーマットする桁区切り記号に使用する文字を表します。



メソッドの詳細

formatDecimal

formatDecimal( value:String)

小数を "." としてストリングを受け取り、出力用に小数をフォーマットする文字を使用して値を返します。

パラメータ
    value:String - Number の String 値 (アメリカ式 ####.## にフォーマットされる)

戻り値
     パラメータのストリング表現 ("." が小数のフォーマット文字に置き換えられる)。


formatNegative

formatNegative( value, useSign)

マイナス記号 (-) か括弧 () のいずれかを使用して、負の数値をフォーマットします。

パラメータ
    value - フォーマットする値を表します。
    useSign - true の場合、マイナス記号 (-) を使用します。false の場合、括弧 () を使用します。

戻り値
     フォーマットしたストリング。


formatPrecision

formatPrecision( value, precision)

デフォルトまたはカスタムの記号を使用して、小数をフォーマットします。dSymbolTo プロパティは小数点の記号として使用されます。

パラメータ
    value - フォーマットする値を表します。
    precision - 小数点の桁数を表します。

戻り値
     フォーマットしたストリング。


formatRounding

formatRounding( value, round)

数値を四捨五入します。

パラメータ
    value - 四捨五入する値を表します。
    round - "none"、"up"、"down"、または "nearest" を指定します。

戻り値
     フォーマットした数値。


formatThousands

formatThousands( value)

定義可能な桁区切り記号および小数点を使用して、数値をフォーマットします。tSymbolTo プロパティは桁区切り記号として使用されます。dSymbolTo プロパティは小数点の記号として使用されます。

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

戻り値
     フォーマットしたストリング。


parseNumberString

parseNumberString( str)

フォーマットしたストリングから数値を抽出します。ストリングを左から右に向かって調べ、最初の数値を返します。桁区切り記号を無視し、整数部と小数部を数値として含めます。

パラメータ
    str - 数値として解析するストリングを表します。

戻り値
     値。小数になる可能性があります。



プロパティの詳細

dSymbolFrom

dSymbolFrom:String  

小数点として使用する文字を含むストリングを表します。デフォルト値は “.” です。


dSymbolTo

dSymbolTo:String  

小数点として使用する文字を含むストリングを表します。デフォルト値は “.” です。


isValid

isValid:Boolean  

フォーマットの状態を表します。


tSymbolFrom

tSymbolFrom:String  

桁区切り文字として使用する文字を含むストリングを表します。デフォルト値は “,” です。


tSymbolTo

tSymbolTo:String  

桁区切り文字として使用する文字を含むストリングを表します。デフォルト値は “,” です。