Package org.opencms.ade.contenteditor

Interface I_CmsContentTranslator

All Superinterfaces:

I_CmsConfigurationParameterHandler

All Known Implementing Classes:

CmsAiContentTranslation, CmsDeeplTranslation, CmsDummyTranslator

public interface I_CmsContentTranslator
extends I_CmsConfigurationParameterHandler

Interface for the content translator.

This is used by the translation button in the form based content editor.

The global content translator is available via CmsWorkplaceManager and is configured in opencms-workplace.xml.

Field Summary

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Method Summary

Modifier and Type	Method	Description
I_CmsXmlContentAugmentation	getContentAugmentation()	Returns a fresh content augmentation object for doing the actual translation work.
void	initialize(CmsObject cms)	Initializes the content translator with an admin CmsObject.
boolean	isEnabled(CmsObject cms, CmsADEConfigData config, CmsFile file)	Checks if the translation should be enabled for the current context.

Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

addConfigurationParameter, getConfiguration, initConfiguration

Method Details

getContentAugmentation

I_CmsXmlContentAugmentation getContentAugmentation()

Returns a fresh content augmentation object for doing the actual translation work.

Returns:

the content augmentation object

initialize

void initialize(CmsObject cms)

Initializes the content translator with an admin CmsObject.

If the translator is already initialized, this should do nothing.

Parameters:

cms - an admin CmsObject

isEnabled

boolean isEnabled(CmsObject cms,
 CmsADEConfigData config,
 CmsFile file)

Checks if the translation should be enabled for the current context.

Parameters:

cms - the CMS context

config - the currently active ADE configuration

file - the edited file

Returns:

true if the translation should be enabled