io.jmix.ui.component

Class PaginationComponent.BeforeRefreshEvent

java.lang.Object

java.util.EventObject

io.jmix.ui.component.PaginationComponent.BeforeRefreshEvent

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

PaginationComponent

public static class PaginationComponent.BeforeRefreshEvent
extends java.util.EventObject

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:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	refreshPrevented

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
BeforeRefreshEvent(PaginationComponent source)

Method Summary

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

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 Detail

refreshPrevented

protected boolean refreshPrevented

Constructor Detail

BeforeRefreshEvent

public BeforeRefreshEvent(PaginationComponent source)

Method Detail

getSource

public PaginationComponent getSource()

Overrides:

getSource in class java.util.EventObject

preventRefresh

public void preventRefresh()

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

isRefreshPrevented

public boolean isRefreshPrevented()