Package org.springframework.web.servlet.view

Interface FragmentsRendering

All Superinterfaces:

SmartView, View

public interface FragmentsRendering
extends SmartView

Public API to render HTML fragments. A fragment is a portion of an HTML page. Normally HTML is rendered with a single model and view. This API allows using multiple model and view pairs, one for each HTML fragment.

For use with frontends technologies such as htmx where multiple page fragments may be rendered in one response.

Supported as a return value from controller methods.

Since:

6.2

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FragmentsRendering.Builder	Defines a builder for FragmentsRendering.

Field Summary

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

PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

Method Summary

Modifier and Type	Method	Description
HttpHeaders	headers()	Return headers to add to the response.
HttpStatusCode	status()	Return the HTTP status to set the response to.
static FragmentsRendering.Builder	with(String viewName)	Create a builder with one HTML fragment, also inheriting attributes from the shared model for the request.
static FragmentsRendering.Builder	with(String viewName, Map<String,Object> model)	Create a builder with one HTML fragment.
static FragmentsRendering.Builder	with(Collection<ModelAndView> fragments)	Create a builder with multiple HTML fragments.

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

isRedirectView, resolveNestedViews

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

getContentType, render

Method Details

status

@Nullable
HttpStatusCode status()

Return the HTTP status to set the response to.

headers

HttpHeaders headers()

Return headers to add to the response.

with

static FragmentsRendering.Builder with(String viewName,
 Map<String,Object> model)

Create a builder with one HTML fragment.

Parameters:

viewName - the view name for the fragment

model - attributes for the fragment, in addition to attributes from the shared model for the request

Returns:

the created builder

with

static FragmentsRendering.Builder with(String viewName)

Create a builder with one HTML fragment, also inheriting attributes from the shared model for the request.

Parameters:

viewName - the name of the view for the fragment

Returns:

the created builder

with

static FragmentsRendering.Builder with(Collection<ModelAndView> fragments)

Create a builder with multiple HTML fragments.

Parameters:

fragments - the fragments to add; each fragment also inherits attributes from the shared model for the request

Returns:

the created builder