Package org.thymeleaf.spring6.webflow.view

Class AjaxThymeleafView

Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.thymeleaf.spring6.view.AbstractThymeleafView

org.thymeleaf.spring6.view.ThymeleafView

org.thymeleaf.spring6.webflow.view.AjaxThymeleafView

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.View, AjaxEnabledView

Direct Known Subclasses:

FlowAjaxThymeleafView

public class AjaxThymeleafView
extends ThymeleafView
implements AjaxEnabledView

Subclass of ThymeleafView adding compatibility with AJAX events in Spring JavaScript (part of Spring WebFlow). This allows this View implementation to be able to return only fragments of the page.

These rendering of fragments is used, for example, in Spring WebFlow's <render> instructions (though not only).

This view searches for a comma-separated list of markup selectors in a request parameter called fragments.

Since:

3.0.3

Author:

Daniel Fernández

Field Summary

Fields inherited from class org.thymeleaf.spring6.view.AbstractThymeleafView

DEFAULT_CONTENT_TYPE, DEFAULT_PRODUCE_PARTIAL_OUTPUT_WHILE_PROCESSING

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Fields inherited from interface org.springframework.web.servlet.View

PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

Constructor Summary

Constructors

Constructor	Description
AjaxThymeleafView()

Method Summary

Modifier and Type	Method	Description
org.springframework.webflow.context.servlet.AjaxHandler	getAjaxHandler()	Return the AJAX handler (from Spring Javascript) used to determine whether a request is an AJAX request or not.
protected Set<String>	getRenderFragments(Map model, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	render(Map<String,?> model, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	setAjaxHandler(org.springframework.webflow.context.servlet.AjaxHandler ajaxHandler)	Sets the AJAX handler (from Spring Javascript) used to determine whether a request is an AJAX request or not.

Methods inherited from class org.thymeleaf.spring6.view.ThymeleafView

getMarkupSelector, renderFragment, setMarkupSelector

Methods inherited from class org.thymeleaf.spring6.view.AbstractThymeleafView

addRequestContextAsVariable, addStaticVariable, getBeanName, getCharacterEncoding, getContentType, getForceContentType, getLocale, getProducePartialOutputWhileProcessing, getStaticVariables, getTemplateEngine, getTemplateName, isContentTypeSet, isForceContentTypeSet, isProducePartialOutputWhileProcessingSet, setBeanName, setCharacterEncoding, setContentType, setForceContentType, setLocale, setProducePartialOutputWhileProcessing, setStaticVariables, setTemplateEngine, setTemplateName

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.servlet.View

getContentType

Constructor Details

AjaxThymeleafView

public AjaxThymeleafView()

Method Details

getAjaxHandler

public org.springframework.webflow.context.servlet.AjaxHandler getAjaxHandler()

Description copied from interface: AjaxEnabledView

Return the AJAX handler (from Spring Javascript) used to determine whether a request is an AJAX request or not.

Views implementing this interface should be used with an instance of AjaxThymeleafViewResolver or any of its subclasses, so that AjaxEnabledView.setAjaxHandler(AjaxHandler) can be called by the resolver when resolving the view, setting the default AJAX handler being used.

Specified by:

getAjaxHandler in interface AjaxEnabledView

Returns:

the AJAX handler.

setAjaxHandler

public void setAjaxHandler(org.springframework.webflow.context.servlet.AjaxHandler ajaxHandler)

Description copied from interface: AjaxEnabledView

Sets the AJAX handler (from Spring Javascript) used to determine whether a request is an AJAX request or not.

Views implementing this interface should be used with an instance of AjaxThymeleafViewResolver or any of its subclasses, so that this method can be called by the resolver when resolving the view, setting the default AJAX handler being used.

Specified by:

setAjaxHandler in interface AjaxEnabledView

Parameters:

ajaxHandler - the AJAX handler.

render

public void render(Map<String,?> model,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
            throws Exception

Specified by:

render in interface org.springframework.web.servlet.View

Overrides:

render in class ThymeleafView

Throws:

Exception

getRenderFragments

protected Set<String> getRenderFragments(Map model,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)