FormatMessage - Adobe ActionScript® 3（AS3 ADEP Client Component）API リファレンス

パッケージ	com.adobe.gravity.utility.message
クラス	public class FormatMessage
継承	FormatMessage Object

言語バージョン:

ActionScript 3.0

製品バージョン:

Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

ランタイムバージョン:

AIR 1.1, Flash Player 9

FormatMessage is a utility class for formatting messages requiring runtime parameters. Parameters substitution locations are indicated by the parameter name surrounded by braces. For example, a parameterized error message might be

Error {errorId}: The file {filename} could not be read.

When the error occurs, the message could be prepared for display with the following code:

     var template:String = "Error {errorId}:  The file {filename} could not be read.";
     var params:Object = new Object();
     params.errorId = 42;
     params.filename = "/Users/alice/vacation.jpg";
     var message:String = FormatMessage.formatString(template, params);
     // message="Error 42:  The file /Users/alice/vacation.jpg could not be read."

The ActionScript object literal syntax is a convenient way to construct the parameter object. The following is functionally equivalent to the code above:

     var template:String = "Error {errorId}:  The file {filename} could not be read.";
     var params:Object =
             {
                 errorId:  42,
                 filename: "/Users/alice/vacation.jpg"
             };
     var message:String = FormatMessage.formatString(template, params);
     // message="Error 42:  The file /Users/alice/vacation.jpg could not be read."

Note that traditional numeric parameters are supported by simply using an Array as the parameter object:

     var template:String = "Error {0}:  The file {1} could not be read.";
     var params:Array =
             [
                 42,
                 "/Users/alice/vacation.jpg"
             ];
     var message:String = FormatMessage.formatString(template, params);
     // message="Error 42:  The file /Users/alice/vacation.jpg could not be read."

Note that for missing parameters, the empty string will be used:

     var template:String = "Error {errorId}:  The file {filename} could not be read.";
     var params:Object =
             {
                 errorId:  42,
             };
     var message:String = FormatMessage.formatString(template, params);
     // message="Error 42:  The file  could not be read."

Note that parameters are substituted verbatim, no parameter replacement or brace processing is performed on the parameters themselves:

     var template:String = "{one}{two}{three}{four}{five}";
     var params:Object =
             {
                 one: "{five}",
                 two: "{four}",
                 three: "{three}",
                 four: "{two}",
                 five: "{one}"
             };
     var message:String = FormatMessage.formatString(template, params);
     // message="{five}{four}{three}{two}{one}"

To escape an opening brace, double the initial brace:

     var template:String = "The {{filename} parameter is {filename}.";
     var message:String = FormatMessage.formatString(template, {filename: "/Users/alice/vacation.jpg"});
     // message="The {filename} parameter is /Users/alice/vacation.jpg."

Best practice: It can be useful to use formatString on all strings, parameterized or not, to ensure that escaping rules are consistent between parameterized and non-parameterized strings (since strings that were unparameterized may become parameterized and vice-versa).

パブリックプロパティ

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

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

	プロパティ		定義元
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object

パブリックメソッド

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

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

	メソッド		定義元
		formatString(message:String, parameters:Object):String [静的] Given a message string, perform parameter substitution on it.	FormatMessage
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object

メソッドの詳細

formatString

()

メソッド

public static function formatString(message:String, parameters:Object):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

ランタイムバージョン:

AIR 1.1, Flash Player 9

Given a message string, perform parameter substitution on it.

パラメーター

	`message:String` — The parameterized message string. Must not be null.

	`parameters:Object` — An object with a property for each parameter that is to be substituted into the message. May be null (which means there are no parameters to be substituted).

戻り値

String — The message string with any parameter substitution performed.

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

FormatMessage - AS3 ADEP Client Component

クラス x

formatString