Package org.ametys.plugins.translationflagging

Class TranslationFlaggingClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.plugins.translationflagging.TranslationFlaggingClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class TranslationFlaggingClientSideElement
extends StaticClientSideElement

This element creates a ribbon button to flag translation on a page. Provides callable methods to set and get translations.

Nested Class Summary

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

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields

Modifier and Type	Field	Description
static String	TRANSLATIONS_META	Constant for the translations metadata name

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

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

Constructor Summary

Constructors

Constructor	Description
TranslationFlaggingClientSideElement()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Page>	_getTranslatedPages(Map<String,String> translations, String pageId)	Get translated pages from the map.
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
Map<String,Object>	getTranslations(String pageId)	Get all the translations associated with a page
void	service(ServiceManager smanager)
List<String>	setTranslations(String pageId, Map<String,String> translations)	Set the translations for a specific page

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

_configureClass, _configureParameters, _configureScript, configureInitialParameters

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

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, configure, getDependencies, getId, getPluginName, getRights, 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

TRANSLATIONS_META

public static final String TRANSLATIONS_META

Constant for the translations metadata name

See Also:

Constant Field Values

Constructor Detail

TranslationFlaggingClientSideElement

public TranslationFlaggingClientSideElement()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticFileImportsClientSideElement

Throws:

ServiceException

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 StaticFileImportsClientSideElement

Parameters:

ignoreRights - True to ignore the rights verification.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of scripts or an empty list.

getTranslations

public Map<String,Object> getTranslations(String pageId)

Get all the translations associated with a page

Parameters:

pageId - The page Id

Returns:

The page and its translations data

setTranslations

public List<String> setTranslations(String pageId,
                                    Map<String,String> translations)

Set the translations for a specific page

Parameters:

pageId - The current page id

translations - an association language-pageId, to set as translations

Returns:

The list of updated pages.

_getTranslatedPages

protected Map<String,Page> _getTranslatedPages(Map<String,String> translations,
                                                     String pageId)

Get translated pages from the map.

Parameters:

translations - the associative list of translations.

pageId - the current page ID.

Returns:

the translated pages as a Map of pages, indexed by sitemap name.