Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
Locale

Package | mx.resources
Class | public class Locale
Inheritance | Locale Object

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The Locale class can be used to parse a locale String such as `"en_US_MAC"` into its three parts: a language code, a country code, and a variant.

The localization APIs in the IResourceManager and IResourceBundle interfaces use locale Strings rather than Locale instances, so this class is seldom used in an application.

See also

mx.resources.IResourceBundle
mx.resources.IResourceManager

Public Properties

| Property | Defined By
--- | --- | ---
|  | country : String [read-only] The country code of this Locale instance. | Locale
|  | language : String [read-only] The language code of this Locale instance. | Locale
|  | variant : String [read-only] The variant part of this Locale instance. | Locale

Public Methods

| Method | Defined By
--- | --- | ---
|  | Locale(localeString:String) Constructor. | Locale
|  | toString():String Returns the locale String that was used to construct this Locale instance. | Locale

Property Detail

country | property

`country:String` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The country code of this Locale instance. [Read-Only]

          var locale:Locale = new Locale("en_US_MAC");
          trace(locale.country); // outputs "US"

Implementation
`public function get country():String`

language | property |

`language:String` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The language code of this Locale instance. [Read-Only]

          var locale:Locale = new Locale("en_US_MAC");
          trace(locale.language); // outputs "en"

Implementation
`public function get language():String`

variant | property |

`variant:String` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The variant part of this Locale instance. [Read-Only]

          var locale:Locale = new Locale("en_US_MAC");
          trace(locale.variant); // outputs "MAC"

Implementation
`public function get variant():String`
Constructor Detail

Locale | () | Constructor

`public function Locale(localeString:String)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `localeString:String` — A 1-, 2-, or 3-part locale String, such as `"en"`, `"en_US"`, or `"en_US_MAC"`. The parts are separated by underscore characters. The first part is a two-letter lowercase language code as defined by ISO-639, such as `"en"` for English. The second part is a two-letter uppercase country code as defined by ISO-3166, such as `"US"` for the United States. The third part is a variant String, which can be used to optionally distinguish multiple locales for the same language and country. It is sometimes used to indicate the operating system that the locale should be used with, such as `"MAC"`, `"WIN"`, or `"UNIX"`.

Method Detail

toString | () | method

`public function toString():String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns the locale String that was used to construct this Locale instance. For example:

          var locale:Locale = new Locale("en_US_MAC");
          trace(locale.toString()); // outputs "en_US_MAC"

Returns

| `String` — Returns the locale String that was used to construct this Locale instance.

Sun Mar 5 2017, 03:42 PM +11:00