Package io.jmix.flowui.component

Class PaginationComponent.BeforeRefreshEvent<T extends AbstractPagination>

java.lang.Object

java.util.EventObject

com.vaadin.flow.component.ComponentEvent<T>

io.jmix.flowui.component.PaginationComponent.BeforeRefreshEvent<T>

All Implemented Interfaces:

Serializable

Enclosing interface:

PaginationComponent<T extends AbstractPagination>

public static class PaginationComponent.BeforeRefreshEvent<T extends AbstractPagination>
extends com.vaadin.flow.component.ComponentEvent<T>

The event that is fired before refreshing the data, when the user clicks next, previous, etc.
You can prevent the data container refresh by invoking preventRefresh(), for example:

 pagination.addBeforeRefreshListener(refreshEvent -> {
     // check modified data and prevent refresh
     refreshEvent.preventRefresh();
 });
 

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	refreshPrevented

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
BeforeRefreshEvent(T source)

Method Summary

Modifier and Type	Method	Description
boolean	isRefreshPrevented()
void	preventRefresh()	If invoked, the component will not refresh the data container.

Methods inherited from class com.vaadin.flow.component.ComponentEvent

getSource, isFromClient, unregisterListener

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Field Details

refreshPrevented

protected boolean refreshPrevented

Constructor Details

BeforeRefreshEvent

public BeforeRefreshEvent(T source)

Method Details

preventRefresh

public void preventRefresh()

If invoked, the component will not refresh the data container.

isRefreshPrevented

public boolean isRefreshPrevented()

Returns:

true if data refresh is prevented