Package org.ametys.cms.clientsideelement

Class LanguageMenu

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.core.ui.SimpleMenu

org.ametys.cms.clientsideelement.LanguageMenu

All Implemented Interfaces:

ClientSideElement, MenuClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

LanguageMenu

public class LanguageMenu
extends SimpleMenu

Menu that lists the available languages for ODF contents

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.core.ui.SimpleMenu

SimpleMenu.GalleryGroup, SimpleMenu.GalleryItem, SimpleMenu.UnresolvedItem

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields

Modifier and Type	Field	Description
protected I18nUtils	_i18nUtils	The i18n utils
private boolean	_languagesInitialized
protected LanguagesManager	_languagesManager	The language manager
protected static String	_RESOURCES_PLUGIN	The plugin in which are the language resources (messages and icons).

Fields inherited from class org.ametys.core.ui.SimpleMenu

_galleryItems, _menuItemManager, _menuItems, _primaryMenuItem, _ribbonControlManager, _smanager, _unresolvedMenuItems

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor	Description
LanguageMenu()

Method Summary

Modifier and Type	Method	Description
private void	_addChildrenToConf(DefaultConfiguration conf, Map<String,Object> childrenAsMap)
protected void	_getGalleryItems(Map<String,Object> parameters, Map<String,Object> contextualParameters)	Get the gallery items
protected Configuration	_getLanguageItemConfiguration(String itemId, Language language)	Get the configuration for a language item
private void	_lazyInitializeLanguageGallery(Map<String,Object> contextualParameters)
protected Map<String,Language>	getAvailableLanguages(Map<String,Object> contextualParameters)	Get the available languages
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.core.ui.SimpleMenu

_addDependencies, _configureClass, _configureGalleries, _configureGroupGallery, _configureItemsMenu, _getGalleryItemManager, _getGalleryItems, _getMenuItems, configure, getReferencedClientSideElements, getRights

Methods inherited from class org.ametys.core.ui.StaticClientSideElement

_configureParameters, _configureScript, configureInitialParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, getDependencies, getId, getPluginName, getScripts, hasRight, setPluginInfo, toString

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

_RESOURCES_PLUGIN

protected static final String _RESOURCES_PLUGIN

The plugin in which are the language resources (messages and icons).

See Also:

Constant Field Values

_languagesManager

protected LanguagesManager _languagesManager

The language manager

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_languagesInitialized

private boolean _languagesInitialized

Constructor Detail

LanguageMenu

public LanguageMenu()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class SimpleMenu

Throws:

ServiceException

_getGalleryItems

protected void _getGalleryItems(Map<String,Object> parameters,
                                Map<String,Object> contextualParameters)

Description copied from class: SimpleMenu

Get the gallery items

Overrides:

_getGalleryItems in class SimpleMenu

Parameters:

parameters - Contextual the parameters given to the control script class.

contextualParameters - Contextual parameters transmitted by the environment.

_lazyInitializeLanguageGallery

private void _lazyInitializeLanguageGallery(Map<String,Object> contextualParameters)
                                     throws ConfigurationException

Throws:

ConfigurationException

getAvailableLanguages

protected Map<String,Language> getAvailableLanguages(Map<String,Object> contextualParameters)

Get the available languages

Parameters:

contextualParameters - The contextual parameters

Returns:

the available languages

getScripts

public List<ClientSideElement.Script> getScripts(boolean ignoreRights,
                                                 Map<String,Object> contextParameters)

Description copied from interface: ClientSideElement

This method return the scripts that will be used on client side. This class will be parametrized by initial and current parameters.

Specified by:

getScripts in interface ClientSideElement

Overrides:

getScripts in class SimpleMenu

Parameters:

ignoreRights - True to ignore the rights verification.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of scripts or an empty list.

_getLanguageItemConfiguration

protected Configuration _getLanguageItemConfiguration(String itemId,
                                                      Language language)

Get the configuration for a language item

Parameters:

itemId - The item id

language - The language

Returns:

The configuration

_addChildrenToConf

private void _addChildrenToConf(DefaultConfiguration conf,
                                Map<String,Object> childrenAsMap)