Package org.opencms.loader

Class CmsTransformerTemplateProvider

java.lang.Object

org.opencms.loader.CmsTransformerTemplateProvider

All Implemented Interfaces:

I_CmsTemplateContextProvider

public class CmsTransformerTemplateProvider
extends Object
implements I_CmsTemplateContextProvider

Template context provider that can be used to migrate from one template to another.

Note: The template provider by itself does not transform anything, the feature is just named like that.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CmsTransformerTemplateProvider.Configuration	Contains the configuration data for the provider, usually read from a configuration file.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COOKIE_PREFIX	The cookie prefix.
static final String	PARAM_CONFIG	Parameter for the configuration file in the template provider string.
static final String	TEMPLATE_KEY_SOURCE	The template context key for the source template.
static final String	TEMPLATE_KEY_TARGET	The template context key for the target template.

Constructor Summary

Constructors

Constructor	Description
CmsTransformerTemplateProvider()

Method Summary

Modifier and Type	Method	Description
Map<String,CmsTemplateContext>	getAllContexts()	Gets a map of all template contexts, with the template context names as keys.
CmsTransformerTemplateProvider.Configuration	getConfiguration()	Gets the configuration data that was read from the config file.
String	getDefaultLabel(Locale locale)	Customizes the label for the default template context option.
String	getEditorStyleSheet(CmsObject cms, String editedResourcePath)	Returns the style sheet to be used for the editor.
Set<CmsUUID>	getFunctionsForGallery(CmsObject cms, String templateContext)	Returns a set of structure ids of dynamic functions that are allowed to appear in the gallery dialog search results, or null if the dynamic function results should not be restricted.
String	getMenuLabel(Locale locale)	Gets the label to use for the menu entry in the given locale.
int	getMenuPosition()	Special integer that indicates the position for the template context selection in the context menu.
String	getOverrideCookieName()	Gets the name of the cookie which should be used for overriding the template context.
String	getTemplateCompatibility(String currentContext)	Gets the template compatibility for the given template context key.
CmsTemplateContext	getTemplateContext(CmsObject cms, javax.servlet.http.HttpServletRequest request, CmsResource resource)	Determines the template context from the current CMS context, request, and resource.
void	initialize(CmsObject cms, String config)	Initializes the context provider using a CMS object.
boolean	isHiddenContext(String key)	Checks if the template context should be hidden in the GUI.
boolean	isIgnoreTemplateContextsSetting()	Checks if the 'templateContexts' setting should be ignored when rendering container elements (i.e.
protected CmsTransformerTemplateProvider.Configuration	loadConfiguration()	Helper method for loading the configuration from the VFS.
String	readCommonProperty(CmsObject cms, String propertyName, String fallbackValue)	Gets the value which should be used instead of a property which was read from the template resource.
boolean	shouldShowContextMenuOption(CmsObject cms)	Checks if the context menu option for switching the template should be shown for the given user context.
boolean	shouldShowElementTemplateContextSelection(CmsObject cms)	Controls whether template context select options should be shown in the element settings dialog.

Methods inherited from class java.lang.Object

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

Field Details

COOKIE_PREFIX

public static final String COOKIE_PREFIX

The cookie prefix.

See Also:

• Constant Field Values

PARAM_CONFIG

public static final String PARAM_CONFIG

Parameter for the configuration file in the template provider string.

See Also:

• Constant Field Values

TEMPLATE_KEY_SOURCE

public static final String TEMPLATE_KEY_SOURCE

The template context key for the source template.

See Also:

• Constant Field Values

TEMPLATE_KEY_TARGET

public static final String TEMPLATE_KEY_TARGET

The template context key for the target template.

See Also:

• Constant Field Values

Constructor Details

CmsTransformerTemplateProvider

public CmsTransformerTemplateProvider()

Method Details

getAllContexts

public Map<String,CmsTemplateContext> getAllContexts()

Description copied from interface: I_CmsTemplateContextProvider

Gets a map of all template contexts, with the template context names as keys.

Specified by:

getAllContexts in interface I_CmsTemplateContextProvider

Returns:

the map of template context providers

See Also:

• I_CmsTemplateContextProvider.getAllContexts()

getConfiguration

public CmsTransformerTemplateProvider.Configuration getConfiguration()

Gets the configuration data that was read from the config file.

Returns:

the configuration data from the config file

getDefaultLabel

public String getDefaultLabel(Locale locale)

Description copied from interface: I_CmsTemplateContextProvider

Customizes the label for the default template context option.

If null is returned, the default label for the default template will be used. If null is returned, a default

Specified by:

getDefaultLabel in interface I_CmsTemplateContextProvider

Parameters:

locale - the locale for i18n

Returns:

the label for the default template context option

See Also:

• I_CmsTemplateContextProvider.getDefaultLabel(java.util.Locale)

getEditorStyleSheet

public String getEditorStyleSheet(CmsObject cms,
 String editedResourcePath)

Description copied from interface: I_CmsTemplateContextProvider

Returns the style sheet to be used for the editor.

Specified by:

getEditorStyleSheet in interface I_CmsTemplateContextProvider

Parameters:

cms - the current CMS context

editedResourcePath - the path of the edited resource

Returns:

the path of the style sheet to be used for the resource

See Also:

• I_CmsTemplateContextProvider.getEditorStyleSheet(org.opencms.file.CmsObject, java.lang.String)

getFunctionsForGallery

public Set<CmsUUID> getFunctionsForGallery(CmsObject cms,
 String templateContext)

Description copied from interface: I_CmsTemplateContextProvider

Returns a set of structure ids of dynamic functions that are allowed to appear in the gallery dialog search results, or null if the dynamic function results should not be restricted.

Note: Functions may be excluded from the gallery dialog search results for other reasons even if they appear in the set returned by this method.

Specified by:

getFunctionsForGallery in interface I_CmsTemplateContextProvider

Parameters:

cms - the current CMS context

templateContext - the current template context key

Returns:

the set of ids of dynamic functions to allow in the gallery search results, or null if function results shouldn't be restricted

See Also:

• I_CmsTemplateContextProvider.getFunctionsForGallery(org.opencms.file.CmsObject, java.lang.String)

getMenuLabel

public String getMenuLabel(Locale locale)

Description copied from interface: I_CmsTemplateContextProvider

Gets the label to use for the menu entry in the given locale.

If this returns null, the default menu entry label is used.

Specified by:

getMenuLabel in interface I_CmsTemplateContextProvider

Parameters:

locale - the locale for which we want the menu entry label

Returns:

the menu entry label

See Also:

• I_CmsTemplateContextProvider.getMenuLabel(java.util.Locale)

getMenuPosition

public int getMenuPosition()

Description copied from interface: I_CmsTemplateContextProvider

Special integer that indicates the position for the template context selection in the context menu.

Currently can only return 0 or 1.

Specified by:

getMenuPosition in interface I_CmsTemplateContextProvider

Returns:

the context menu position

See Also:

• I_CmsTemplateContextProvider.getMenuPosition()

getOverrideCookieName

public String getOverrideCookieName()

Description copied from interface: I_CmsTemplateContextProvider

Gets the name of the cookie which should be used for overriding the template context.

Specified by:

getOverrideCookieName in interface I_CmsTemplateContextProvider

Returns:

the name of the cookie used for overriding the template context

See Also:

• I_CmsTemplateContextProvider.getOverrideCookieName()

getTemplateCompatibility

public String getTemplateCompatibility(String currentContext)

Description copied from interface: I_CmsTemplateContextProvider

Gets the template compatibility for the given template context key.

The template compatibility controls which elements are visible as gallery search results when the template with the given key is active. If the template.compatibility property on a resource is set (possibly inherited from a parent folder), but does not contain the compatibility value returned by this method, it will not show up in gallery search results when the template referenced by templateContextKey is active.

Specified by:

getTemplateCompatibility in interface I_CmsTemplateContextProvider

Parameters:

currentContext - the key for a template context

Returns:

a template compatibility string (should not contain whitespace or punctuation)

See Also:

• I_CmsTemplateContextProvider.getTemplateCompatibility(java.lang.String)

getTemplateContext

public CmsTemplateContext getTemplateContext(CmsObject cms,
 javax.servlet.http.HttpServletRequest request,
 CmsResource resource)

Description copied from interface: I_CmsTemplateContextProvider

Determines the template context from the current CMS context, request, and resource.

Specified by:

getTemplateContext in interface I_CmsTemplateContextProvider

Parameters:

cms - the CMS context

request - the current request

resource - the resource being rendered

Returns:

the current template context

See Also:

• I_CmsTemplateContextProvider.getTemplateContext(org.opencms.file.CmsObject, javax.servlet.http.HttpServletRequest, org.opencms.file.CmsResource)

initialize

public void initialize(CmsObject cms,
 String config)

Description copied from interface: I_CmsTemplateContextProvider

Initializes the context provider using a CMS object.

Initialization always happens in the Online project.

Specified by:

initialize in interface I_CmsTemplateContextProvider

Parameters:

cms - the current CMS context

config - the template context provider configuration

See Also:

• I_CmsTemplateContextProvider.initialize(org.opencms.file.CmsObject, java.lang.String)

isHiddenContext

public boolean isHiddenContext(String key)

Description copied from interface: I_CmsTemplateContextProvider

Checks if the template context should be hidden in the GUI.

Specified by:

isHiddenContext in interface I_CmsTemplateContextProvider

Parameters:

key - the key of a template context

Returns:

true if the template context should be hidden in the GUI

See Also:

• I_CmsTemplateContextProvider.isHiddenContext(java.lang.String)

isIgnoreTemplateContextsSetting

public boolean isIgnoreTemplateContextsSetting()

Description copied from interface: I_CmsTemplateContextProvider

Checks if the 'templateContexts' setting should be ignored when rendering container elements (i.e. they will be rendered by default, regardless of the setting value).

Specified by:

isIgnoreTemplateContextsSetting in interface I_CmsTemplateContextProvider

Returns:

true if the templateContexts setting should be ignored by the cms:container tag

See Also:

• I_CmsTemplateContextProvider.isIgnoreTemplateContextsSetting()

readCommonProperty

public String readCommonProperty(CmsObject cms,
 String propertyName,
 String fallbackValue)

Description copied from interface: I_CmsTemplateContextProvider

Gets the value which should be used instead of a property which was read from the template resource.

This is needed because before template context providers, it was common to store template-specific configuration in a property on the template JSP. Since template context providers make the result ambiguous, this method is intended as a replacement.

Specified by:

readCommonProperty in interface I_CmsTemplateContextProvider

Parameters:

cms - the CMS context to use

propertyName - the name of the property

fallbackValue - the value to return if no value is found or an error occurs

Returns:

the common property value

See Also:

• I_CmsTemplateContextProvider.readCommonProperty(org.opencms.file.CmsObject, java.lang.String, java.lang.String)

shouldShowContextMenuOption

public boolean shouldShowContextMenuOption(CmsObject cms)

Description copied from interface: I_CmsTemplateContextProvider

Checks if the context menu option for switching the template should be shown for the given user context.

Specified by:

shouldShowContextMenuOption in interface I_CmsTemplateContextProvider

Parameters:

cms - the CmsObject to check

Returns:

true if the context menu option should be visible

See Also:

• I_CmsTemplateContextProvider.shouldShowContextMenuOption(org.opencms.file.CmsObject)

shouldShowElementTemplateContextSelection

public boolean shouldShowElementTemplateContextSelection(CmsObject cms)

Description copied from interface: I_CmsTemplateContextProvider

Controls whether template context select options should be shown in the element settings dialog.

Specified by:

shouldShowElementTemplateContextSelection in interface I_CmsTemplateContextProvider

Parameters:

cms - the CmsObject for the current user

Returns:

true if the template context select options should be shown in the element settings dialog

See Also:

• I_CmsTemplateContextProvider.shouldShowElementTemplateContextSelection(org.opencms.file.CmsObject)

loadConfiguration

protected CmsTransformerTemplateProvider.Configuration loadConfiguration()
                                                                  throws Exception

Helper method for loading the configuration from the VFS.

Returns:

the provider configuration

Throws:

Exception - if something goes wrong