Adobe® Flash® Platform 用 ActionScript® 3.0 リファレンスガイド
ホーム  |  パッケージおよびクラスリストの非表示 |  パッケージ  |  クラス  |  新機能  |  索引  |  付録  |  英語で表示される理由
フィルター: サーバーからデータを取得しています...
サーバーからデータを取得しています...
mx.formatters 

NumberBase  - AS3 Flex

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

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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

関連する API エレメント



パブリックプロパティ
 プロパティ定義元
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。
Object
  decimalSeparatorFrom : String
入力ストリングを解析する際に使用する小数点の区切り記号文字です。
NumberBase
  decimalSeparatorTo : String
フォーマットした小数の値を出力するときに使用する小数点の区切り文字を表します。
NumberBase
  isValid : Boolean = false
true の場合、フォーマットが成功したことを示します。それ以外の場合は false です。
NumberBase
  thousandsSeparatorFrom : String
入力ストリングで桁区切り記号として使用する文字を表します。
NumberBase
  thousandsSeparatorTo : String
出力ストリングで桁区切り記号として使用する文字を表します。
NumberBase
パブリックメソッド
 メソッド定義元
  
NumberBase(decimalSeparatorFrom:String = ".", thousandsSeparatorFrom:String = ",", decimalSeparatorTo:String = ".", thousandsSeparatorTo:String = ",")
コンストラクターです。
NumberBase
  
指数表記の数値を 10 進数表記の数値にフォーマットします。
NumberBase
  
デフォルトの小数区切り記号である "." を decimalSeparatorTo で指定した小数区切り記号に置き換えて数値をフォーマットします。
NumberBase
  
マイナス記号(-)か括弧 () のいずれかを使用して、負の数値をフォーマットします。
NumberBase
  
formatPrecision(value:String, precision:int):String
decimalSeparatorTo プロパティを小数区切り記号として使用して小数を設定し、数値をフォーマットします。
NumberBase
  
数値を四捨五入してフォーマットします。
NumberBase
  
formatRoundingWithPrecision(value:String, roundType:String, precision:int):String
数値を四捨五入し、小数を設定してフォーマットします。
NumberBase
  
thousandsSeparatorTo プロパティを桁区切り記号、decimalSeparatorTo プロパティを小数区切り記号として使用し、数値をフォーマットします。
NumberBase
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
  
フォーマットしたストリングから数値を抽出します。
NumberBase
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
プロパティの詳細

decimalSeparatorFrom

プロパティ
public var decimalSeparatorFrom:String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

入力ストリングを解析する際に使用する小数点の区切り記号文字です。

デフォルト値: "."。

decimalSeparatorTo

プロパティ 
public var decimalSeparatorTo:String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

フォーマットした小数の値を出力するときに使用する小数点の区切り文字を表します。

デフォルト値: "."。

isValid

プロパティ 
public var isValid:Boolean = false

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

true の場合、フォーマットが成功したことを示します。それ以外の場合は false です。

thousandsSeparatorFrom

プロパティ 
public var thousandsSeparatorFrom:String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

入力ストリングで桁区切り記号として使用する文字を表します。

デフォルト値: ","。

thousandsSeparatorTo

プロパティ 
public var thousandsSeparatorTo:String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

出力ストリングで桁区切り記号として使用する文字を表します。

デフォルト値: ","。

コンストラクターの詳細

NumberBase

()コンストラクター
public function NumberBase(decimalSeparatorFrom:String = ".", thousandsSeparatorFrom:String = ",", decimalSeparatorTo:String = ".", thousandsSeparatorTo:String = ",")

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

コンストラクターです。

パラメーター
decimalSeparatorFrom:String (default = ".") — 入力ストリングを解析する際に使用する小数点の区切り記号です。
 
thousandsSeparatorFrom:String (default = ",") — 入力ストリングで桁区切り記号として使用する文字を表します。
 
decimalSeparatorTo:String (default = ".") — フォーマットした小数の値を出力するときに使用する小数点の区切り文字を表します。
 
thousandsSeparatorTo:String (default = ",") — 出力ストリングで桁区切り記号として使用する文字を表します。
メソッドの詳細

expandExponents

()メソッド
public function expandExponents(value:String):String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

指数表記の数値を 10 進数表記の数値にフォーマットします。

パラメーター

value:String — 指数表記で処理するストリング。

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

formatDecimal

()メソッド 
public function formatDecimal(value:String):String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

デフォルトの小数区切り記号である "." を decimalSeparatorTo で指定した小数区切り記号に置き換えて数値をフォーマットします。

パラメーター

value:String — Number のストリング値(アメリカ式 ####.## にフォーマットされる)。

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

formatNegative

()メソッド 
public function formatNegative(value:String, useSign:Boolean):String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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

パラメーター

value:String — フォーマットする値を表します。
 
useSign:Booleantrue の場合、マイナス記号(-)が使用されます。 false の場合、括弧 () が使用されます。

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

formatPrecision

()メソッド 
public function formatPrecision(value:String, precision:int):String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

decimalSeparatorTo プロパティを小数区切り記号として使用して小数を設定し、数値をフォーマットします。

パラメーター

value:String — フォーマットする値を表します。
 
precision:int — 使用する小数点以下の桁数を表します。

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

formatRounding

()メソッド 
public function formatRounding(value:String, roundType:String):String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

数値を四捨五入してフォーマットします。 実行できる四捨五入のタイプは、mx.formatters.NumberBaseRoundType で定義されています。

パラメーター

value:String — 四捨五入する値を表します。
 
roundType:String — 実行する四捨五入のタイプを表します。NumberBaseRoundType.NONE、NumberBaseRoundType.UP、NumberBaseRoundType.DOWN または NumberBaseRoundType.NEAREST です。

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

関連する API エレメント

formatRoundingWithPrecision

()メソッド 
public function formatRoundingWithPrecision(value:String, roundType:String, precision:int):String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

数値を四捨五入し、小数を設定してフォーマットします。 実行できる四捨五入のタイプは、mx.formatters.NumberBaseRoundType で定義されています。

パラメーター

value:String — 四捨五入する値を表します。
 
roundType:String — 実行する四捨五入のタイプを表します。NumberBaseRoundType.NONE、NumberBaseRoundType.UP、NumberBaseRoundType.DOWN または NumberBaseRoundType.NEAREST です。
 
precision:int — 使用する小数の桁数(整数)を表します。

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

関連する API エレメント

formatThousands

()メソッド 
public function formatThousands(value:String):String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

thousandsSeparatorTo プロパティを桁区切り記号、decimalSeparatorTo プロパティを小数区切り記号として使用し、数値をフォーマットします。

パラメーター

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

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

parseNumberString

()メソッド 
public function parseNumberString(str:String):String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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

パラメーター

str:String — 数値として解析するストリングを表します。

戻り値
String — 小数になる可能性がある値です。




[ X ]英語で表示される理由
ActionScript 3.0 リファレンスガイドのコンテンツが英語で表示されます。

ActionScript 3.0 リファレンスガイドのすべての部分がすべての言語に翻訳されているわけではありません。言語エレメントが翻訳されていない場合、そのエレメントは英語で表示されます。例えば、ga.controls.HelpBox クラスはどの言語にも訳されていません。このため、リファレンスガイドの日本語バージョンでは、ga.controls.HelpBox クラスは英語で表示されます。