Package io.jmix.flowui.view.navigation

Class ListViewClassNavigator<E,V extends View<?>>

java.lang.Object

io.jmix.flowui.view.navigation.AbstractViewNavigator

io.jmix.flowui.view.navigation.ListViewNavigator<E>

io.jmix.flowui.view.navigation.ListViewClassNavigator<E,V>

Type Parameters:

E - the type of the entity managed by the list view

V - the type of the view being navigated to, which extends View

All Implemented Interfaces:

SupportsAfterViewNavigationHandler<V>

public class ListViewClassNavigator<E,V extends View<?>>
extends ListViewNavigator<E>
implements SupportsAfterViewNavigationHandler<V>

Facilitates navigation to a detail view of a specific type with additional configuration options. This class extends ListViewNavigator to provide the ability to specify a particular view class and handle additional navigation scenarios like executing a callback after successful navigation to a view.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.flowui.view.navigation.SupportsAfterViewNavigationHandler

SupportsAfterViewNavigationHandler.AfterViewNavigationEvent<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<SupportsAfterViewNavigationHandler.AfterViewNavigationEvent<V>>	afterNavigationHandler
protected Class<V>	viewClass

Fields inherited from class io.jmix.flowui.view.navigation.ListViewNavigator

entityClass

Fields inherited from class io.jmix.flowui.view.navigation.AbstractViewNavigator

backwardNavigation, handler, origin, queryParameters, routeParameters, viewId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ListViewClassNavigator(ListViewNavigator<E> viewNavigator, Class<V> viewClass)
	ListViewClassNavigator(View<?> origin, Class<E> entityClass, Consumer<? extends ListViewNavigator<E>> handler, Class<V> viewClass)
	ListViewClassNavigator(Class<E> entityClass, Consumer<? extends ListViewNavigator<E>> handler, Class<V> viewClass)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
Optional<Consumer<SupportsAfterViewNavigationHandler.AfterViewNavigationEvent<V>>>	getAfterNavigationHandler()
Optional<Class<? extends View>>	getViewClass()
ListViewClassNavigator<E,V>	withAfterNavigationHandler(Consumer<SupportsAfterViewNavigationHandler.AfterViewNavigationEvent<V>> handler)	Adds a handler that will be invoked if navigation to a view actually happened.

Methods inherited from class io.jmix.flowui.view.navigation.ListViewNavigator

getEntityClass, withBackwardNavigation, withQueryParameters, withRouteParameters, withViewClass, withViewId

Methods inherited from class io.jmix.flowui.view.navigation.AbstractViewNavigator

getOrigin, getQueryParameters, getRouteParameters, getViewId, isBackwardNavigation, navigate

Methods inherited from class java.lang.Object

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

Field Details

viewClass

protected Class<V extends View<?>> viewClass

afterNavigationHandler

protected Consumer<SupportsAfterViewNavigationHandler.AfterViewNavigationEvent<V extends View<?>>> afterNavigationHandler

Constructor Details

ListViewClassNavigator

@Deprecated(since="2.3",
            forRemoval=true)
public ListViewClassNavigator(Class<E> entityClass,
 Consumer<? extends ListViewNavigator<E>> handler,
 Class<V> viewClass)

Deprecated, for removal: This API element is subject to removal in a future version.

ListViewClassNavigator

public ListViewClassNavigator(View<?> origin,
 Class<E> entityClass,
 Consumer<? extends ListViewNavigator<E>> handler,
 Class<V> viewClass)

ListViewClassNavigator

protected ListViewClassNavigator(ListViewNavigator<E> viewNavigator,
 Class<V> viewClass)

Method Details

withAfterNavigationHandler

public ListViewClassNavigator<E,V> withAfterNavigationHandler(Consumer<SupportsAfterViewNavigationHandler.AfterViewNavigationEvent<V>> handler)

Adds a handler that will be invoked if navigation to a view actually happened.

Note: this handler is invoked after all lifecycle events of a view.

Example of setting a custom parameter to a view:

     viewNavigators.listView(Foo.class)
         .withViewClass(FooListView.class)
         .withAfterNavigationHandler(navigationEvent -> {
             FooListView view = navigationEvent.getView();
             view.setBar("bar");
         }).navigate();
 

Parameters:

handler - a handler to set

Returns:

this instance for chaining

getAfterNavigationHandler

public Optional<Consumer<SupportsAfterViewNavigationHandler.AfterViewNavigationEvent<V>>> getAfterNavigationHandler()

Specified by:

getAfterNavigationHandler in interface SupportsAfterViewNavigationHandler<E>

Returns:

a handler that must be called if navigation to a view actually happened

getViewClass

public Optional<Class<? extends View>> getViewClass()

Overrides:

getViewClass in class AbstractViewNavigator

Returns:

opened view class