| 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 |
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 | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| resourceStringFunction : Function [static]
Function that the getString methods uses to retrieve a user-facing string. | OSMFStrings | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
[static]
Returns the user-facing string for the given key. | OSMFStrings | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | 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):voidMethod 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) |
String |
Mon Nov 28 2011, 06:48 AM -08:00