Package io.jmix.flowui.facet.urlqueryparameters

Class PaginationUrlQueryParametersBinderProvider

java.lang.Object

io.jmix.flowui.facet.urlqueryparameters.AbstractUrlQueryParametersBinderProvider

io.jmix.flowui.facet.urlqueryparameters.PaginationUrlQueryParametersBinderProvider

All Implemented Interfaces:

UrlQueryParametersBinderProvider

@Component("flowui_PaginationUrlQueryParametersBinderProvider")
public class PaginationUrlQueryParametersBinderProvider
extends AbstractUrlQueryParametersBinderProvider

Provides a binder implementation for URL query parameters specifically designed for pagination components. Binds URL query parameter values to a pagination component's state and vice versa.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaginationUrlQueryParametersBinderProvider.PaginationQueryParametersBinderInitTask	A task that initializes and registers a PaginationUrlQueryParametersBinder for components capable of handling pagination behavior.

Field Summary

Fields inherited from class io.jmix.flowui.facet.urlqueryparameters.AbstractUrlQueryParametersBinderProvider

loaderSupport, urlParamSerializer

Constructor Summary

Constructors

Constructor	Description
PaginationUrlQueryParametersBinderProvider(UrlParamSerializer urlParamSerializer, LoaderSupport loaderSupport)

Method Summary

Modifier and Type	Method	Description
void	load(UrlQueryParametersFacet facet, org.dom4j.Element element, ComponentLoader.ComponentContext context)	Loads parameters from XML to create a binder that binds the parameters of the URL query and the state of the component.
boolean	supports(org.dom4j.Element element)	Checks whether the provided element can be loaded by provider.

Methods inherited from class io.jmix.flowui.facet.urlqueryparameters.AbstractUrlQueryParametersBinderProvider

loadAttribute, loadRequiredAttribute

Methods inherited from class java.lang.Object

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

Constructor Details

PaginationUrlQueryParametersBinderProvider

public PaginationUrlQueryParametersBinderProvider(UrlParamSerializer urlParamSerializer,
 LoaderSupport loaderSupport)

Method Details

supports

public boolean supports(org.dom4j.Element element)

Description copied from interface: UrlQueryParametersBinderProvider

Checks whether the provided element can be loaded by provider.

Parameters:

element - element to check

Returns:

true if element is supported

load

public void load(UrlQueryParametersFacet facet,
 org.dom4j.Element element,
 ComponentLoader.ComponentContext context)

Description copied from interface: UrlQueryParametersBinderProvider

Loads parameters from XML to create a binder that binds the parameters of the URL query and the state of the component.

See example: PaginationUrlQueryParametersBinderProvider.

Parameters:

facet - the facet

element - element to load

context - loader context