io.micronaut.views.thymeleaf

Class ThymeleafViewsRenderer

java.lang.Object

io.micronaut.views.thymeleaf.ThymeleafViewsRenderer

All Implemented Interfaces:

ViewsRenderer

@Produces(value="text/html")
 @Singleton
public class ThymeleafViewsRenderer
extends java.lang.Object
implements ViewsRenderer

Renders templates Thymeleaf Java template engine.

Since:

1.0

Author:

Sergio del Amo, graemerocher

See Also:

https://www.thymeleaf.org

Field Summary

Fields

Modifier and Type	Field and Description
protected org.thymeleaf.TemplateEngine	engine
protected io.micronaut.core.io.ResourceLoader	resourceLoader
protected org.thymeleaf.templateresolver.AbstractConfigurableTemplateResolver	templateResolver

Fields inherited from interface io.micronaut.views.ViewsRenderer

EXTENSION_SEPARATOR, FILE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
ThymeleafViewsRenderer(org.thymeleaf.templateresolver.AbstractConfigurableTemplateResolver templateResolver, org.thymeleaf.TemplateEngine templateEngine, io.micronaut.core.io.scan.ClassPathResourceLoader resourceLoader)
ThymeleafViewsRenderer(ViewsConfiguration viewsConfiguration, ThymeleafViewsRendererConfiguration thConfiguration, io.micronaut.core.io.scan.ClassPathResourceLoader resourceLoader) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	exists(java.lang.String viewName)
void	render(java.lang.String viewName, org.thymeleaf.context.IContext context, java.io.Writer writer) Passes the arguments as is to TemplateEngine.process(String, IContext, Writer).
io.micronaut.core.io.Writable	render(java.lang.String viewName, java.lang.Object data)
io.micronaut.core.io.Writable	render(java.lang.String viewName, java.lang.Object data, io.micronaut.http.HttpRequest<?> request)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.views.ViewsRenderer

modelOf, normalizeFile, normalizeFolder

Field Detail

templateResolver

protected final org.thymeleaf.templateresolver.AbstractConfigurableTemplateResolver templateResolver

engine

protected final org.thymeleaf.TemplateEngine engine

resourceLoader

protected io.micronaut.core.io.ResourceLoader resourceLoader

Constructor Detail

ThymeleafViewsRenderer

@Deprecated
public ThymeleafViewsRenderer(ViewsConfiguration viewsConfiguration,
                                          ThymeleafViewsRendererConfiguration thConfiguration,
                                          io.micronaut.core.io.scan.ClassPathResourceLoader resourceLoader)

Deprecated.

Parameters:

viewsConfiguration - Views Configuration

thConfiguration - Thymeleaf template renderer configuration

resourceLoader - The resource loader

ThymeleafViewsRenderer

@Inject
public ThymeleafViewsRenderer(org.thymeleaf.templateresolver.AbstractConfigurableTemplateResolver templateResolver,
                                      org.thymeleaf.TemplateEngine templateEngine,
                                      io.micronaut.core.io.scan.ClassPathResourceLoader resourceLoader)

Parameters:

templateResolver - The template resolver

templateEngine - The template engine

resourceLoader - The resource loader

Method Detail

render

@Nonnull
public io.micronaut.core.io.Writable render(@Nonnull
                                                     java.lang.String viewName,
                                                     @Nullable
                                                     java.lang.Object data)

Specified by:

render in interface ViewsRenderer

Parameters:

viewName - view name to be render

data - response body to render it with a view

Returns:

A writable where the view will be written to.

render

@Nonnull
public io.micronaut.core.io.Writable render(@Nonnull
                                                     java.lang.String viewName,
                                                     @Nullable
                                                     java.lang.Object data,
                                                     @Nonnull
                                                     io.micronaut.http.HttpRequest<?> request)

Specified by:

render in interface ViewsRenderer

Parameters:

viewName - view name to be render

data - response body to render it with a view

request - HTTP request

Returns:

A writable where the view will be written to.

render

public void render(java.lang.String viewName,
                   org.thymeleaf.context.IContext context,
                   java.io.Writer writer)

Passes the arguments as is to TemplateEngine.process(String, IContext, Writer).

Parameters:

viewName - The view name

context - The context

writer - The writer

exists

public boolean exists(@Nonnull
                      java.lang.String viewName)

Specified by:

exists in interface ViewsRenderer

Parameters:

viewName - view name to be render

Returns:

true if a template can be found for the supplied view name.