Package io.jmix.flowui.view.navigation

Class ViewClassNavigator<V extends View<?>>

java.lang.Object

io.jmix.flowui.view.navigation.AbstractViewNavigator

io.jmix.flowui.view.navigation.ViewNavigator

io.jmix.flowui.view.navigation.ViewClassNavigator<V>

All Implemented Interfaces:

SupportsAfterViewNavigationHandler<V>

public class ViewClassNavigator<V extends View<?>>
extends ViewNavigator
implements SupportsAfterViewNavigationHandler<V>

Provides a fluent interface to configure navigation parameters and navigate to a View.

An instance of this class should be obtained through ViewNavigators.view(Class).

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.AbstractViewNavigator

backwardNavigation, handler, origin, queryParameters, routeParameters, viewId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ViewClassNavigator(ViewNavigator viewNavigator, Class<V> viewClass)
	ViewClassNavigator(View<?> origin, Consumer<? extends ViewNavigator> handler, Class<V> viewClass)
	ViewClassNavigator(Consumer<? extends ViewNavigator> 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()
ViewClassNavigator<V>	withAfterNavigationHandler(Consumer<SupportsAfterViewNavigationHandler.AfterViewNavigationEvent<V>> handler)	Adds a handler that will be invoked if navigation to a view actually happened.
ViewClassNavigator<V>	withBackwardNavigation(boolean backwardNavigation)	Sets whether the current URL should be navigated to when the opened view is closed.
ViewClassNavigator<V>	withQueryParameters(com.vaadin.flow.router.QueryParameters queryParameters)	Sets URL query parameters.
ViewClassNavigator<V>	withRouteParameters(com.vaadin.flow.router.RouteParameters routeParameters)	Sets URL route parameters.
ViewClassNavigator<V>	withViewId(String viewId)	Sets the opened view by id.

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

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

Constructor Details

ViewClassNavigator

@Deprecated(since="2.3",
            forRemoval=true)
public ViewClassNavigator(Consumer<? extends ViewNavigator> handler,
 Class<V> viewClass)

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

ViewClassNavigator

public ViewClassNavigator(View<?> origin,
 Consumer<? extends ViewNavigator> handler,
 Class<V> viewClass)

ViewClassNavigator

protected ViewClassNavigator(ViewNavigator viewNavigator,
 Class<V> viewClass)

Method Details

withViewId

public ViewClassNavigator<V> withViewId(@Nullable
 String viewId)

Description copied from class: AbstractViewNavigator

Sets the opened view by id.

Overrides:

withViewId in class ViewNavigator

Parameters:

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

Returns:

this instance for chaining

withRouteParameters

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

Description copied from class: AbstractViewNavigator

Sets URL route parameters.

Overrides:

withRouteParameters in class ViewNavigator

Parameters:

routeParameters - route parameters

Returns:

this instance for chaining

withQueryParameters

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

Description copied from class: AbstractViewNavigator

Sets URL query parameters.

Overrides:

withQueryParameters in class ViewNavigator

Parameters:

queryParameters - query parameters

Returns:

this instance for chaining

withBackwardNavigation

public ViewClassNavigator<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 ViewNavigator

Parameters:

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

Returns:

this instance for chaining

withAfterNavigationHandler

public ViewClassNavigator<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.view(FooView.class)
         .withAfterNavigationHandler(navigationEvent -> {
             FooView 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<V extends View<?>>

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