Package io.jmix.flowui.view.navigation

Class ViewNavigator

java.lang.Object

io.jmix.flowui.view.navigation.ViewNavigator

Direct Known Subclasses:

DetailViewNavigator, ListViewNavigator

public class ViewNavigator
extends Object

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) or ViewNavigators.view(Class).

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	backwardNavigation
protected final Consumer<ViewNavigator>	handler
protected com.vaadin.flow.router.QueryParameters	queryParameters
protected com.vaadin.flow.router.RouteParameters	routeParameters
protected Class<? extends View>	viewClass
protected String	viewId

Constructor Summary

Constructors

Constructor	Description
ViewNavigator(Consumer<? extends ViewNavigator> handler)

Method Summary

Modifier and Type	Method	Description
Optional<com.vaadin.flow.router.QueryParameters>	getQueryParameters()
Optional<com.vaadin.flow.router.RouteParameters>	getRouteParameters()
Optional<Class<? extends View>>	getViewClass()
Optional<String>	getViewId()
boolean	isBackwardNavigation()
void	navigate()	Perform navigation to the view configured using withViewId(String) or withViewClass(Class).
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.
ViewNavigator	withViewClass(Class<? extends View> viewClass)	Sets the opened view by its class.
ViewNavigator	withViewId(String viewId)	Sets the opened view by id.

Methods inherited from class java.lang.Object

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

Field Details

handler

protected final Consumer<ViewNavigator> handler

viewId

protected String viewId

viewClass

protected Class<? extends View> viewClass

routeParameters

protected com.vaadin.flow.router.RouteParameters routeParameters

queryParameters

protected com.vaadin.flow.router.QueryParameters queryParameters

backwardNavigation

protected boolean backwardNavigation

Constructor Details

ViewNavigator

public ViewNavigator(Consumer<? extends ViewNavigator> handler)

Method Details

withViewId

public ViewNavigator withViewId(@Nullable
 String viewId)

Sets the opened view by id.

Parameters:

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

Returns:

this instance for chaining

withViewClass

public ViewNavigator withViewClass(@Nullable
 Class<? extends View> 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)

Sets URL route parameters.

Parameters:

routeParameters - route parameters

Returns:

this instance for chaining

withQueryParameters

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

Sets URL query parameters.

Parameters:

queryParameters - query parameters

Returns:

this instance for chaining

withBackwardNavigation

public ViewNavigator withBackwardNavigation(boolean backwardNavigation)

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

Parameters:

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

Returns:

this instance for chaining

getViewId

public Optional<String> getViewId()

Returns:

identifier of the opened view as specified in the ViewController annotation

getViewClass

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

Returns:

opened view class

getRouteParameters

public Optional<com.vaadin.flow.router.RouteParameters> getRouteParameters()

Returns:

URL route parameters

getQueryParameters

public Optional<com.vaadin.flow.router.QueryParameters> getQueryParameters()

Returns:

URL query parameters

isBackwardNavigation

public boolean isBackwardNavigation()

Returns:

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

navigate

public void navigate()

Perform navigation to the view configured using withViewId(String) or withViewClass(Class).