Package io.quarkiverse.renarde.htmx

Class HxController

java.lang.Object

io.quarkiverse.renarde.Controller

io.quarkiverse.renarde.htmx.HxController

public abstract class HxController
extends Controller

This is a Controller's overlay to simplify usage of Quarkus Renarde alongside .

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HxController.HxRequestHeader
static enum	HxController.HxResponseHeader

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.ws.rs.core.HttpHeaders	httpHeaders
static final String	HX_REQUEST_HEADER
protected io.vertx.core.http.HttpServerResponse	response

Fields inherited from class io.quarkiverse.renarde.Controller

flash, i18n, identity, renderArgs, uriInfo, validation

Constructor Summary

Constructors

Constructor	Description
HxController()

Method Summary

Modifier and Type	Method	Description
protected void	beforeRedirect()	This hook is called before any redirects caused by calls to controller public methods, including redirect(FooController.class).method().
static io.quarkus.qute.TemplateInstance	concatTemplates(io.quarkus.qute.TemplateInstance... templates)	This Qute helper make it easy to achieve htmx "Out of Band" swap by choosing which templates to return (refresh).
protected void	flashHxRequest()	Keep the htmx flag for the redirect request.
protected String	hx(HxController.HxRequestHeader header)
protected void	hx(HxController.HxResponseHeader hxHeader, String value)	Helper to define htmx response headers.
protected boolean	isHxRequest()	Check if this request has the htmx flag (header or flash data)
protected void	onlyHxRequest()	Make sure only htmx requests are calling this method.

Methods inherited from class io.quarkiverse.renarde.Controller

badRequest, emptyAsNull, flash, forbidden, forbidden, notFound, notFound, notFoundIfNull, prepareForErrorRedirect, redirect, seeOther, seeOther, temporaryRedirect, validationFailed

Methods inherited from class java.lang.Object

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

Field Details

HX_REQUEST_HEADER

public static final String HX_REQUEST_HEADER

See Also:

• Constant Field Values

httpHeaders

@Inject
protected jakarta.ws.rs.core.HttpHeaders httpHeaders

response

@Inject
protected io.vertx.core.http.HttpServerResponse response

Constructor Details

HxController

public HxController()

Method Details

concatTemplates

public static io.quarkus.qute.TemplateInstance concatTemplates(io.quarkus.qute.TemplateInstance... templates)

This Qute helper make it easy to achieve htmx "Out of Band" swap by choosing which templates to return (refresh).

Parameters:

templates - the list of template instances to concatenate

Returns:

the concatenated templates instances

isHxRequest

protected boolean isHxRequest()

Check if this request has the htmx flag (header or flash data)

hx

protected void hx(HxController.HxResponseHeader hxHeader,
 String value)

Helper to define htmx response headers.

Parameters:

hxHeader - the HxController.HxResponseHeader to define

value - the value for this header

hx

protected String hx(HxController.HxRequestHeader header)

onlyHxRequest

protected void onlyHxRequest()

Make sure only htmx requests are calling this method.

flashHxRequest

protected void flashHxRequest()

Keep the htmx flag for the redirect request. This is automatic.

beforeRedirect

protected void beforeRedirect()

Description copied from class: Controller

This hook is called before any redirects caused by calls to controller public methods, including redirect(FooController.class).method().

Overrides:

beforeRedirect in class Controller