FormatMessage - Adobe ActionScript® 3 (AS3 ADEP Client-Komponente) API-Referenz

Paket	com.adobe.gravity.utility.message
Klasse	public class FormatMessage
Vererbung	FormatMessage Object

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Client-Komponenten-Framework 10

Laufzeitversionen:

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).

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		constructor : Object Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	Object

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		formatString(message:String, parameters:Object):String [statisch] Given a message string, perform parameter substitution on it.	FormatMessage
		hasOwnProperty(name:String):Boolean Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.	Object
		isPrototypeOf(theClass:Object):Boolean Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.	Object
		propertyIsEnumerable(name:String):Boolean Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.	Object
		toLocaleString():String Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.	Object
		toString():String Gibt das angegebene Objekt als String zurück.	Object
		valueOf():Object Gibt den Grundwert des angegebenen Objekts zurück.	Object

Methodendetails

formatString

()

Methode

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

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Client-Komponenten-Framework 10

Laufzeitversionen:

AIR 1.1, Flash Player 9

Given a message string, perform parameter substitution on it.

Parameter

	`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).

Rückgabewerte

String — The message string with any parameter substitution performed.

Rechtliche Hinweise | Onlinedatenschutzerklärung

FormatMessage - AS3 ADEP Client-Komponente

Klassen x

formatString