Package io.jmix.flowui.facet.urlqueryparameters

Class PaginationUrlQueryParametersBinder

java.lang.Object

io.jmix.flowui.facet.urlqueryparameters.AbstractUrlQueryParametersBinder

io.jmix.flowui.facet.urlqueryparameters.PaginationUrlQueryParametersBinder

All Implemented Interfaces:

HasInitialState, UrlQueryParametersFacet.Binder

public class PaginationUrlQueryParametersBinder
extends AbstractUrlQueryParametersBinder
implements HasInitialState

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	PaginationUrlQueryParametersBinder.InitialState	A POJO class for storing properties of the PaginationComponent's initial state.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIRST_RESULT_PARAM
protected String	firstResultParam
protected PaginationUrlQueryParametersBinder.InitialState	initialState
static final String	MAX_RESULTS_PARAM
protected String	maxResultsParam
static final String	NAME
protected PaginationComponent<?>	pagination
protected UrlParamSerializer	urlParamSerializer

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

id

Constructor Summary

Constructors

Constructor	Description
PaginationUrlQueryParametersBinder(PaginationComponent<?> pagination, UrlParamSerializer urlParamSerializer)

Method Summary

Modifier and Type	Method	Description
void	applyInitialState()	Restores the component to its initial state.
com.vaadin.flow.component.Component	getComponent()
String	getFirstResultParam()
String	getMaxResultsParam()
protected Optional<PaginationDataLoader>	getPaginationLoader()
protected void	initComponent(PaginationComponent<?> pagination)
protected void	onAfterRefresh(PaginationComponent.AfterRefreshEvent<?> event)
void	saveInitialState()	Saves component's initial state.
com.google.common.collect.ImmutableMap<String,String>	serializeQueryParameters(PaginationDataLoader paginationLoader)
void	setFirstResultParam(String firstResultParam)
void	setMaxResultsParam(String maxResultsParam)
void	updateState(com.vaadin.flow.router.QueryParameters queryParameters)	Informs query parameters binder that view query parameters has been changed.

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

addUrlQueryParametersChangeListener, fireQueryParametersChanged, getEventBus, getId, setId

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

FIRST_RESULT_PARAM

public static final String FIRST_RESULT_PARAM

See Also:

• Constant Field Values

MAX_RESULTS_PARAM

public static final String MAX_RESULTS_PARAM

See Also:

• Constant Field Values

pagination

protected PaginationComponent<?> pagination

firstResultParam

protected String firstResultParam

maxResultsParam

protected String maxResultsParam

initialState

protected PaginationUrlQueryParametersBinder.InitialState initialState

urlParamSerializer

protected UrlParamSerializer urlParamSerializer

Constructor Details

PaginationUrlQueryParametersBinder

public PaginationUrlQueryParametersBinder(PaginationComponent<?> pagination,
 UrlParamSerializer urlParamSerializer)

Method Details

initComponent

protected void initComponent(PaginationComponent<?> pagination)

saveInitialState

public void saveInitialState()

Description copied from interface: HasInitialState

Saves component's initial state.

Specified by:

saveInitialState in interface HasInitialState

onAfterRefresh

protected void onAfterRefresh(PaginationComponent.AfterRefreshEvent<?> event)

serializeQueryParameters

public com.google.common.collect.ImmutableMap<String,String> serializeQueryParameters(PaginationDataLoader paginationLoader)

applyInitialState

public void applyInitialState()

Description copied from interface: HasInitialState

Restores the component to its initial state.

Specified by:

applyInitialState in interface HasInitialState

updateState

public void updateState(com.vaadin.flow.router.QueryParameters queryParameters)

Description copied from interface: UrlQueryParametersFacet.Binder

Informs query parameters binder that view query parameters has been changed.

Specified by:

updateState in interface UrlQueryParametersFacet.Binder

Parameters:

queryParameters - a view query parameters

getFirstResultParam

public String getFirstResultParam()

setFirstResultParam

public void setFirstResultParam(@Nullable
 String firstResultParam)

getMaxResultsParam

public String getMaxResultsParam()

setMaxResultsParam

public void setMaxResultsParam(@Nullable
 String maxResultsParam)

getPaginationLoader

protected Optional<PaginationDataLoader> getPaginationLoader()

getComponent

@Nullable
public com.vaadin.flow.component.Component getComponent()

Specified by:

getComponent in class AbstractUrlQueryParametersBinder