Class ListViewNavigator<E>

java.lang.Object
io.jmix.flowui.view.navigation.ViewNavigator
io.jmix.flowui.view.navigation.ListViewNavigator<E>

public class ListViewNavigator<E> extends ViewNavigator
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(Class).

  • Field Details

    • entityClass

      protected final Class<E> entityClass
  • Constructor Details

  • Method Details

    • withViewId

      public ListViewNavigator<E> withViewId(@Nullable String viewId)
      Description copied from class: ViewNavigator
      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
    • withViewClass

      public ListViewNavigator<E> withViewClass(@Nullable Class<? extends View> viewClass)
      Description copied from class: ViewNavigator
      Sets the opened view by its class.
      Overrides:
      withViewClass in class ViewNavigator
      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: ViewNavigator
      Sets URL route parameters.
      Overrides:
      withRouteParameters in class ViewNavigator
      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: ViewNavigator
      Sets URL query parameters.
      Overrides:
      withQueryParameters in class ViewNavigator
      Parameters:
      queryParameters - query parameters
      Returns:
      this instance for chaining
    • withBackwardNavigation

      public ListViewNavigator<E> withBackwardNavigation(boolean backwardNavigation)
      Description copied from class: ViewNavigator
      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
    • getEntityClass

      public Class<E> getEntityClass()
      Returns:
      entity class of the list view