com.hybris.cockpitng.i18n.impl

Class DefaultCockpitLocaleService

java.lang.Object

com.hybris.cockpitng.i18n.impl.DefaultCockpitLocaleService

All Implemented Interfaces:

Resettable, CockpitLocaleService

public class DefaultCockpitLocaleService
extends Object
implements CockpitLocaleService, Resettable

Default implementation of CockpitLocaleService. Session locale are based on ZK Locale handling. Data Locale are stored per principal in cockpit-configuration : 'available-locales'.

Constructor Summary

Constructors

Constructor and Description
DefaultCockpitLocaleService()

Method Summary

Modifier and Type	Method and Description
protected ConfigContext	buildContext(String principal, boolean addGroupDimension)
<T> T	executeWithLocale(AbstractExecutionBody<T> executionBody, Locale locale) Using this method you can execute code in a context of a different locale than the current one
protected List<CockpitLocale>	getAllCockpitLocales(String principal) Override, if your system has additional language management.
List<Locale>	getAllLocales() Returns a list of all available locales.
protected List<CockpitLocale>	getAvailableCockpitLocales(String principal)
List<Locale>	getAvailableDataLocales(String principal) Returns a collection of available data locales (both enabled and disabled) for specified principal.
protected CockpitConfigurationService	getCockpitConfigurationService()
protected CockpitLocalesFactory	getCockpitLocalesFactory()
protected CockpitProperties	getCockpitProperties()
Locale	getCurrentLocale() Returns the currently active locale.
Locale	getDefaultDataLocale(String principal) Returns the default data locale for specified principal.
List<Locale>	getEnabledDataLocales(String principal) Returns a collection of enabled locales for specified principal.
protected org.zkoss.zk.ui.Session	getZKSession() Deprecated. since 6.7 please us lookupZkSession()
boolean	isDataLocaleEnabled(Locale locale, String principal) Checks if the given data locale is an active data locale for the given user.
protected Optional<org.zkoss.zk.ui.Session>	lookupZkSession()
void	reset() Resets the something the implementation provides.
protected void	saveLocales(Collection<CockpitLocale> cockpitLocale, String principal)
void	setAuthorityGroupService(AuthorityGroupService authorityGroupService)
void	setCockpitConfigurationService(CockpitConfigurationService cockpitConfigurationService)
void	setCockpitLocalesFactory(CockpitLocalesFactory cockpitLocalesFactory)
void	setCockpitProperties(CockpitProperties cockpitProperties)
void	setCurrentLocale(Locale locale) Changes the current locale to the given one.
void	setWidgetConfigurationContextDecoratorList(List<WidgetConfigurationContextDecorator> configContextDecoratorList)
void	toggleDataLocale(Locale locale, String principal) Toggles the specified data locale.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCockpitLocaleService

public DefaultCockpitLocaleService()

Method Detail

getCurrentLocale

public Locale getCurrentLocale()

Description copied from interface: CockpitLocaleService

Returns the currently active locale. You normally do not need to call this. All localized widget labels are automatically rendered using the current locale.

Specified by:

getCurrentLocale in interface CockpitLocaleService

Returns:

currently active locale

setCurrentLocale

public void setCurrentLocale(Locale locale)

Description copied from interface: CockpitLocaleService

Changes the current locale to the given one. After calling this you need to refresh the cockpit application (unless this is called before the application was rendered, e.g. shortly after login). You can use Executions.sendRedirect(String) with null as a parameter to re-render the application.

Specified by:

setCurrentLocale in interface CockpitLocaleService

Parameters:

locale - the locale to be set as the current one

executeWithLocale

public <T> T executeWithLocale(AbstractExecutionBody<T> executionBody,
                               Locale locale)

Description copied from interface: CockpitLocaleService

Using this method you can execute code in a context of a different locale than the current one

Specified by:

executeWithLocale in interface CockpitLocaleService

Parameters:

executionBody - the execution body

locale - the locale

Returns:

the result of the execution body call or null if execution is without result

getZKSession

@Deprecated
protected org.zkoss.zk.ui.Session getZKSession()

Deprecated. since 6.7 please us lookupZkSession()

lookupZkSession

protected Optional<org.zkoss.zk.ui.Session> lookupZkSession()

getAllLocales

public List<Locale> getAllLocales()

Description copied from interface: CockpitLocaleService

Returns a list of all available locales.

Specified by:

getAllLocales in interface CockpitLocaleService

Returns:

currently active locale

getAvailableDataLocales

public List<Locale> getAvailableDataLocales(String principal)

Description copied from interface: CockpitLocaleService

Returns a collection of available data locales (both enabled and disabled) for specified principal.

An exception of type AvailableLocaleException is thrown when an attempt to load the cockpit locales failed.

Specified by:

getAvailableDataLocales in interface CockpitLocaleService

Parameters:

principal - needed to filter available cockpit locales

Returns:

collection of available locales

toggleDataLocale

public void toggleDataLocale(Locale locale,
                             String principal)

Description copied from interface: CockpitLocaleService

Toggles the specified data locale. Does nothing if the locale does not exist. Toggling data locale would enable or disable it for localized editors.

Specified by:

toggleDataLocale in interface CockpitLocaleService

Parameters:

locale - to toggle

principal - needed to filter available cockpit locales

getEnabledDataLocales

public List<Locale> getEnabledDataLocales(String principal)

Description copied from interface: CockpitLocaleService

Returns a collection of enabled locales for specified principal. Only enabled locales are used to render localized attributes. By disabling locale you can reduce the visible localized data.

An exception of type AvailableLocaleException is thrown when an attempt to load the cockpit locales failed.

Specified by:

getEnabledDataLocales in interface CockpitLocaleService

Parameters:

principal - needed to filter available cockpit locales

Returns:

collection of enabled locales

getDefaultDataLocale

public Locale getDefaultDataLocale(String principal)

Description copied from interface: CockpitLocaleService

Returns the default data locale for specified principal. A collapsed localized editor would only show the data using the default data locale.

An exception of type AvailableLocaleException is thrown when an attempt to load the cockpit locales failed.

Specified by:

getDefaultDataLocale in interface CockpitLocaleService

Parameters:

principal - needed to filter available cockpit locales

Returns:

Locale

isDataLocaleEnabled

public boolean isDataLocaleEnabled(Locale locale,
                                   String principal)

Description copied from interface: CockpitLocaleService

Checks if the given data locale is an active data locale for the given user.

Specified by:

isDataLocaleEnabled in interface CockpitLocaleService

Parameters:

locale - to check

principal - needed to filter available cockpit locales

Returns:

true if data locale is enabled.

saveLocales

protected void saveLocales(Collection<CockpitLocale> cockpitLocale,
                           String principal)

buildContext

protected ConfigContext buildContext(String principal,
                                     boolean addGroupDimension)

getAvailableCockpitLocales

protected List<CockpitLocale> getAvailableCockpitLocales(String principal)

getAllCockpitLocales

protected List<CockpitLocale> getAllCockpitLocales(String principal)

Override, if your system has additional language management.

Parameters:

principal - user that can be used to restrict the list of available languages. Can be null.

getCockpitProperties

protected CockpitProperties getCockpitProperties()

setCockpitProperties

public void setCockpitProperties(CockpitProperties cockpitProperties)

getCockpitConfigurationService

protected CockpitConfigurationService getCockpitConfigurationService()

setCockpitConfigurationService

public void setCockpitConfigurationService(CockpitConfigurationService cockpitConfigurationService)

getCockpitLocalesFactory

protected CockpitLocalesFactory getCockpitLocalesFactory()

setCockpitLocalesFactory

public void setCockpitLocalesFactory(CockpitLocalesFactory cockpitLocalesFactory)

reset

public void reset()

Description copied from interface: Resettable

Resets the something the implementation provides.

Specified by:

reset in interface Resettable

setWidgetConfigurationContextDecoratorList

public void setWidgetConfigurationContextDecoratorList(List<WidgetConfigurationContextDecorator> configContextDecoratorList)

setAuthorityGroupService

public void setAuthorityGroupService(AuthorityGroupService authorityGroupService)