io.jmix.ui.model

Class KeyValueCollectionLoader.PreLoadEvent

java.lang.Object

java.util.EventObject

io.jmix.ui.model.KeyValueCollectionLoader.PreLoadEvent

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

KeyValueCollectionLoader

public static class KeyValueCollectionLoader.PreLoadEvent
extends java.util.EventObject

Event sent before loading entities.

You can prevent load using the preventLoad() method of the event, for example:

     @Subscribe(id = "fooDl", target = Target.DATA_LOADER)
     private void onFooDlPreLoad(KeyValueCollectionLoader.PreLoadEvent event) {
         if (doNotLoad()) {
             event.preventLoad();
         }
     }
 

See Also:

KeyValueCollectionLoader.addPreLoadListener(Consumer), Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
PreLoadEvent(KeyValueCollectionLoader loader, io.jmix.core.ValueLoadContext loadContext)

Method Summary

Modifier and Type	Method and Description
io.jmix.core.ValueLoadContext	getLoadContext() Returns the load context of the current data loader.
KeyValueCollectionLoader	getSource() The data loader which sent the event.
boolean	isLoadPrevented() Returns true if preventLoad() method was called and loading will be aborted.
void	preventLoad() Invoke this method if you want to abort the loading.

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

Constructor Detail

PreLoadEvent

public PreLoadEvent(KeyValueCollectionLoader loader,
                    io.jmix.core.ValueLoadContext loadContext)

Method Detail

getSource

public KeyValueCollectionLoader getSource()

The data loader which sent the event.

Overrides:

getSource in class java.util.EventObject

getLoadContext

public io.jmix.core.ValueLoadContext getLoadContext()

Returns the load context of the current data loader.

preventLoad

public void preventLoad()

Invoke this method if you want to abort the loading.

isLoadPrevented

public boolean isLoadPrevented()

Returns true if preventLoad() method was called and loading will be aborted.