de.ipcon.form

Class AutoRefreshHandler

java.lang.Object

de.ipcon.form.AutoRefreshHandler

All Implemented Interfaces:

DBManEventListenerI

public class AutoRefreshHandler
extends java.lang.Object
implements DBManEventListenerI

helper class that encapsulates the autoRefresh functionality of FElements

Field Summary

Fields inherited from interface de.ipcon.db.event.DBManEventListenerI

$0

Constructor Summary

Constructors

Constructor and Description
AutoRefreshHandler(FormElementI formElement, java.util.Set<java.lang.Class<? extends BO>> eventFilterClasses, java.util.function.Predicate<java.util.Collection<java.lang.Long>> relevanceFilter) Creates a new autoRefresh Handler for the provided form element.

Method Summary

Modifier and Type	Method and Description
boolean	isAutoRefreshEnabled()
void	processDBManEvent(DBManEvent event) Invoked when a subscribed DBManEvent occurs.
void	setAutoRefresh(boolean enabled)

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoRefreshHandler

public AutoRefreshHandler(FormElementI formElement,
                          java.util.Set<java.lang.Class<? extends BO>> eventFilterClasses,
                          java.util.function.Predicate<java.util.Collection<java.lang.Long>> relevanceFilter)

Creates a new autoRefresh Handler for the provided form element. use this#setAutoRefresh(boolean) to subscribe to db man events.

Parameters:

formElement - the form element which should be automatically refreshed on incoming changes. From it, the form and client context are derived and used as needed.

eventFilterClasses - the classes by which db man events should be filtered. To prevent performance issues, filter classes must be provided

relevanceFilter - generic filter function that receives the Ids of the event BOs for checking if the received instances are truly relevant. Please note that newly created objects of the filter class type(s) are always considered relevant.

Method Detail

processDBManEvent

public void processDBManEvent(DBManEvent event)

Description copied from interface: DBManEventListenerI

Invoked when a subscribed DBManEvent occurs. See DBManBOChangeEvent for events triggered after modification on BOs.

Specified by:

processDBManEvent in interface DBManEventListenerI

setAutoRefresh

public void setAutoRefresh(boolean enabled)

isAutoRefreshEnabled

public boolean isAutoRefreshEnabled()