Package io.jmix.flowui.view.navigation

Class ViewNavigator

java.lang.Object

io.jmix.flowui.view.navigation.AbstractViewNavigator

io.jmix.flowui.view.navigation.ViewNavigator

Direct Known Subclasses:

ViewClassNavigator

public class ViewNavigator
extends AbstractViewNavigator

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

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

Field Summary

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

backwardNavigation, handler, origin, queryParameters, routeParameters, viewId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ViewNavigator(ViewNavigator viewNavigator)
	ViewNavigator(View<?> origin, Consumer<? extends ViewNavigator> handler)
	ViewNavigator(Consumer<? extends ViewNavigator> handler)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
ViewNavigator	withBackwardNavigation(boolean backwardNavigation)	Sets whether the current URL should be navigated to when the opened view is closed.
ViewNavigator	withQueryParameters(com.vaadin.flow.router.QueryParameters queryParameters)	Sets URL query parameters.
ViewNavigator	withRouteParameters(com.vaadin.flow.router.RouteParameters routeParameters)	Sets URL route parameters.
<V extends View<?>> ViewClassNavigator<V>	withViewClass(Class<V> viewClass)	Sets the opened view by its class.
ViewNavigator	withViewId(String viewId)	Sets the opened view by id.

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

getOrigin, getQueryParameters, getRouteParameters, getViewClass, getViewId, isBackwardNavigation, navigate

Methods inherited from class java.lang.Object

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

Constructor Details

ViewNavigator

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

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

ViewNavigator

public ViewNavigator(View<?> origin,
 Consumer<? extends ViewNavigator> handler)

ViewNavigator

protected ViewNavigator(ViewNavigator viewNavigator)

Method Details

withViewId

public ViewNavigator withViewId(@Nullable
 String viewId)

Description copied from class: AbstractViewNavigator

Sets the opened view by id.

Overrides:

withViewId in class AbstractViewNavigator

Parameters:

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

Returns:

this instance for chaining

withViewClass

public <V extends View<?>> ViewClassNavigator<V> withViewClass(Class<V> viewClass)

Sets the opened view by its class.

Parameters:

viewClass - view class

Returns:

this instance for chaining

withRouteParameters

public ViewNavigator withRouteParameters(@Nullable
 com.vaadin.flow.router.RouteParameters routeParameters)

Description copied from class: AbstractViewNavigator

Sets URL route parameters.

Overrides:

withRouteParameters in class AbstractViewNavigator

Parameters:

routeParameters - route parameters

Returns:

this instance for chaining

withQueryParameters

public ViewNavigator withQueryParameters(@Nullable
 com.vaadin.flow.router.QueryParameters queryParameters)

Description copied from class: AbstractViewNavigator

Sets URL query parameters.

Overrides:

withQueryParameters in class AbstractViewNavigator

Parameters:

queryParameters - query parameters

Returns:

this instance for chaining

withBackwardNavigation

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

Parameters:

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

Returns:

this instance for chaining