Overview

API Versioning

Deprecated

dw.util

Class Locale

Object

dw.util.Locale

Represents a Locale supported by the system.

Properties

country  :  String  (Read Only)

The uppercase ISO 3166 2-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.

displayCountry  :  String  (Read Only)

The display name of this Locale's country, in this Locale's language, not in the session locale's language. If no country has been specified for this Locale, this value is an empty string.

displayLanguage  :  String  (Read Only)

The display name of this Locale's language, in this Locale's language, not in the session locale's language. If no country has been specified for this Locale, this value is an empty string.

displayName  :  String  (Read Only)

The display name of this Locale, in this Locale's language, not in the session locale's language. If no display name has been specified for this Locale, this value is an empty string.

ID  :  String  (Read Only)

The String representation of the localeID.

Combines the language and the country key, concatenated with "_". For example: "en_US". This attribute is the primary key of the class.

ISO3Country  :  String  (Read Only)

The uppercase ISO 3166 3-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.

ISO3Language  :  String  (Read Only)

The 3-letter ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.

language  :  String  (Read Only)

The lowercase ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.

Constructor Summary

This class does not have a constructor, so you cannot create it directly.

Method Summary

getCountry() : String

Returns the uppercase ISO 3166 2-letter country/region code for this Locale.

getDisplayCountry() : String

Returns the display name of this Locale's country, in this Locale's language, not in the session locale's language.

getDisplayLanguage() : String

Returns the display name of this Locale's language, in this Locale's language, not in the session locale's language.

getDisplayName() : String

Returns the display name of this Locale, in this Locale's language, not in the session locale's language.

getID() : String

Returns the String representation of the localeID.

getISO3Country() : String

Returns the uppercase ISO 3166 3-letter country/region code for this Locale.

getISO3Language() : String

Returns the 3-letter ISO 639 language code for this Locale.

getLanguage() : String

Returns the lowercase ISO 639 language code for this Locale.

static getLocale(localeId : String) : Locale

Returns a Locale instance for the given localeId, or null if no such Locale could be found.

toString() : String

Returns the String representation of the localeID.

Methods inherited from class Object

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Method Detail

getCountry

getCountry() : String

Returns the uppercase ISO 3166 2-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.

Returns:

the uppercase ISO 3166 2-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.

---

getDisplayCountry

getDisplayCountry() : String

Returns the display name of this Locale's country, in this Locale's language, not in the session locale's language. If no country has been specified for this Locale, this value is an empty string.

Returns:

the display name of this Locale's country, in this Locale's language. If no country has been specified for this Locale, this value is an empty string.

---

getDisplayLanguage

getDisplayLanguage() : String

Returns the display name of this Locale's language, in this Locale's language, not in the session locale's language. If no country has been specified for this Locale, this value is an empty string.

Returns:

the display name of this Locale's language, in this Locale's language. If no language has been specified for this Locale, this value is an empty string.

---

getDisplayName

getDisplayName() : String

Returns the display name of this Locale, in this Locale's language, not in the session locale's language. If no display name has been specified for this Locale, this value is an empty string.

Returns:

the display name of this Locale, in this Locale's language. If no display name has been specified for this Locale, this value is an empty string.

---

getID

getID() : String

Returns the String representation of the localeID.

Combines the language and the country key, concatenated with "_". For example: "en_US". This attribute is the primary key of the class.

Returns:

the String representation of the localeID.

---

getISO3Country

getISO3Country() : String

Returns the uppercase ISO 3166 3-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.

Returns:

the uppercase ISO 3166 3-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.

---

getISO3Language

getISO3Language() : String

Returns the 3-letter ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.

Returns:

the 3-letter ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.

---

getLanguage

getLanguage() : String

Returns the lowercase ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.

Returns:

the lowercase ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.

---

getLocale

static getLocale(localeId : String) : Locale

Returns a Locale instance for the given localeId, or null if no such Locale could be found.

Parameters:

localeId - the localeID of the desired Locale

Returns:

the Locale instance for the given localeId, or null if no such Locale could be found.

---

toString

toString() : String

Returns the String representation of the localeID.

Combines the language and the country key, concatenated with "_". For example: "en_US". This attribute is the primary key of the class.

Returns:

the String representation of the localeID.

---