Package io.jmix.flowui.view.navigation

Class ListViewNavigator<E>

java.lang.Object

io.jmix.flowui.view.navigation.AbstractViewNavigator

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

Direct Known Subclasses:

ListViewClassNavigator

public class ListViewNavigator<E>
extends AbstractViewNavigator

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

An instance of this class should be obtained through ViewNavigators.listView(View, Class).

Field Summary

Fields

Modifier and Type	Field	Description
protected final Class<E>	entityClass

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

backwardNavigation, handler, origin, queryParameters, routeParameters, viewId

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Class<E>	getEntityClass()
ListViewNavigator<E>	withBackwardNavigation(boolean backwardNavigation)	Sets whether the current URL should be navigated to when the opened view is closed.
ListViewNavigator<E>	withQueryParameters(com.vaadin.flow.router.QueryParameters queryParameters)	Sets URL query parameters.
ListViewNavigator<E>	withRouteParameters(com.vaadin.flow.router.RouteParameters routeParameters)	Sets URL route parameters.
<V extends View<?>> ListViewClassNavigator<E,V>	withViewClass(Class<V> viewClass)	Sets the opened view by its class.
ListViewNavigator<E>	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

Field Details

entityClass

protected final Class<E> entityClass

Constructor Details

ListViewNavigator

@Deprecated(since="2.3",
            forRemoval=true)
public ListViewNavigator(Class<E> entityClass,
 Consumer<? extends ListViewNavigator<E>> handler)

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

ListViewNavigator

public ListViewNavigator(View<?> origin,
 Class<E> entityClass,
 Consumer<? extends ListViewNavigator<E>> handler)

ListViewNavigator

protected ListViewNavigator(ListViewNavigator<E> viewNavigator)

Method Details

withViewId

public ListViewNavigator<E> 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<?>>
ListViewClassNavigator<E,V> withViewClass(Class<V> viewClass)

Sets the opened view by its class.

Parameters:

viewClass - view class

Returns:

this instance for chaining

withRouteParameters

public ListViewNavigator<E> 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 ListViewNavigator<E> 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 ListViewNavigator<E> 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

getEntityClass

public Class<E> getEntityClass()

Returns:

entity class of the list view