Package io.jmix.flowui.view.navigation

Class AbstractViewNavigator

java.lang.Object

io.jmix.flowui.view.navigation.AbstractViewNavigator

Direct Known Subclasses:

DetailViewNavigator, ListViewNavigator, ViewNavigator

public abstract class AbstractViewNavigator
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).

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
View<?>	getOrigin()
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).
AbstractViewNavigator	withBackwardNavigation(boolean backwardNavigation)	Sets whether the current URL should be navigated to when the opened view is closed.
AbstractViewNavigator	withQueryParameters(com.vaadin.flow.router.QueryParameters queryParameters)	Sets URL query parameters.
AbstractViewNavigator	withRouteParameters(com.vaadin.flow.router.RouteParameters routeParameters)	Sets URL route parameters.
AbstractViewNavigator	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

origin

protected final View<?> origin

handler

protected final Consumer<? extends AbstractViewNavigator> handler

viewId

protected String viewId

routeParameters

protected com.vaadin.flow.router.RouteParameters routeParameters

queryParameters

protected com.vaadin.flow.router.QueryParameters queryParameters

backwardNavigation

protected boolean backwardNavigation

Constructor Details

AbstractViewNavigator

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

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

AbstractViewNavigator

protected AbstractViewNavigator(View<?> origin,
 Consumer<? extends AbstractViewNavigator> handler)

AbstractViewNavigator

protected AbstractViewNavigator(AbstractViewNavigator viewNavigator)

Method Details

getOrigin

public View<?> getOrigin()

Returns:

invoking view

withViewId

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

withRouteParameters

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

Sets URL route parameters.

Parameters:

routeParameters - route parameters

Returns:

this instance for chaining

withQueryParameters

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

Sets URL query parameters.

Parameters:

queryParameters - query parameters

Returns:

this instance for chaining

withBackwardNavigation

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