OSMFStrings - Adobe ActionScript® 3 (AS3 OSMF) API Reference

Package	org.osmf.utils
Class	public class OSMFStrings
Inheritance	OSMFStrings Object

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Utility class that exposes all user-facing strings.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		resourceStringFunction : Function [static] Function that the getString methods uses to retrieve a user-facing string.	OSMFStrings

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		getString(key:String, params:Array = null):String [static] Returns the user-facing string for the given key.	OSMFStrings
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

resourceStringFunction

property

resourceStringFunction:Function

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Function that the getString methods uses to retrieve a user-facing string.

This function takes a String parameter (which is expected to be one of the static consts on this class) and an optional Array of parameters which can be substituted into the String (formatted as {0}, {1}, etc.).

Clients can supply their own getString function to localize the strings. By default, the getString function returns an English-language String.

Implementation
public static function get resourceStringFunction():Function
public static function set resourceStringFunction(value:Function):void

Method Detail

getString

()

method

public static function getString(key:String, params:Array = null):String

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Returns the user-facing string for the given key. All possible keys are defined as static constants on this class. The parameters are optional substitution variables, formatted as {0}, {1}, etc.

Parameters

	`key:String`

	`params:Array` (default = `null`)

Returns

String

OSMFStrings - AS3 OSMF

Classes x

resourceStringFunction

getString

org.osmf.utils OSMFStrings - AS3 OSMF		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples