com.comtrade.ecm.engine.i18n

Interface TextManager

All Superinterfaces:

EcmService

All Known Implementing Classes:

TextManagerDefault, TextManagerEngine

public interface TextManager
extends EcmService

An object that defines an API for localization process' manager.

Method Summary

Modifier and Type	Method and Description
void	addListener(TextManagerListener listener) Sets a listener TextManagerListener to TextManager-object
java.lang.String	getString(java.lang.String key, java.util.Locale locale)
java.lang.String	getString(java.lang.String bundleFamily, java.lang.String key, java.util.Locale locale)
void	registerBundle(java.lang.String bundleFamilyName) Registers new bundle-family identified by its filename. Registered/added bundle-family will be used in the process of localization.
void	registerClassBundle(java.lang.Class<?> bundleFamilyClass) Registers new bundle-family class. Registered/added bundle-family will be used in the process of localization.
void	removeListener(TextManagerListener listener) Removes a listener TextManagerListener from TextManager-object
void	setForceToLatin(boolean forceToLatin) Instructs TextManager to force (or not to force) conversion to latin alphabet
void	unregisterBundle(java.lang.String bundleFamilyName) Removes bundle-family from process of localization
void	unregisterClassBundle(java.lang.Class<?> bundleFamilyClass) Removes bundle-family from process of localization

Method Detail

getString

java.lang.String getString(java.lang.String bundleFamily,
                           java.lang.String key,
                           java.util.Locale locale)

Parameters:

bundleFamily - ResourceBundle which should be primarily used for localization

key - Localization key

locale - Locale to be used for localization

Returns:

Localized key

getString

java.lang.String getString(java.lang.String key,
                           java.util.Locale locale)

Parameters:

key - Localization key

locale - Locale to be used for localization

Returns:

Localized key

addListener

void addListener(TextManagerListener listener)

Sets a listener TextManagerListener to TextManager-object

Parameters:

listener - TextManagerListener to be set

removeListener

void removeListener(TextManagerListener listener)

Removes a listener TextManagerListener from TextManager-object

Parameters:

listener - TextManagerListener to be removed

registerBundle

void registerBundle(java.lang.String bundleFamilyName)

Registers new bundle-family identified by its filename.
Registered/added bundle-family will be used in the process of localization.

Parameters:

bundleFamilyName - Filename of a bundle-family to be registered

unregisterBundle

void unregisterBundle(java.lang.String bundleFamilyName)

Removes bundle-family from process of localization

Parameters:

bundleFamilyName - Filename of a bundle-family to be removed

registerClassBundle

void registerClassBundle(java.lang.Class<?> bundleFamilyClass)

Registers new bundle-family class.
Registered/added bundle-family will be used in the process of localization.

Parameters:

bundleFamilyClass - Class of a bundle-family to be registered

unregisterClassBundle

void unregisterClassBundle(java.lang.Class<?> bundleFamilyClass)

Removes bundle-family from process of localization

Parameters:

bundleFamilyClass - Class of a bundle-family to be removed

setForceToLatin

void setForceToLatin(boolean forceToLatin)

Instructs TextManager to force (or not to force) conversion to latin alphabet

Parameters:

forceToLatin - Whether we should force transformation to latin characters