NumberFormatter  - AS3

この NumberFormatter オブジェクトで使用される実際のロケール ID の名前。

オペレーティングシステムおよび Collator() コンストラクターに渡される requestedLocaleIDName パラメーターの値に応じて、この名前の値には 3 つの可能性があります。

1. 要求されたロケールが LocaleID.DEFAULT ではなく、要求されたロケールをオペレーティングシステムがサポートする場合、返される名前は requestedLocaleIDName プロパティと同じです。
2. LocaleID.DEFAULT がコンストラクターに対する requestedLocaleIDName パラメーターの値として使用された場合、ユーザーのオペレーティングシステムによって指定された現在のロケールの名前が使用されます。LocaleID.DEFAULT 値により、ユーザーのカスタマイズした設定が OS に保持されます。requestedLocaleIDName パラメーターとして明示的な値を渡した場合に、2 つのロケール ID 名が同じでも LocaleID.DEFAULT を使用する場合と同じ結果になるとは限りません。ユーザーがコンピューターのロケール設定をカスタマイズして、LocaleID.DEFAULT を使用するのではなく、明示的なロケール ID 名を要求した場合、アプリケーションがそれらのカスタマイズされた設定を取得しない場合があります。
3. システムがコンストラクターで指定された requestedLocaleIDName をサポートしていない場合、代替のロケール ID 名が提供されます。

関連する API エレメント

小数部を持つ数字のフォーマットまたは解析に使用される小数点記号。

このプロパティは最初、formatter オブジェクトを構築するときに選択したロケールに基づいて設定されます。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： dependent on the locale and operating system.。

関連する API エレメント

数字をフォーマットするときに使用される数字のセットを定義します。

さまざまな言語と地域で使用されるさまざまな文字セットを、0～9 の数字で表します。 このプロパティは、使用される数字のセットを定義します。

このプロパティの値は、10 進数字セットのゼロ桁の Unicode 値を表しています。このプロパティの有効な値は NationalDigitsType クラスで定義されています。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： dependent on the locale and operating system.。

関連する API エレメント

小数点記号の後に表示できる最大桁数。

数字はこのプロパティによって指定された桁数に丸められます。丸めのスキームは、ユーザーのオペレーティングシステムによって異なります。

trailingZeros プロパティが true に設定されると、数字の小数部分（小数点の後）にこの fractionalDigits プロパティの値に一致する長さまで、0 が置かれます。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： 0。

関連する API エレメント

フォーマットされた文字列内のグループ化区切り文字の配置を記述します。

useGrouping プロパティが true に設定されると、groupingPattern プロパティを使用して、グループ化区切り文字に使用される配置とパターンが定義されます。

グループ化パターンはセミコロンで区切られ、場合によっては最後にアスタリスクが付く数字を含む文字列として定義されます。例： "3;2;*"文字列内のそれぞれの数字は、グループ内の桁数を表しています。グループセパレーターは、各数字グループの前に置かれます。ストリングの最後のアスタリスクは、その桁数を持つグループが、フォーマットされた残りのストリングで繰り返されることを示しています。アスタリスクがない場合、フォーマットされた残りのストリングに追加のグループやセパレーターはありません。

文字列内の最初の数字は、小数点の左側の数字の最初のグループに対応しています。その後に続く数字は、左側の後続のグループの桁数を定義します。 このため、文字列「3;2;*」はグループ化区切り文字が最初の 3 桁のグループの後に置かれ、その後に 2 桁のグループが続くことを示しています。例： 98,76,54,321

次の表は、さまざまなグループ化パターンによる数字 123456789.12 のフォーマットの例を示しています。グループ化の区切り文字はカンマで、小数点はピリオドです。

限定された数のグループ化サイズのみ定義できます。一部のオペレーティングシステムは、グループ化パターンに 2 つの数字とアスタリスクのみ含むことができます。 その他のオペレーティングシステムは、4 つまでの数字とアスタリスクを含むことができます。アスタリスクがないパターンの場合、一部のオペレーティングシステムは 1 つの数字のみサポートし、その他のオペレーティングシステムは 3 つまでの数字をサポートします。グループ化パターン要素の最大数を超えると、追加の要素は無視され、lastOperationStatus プロパティは以下で説明するように設定されます。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

関連する API エレメント

グループ化区切りに使用される文字または文字列。

useGrouping プロパティが true に設定されている数字をフォーマットするときに、このプロパティの値がグループ化区切り文字として使用されます。 このプロパティは最初、formatter オブジェクトを構築するときに選択したロケールに基づいて設定されます。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： dependent on the locale and operating system.。

関連する API エレメント

この NumberFormatter オブジェクトが実行した前の操作のステータス。コンストラクターまたはこのクラスのメソッドが呼び出されたり、別のプロパティが設定されたりすると、必ず lastOperationStatus プロパティが設定されます。有効な値については、各メソッドの説明を参照してください。

関連する API エレメント

小数点区切り文字の左側に整数がない場合に、フォーマットされた数値に先頭の 0 を含めるかどうかを指定します。

このプロパティが true に設定されている場合、-1.0～1.0 の数値をフォーマットするときに、小数点区切り文字の左側に先頭の 0 が含まれます。このプロパティが false に設定されている場合、0 は含まれません。

例えば、数値が 0.321 でこのプロパティが true に設定されている場合、フォーマットされたストリングに先頭の 0 が含まれます。プロパティが false に設定されている場合、先頭の 0 は含まれません。その場合、文字列には、.321 のように小数点とその後に続く 10 進数の数字が含まれます。

次の表は、このプロパティと fractionalDigits および trailingZeros の関連プロパティの値に基づいて数値をフォーマットする方法の例を示しています。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： dependent on the locale and operating system.。

関連する API エレメント

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

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

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： dependent on the locale and operating system.。

関連する API エレメント

負の値をフォーマットするときに使用されるマイナス記号。

この記号は、0 よりも小さい数値をフォーマットするときに、負の数値のフォーマットと組み合わせて使用されます。負の記号を含まない負の数値のフォーマットでは使用されません（例えば、負の数値が括弧で囲まれている場合）。

このプロパティは、このフォーマッターを構築するときに選択した実際のロケールのデフォルト値に設定されます。値を設定して、デフォルト設定を無効にすることができます。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

関連する API エレメント

この NumberFormatter オブジェクトのコンストラクターに渡された、要求されたロケール ID の名前。

LocaleID.DEFAULT 値が使用された場合、返される名前は「i-default」です。代替のロケールが適用される場合、実際に使用されるロケールは要求されたロケールと異なる場合があります。 実際のロケール名は actualLocaleIDName プロパティを使用して取得できます。

関連する API エレメント

末尾の 0 をフォーマットされた数値に含めるかどうかを指定します。

このプロパティが true に設定されている場合、末尾の 0 が fractionalDigits プロパティで指定された限界までフォーマットされた数値の小数部分に含まれます。このプロパティが false に設定されている場合、末尾の 0 は表示されません。

例えば、数値が 123.4 で、このプロパティが true に設定されている場合、fractionalDigits プロパティは 3 に設定され、フォーマットされたストリングには 123.400 のように末尾の 0 が表示されます。このプロパティが false の場合、末尾の 0 は含まれず、ストリングには 123.4 のように小数点区切り文字とその後に続く 0 以外の 10 進数の数字が表示されます。

次の表は、このプロパティと fractionalDigits および leadingZero の関連プロパティの値に基づいて数値をフォーマットする方法の例を示しています。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

デフォルト値： dependent on the locale and operating system.。

関連する API エレメント

数字をフォーマットするときに、グループ化区切りを使用できるようにします。

useGrouping プロパティが true に設定されている場合、数字はグループ化され、グループセパレーター文字で区切られます。例：123,456,789.22

useGrouping プロパティが false に設定されている場合、数字はグループ化されず、区切られません。例：123456789.22

グループ化区切りとして使用される記号は groupingSeparator プロパティによって定義されます。グループ化区切り間の桁数は、groupingPattern プロパティによって定義されます。

このプロパティに値が割り当てられ、エラーや警告がない場合、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

関連する API エレメント

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

このコンストラクターは、現在のオペレーティングシステムが要求されたロケール ID 名をサポートしているかどうかを判別します。サポートされていない場合、代わりに代替のロケールが使用されます。代替のロケールが使用される場合、lastOperationStatus プロパティに代替ロケールの種類が表示され、actualLocaleIDName プロパティには代替ロケール ID の名前が表示されます。

ユーザーの現在のオペレーティングシステムの環境設定に基づいてフォーマットするには、requestedLocaleIDName パラメーターの値 LocaleID.DEFAULT をコンストラクターに渡します。

コンストラクターが正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

要求されたロケール ID 名を使用できない場合、lastOperationStatus は以下のいずれかに設定されます。

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

このクラスが現在のオペレーティングシステムでサポートされていない場合、lastOperationStatus プロパティは次のように設定されます。

• LastOperationStatus.UNSUPPORTED_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

上記の警告および lastOperationStatus プロパティのその他の有効な値について詳しくは、LastOperationStatus クラスの説明を参照してください。

関連する API エレメント

int 値をフォーマットします。この関数は、int 値を取ること以外は、formatNumber() メソッドと同じです。渡される値が 1.72e308 より大きい値や 1.72e-308 より小さい値のように、大きすぎるかまたは小さすぎる場合、この関数は 0 を返します。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

パラメーター

関連する API エレメント

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

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

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

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

パラメーター

関連する API エレメント

uint 値をフォーマットします。この関数は、uint を取ること以外 formatNumber() メソッドと同じです。 渡される値が 1.72e308 より大きいなどのように大きすぎる場合、この関数は 0 を返します。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

パラメーター

関連する API エレメント

このクラスでサポートされているすべてのロケール ID 名のリストが表示されます。

このクラスが現在のオペレーティングシステムでサポートされていない場合、このメソッドは null 値を返します。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

文字列を解析して、解析した要素を含む NumberParseResult オブジェクトを返します。

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

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

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

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

数字とマイナス記号または括弧の間には、スペースを 1 つ入れることができます。

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

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

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

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

パラメーター

関連する API エレメント

 
         var nf:NumberFormatter = new NumberFormatter("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"
         

数字とスペース（オプション）のみを含む文字列を解析して、Number を返します。文字列が数字で始まらないか、数字の一部ではないスペース以外の文字を含む場合、このメソッドは NaN を返します。 数字桁の前後のスペースは無視されます。スペース文字とは、Unicode Character Database （「http://www.unicode.org/ucd/」を参照）の Space Separator（Zs）プロパティを持つ文字のことです。

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

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

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

パラメーター

関連する API エレメント

この例では、ユーザーのオペレーティングシステムのデフォルトのロケールである、日本語（日本）、英語（米国）およびフランス語（フランス）の各ロケールを使用して数字をフォーマットします。この例では、静的メンバー LocaleID.DEFAULT を使用して、デフォルトのオペレーティングシステムのロケールを要求します。

この例の結果は、オペレーティングシステムやユーザー環境設定によって異なる場合があります。

この例では、リストの各ロケールに対して、次の処理を行います。

1. NumberFormatter オブジェクトを作成します。
2. 同じ値を数字、整数、符号なし整数としてフォーマットし、結果を表示します。

 
package {
    import flash.globalization.NumberFormatter;
    import flash.globalization.LocaleID;
    
    public class NumberFormatterExample extends Sprite
    {
        public function NumberFormatterExample():void
        {
            var localeNames:Array = [LocaleID.DEFAULT,"ja_JP","en_US","fr_FR"];
            
            for ( var i:int = 0; i < localeNames.length; i++ ) 
            {
                var nf:NumberFormatter = new NumberFormatter( localeNames[i] as String );
                trace('\n\n' + "LocaleID requested: " + nf.requestedLocaleIDName 
                    + "; actual: " + nf.actualLocaleIDName);
                trace( "Last Operation Status:" + nf.lastOperationStatus );   
            
                var numberString:String = nf.formatNumber(123456789.19); 
                trace( "Formatted Number:" + numberString);
                numberString = nf.formatInt(-123456789); 
                trace( "Formatted Int:" + numberString);
                numberString = nf.formatUint(123456789); 
                trace( "Formatted UInt:" + numberString);
            }
        }
    }
}

この例の結果は、オペレーティングシステムやユーザー環境設定によって異なる場合があります。

この例では、次の処理を行います。

1. NumberFormatter オブジェクトを作成します。
2. NumberFormatter.parse() メソッドを呼び出し、ストリングを解析して NumberParseResult オブジェクトを返します。
3. NumberFormatter.parseNumber() メソッドを呼び出し、ストリングを解析して数値を返します。

 
package {
      import flash.globalization.NumberFormatter;
      import flash.globalization.NumberParseResult;
      import flash.globalization.LastOperationStatus;
      import flash.globalization.LocaleID;

      public class NumberFormatterParseExample
      {
            public function NumberFormatterParseExample():void
            {
                var nf:NumberFormatter = new NumberFormatter( "en_US" );
                trace("LocaleID requested: " + nf.requestedLocaleIDName 
                    + "; actual: " + nf.actualLocaleIDName);
                trace( "Last Operation Status:" + nf.lastOperationStatus );  

                var inputNumberString:String = "123,567,89,0.254";
                var parseResult:NumberParseResult = nf.parse(inputNumberString);
                if ( nf.lastOperationStatus == LastOperationStatus.NO_ERROR ) {
                    trace("Parsed value:" + parseResult.value);
                }
                inputNumberString = "-123,567,89,0.254";
                var parsedNumber:Number = nf.parseNumber(inputNumberString);
                if ( nf.lastOperationStatus == LastOperationStatus.NO_ERROR ) {
                    trace("Parsed value:" + parsedNumber);
                }
            }
      }
}