Consultingwerk.SmartFramework.System.TranslationProvider

Namespace:

Consultingwerk.SmartFramework.System

Class

TranslationProvider

Parent classes:

Progress.Lang.Object

Consultingwerk.SmartFramework.System.TranslationProvider

Inherits:

Progress.Lang.Object

Implements:

Consultingwerk.SmartFramework.ITranslationProvider

File:	TranslationProvider
Purpose:	Default ITranslationProvider implementation that returns
	translations for strings based on an optional scope,
	the original string or a key value
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Thu Jan 10 23:09:45 CET 2013
Notes:	The TranslationProvider is primarily intended to be used from
	client side code. It can also be used on the AppServer,
	however in those cases the caching (by the current language)
	of translation records that are disposed when the language
	changes may cause some overhead
	The static property "UseEmptyScopeAsFallback" controls if the
	translation provider uses the empty scope as a fallback when
	fetching translations with a scope. This allows to use the
	scope to identify a screen and use the empty scope for generic
	translations

Options	Name	Purpose
+	CacheAllTranslations ()	Caches all translations for the current language
+	CacheTranslationsByScope (character)	Caches all translations by a given scope
+	CHARACTER GetTranslationByKey (character, character)	Returns a translation based on a key value and an optional scope
+	CHARACTER GetTranslationByKey (character, character, character)	Returns a translation based on a key value and an optional scope
+	CHARACTER GetTranslationByString (character, character)	Returns a translation for a string value and an optional scope
-	LanguageKeyChangedHandler ()	Event handler for the LanguageKeyChanged handler of the SessionManager

Options

Name

Purpose

CacheAllTranslations ()

Caches all translations for the current language

CacheTranslationsByScope (character)

Caches all translations by a given scope

CHARACTER GetTranslationByKey (character, character)

Returns a translation based on a key value and an optional scope

CHARACTER GetTranslationByKey (character, character, character)

Returns a translation based on a key value and an optional scope

CHARACTER GetTranslationByString (character, character)

Returns a translation for a string value and an optional scope

LanguageKeyChangedHandler ()

Event handler for the LanguageKeyChanged handler of the SessionManager

	Options	Name	Purpose
	+	TranslationProvider ()	Constructor for the TranslationProvider class

Options

Name

Purpose

TranslationProvider ()

Constructor for the TranslationProvider class

	Options	Name	Purpose
	+	LOGICAL AllTranslationsCached
	+	LOGICAL DontFetchTranslationsWhenAllTranslationsCached
	+	LOGICAL KeepTranslationCacheOnLanguageChange
	+	LOGICAL UseEmptyScopeAsFallback

Options

Name

Purpose

LOGICAL AllTranslationsCached

LOGICAL DontFetchTranslationsWhenAllTranslationsCached

LOGICAL KeepTranslationCacheOnLanguageChange

LOGICAL UseEmptyScopeAsFallback

PUBLIC CacheAllTranslations ()

PUBLIC CacheTranslationsByScope (character)

PUBLIC CHARACTER GetTranslationByKey (character, character)

PUBLIC CHARACTER GetTranslationByKey (character, character, character)

PUBLIC CHARACTER GetTranslationByString (character, character)

PRIVATE LanguageKeyChangedHandler ()

PUBLIC TranslationProvider ()

PUBLIC LOGICAL AllTranslationsCached

PUBLIC LOGICAL DontFetchTranslationsWhenAllTranslationsCached

PUBLIC LOGICAL KeepTranslationCacheOnLanguageChange

PUBLIC LOGICAL UseEmptyScopeAsFallback