| window.runtime property | window.runtime.flash.globalization.LocaleID |
| Inheritance | LocaleID  Object |
| Runtime Versions: | 2 |
Hide Inherited Public Properties
Show Inherited Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| lastOperationStatus : String [read-only]
The status of the most recent operation that this LocaleID object performed. | LocaleID | ||
| name : String [read-only]
Returns a slightly more "canonical" locale identifier. | LocaleID | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| Method | Defined By | ||
|---|---|---|---|
LocaleID(name:String)
Constructs a new LocaleID object, given a locale name. | LocaleID | ||
determinePreferredLocales(want:Vector.<String>, have:Vector.<String>, keyword:String = "userinterface"):Vector.<String> [static]
Returns a list of acceptable locales based on a list of desired locales and a list of the locales that are currently available. | LocaleID | ||
getKeysAndValues():Object
Returns an object containing all of the key and value pairs from the LocaleID object. | LocaleID | ||
getLanguage():String
Returns the language code specified by the locale ID name. | LocaleID | ||
getRegion():String
Returns the region code specified by the locale ID name. | LocaleID | ||
getScript():String
Returns the script code specified by the locale ID name. | LocaleID | ||
getVariant():String
Returns the language variant code specified by the locale ID name. | LocaleID | ||
| 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 | |
isRightToLeft():Boolean
Specifies whtehr the text direction for the specified locale is right to left. | LocaleID | ||
| 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 | |
| Constant | Defined By | ||
|---|---|---|---|
| DEFAULT : String = "i-default" [static]
Indicates that the user's default linguistic preferences should be used, as specified in the user's operating system settings. | LocaleID | ||
lastOperationStatus | property |
lastOperationStatus:String [read-only] | Runtime Versions: | 2 |
The status of the most recent operation that this LocaleID object performed.
The lastOperationStatus property is set whenever the constructor or a method of
this class is called or another property is set. For the possible values see the description for each method.
See also
name | property |
name:String [read-only] | Runtime Versions: | 2 |
Returns a slightly more "canonical" locale identifier.
This method performs the following conversion to the locale ID name to give it a more canonical form.
- Proper casing is applied to all of the components.
- Underscores are converted to dashes.
No additional processing is performed. For example, aliases are not replaced, and no elements are added or removed.
When this method is called and it completes successfully, the lastOperationStatus property is set to:
LastOperationStatus.NO_ERROR
Otherwise the lastOperationStatus property is set to one of the constants defined in the
LastOperationStatus class.
LocaleID | () | Constructor |
public function LocaleID(name:String)| Runtime Versions: | 2 |
Constructs a new LocaleID object, given a locale name. The locale name must conform to the syntax defined by the Unicode Technical Standard #35 (http://unicode.org/reports/tr35/).
When the constructor completes successfully the lastOperationStatus property is set to:
LastOperationStatus.NO_ERROR
When the requested locale ID name is not available then the lastOperationStatus
is set to one of the following:
LastOperationStatus.USING_FALLBACK_WARNINGLastOperationStatus.USING_DEFAULT_WARNING
Otherwise the lastOperationStatus property is set to one of the constants defined in
the LastOperationStatus class.
For details on the warnings listed above and other possible values of the lastOperationStatus property
see the descriptions in the LastOperationStatus class.
name:String — A locale ID name, which can also include an optional collation string.
For example: "en-US" or "de-DE@collation=phonebook"
|
Throws
ArgumentError — if the name is null.
|
See also
determinePreferredLocales | () | method |
public function determinePreferredLocales(want:Vector.<String>, have:Vector.<String>, keyword:String = "userinterface"):Vector.<String>| Runtime Versions: | 2 |
Returns a list of acceptable locales based on a list of desired locales and a list of the locales that are currently available.
The resulting list is sorted according in order of preference.
Here is a typical use case for this method:
- A user specifies a list of languages that she understands (stored in a user profile, a browser setting, or a cookie). The user lists the languages that she understands best first, so the order of the languages in the list is relevant. This list is the "want" list.
- The application is localized into a number of different languages. This list is the "have" list.
- The
determinePreferredLocales()method returns an intersection of the two lists, sorted so that the user's preferred languages come first.
If this feature is not supported on the current operating system, this method returns a null value.
When this method is called and it completes successfully, the lastOperationStatus property is set to:
LastOperationStatus.NO_ERROR
Otherwise the lastOperationStatus property is set to one of the constants defined in the
LastOperationStatus class.
Parameters
want:Vector.<String> — A list of the user's preferred locales sorted in order of preference.
| |
have:Vector.<String> — A list of locales available to the application. The order of this list is not important.
| |
keyword:String (default = "userinterface") |
Vector.<String> — A subset of the available locales, sorted according to the user's preferences.
|
See also
getKeysAndValues | () | method |
public function getKeysAndValues():Object| Runtime Versions: | 2 |
Returns an object containing all of the key and value pairs from the LocaleID object.
The returned object is structured as a hash table or associative array, where each property name represents a key
and the value of the property is value for that key. For example, the following code lists all of the keys and values
obtained from the LocaleID object using the getKeysAndValues() method:
var myLocale:LocaleID = new LocaleID("fr-CA");
var localeData:Object = myLocale.getKeysAndValues();
for (var propertyName:String in localeData)
{
trace(propertyName + " = " + localeData[propertyName]);
}
When this method is called and it completes successfully, the lastOperationStatus property is set to:
LastOperationStatus.NO_ERROR
Otherwise the lastOperationStatus property is set to one of the constants defined in the
LastOperationStatus class.
Object — An Object containing all the keys and values in the LocaleID object, structured as an associative array or hashtable.
|
See also
getLanguage | () | method |
public function getLanguage():String| Runtime Versions: | 2 |
Returns the language code specified by the locale ID name.
If the locale name cannot be properly parsed then the language code is the same as the full locale name.
When this method is called and it completes successfully, the lastOperationStatus property is set to:
LastOperationStatus.NO_ERROR
Otherwise the lastOperationStatus property is set to one of the constants defined in the
LastOperationStatus class.
String — A two-character language code obtained by parsing the locale ID name.
|
See also
getRegion | () | method |
public function getRegion():String| Runtime Versions: | 2 |
Returns the region code specified by the locale ID name.
This method returns an empty string if the region code cannot be parsed or guessed This could occur if an unknown or incomplete locale ID name like "xy" is used. The region code is not validated against a fixed list. For example, the region code returned for a locale ID name of "xx-YY" is "YY".
When this method is called and it completes successfully, the lastOperationStatus property is set to:
LastOperationStatus.NO_ERROR
If the region is not part of the specified locale name, the most likely region code for the locale is "guessed" and
lastOperationStatus property is set to LastOperationStatus.USING_FALLBACK_WARNING
Otherwise the lastOperationStatus property is set to one of the constants defined in the
LastOperationStatus class.
String — A two-character region code, or an empty string if the region code cannot be parsed or otherwise
determined from the locale name.
|
See also
getScript | () | method |
public function getScript():String| Runtime Versions: | 2 |
Returns the script code specified by the locale ID name.
This method returns an empty string if the script code cannot be parsed or guessed This could occur if an unknown or incomplete locale ID name like "xy" is used. The script code is not validated against a fixed list. For example, the script code returned for a locale ID name of "xx-Abcd-YY" is "Abcd".
The region, as well as the language, can also affect the return value. For example, the script code for "mn-MN" (Mongolian-Mongolia) is "Cyrl" (Cyrillic), while the script code for "mn-CN" (Mongolian-China) is "Mong" (Mongolian).
When this method is called and it completes successfully, the lastOperationStatus property is set to:
LastOperationStatus.NO_ERROR
If the script code is not part of the specified locale name, the most likely script code is "guessed" and
lastOperationStatus property is set to LastOperationStatus.USING_FALLBACK_WARNING.
Otherwise the lastOperationStatus property is set to one of the constants defined in the
LastOperationStatus class.
String — A four-character script code, or an empty string if the script code cannot be parsed or otherwise
determined from the locale name.
|
See also
getVariant | () | method |
public function getVariant():String| Runtime Versions: | 2 |
Returns the language variant code specified by the locale ID name.
This method returns an empty string if there is no language variant code in the given locale ID name. (No guessing is necessary because few locales have or need a language variant.)
When this method is called and it completes successfully, the lastOperationStatus property is set to:
LastOperationStatus.NO_ERROR
Otherwise the lastOperationStatus property is set to one of the constants defined in the
LastOperationStatus class.
String — A language variant code, or an empty string if the locale ID name does not contain a language variant code.
|
See also
isRightToLeft | () | method |
public function isRightToLeft():Boolean| Runtime Versions: | 2 |
Specifies whtehr the text direction for the specified locale is right to left.
The result can be used to determine the direction of the text in the Flash text engine, and to decide whether to mirror the user interface to support the current text direction.
When this method is called and it completes successfully, the lastOperationStatus property is set to:
LastOperationStatus.NO_ERROR
Otherwise the lastOperationStatus property is set to one of the constants defined in the
LastOperationStatus class.
Boolean — true if the general text flows in a line of text should go from right to left; otherwise false;
|
See also
DEFAULT | Constant |
public static const DEFAULT:String = "i-default"| Runtime Versions: | 2 |
Indicates that the user's default linguistic preferences should be used, as specified in the user's operating system settings. For example, such preferences are typically set using the "Control Panel" for Windows, or the "System Preferences" in Mac OS X.
Using the LocaleID.DEFAULT setting can result in the use of a different locale ID name for different
kinds of operations. For example, one locale could be used for sorting and a different one for formatting.
This flexibility respects the user preferences, and the class behaves this way by design.
This locale identifier is not always the most appropriate one to use. For applications running in the browser, the browser's preferred locale could be a better choice. It is often a good idea to let the user alter the preferred locale ID name setting and preserve that preference in a user profile, cookie, or shared object.
Thu Sep 29 2011, 02:34 AM -07:00