Uses of Class
com.vaadin.flow.router.RouteParameters

Packages that use RouteParameters

Package	Description
com.vaadin.flow.component
com.vaadin.flow.component.sidenav
com.vaadin.flow.router
com.vaadin.flow.router.internal
com.vaadin.flow.server
com.vaadin.flow.server.auth

Uses of RouteParameters in com.vaadin.flow.component

Methods in com.vaadin.flow.component with parameters of type RouteParameters

Modifier and Type	Method	Description
<C extends Component> Optional<C>	UI.navigate(Class<? extends C> navigationTarget, RouteParameters routeParameter, QueryParameters queryParameters)	Updates this UI to show the view corresponding to the given navigation target with the specified parameters.
<T extends Component> Optional<T>	UI.navigate(Class<T> navigationTarget, RouteParameters parameters)	Updates this UI to show the view corresponding to the given navigation target with the specified parameters.

Uses of RouteParameters in com.vaadin.flow.component.sidenav

Methods in com.vaadin.flow.component.sidenav with parameters of type RouteParameters

Modifier and Type	Method	Description
void	SideNavItem.setPath(Class<? extends Component> view, RouteParameters routeParameters)	Retrieves Route and RouteAlias annotations from the specified view, and then sets the corresponding path and path aliases for this item.

Constructors in com.vaadin.flow.component.sidenav with parameters of type RouteParameters

Modifier	Constructor	Description
	SideNavItem(String label, Class<? extends Component> view, RouteParameters routeParameters)	Creates a new menu item using the given label that links to the given view.
	SideNavItem(String label, Class<? extends Component> view, RouteParameters routeParameters, Component prefixComponent)	Creates a new menu item using the given label and prefix component (like an icon) that links to the given view.

Uses of RouteParameters in com.vaadin.flow.router

Methods in com.vaadin.flow.router that return RouteParameters

Modifier and Type	Method	Description
static RouteParameters	RouteParameters.empty()	Creates an empty RouteParameters instance.
RouteParameters	BeforeEvent.getForwardTargetRouteParameters()	Gets the URL parameters of the forward target.
RouteParameters	BeforeEvent.getRerouteTargetRouteParameters()	Get the URL parameters of the reroute target.
RouteParameters	AfterNavigationEvent.getRouteParameters()	Gets the route parameters associated with this event.
RouteParameters	BeforeEvent.getRouteParameters()	Gets the route parameters associated with this event.
RouteParameters	NavigationState.getRouteParameters()	Gets the route parameters map.

Methods in com.vaadin.flow.router with parameters of type RouteParameters

Modifier and Type	Method	Description
<C extends Component> void	BeforeEvent.forwardTo(Class<? extends C> forwardTargetComponent, RouteParameters routeParameters, QueryParameters queryParameters)	Forward the navigation to show the given component with given route parameters and query parameters instead of the component that is currently about to be displayed.
void	BeforeEvent.forwardTo(Class<? extends Component> forwardTargetComponent, RouteParameters parameters)	Forward the navigation to show the given component with given route parameters instead of the component that is currently about to be displayed.
String	RouteConfiguration.getUrl(Class<? extends Component> navigationTarget, RouteParameters parameters)	Gets the url which navigates to given navigationTarget using given parameters.
<C extends Component> void	BeforeEvent.rerouteTo(Class<? extends C> routeTargetType, RouteParameters routeParameters, QueryParameters queryParameters)	Reroutes the navigation to show the given component with given route parameters and query parameters instead of the component that is currently about to be displayed.
void	BeforeEvent.rerouteTo(Class<? extends Component> routeTargetType, RouteParameters parameters)	Reroutes the navigation to show the given component with given route parameters instead of the component that is currently about to be displayed.
void	RouterLink.setRoute(Router router, Class<? extends Component> navigationTarget, RouteParameters parameters)	Set the navigation target for this link.
void	RouterLink.setRoute(Class<? extends Component> navigationTarget, RouteParameters parameters)	Set the navigation target for this link.
NavigationStateBuilder	NavigationStateBuilder.withTarget(RouteTarget routeTarget, RouteParameters parameters)	Assigns the given route target with the given route parameters to the navigation state being built.
NavigationStateBuilder	NavigationStateBuilder.withTarget(Class<? extends Component> navigationTarget, RouteParameters parameters)	Assigns the given navigation target with the given url parameter to the navigation state being built.

Constructors in com.vaadin.flow.router with parameters of type RouteParameters

Modifier	Constructor	Description
	AfterNavigationEvent(LocationChangeEvent event, RouteParameters routeParameters)	Construct event from a NavigationEvent.
	BeforeEnterEvent(NavigationEvent event, Class<?> navigationTarget, RouteParameters parameters, List<Class<? extends RouterLayout>> layouts)	Constructs event from a NavigationEvent.
	BeforeEnterEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, RouteParameters parameters, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeEnterEvent.
	BeforeEvent(NavigationEvent event, Class<?> navigationTarget, RouteParameters parameters, List<Class<? extends RouterLayout>> layouts)	Constructs event from a NavigationEvent.
	BeforeEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, RouteParameters parameters, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeEvent.
	BeforeLeaveEvent(NavigationEvent event, Class<?> navigationTarget, RouteParameters parameters, List<Class<? extends RouterLayout>> layouts)	Constructs event from a NavigationEvent.
	BeforeLeaveEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, RouteParameters parameters, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeLeaveEvent.
	RouterLink(Router router, Class<? extends Component> navigationTarget, RouteParameters parameters)	Creates a new router link for the given navigation target using the given parameters.
	RouterLink(Router router, String text, Class<? extends Component> navigationTarget, RouteParameters parameters)	Creates a new router link for the given navigation target using the given text and parameters.
	RouterLink(Class<? extends Component> navigationTarget, RouteParameters parameters)	Creates a new router link for the given navigation target using the given parameters.
	RouterLink(String text, Class<? extends Component> navigationTarget, RouteParameters parameters)	Creates a new router link for the given navigation target using the given text and parameters.

Uses of RouteParameters in com.vaadin.flow.router.internal

Methods in com.vaadin.flow.router.internal that return RouteParameters

Modifier and Type	Method	Description
static <T> RouteParameters	HasUrlParameterFormat.getParameters(List<T> parametersList)	Transform the HasUrlParameter values into a RouteParameters object.
static <T> RouteParameters	HasUrlParameterFormat.getParameters(T parameter)	Transform the HasUrlParameter value into a RouteParameters object.
RouteParameters	NavigationRouteTarget.getRouteParameters()	Gets the route parameters for this search response.

Methods in com.vaadin.flow.router.internal with parameters of type RouteParameters

Modifier and Type	Method	Description
static void	HasUrlParameterFormat.checkMandatoryParameter(Class<? extends Component> navigationTarget, RouteParameters parameters)	Verify whether the navigationTarget has mandatory parameter and complies with the given parameter values.
static List<String>	HasUrlParameterFormat.getParameterValues(RouteParameters parameters)	Gets the values for the HasUrlParameter from the specified route parameters.
RouteTarget	AbstractRouteRegistry.getRouteTarget(Class<? extends Component> target, RouteParameters parameters)
RouteTarget	ConfiguredRoutes.getRouteTarget(Class<? extends Component> target, RouteParameters parameters)	Gets the RouteTarget instance matching the given target component and route parameters.
Optional<String>	AbstractRouteRegistry.getTargetUrl(Class<? extends Component> navigationTarget, RouteParameters parameters)
String	ConfiguredRoutes.getTargetUrl(Class<? extends Component> navigationTarget, RouteParameters parameters)	Get the url path String for the given navigation target class and parameters.

Uses of RouteParameters in com.vaadin.flow.server

Methods in com.vaadin.flow.server with parameters of type RouteParameters

Modifier and Type	Method	Description
RouteTarget	RouteRegistry.getRouteTarget(Class<? extends Component> target, RouteParameters parameters)	Gets the RouteTarget instance matching the given target component and route parameters.
RouteTarget	SessionRouteRegistry.getRouteTarget(Class<? extends Component> target, RouteParameters parameters)
Optional<String>	RouteRegistry.getTargetUrl(Class<? extends Component> navigationTarget, RouteParameters parameters)	Get the url string for given navigation target.
Optional<String>	SessionRouteRegistry.getTargetUrl(Class<? extends Component> navigationTarget, RouteParameters parameters)

Uses of RouteParameters in com.vaadin.flow.server.auth

Methods in com.vaadin.flow.server.auth that return RouteParameters

Modifier and Type	Method	Description
RouteParameters	NavigationContext.getParameters()	Gets the route parameters associated with this event.

Constructors in com.vaadin.flow.server.auth with parameters of type RouteParameters

Modifier	Constructor	Description
	NavigationContext(Router router, Class<?> navigationTarget, Location location, RouteParameters parameters, Principal principal, Predicate<String> roleChecker, boolean errorHandling)	Creates a new navigation context instance.