Package org.opencms.i18n

Classes to handle internalization (i18n) and locale selection in OpenCms.

Since:

6.0.0

See Also:

CmsLocaleManager, I_CmsMessageBundle

Interface Summary

Interface	Description
CmsMultiMessages.I_KeyFallbackHandler	Interface to provide fallback keys to be used when the message for a key is not found.
CmsVfsResourceBundle.I_Loader	Implementors of this interface are responsible for actually loading the data from the VFS.
I_CmsLocaleHandler	A locale handler returns the locale name to use for the given request context.
I_CmsMessageBundle	Utility interface for generating localized messages for internal OpenCms operations.
I_CmsMessageContainer	Interface which represents a message independent of the locale.
I_CmsResourceBundle	Increases the visibility of some key methods of a ResourceBundle.

Class Summary

Class	Description
A_CmsMessageBundle	Convenience base class to access the localized messages of an OpenCms package.
CmsAcceptLanguageHeaderParser	Parses the HTTP Accept-Language header as per section 14.4 of RFC 2068 (HTTP 1.1 header field definitions) and creates a sorted list of Locales from it.
CmsAcceptLanguageHeaderParser.AcceptLanguage	Struct representing an element of the HTTP Accept-Language header.
CmsDefaultLocaleHandler	Default implementation of the locale handler.
CmsEncoder	The OpenCms CmsEncoder class provides static methods to decode and encode data.
CmsI18nInfo	Bundle of i18n setting to be used to setup a new request context.
CmsListResourceBundle	A list based resource bundle that with increased visibility of some key methods.
CmsLocaleComparator	Simple comparator implementation for locales, that compares the String value of the locales.
CmsLocaleGroup	Represents a group of resources which are locale variants of each other.
CmsLocaleGroupService	Helper class for manipulating locale groups.
CmsLocaleManager	Manages the locales configured for this OpenCms installation.
CmsMessageContainer	Contains a localized message key, it's arguments and a I_CmsMessageBundle.
CmsMessages	Reads localized resource Strings from a java.util.ResourceBundle and provides convenience methods to access the Strings from a template.
CmsMessageToBundleIndex	A lookup table used to find out which VFS based message bundles (XML/property bundles) contain a given key.
CmsMultiMessages	Provides access to the localized messages for several resource bundles simultaneously.
CmsPropertyResourceBundle	A property based resource bundle with increased visibility of some key methods.
CmsRemoveInnerNameFallback	Message key fallback handler used to enable reuse of localization keys for editor labels.
CmsReplaceMessageKeyPrefix	Message key fallback handler which replaces a given set of prefixes with alternative prefixes.
CmsResourceBundleLoader	Resource bundle loader for property based resource bundles from OpenCms that has a flushable cache.
CmsSingleTreeLocaleHandler	Advanced locale handler allowing single tree localization.
CmsVfsBundleLoaderProperties	Loads message bundles from .properties files in the VFS.
CmsVfsBundleManager	Manages message bundles loaded from the VFS.
CmsVfsBundleManager.NameAndLocale	Data holder for a base name and locale of a message bundle.
CmsVfsBundleParameters	Data class containing the parameters for a VFS-based resource bundle.
CmsVfsResourceBundle	Resource bundle which loads its data from a VFS resource.
Messages	Convenience class to access the localized messages of this OpenCms package.

Enum Summary

Enum	Description
CmsLocaleGroupService.Status	Enum representing whether two resources can be linked together in a locale group.

Exception Summary

Exception	Description
CmsMessageException	Used to signal issues with the localization support, for example during localized messages access.