Package io.jmix.flowui.view.navigation

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

java.lang.Object

io.jmix.flowui.view.navigation.AbstractViewNavigator

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

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

Type Parameters:

E - the type of the entity shown by the view

V - the type of the view being navigated to

All Implemented Interfaces:

SupportsAfterViewNavigationHandler<V>

@NullMarked
public class ReadViewClassNavigator<E,V extends View<?>>
extends ReadViewNavigator<E>
implements SupportsAfterViewNavigationHandler<V>

Facilitates navigation to a read view of a specific type with additional configuration options. This class extends ReadViewNavigator to provide the ability to specify a particular view class and to handle 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 @Nullable Consumer<SupportsAfterViewNavigationHandler.AfterViewNavigationEvent<V>>	afterNavigationHandler
protected Class<V>	viewClass

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

entity, entityClass

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

backwardNavigation, handler, origin, queryParameters, routeParameters, viewId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReadViewClassNavigator(ReadViewNavigator<E> viewNavigator, Class<V> viewClass)
	ReadViewClassNavigator(View<?> origin, Class<E> entityClass, Consumer<? extends ReadViewNavigator<E>> handler, Class<V> viewClass)

Method Summary

Modifier and Type	Method	Description
Optional<Consumer<SupportsAfterViewNavigationHandler.AfterViewNavigationEvent<V>>>	getAfterNavigationHandler()
Optional<Class<? extends View>>	getViewClass()
ReadViewClassNavigator<E,V>	readEntity(E entity)	Sets the entity instance to show.
ReadViewClassNavigator<E,V>	withAfterNavigationHandler(Consumer<SupportsAfterViewNavigationHandler.AfterViewNavigationEvent<V>> handler)	Adds a handler that will be invoked if navigation to a view actually happened.
ReadViewClassNavigator<E,V>	withBackwardNavigation(boolean backwardNavigation)	Sets whether the current URL should be navigated to when the opened view is closed.
ReadViewClassNavigator<E,V>	withQueryParameters(@Nullable com.vaadin.flow.router.QueryParameters queryParameters)	Sets URL query parameters.
ReadViewClassNavigator<E,V>	withRouteParameters(@Nullable com.vaadin.flow.router.RouteParameters routeParameters)	Sets URL route parameters.
ReadViewClassNavigator<E,V>	withViewId(@Nullable String viewId)	Sets the opened view by id.

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

getEntity, getEntityClass, withViewClass

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 @Nullable Consumer<SupportsAfterViewNavigationHandler.AfterViewNavigationEvent<V extends View<?>>> afterNavigationHandler

Constructor Details

ReadViewClassNavigator

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

ReadViewClassNavigator

protected ReadViewClassNavigator(ReadViewNavigator<E> viewNavigator,
 Class<V> viewClass)

Method Details

readEntity

public ReadViewClassNavigator<E,V> readEntity(E entity)

Description copied from class: ReadViewNavigator

Sets the entity instance to show.

Overrides:

readEntity in class ReadViewNavigator<E>

Parameters:

entity - entity instance to show

Returns:

this instance for chaining

withViewId

public ReadViewClassNavigator<E,V> withViewId(@Nullable String viewId)

Description copied from class: AbstractViewNavigator

Sets the opened view by id.

Overrides:

withViewId in class ReadViewNavigator<E>

Parameters:

viewId - identifier of the view as specified in the ViewController annotation

Returns:

this instance for chaining

withRouteParameters

public ReadViewClassNavigator<E,V> withRouteParameters(@Nullable com.vaadin.flow.router.RouteParameters routeParameters)

Description copied from class: AbstractViewNavigator

Sets URL route parameters.

Overrides:

withRouteParameters in class ReadViewNavigator<E>

Parameters:

routeParameters - route parameters

Returns:

this instance for chaining

withQueryParameters

public ReadViewClassNavigator<E,V> withQueryParameters(@Nullable com.vaadin.flow.router.QueryParameters queryParameters)

Description copied from class: AbstractViewNavigator

Sets URL query parameters.

Overrides:

withQueryParameters in class ReadViewNavigator<E>

Parameters:

queryParameters - query parameters

Returns:

this instance for chaining

withBackwardNavigation

public ReadViewClassNavigator<E,V> withBackwardNavigation(boolean backwardNavigation)

Description copied from class: AbstractViewNavigator

Sets whether the current URL should be navigated to when the opened view is closed.

Overrides:

withBackwardNavigation in class ReadViewNavigator<E>

Parameters:

backwardNavigation - whether the current URL should be registered for backward navigation

Returns:

this instance for chaining

withAfterNavigationHandler

public ReadViewClassNavigator<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.

     viewNavigators.readView(Foo.class)
         .readEntity(someFoo)
         .withViewClass(FooReadView.class)
         .withAfterNavigationHandler(navigationEvent -> {
             FooReadView 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