Package org.opencms.jsp.util

Class CmsStringTemplateRenderer

java.lang.Object

org.opencms.jsp.util.CmsStringTemplateRenderer

public class CmsStringTemplateRenderer
extends Object

Renderer for string templates.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_DISPLAY	The error display HTML.
static final String	ERROR_DISPLAY_WITH_DETAILS	The error display HTML, including error details.
static final String	KEY_FUNCTIONS	Key to access object function wrapper.
static final String	KEY_SETTINGS	Key to access element settings.

Constructor Summary

Constructors

Constructor	Description
CmsStringTemplateRenderer(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	render()	Renders the requested element content with the flex formatter string template.
static String	renderTemplate(CmsObject cms, String template, CmsResource content, Map<String,Object> contextObjects)	Renders the given string template.
static String	renderTemplate(CmsObject cms, String template, CmsResource content, Map<String,Object> contextObjects, String pathPrefix)	Renders the given string template.
static String	renderTemplate(CmsObject cms, String template, CmsJspContentAccessBean content, Map<String,Object> contextObjects)	Renders the given string template.
static String	renderTemplate(CmsObject cms, String template, CmsJspContentAccessValueWrapper contentValue, Map<String,Object> contextObjects)	Renders the given string template.
static Map<String,CmsJspObjectValueWrapper>	wrapSettings(CmsObject cms, Map<String,String> settings)	Wraps the element settings with access wrappers.

Methods inherited from class java.lang.Object

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

Field Details

ERROR_DISPLAY

public static final String ERROR_DISPLAY

The error display HTML.

See Also:

• Constant Field Values

ERROR_DISPLAY_WITH_DETAILS

public static final String ERROR_DISPLAY_WITH_DETAILS

The error display HTML, including error details.

See Also:

• Constant Field Values

KEY_FUNCTIONS

public static final String KEY_FUNCTIONS

Key to access object function wrapper.

See Also:

• Constant Field Values

KEY_SETTINGS

public static final String KEY_SETTINGS

Key to access element settings.

See Also:

• Constant Field Values

Constructor Details

CmsStringTemplateRenderer

public CmsStringTemplateRenderer(javax.servlet.jsp.PageContext context,
 javax.servlet.http.HttpServletRequest req)

Constructor.

Parameters:

context - the page context

req - the request

Method Details

renderTemplate

public static String renderTemplate(CmsObject cms,
 String template,
 CmsJspContentAccessBean content,
 Map<String,Object> contextObjects)

Renders the given string template.

Parameters:

cms - the cms context

template - the template

content - the content

contextObjects - additional context objects made available to the template

Returns:

the rendering result

renderTemplate

public static String renderTemplate(CmsObject cms,
 String template,
 CmsJspContentAccessValueWrapper contentValue,
 Map<String,Object> contextObjects)

Renders the given string template.

Parameters:

cms - the cms context

template - the template

contentValue - the content value (part of a content)

contextObjects - additional context objects made available to the template

Returns:

the rendering result

renderTemplate

public static String renderTemplate(CmsObject cms,
 String template,
 CmsResource content,
 Map<String,Object> contextObjects)

Renders the given string template.

Parameters:

cms - the cms context

template - the template

content - the content

contextObjects - additional context objects made available to the template

Returns:

the rendering result

renderTemplate

public static String renderTemplate(CmsObject cms,
 String template,
 CmsResource content,
 Map<String,Object> contextObjects,
 String pathPrefix)

Renders the given string template.

Parameters:

cms - the cms context

template - the template

content - the content

contextObjects - additional context objects made available to the template

pathPrefix - the path to the content part that should be accessible as content to the string template.

Returns:

the rendering result

wrapSettings

public static Map<String,CmsJspObjectValueWrapper> wrapSettings(CmsObject cms,
 Map<String,String> settings)

Wraps the element settings with access wrappers.

Parameters:

cms - the current OpenCms user context

settings - the settings to wrap

Returns:

the element settings wrapped in access wrappers

render

public void render()
            throws IOException

Renders the requested element content with the flex formatter string template.

Throws:

IOException - in case writing to to page context out fails