NumberFormatter

パッケージ	spark.formatters
クラス	public class NumberFormatter
継承	NumberFormatter NumberFormatterBase GlobalizationBase AdvancedStyleClient EventDispatcher Object
実装	IFormatter

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

NumberFormatter クラスは、ロケールに依存した、数値のフォーマットと解析を提供します。int、uint および Number オブジェクトをフォーマットできます。

このクラスは flash.globalization.NumberFormatter クラスのラッパークラスです。したがって、ロケール固有のフォーマットが flash.globalization.NumberFormatter によって提供されます。ただし、この NumberFormatter クラスは MXML 宣言で使用でき、要求されたロケール ID 名にロケールスタイルを使用し、バインド可能なメソッドおよびプロパティを持ちます。

flash.globalization.NumberFormatter クラスでは、フォーマット機能と、ロケール固有データの提供用に、基盤となるオペレーティングシステムを使用します。一部のオペレーティングシステムでは、flash.globalization クラスがサポートされておらず、これらのシステムではこのラッパークラスが代替機能を提供します。

MXML シンタックス expanded

MXML シンタックスを隠す

The <s:NumberFormatter> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

  <s:NumberFormatter 
    Properties
    negativeNumberFormat="locale and OS dependent"
  />

例を表示

さらに例を参照

Localization

関連する API エレメント

flash.globalization.NumberFormatter

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		actualLocaleIDName : String [オーバーライド] [読み取り専用] このクラスオブジェクトで使用される実際のロケール ID の名前。	NumberFormatter
		className : String [読み取り専用] コンポーネントクラスの名前です。	AdvancedStyleClient
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		decimalSeparator : String 小数部を持つ数字のフォーマットまたは解析に使用される小数点記号。	NumberFormatterBase
		digitsType : uint 数字をフォーマットするときに使用される数字のセットを定義します。	NumberFormatterBase
		errorText : String エラーが発生したときに format() メソッドによって返される置換文字列。	NumberFormatterBase
		fractionalDigits : int 小数点記号の後に表示できる最大桁数。	NumberFormatterBase
		groupingPattern : String フォーマットされた文字列内のグループ化区切り文字の配置を記述します。	NumberFormatterBase
		groupingSeparator : String グループ化区切りに使用される文字または文字列。	NumberFormatterBase
		id : String コンポーネントの ID です。	AdvancedStyleClient
		inheritingStyles : Object このビジュアルでないスタイルクライアントのインスタンスの継承可能なスタイルを含むオブジェクトです。	AdvancedStyleClient
		lastOperationStatus : String [オーバーライド] [読み取り専用] このクラスオブジェクトが実行した最新の操作のステータス。	NumberFormatterBase
		leadingZero : Boolean 小数点区切り文字の左側に整数がない場合に、フォーマットされた数値に先頭の 0 を含めるかどうかを指定します。	NumberFormatterBase
		moduleFactory : IFlexModuleFactory モジュールファクトリは、このビジュアルでないスタイルクライアントのインスタンスのスタイルを制御するスタイルマネージャーを検索するためのコンテキストとして使用されます。	AdvancedStyleClient
		negativeNumberFormat : uint 負の数のフォーマットパターンを示す数値。	NumberFormatter
		negativeSymbol : String 負の値をフォーマットするときに使用されるマイナス記号。	NumberFormatterBase
		nonInheritingStyles : Object このコンポーネントの非継承スタイルのチェーンの始まりです。	AdvancedStyleClient
		styleDeclaration : CSSStyleDeclaration このオブジェクトで宣言されたインラインスタイルを保持するスタイル宣言です。	AdvancedStyleClient
		styleManager : IStyleManager2 [読み取り専用] このコンポーネントで使用する StyleManager インスタンスを返します。	AdvancedStyleClient
		styleName : Object オブジェクトのスタイル値のソースです。	AdvancedStyleClient
		styleParent : IAdvancedStyleClient コンポーネントの親は、下位要素のセレクターを評価するために使用されます。	AdvancedStyleClient
		trailingZeros : Boolean 末尾の 0 をフォーマットされた数値に含めるかどうかを指定します。	NumberFormatterBase
		useGrouping : Boolean 数字をフォーマットするときに、グループ化区切りを使用できるようにします。	NumberFormatterBase

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		NumberFormatter() 所定のロケールの規則に基づいて数字をフォーマットするために、新しい NumberFormatter オブジェクトを構築します。	NumberFormatter
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		clearStyle(styleProp:String):void このコンポーネントインスタンスからスタイルプロパティを削除します。	AdvancedStyleClient
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		format(value:Object):String 数字をフォーマットします。	NumberFormatter
		getAvailableLocaleIDNames():Vector.<String> [静的] このクラスでサポートされているすべてのロケール ID 名のリストが表示されます。	NumberFormatter
		getClassStyleDeclarations():Array このコンポーネントに適用されるタイプセレクターの CSSStyleDeclaration オブジェクトの配列を返します。何も存在しない場合は null を返します。	AdvancedStyleClient
		getStyle(styleProp:String):* [オーバーライド] このコンポーネントのスタイル参照チェーンのいずれかの場所に設定されたスタイルプロパティを取得します。	GlobalizationBase
		hasCSSState():Boolean currentCSSState が null でない場合、true を返します。	AdvancedStyleClient
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		initialized(document:Object, id:String):void initialized メソッドは、このクラスまたはこのクラスを拡張するクラスが MXML 宣言で使用されると呼び出されます。	AdvancedStyleClient
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		matchesCSSState(cssState:String):Boolean cssState が currentCSSState に一致した場合は、true を返します。	AdvancedStyleClient
		matchesCSSType(cssType:String):Boolean このインスタンスが、指定されたタイプと同じであるのか、それともそのサブクラスであるのかを判別します。	AdvancedStyleClient
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void スタイルの変更を、このスタイルクライアントのインスタンスの子に通知します。	AdvancedStyleClient
		parse(inputString:String):NumberParseResult 文字列を解析して、解析した要素を含む NumberParseResult オブジェクトを返します。	NumberFormatter
		parseNumber(parseString:String):Number 数字とスペース（オプション）のみを含む文字列を解析して、Number を返します。	NumberFormatter
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		regenerateStyleCache(recursive:Boolean):void getStyle() メソッドが機能するように、内部のスタイルキャッシュ値を設定します。	AdvancedStyleClient
		registerEffects(effects:Array):void 各エフェクトイベントのイベントリスナーの 1 つとして、EffectManager を登録します。	AdvancedStyleClient
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		setStyle(styleProp:String, newValue:*):void このコンポーネントインスタンスのスタイルプロパティを設定します。	AdvancedStyleClient
		styleChanged(styleProp:String):void スタイルプロパティの変更を検出します。	AdvancedStyleClient
		stylesInitialized():void コンポーネントのスタイルを初めて初期化するとき、Flex は stylesInitialized() メソッドを呼び出します。	AdvancedStyleClient
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

イベント

イベントの詳細についてはここをクリックしてください

継承されるイベントを隠す

継承されるイベントを表示

	概要	定義元
activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
change	変更イベントは、ロケールスタイルが変更された場合、および、別のプロパティが設定されたことによって、数値のフォーマットが変更されたり、このクラスを通じて使用可能な他の値が更新されたりした場合に、常に生成されます。	GlobalizationBase
deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher

スタイル

スタイルには共通スタイルと特定のテーマに関連するスタイルがあります。共通スタイルは、任意のテーマと共に使用できます。特定のテーマに関連するスタイルは、アプリケーションがそのテーマを使用する場合にのみ使用できます。

共通スタイル

スタイルの詳細についてはここをクリックしてください

継承されるスタイルを隠す

継承されるスタイルを表示

	スタイル		説明	定義元
		locale	型: String CSS 継承: はい言語バージョン: ActionScript 3.0 製品バージョン: Flex 4.5 ランタイムバージョン: Flash10.1, AIR 2.5 言語、地域、スクリプトおよびオプションで他の関連するタグおよびキーを指定するロケール識別子です.	GlobalizationBase

プロパティの詳細

actualLocaleIDName

プロパティ

actualLocaleIDName:String [読み取り専用] [オーバーライド]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

このクラスオブジェクトで使用される実際のロケール ID の名前。これはフォーマットするデータと機能にオペレーティングシステムからアクセスするために使用されるロケールです。

locale スタイルによって設定されたロケールが使用できない場合、actualLocaleIDName の値は locale スタイルの値とは異なります。この値は使用中の代替ロケールを示します。 locale スタイルが LocaleID.DEFAULT に設定された場合、ユーザーのオペレーティングシステムによって指定されたロケールの名前が使用されます。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 change イベントが送出されます。

実装
override public function get actualLocaleIDName():String

関連する API エレメント

flash.globalization.NumberFormatter.actualLocaleIDName
NumberFormatter()

negativeNumberFormat

プロパティ

negativeNumberFormat:uint

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

負の数のフォーマットパターンを示す数値。このパターンは、フォーマットされた数字の数値部分に関連するマイナス記号または括弧の位置を定義します。

次の表は、負の数の有効なフォーマットの概要を示しています。負の数がフォーマットされると、フォーマットのマイナス記号が negativeSymbol プロパティの値に置き換えられ、「n」の文字がフォーマットされた数値に置き換えられます。

負の数のフォーマットの種類	形式
0	(n)
1	-n
2	- n
3	n-
4	n -

デフォルト値はロケールおよびオペレーティングシステムによって異なります。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 change イベントが送出されます。

実装
public function get negativeNumberFormat():uint
public function set negativeNumberFormat(value:uint):void

例外

ArgumentError — 割り当てられた値が 0～4 の数字でない場合。

関連する API エレメント

negativeSymbol
format()

コンストラクターの詳細

()

コンストラクター

public function NumberFormatter()

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

所定のロケールの規則に基づいて数字をフォーマットするために、新しい NumberFormatter オブジェクトを構築します。

このクラスのロケールはロケールスタイルによって提供されます。ロケールスタイルは、次のいくつかの方法で設定できます。

MXML 宣言内でクラスを使用し、宣言を格納するドキュメントからロケールを継承する。例：
```
      <fx:Declarations> 
             <s:NumberFormatter id="nf" />
      </fx:Declarations>
```

MXML 宣言を使用し、代入のリスト内でロケールの値を指定する。例：

      <fx:Declarations>
          <s:NumberFormatter id="nf_French_France" locale="fr_FR" />
      </fx:Declarations>

setStyle メソッドを呼び出す。次に実際の使用例を示します。
```
      nf.setStyle("locale", "fr-FR")
```
UIComponent の addStyleClient() メソッドを呼び出すことによって UIComponent からスタイルを継承する。

locale スタイルが上記のいずれかの手法で設定されていない場合は、このクラスのインスタンスが StyleClient として topLevelApplication に追加されるため、locale 依存のプロパティ getter または locale 依存のメソッドが呼び出されるときに、topLevelApplication オブジェクトから locale が継承されます。

このクラスのほとんどのプロパティは、ロケールスタイルに基づいて自動的に設定されます。ロケールスタイルが変更されると、明示的に設定されていないすべてのプロパティは新しいロケールに基づいて更新されます。使用される実際のロケールは actualLocaleIDName プロパティによって指定されることに注意してください。

関連する API エレメント

actualLocaleIDName
lastOperationsStatus

メソッドの詳細

format

()

メソッド

public function format(value:Object):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

数字をフォーマットします。

この関数はフォーマッターのプロパティ値に基づいて数字をフォーマットします。locale スタイルが設定された後にプロパティが変更されない場合、数字は、actualLocaleIDName プロパティによって識別されるロケールのオペレーティングシステムが提供するロケール固有の規則に従ってフォーマットされます。フォーマットをカスタマイズするために、プロパティを変更して、特定の面で数字のフォーマットを変更できます。

非常に大きな数字と非常に小さな数字をこの関数でフォーマットできます。ただし、有効桁数は Number オブジェクトによって指定される精度に限定されます。科学的記数法はサポートされていません。

不正な入力値またはその他のエラーによりフォーマット中にエラーが発生した場合、format() メソッドはデフォルトで null を返します。ただし、errorText プロパティが null 以外の場合、errorText プロパティの値が返されます。 lastOperationStatus プロパティが、発生したエラーを示すように設定されます。

パラメーター

value:Object — フォーマットする数値を格納するオブジェクト。オブジェクトが Number でない場合、オブジェクトは Number() 変換機能を使用して数値に変換されます。

戻り値

String — フォーマット済み数字文字列。

getAvailableLocaleIDNames

()

メソッド

public static function getAvailableLocaleIDNames():Vector.<String>

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

このクラスでサポートされているすべてのロケール ID 名のリストが表示されます。これはオペレーティングシステムでサポートされているロケールのリストです。ResourceManager にリソースがあるロケールのリストではありません。

戻り値

Vector.<String> — このクラスおよびオペレーティングシステムでサポートされているすべてのロケール ID 名を含む文字列のベクトル。

parse

()

メソッド

public function parse(inputString:String):NumberParseResult

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

ストリングを解析し、解析されたエレメントを含む NumberParseResult オブジェクトを返します。

NumberParseResult オブジェクトには入力文字列で見つかった最初の数字の値、文字列内の数字の開始インデックス、文字列内の数字の後の最初の文字のインデックスが含まれます。

ストリングに数字が含まれない場合、NumberParseResult の value プロパティは NaN に設定され、startIndex および endIndex プロパティは 16 進数値の 0x7fffffff に設定されます。

この関数は、decimalSeparator プロパティの値を使用して少数桁を含む数字の部分を判別し、groupingSeparator プロパティの値を使用して、数字の桁内で許容される文字を判別し、negativeNumberFormat プロパティの値を使用して、負の値を表示方法を制御します。

次の表は様々な NegativeNumberFormat 値で解析される文字列の結果を示しています。

NegativeNumberFormat	入力文字列	結果
(n)	"(123)" または "( 123 )"	"-123"
-n	"-123" または "- 123"	"-123"
- n	"-123" または "- 123"	"-123"
n-	"123-" または "123 -"	"-123"
n -	"123-" または "123 -"	"-123"

数字とマイナス記号または括弧の間には、スペースを 1 つ入れることができます。スペース文字とは、Unicode Character Database の Space Separator（Zs）プロパティを持つ文字のことです。詳細については、http://www.unicode.org/ucd/ を参照してください。

その他のプロパティは、有効な数字を判別するときに無視されます。特に digitsType プロパティの値が無視され、桁は NationalDigitsType クラスで列挙される桁セットのいずれかから取得できます。 groupingPattern および useGrouping プロパティの値は数字の解析に影響を与えます。

数字の前または後にプラス記号「+」が付いている場合、このプラス記号は数字の一部ではない文字として扱われます。

この関数では、科学的表記の数字（1.23e40 など）が含まれるストリングは解析されません。

パラメーター

inputString:String — 解析する入力文字列。

戻り値

NumberParseResult — 数値と、数字を格納するストリング部分の開始および終了のインデックスを格納する NumberParseResult オブジェクト。

例外

TypeError — inputString パラメーターが null の場合。

例 ( この例の使用方法 )

次のコードで文字列から数字を解析して、接頭辞と接尾辞を取得します。

      var nf:NumberFormatter = new NumberFormatter();
      nf.setStyle("locale","fr-FR");
      var str:String = "1,56 mètre"
      var result:NumberParseResult = nf.parse(str);
      trace(result.value) // 1.56
      trace(str.substr(0,result.startIndex));                // ""
      trace(str.substr(result.startIndex, result.endIndex)); // "1,56"
      trace(str.substr(result.endIndex));                 // " mètre"

parseNumber

()

メソッド

public function parseNumber(parseString:String):Number

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10.1, AIR 2.5

数字とスペース（オプション）のみを含む文字列を解析して、Number を返します。文字列が数字で始まらないか、数字の一部ではないスペース以外の文字を含む場合、このメソッドは NaN を返します。数字桁の前後のスペースは無視されます。

数字桁の前または後ろにプラス記号「+」が付いている場合は、空白文字以外として扱われます。戻り値は NaN です。

数字の解析および有効な数字の構成について詳しくは、解析機能の説明を参照してください。

パラメーター

parseString:String — 解析する入力文字列。

戻り値

Number — 数値を含む Number オブジェクト。

例外

TypeError — parseString が null の場合

例この例の使用方法

NumberFormatterExample1.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Sample program for spark.formatters.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:Declarations>
        <s:NumberFormatter id="numberFormatter"/>
    </fx:Declarations>

    <fx:Script>
        <![CDATA[
            [Bindable]
            private var number:Number = 123456789.123456789;
        ]]>
    </fx:Script>

    <mx:Form>
        <mx:FormItem label="Input Locale ID Name">
            <mx:HBox>
                <s:TextInput id="inputLocaleIDName"/>
                <!-- Upon button click, sets the locale style on the document
                    UI component. The formatter will inherit this style. -->
                <s:Button click="setStyle('locale', inputLocaleIDName.text);"
                          label="Apply"/>
            </mx:HBox>
            <mx:Text text="Example: 'en-US', 'fr-FR', 'ja-JP', 'ar-SA'"/>
        </mx:FormItem>
        <mx:FormItem label="Use Grouping">
            <mx:CheckBox id="useGrouping"
                change="numberFormatter.useGrouping= useGrouping.selected"/>
        </mx:FormItem>
        <mx:FormItem label="Fractional Digits">
            <mx:TextInput id="fractionalDigits"
                change="numberFormatter.fractionalDigits = Number(fractionalDigits.text)"/>
        </mx:FormItem>
        <mx:FormItem label="Actual Locale ID Name">
            <mx:Text text="{numberFormatter.actualLocaleIDName}"/>
        </mx:FormItem>
        <mx:FormItem label="Formatted Result">
            <mx:Text text="{numberFormatter.format(number)}"/>
        </mx:FormItem>
    </mx:Form>
</s:Application>

NumberFormatterExample2.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Sample program for spark.formatters.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:Declarations>
        <s:NumberFormatter id="numberFormatter"/>
    </fx:Declarations>

    <mx:Form>
        <mx:FormItem label="Input Locale ID Name">
            <mx:HBox>
                <s:TextInput id="inputLocaleIDName"/>
                <!-- Upon button click, sets the locale style on the document
                    UI component. The formatter will inherit this style. -->
                <s:Button click="setStyle('locale', inputLocaleIDName.text);"
                          label="Apply"/>
            </mx:HBox>
            <mx:Text text="Example: 'en-US', 'fr-FR', 'ja-JP', 'ar-SA'"/>
        </mx:FormItem>
        <mx:FormItem label="Input Number">
            <s:TextInput id="inputNumber"/>
            <mx:Text text="Example: {numberFormatter.format(123456789.123)}"/>
        </mx:FormItem>
        <mx:FormItem label="Actual Locale ID Name">
            <mx:Text text="{numberFormatter.actualLocaleIDName}"/>
        </mx:FormItem>
        <mx:FormItem label="Parsed Result">
            <mx:Text
                text="{numberFormatter.parseNumber(inputNumber.text).toString()}"/>
        </mx:FormItem>
    </mx:Form>
</s:Application>

法律上の注意 | プライバシーポリシー

NumberFormatter - AS3 Flex

クラス x

actualLocaleIDName

negativeNumberFormat