Package com.google.gwt.i18n.shared
Interface GwtLocale
- All Superinterfaces:
Comparable<GwtLocale>
- All Known Implementing Classes:
GwtLocaleImpl
Class representing GWT locales and conversion to/from other formats.
These locales correspond to BCP47.
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
The default comparison is a lexical ordering.Returns the list of aliases for this locale.Returns the locale as a fixed-format string suitable for use in searching for localized resources.Returns this locale in canonical form.Returns the complete list of locales to search for the current locale.Returns a list of locales to search for, in order of preference.Returns the language portion of the locale, or null if none.Returns the language portion of the locale, or the empty string if none.Returns the region portion of the locale, or null if none.Returns the region portion of the locale, or the empty string if none.Returns the script portion of the locale, or null if none.Returns the script portion of the locale, or the empty string if none.Returns the variant portion of the locale, or null if none.Returns the variant portion of the locale, or the empty string if none.boolean
inheritsFrom
(GwtLocale parent) Returns true if this locale inherits from the specified locale.boolean
Returns true if this is the default or root locale.toString()
Returns a human readable string -- "default" or the same as getAsString().boolean
usesSameScript
(GwtLocale other) Checks if this locale uses the same script as another locale.
-
Field Details
-
DEFAULT_LOCALE
- See Also:
-
-
Method Details
-
getAliases
Returns the list of aliases for this locale. The canonical form of the current locale is always first on the list. Language/region codes have changed over time, so some systems continue to use the older codes. Aliases allow GWT to use the official Unicode CLDR locales while still interoperating with such systems.- Returns:
- alias list
-
getAsString
String getAsString()Returns the locale as a fixed-format string suitable for use in searching for localized resources. The format is language_Script_REGION_VARIANT, where language is a 2-8 letter code (possibly with 3-letter extensions), script is a 4-letter code with an initial capital letter, region is a 2-character country code or a 3-digit region code, and variant is a 5-8 character (may be 4 if the first character is numeric) code. If a component is missing, its preceding _ is also omitted. If this is the default locale, the empty string will be returned.- Returns:
- String representing locale
-
getCanonicalForm
GwtLocale getCanonicalForm()Returns this locale in canonical form.- Deprecated language/region tags are replaced with official versions
- Default scripts are removed (including region-specific defaults for Chinese)
- no/nb/nn are normalized
- Default region for zh_Hans and zh_Hant if none specified
- Returns:
- GwtLocale instance
-
getCompleteSearchList
Returns the complete list of locales to search for the current locale. This list will always start with the canonical form of this locale, and end with "default", and include all appropriate aliases along the way.- Returns:
- search list
-
getInheritanceChain
Returns a list of locales to search for, in order of preference. The current locale is always first on the list. Aliases are not included in the list -- usegetAliases()
to expand those.- Returns:
- inheritance list
-
getLanguage
String getLanguage()Returns the language portion of the locale, or null if none. -
getLanguageNotNull
String getLanguageNotNull()Returns the language portion of the locale, or the empty string if none. -
getRegion
String getRegion()Returns the region portion of the locale, or null if none. -
getRegionNotNull
String getRegionNotNull()Returns the region portion of the locale, or the empty string if none. -
getScript
String getScript()Returns the script portion of the locale, or null if none. -
getScriptNotNull
String getScriptNotNull()Returns the script portion of the locale, or the empty string if none. -
getVariant
String getVariant()Returns the variant portion of the locale, or null if none. -
getVariantNotNull
String getVariantNotNull()Returns the variant portion of the locale, or the empty string if none. -
isDefault
boolean isDefault()Returns true if this is the default or root locale. -
toString
String toString()Returns a human readable string -- "default" or the same as getAsString().