org.everit.templating

Interface TemplateContext

public interface TemplateContext

The template context instance should be available as a variable with the TemplateConstants.VAR_TEMPLATE_CONTEXT name.

Method Summary

Modifier and Type	Method and Description
String	getFragmentId() Gets the id of the fragment.
String	renderFragment(String fragmentId) Renders one of the fragments of the current template.
String	renderFragment(String fragmentId, Map<String,Object> parameters) Renders one of the fragments of the current template.

Method Detail

getFragmentId

String getFragmentId()

Gets the id of the fragment.

Returns:

the id of the fragment of the template that was called to be rendered. In case the whole template is rendered, TemplateConstants.FRAGMENT_ROOT is returned.

renderFragment

String renderFragment(String fragmentId)

Renders one of the fragments of the current template. The variables that are declared / assigned within the fragment are not visible outside. Variables that are already declared / assigned outside are visible within the fragment.

Parameters:

fragmentId - The id of the fragment.

Returns:

The rendered fragment.

renderFragment

String renderFragment(String fragmentId,
                      Map<String,Object> parameters)

Renders one of the fragments of the current template. The variables that are declared / assigned within the fragment are not visible outside. Variables that are already declared / assigned outside are visible within the fragment.

Parameters:

fragmentId - The id of the fragment.

parameters - Map of variables that are also visible during rendering the fragment.

Returns:

The rendered fragment.