Package org.nuxeo.ecm.platform.rendering.api

Interface RenderingEngine

All Known Implementing Classes:

FreemarkerEngine, FreemarkerRender

public interface RenderingEngine

Author:

Bogdan Stefanescu

Method Summary

Modifier and Type	Method	Description
void	flushCache()
ResourceBundle	getMessageBundle()
ResourceLocator	getResourceLocator()
View	getView(String path)
View	getView(String path, Object object)
default String	render(String template, Object input)	Renders and returns the given template.
void	render(String template, Object input, Writer writer)	Starts the rendering for the given document context.
default String	renderInline(String inlineTemplate, Object input)	Renders and returns the given value as inline template.
default void	renderInline(String inlineTemplate, Object input, Writer writer)	Renders the given value as inline template.
void	setMessageBundle(ResourceBundle messages)
void	setResourceLocator(ResourceLocator locator)
void	setSharedVariable(String key, Object value)

Method Details

setMessageBundle

void setMessageBundle(ResourceBundle messages)

getMessageBundle

ResourceBundle getMessageBundle()

setResourceLocator

void setResourceLocator(ResourceLocator locator)

getResourceLocator

ResourceLocator getResourceLocator()

setSharedVariable

void setSharedVariable(String key,
 Object value)

render

default String render(String template,
 Object input)
               throws RenderingException

Renders and returns the given template.

Throws:

RenderingException

Since:

2025.14

render

void render(String template,
 Object input,
 Writer writer)
     throws RenderingException

Starts the rendering for the given document context.

Throws:

RenderingException

renderInline

default String renderInline(String inlineTemplate,
 Object input)
                     throws RenderingException

Renders and returns the given value as inline template.

Throws:

RenderingException

Since:

2025.14

renderInline

default void renderInline(String inlineTemplate,
 Object input,
 Writer writer)
                   throws RenderingException

Renders the given value as inline template.

Throws:

RenderingException

Since:

2025.14

getView

View getView(String path)

getView

View getView(String path,
 Object object)

flushCache

void flushCache()