io.mangoo.templating

Interface TemplateEngine

All Known Implementing Classes:

TemplateEngineFreemarker, TemplateEnginePebble

public interface TemplateEngine

Author:

svenkubiak

Method Summary

Modifier and Type	Method and Description
String	getTemplateName(String templateName) Checks if a given template name has the current suffix and sets is if it does not exist
String	render(Flash flash, Session session, Form form, Messages messages, String templatePath, Map<String,Object> content) Renders a template for a specific controller class and method
String	render(String pathPrefix, String templateName, Map<String,Object> content) Renders a template for a specific controller class and method
String	renderException(io.undertow.server.HttpServerExchange exchange, Throwable cause, boolean templateException) When in dev mode, this method is used to pass the framework exception to the frontend

Method Detail

render

String render(Flash flash,
              Session session,
              Form form,
              Messages messages,
              String templatePath,
              Map<String,Object> content)
       throws MangooTemplateEngineException

Renders a template for a specific controller class and method

Parameters:

flash - The current flash

session - The current session

form - The current Form

messages - The current messages

templatePath - The path to the template to render

content - The content map which is passed to the template

Returns:

A rendered template

Throws:

MangooTemplateEngineException - MangooTemplateEngineException

render

String render(String pathPrefix,
              String templateName,
              Map<String,Object> content)
       throws MangooTemplateEngineException

Renders a template for a specific controller class and method

Parameters:

pathPrefix - A path prefix for the template

templateName - The path to the template to render

content - The content map which is passed to the template

Returns:

A rendered template

Throws:

MangooTemplateEngineException - MangooTemplateEngineException

renderException

String renderException(io.undertow.server.HttpServerExchange exchange,
                       Throwable cause,
                       boolean templateException)
                throws MangooTemplateEngineException

When in dev mode, this method is used to pass the framework exception to the frontend

Parameters:

exchange - A HttpServerExchange instance

cause - The throwable cause

templateException - True if the exceptions occurs during exception rendering, false otherwise

Returns:

A rendered template

Throws:

MangooTemplateEngineException - MangooTemplateEngineException

getTemplateName

String getTemplateName(String templateName)

Checks if a given template name has the current suffix and sets is if it does not exist

Parameters:

templateName - The name of the template file

Returns:

The template name with correct suffix