Package io.github.wimdeblauwe.htmx.spring.boot.mvc

Class HtmxResponse

java.lang.Object

io.github.wimdeblauwe.htmx.spring.boot.mvc.HtmxResponse

public final class HtmxResponse
extends Object

Used as a controller method return type to specify htmx-related response headers and returning multiple template partials in a single response.

Author:

Oliver Drotbohm, Clint Checketts, Sascha Woo

See Also:

• Response Headers Reference

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HtmxResponse.Builder

Constructor Summary

Constructors

Constructor	Description
HtmxResponse()	Deprecated. use builder() instead.

Method Summary

Modifier and Type	Method	Description
HtmxResponse	addTemplate(String template)	Deprecated. use HtmxResponse.Builder.view(String) instead.
HtmxResponse	addTemplate(org.springframework.web.servlet.ModelAndView template)	Deprecated. use HtmxResponse.Builder.view(ModelAndView) instead.
HtmxResponse	addTemplate(org.springframework.web.servlet.View template)	Deprecated. use HtmxResponse.Builder.view(View) instead.
HtmxResponse	addTrigger(String eventName)	Deprecated. use HtmxResponse.Builder.trigger(String) instead.
HtmxResponse	addTrigger(String eventName, String eventDetail, HxTriggerLifecycle step)	Deprecated. use HtmxResponse.Builder.trigger(String, Object) instead.
HtmxResponse	and(HtmxResponse otherResponse)	Deprecated. use HtmxResponse.Builder.and(HtmxResponse) instead.
HtmxResponse	browserRedirect(String url)	Deprecated. use HtmxResponse.Builder.redirect(String) instead.
HtmxResponse	browserRefresh(boolean refresh)	Deprecated. use HtmxResponse.Builder.refresh() instead.
static HtmxResponse.Builder	builder()	Return a builder to build a HtmxResponse.
String	getHeaderReswap()	Deprecated. use getReswap() instead.
HtmxLocation	getLocation()
String	getPushUrl()
String	getRedirect()
String	getReplaceUrl()
String	getReselect()
HtmxReswap	getReswap()
String	getRetarget()
Collection<org.springframework.web.servlet.ModelAndView>	getTemplates()	Deprecated. use getViews() instead.
Map<String,String>	getTriggers()
Map<String,String>	getTriggersAfterSettle()
Map<String,String>	getTriggersAfterSwap()
Collection<org.springframework.web.servlet.ModelAndView>	getViews()
boolean	isRefresh()
HtmxResponse	pushHistory(String url)	Deprecated. use HtmxResponse.Builder.pushUrl(String) instead.
HtmxResponse	reswap(HxSwapType swapType)	Deprecated. use reswap(HxSwapType) instead.
HtmxResponse	retarget(String cssSelector)	Deprecated. use HtmxResponse.Builder.retarget(String) instead.

Methods inherited from class java.lang.Object

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

Constructor Details

HtmxResponse

@Deprecated
public HtmxResponse()

Deprecated.

use builder() instead. Will be removed in 4.0.

Method Details

builder

public static HtmxResponse.Builder builder()

Return a builder to build a HtmxResponse.

Returns:

the builder

addTemplate

@Deprecated
public HtmxResponse addTemplate(String template)

Deprecated.

use HtmxResponse.Builder.view(String) instead. Will be removed in 4.0.

Append the rendered template or fragment.

Parameters:

template - must not be null or empty.

Returns:

same HtmxResponse for chaining

addTemplate

@Deprecated
public HtmxResponse addTemplate(org.springframework.web.servlet.View template)

Deprecated.

use HtmxResponse.Builder.view(View) instead. Will be removed in 4.0.

Append the rendered template or fragment as a resolved View.

Parameters:

template - must not be null.

Returns:

same HtmxResponse for chaining

addTemplate

@Deprecated
public HtmxResponse addTemplate(org.springframework.web.servlet.ModelAndView template)

Deprecated.

use HtmxResponse.Builder.view(ModelAndView) instead. Will be removed in 4.0.

Append the rendered template or fragment as a ModelAndView.

Parameters:

template - must not be null.

Returns:

same HtmxResponse for chaining

addTrigger

@Deprecated
public HtmxResponse addTrigger(String eventName)

Deprecated.

use HtmxResponse.Builder.trigger(String) instead. Will be removed in 4.0.

Set a HX-Trigger header. Multiple trigger were automatically be merged into the same header.

Parameters:

eventName - must not be null or empty.

Returns:

same HtmxResponse for chaining

See Also:

• HX-Trigger Response Headers

addTrigger

@Deprecated
public HtmxResponse addTrigger(String eventName,
 String eventDetail,
 HxTriggerLifecycle step)

Deprecated.

use HtmxResponse.Builder.trigger(String, Object) instead. Will be removed in 4.0.

Set a HX-Trigger (or HX-Trigger-After-Settle or HX-Trigger-After-Swap headers. Multiple trigger were automatically be merged into the same header.

Parameters:

eventName - must not be null or empty.

eventDetail - can be null.

step - must not be null or empty.

Returns:

same HtmxResponse for chaining

See Also:

• HX-Trigger Response Headers

pushHistory

@Deprecated
public HtmxResponse pushHistory(String url)

Deprecated.

use HtmxResponse.Builder.pushUrl(String) instead. Will be removed in 4.0.

Pushes a new url into the history stack

Parameters:

url - must not be null or empty. false prevents the browser history from being updated

Returns:

same HtmxResponse for chaining

See Also:

• HX-Push Response Header documentation

browserRedirect

@Deprecated
public HtmxResponse browserRedirect(String url)

Deprecated.

use HtmxResponse.Builder.redirect(String) instead. Will be removed in 4.0.

Can be used to do a client-side redirect to a new location

Parameters:

url - can be a relative or an absolute url

Returns:

same HtmxResponse for chaining

browserRefresh

@Deprecated
public HtmxResponse browserRefresh(boolean refresh)

Deprecated.

use HtmxResponse.Builder.refresh() instead. Will be removed in 4.0.

If set to "true" the client side will do a full refresh of the page

Parameters:

refresh - boolean to indicate full refresh or not.

Returns:

same HtmxResponse for chaining

retarget

@Deprecated
public HtmxResponse retarget(String cssSelector)

Deprecated.

use HtmxResponse.Builder.retarget(String) instead. Will be removed in 4.0.

Set a CSS selector that updates the target of the content update to a different element on the page

Parameters:

cssSelector - must not be null or empty.

Returns:

same HtmxResponse for chaining

reswap

@Deprecated
public HtmxResponse reswap(HxSwapType swapType)

Deprecated.

use reswap(HxSwapType) instead. Will be removed in 4.0.

Set a new swap to specify how the response will be swapped

Parameters:

swapType - must not be null.

Returns:

same HtmxResponse for chaining

and

@Deprecated
public HtmxResponse and(HtmxResponse otherResponse)

Deprecated.

use HtmxResponse.Builder.and(HtmxResponse) instead. Will be removed in 4.0.

Parameters:

otherResponse - Another HtmxResponse that will be merged into this response.

Returns:

this for chaining

getHeaderReswap

@Deprecated
public String getHeaderReswap()

Deprecated.

use getReswap() instead. Will be removed in 4.0.

getTemplates

@Deprecated
public Collection<org.springframework.web.servlet.ModelAndView> getTemplates()

Deprecated.

use getViews() instead. Will be removed in 4.0.

getLocation

public HtmxLocation getLocation()

getPushUrl

public String getPushUrl()

getRedirect

public String getRedirect()

getReplaceUrl

public String getReplaceUrl()

getReselect

public String getReselect()

getReswap

public HtmxReswap getReswap()

getRetarget

public String getRetarget()

getTriggers

public Map<String,String> getTriggers()

getTriggersAfterSettle

public Map<String,String> getTriggersAfterSettle()

getTriggersAfterSwap

public Map<String,String> getTriggersAfterSwap()

getViews

public Collection<org.springframework.web.servlet.ModelAndView> getViews()

isRefresh

public boolean isRefresh()