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

  • Constructor Details

  • 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