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

Packages that use RouteParameters

Package	Description
com.vaadin.flow.component
com.vaadin.flow.component.breadcrumbs
com.vaadin.flow.component.sidenav
com.vaadin.flow.internal.menu
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.breadcrumbs

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

Modifier and Type	Method	Description
void	BreadcrumbsItem.setPath(Class<? extends Component> view, RouteParameters parameters)	Resolves the URL of the given view via the Vaadin router using the given route parameters and sets it as the path this item links to.

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

Modifier	Constructor	Description
	BreadcrumbsItem(String text, Class<? extends Component> view, RouteParameters params)	Creates a breadcrumbs item with the given text that links to the given view using the given route parameters.
	BreadcrumbsItem(String text, Class<? extends Component> view, RouteParameters params, Component prefixComponent)	Creates a breadcrumbs item with the given text and prefix component (like an icon) that links to the given view using the given route 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.internal.menu

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

Modifier and Type	Method	Description
static String	MenuRegistry.getTitle(Class<? extends Component> target, RouteParameters parameters)	Get page title for route or simple name if no PageTitle is set.

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.
RouteParameters	PageTitleContext.routeParameters()	Returns the value of the routeParameters record component.
RouteParameters	RouteParentContext.routeParameters()	Returns the value of the routeParameters record component.
RouteParameters	RouteReference.routeParameters()	Returns the value of the routeParameters record component.
RouteParameters	RouterState.routeParameters()	Returns the value of the routeParameters record component.

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.
List<RouteReference>	RouteConfiguration.getRouteHierarchy(Class<? extends Component> navigationTarget, RouteParameters parameters)	Resolves the logical route hierarchy of the given navigation target in this configuration's registry, without instantiating any of the routes.
Optional<RouteReference>	RouteConfiguration.getRouteParent(Class<? extends Component> navigationTarget, RouteParameters parameters)	Resolves the logical parent of the given navigation target in this configuration's registry, without instantiating the route or its parent.
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.
Optional<String>	Router.resolvePageTitle(Component navigationTarget, RouteParameters routeParameters)	Resolves the page title of the given navigation target instance, using empty query parameters.
Optional<String>	Router.resolvePageTitle(Component navigationTarget, RouteParameters routeParameters, QueryParameters queryParameters)	Resolves the page title of the given navigation target instance.
Optional<String>	Router.resolvePageTitle(Class<? extends Component> navigationTarget, RouteParameters routeParameters)	Resolves the page title of the given navigation target without creating an instance of it, using empty query parameters.
Optional<String>	Router.resolvePageTitle(Class<? extends Component> navigationTarget, RouteParameters routeParameters, QueryParameters queryParameters)	Resolves the page title of the given navigation target without creating an instance of it.
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<? extends Component> navigationTarget, RouteParameters parameters, List<Class<? extends RouterLayout>> layouts)	Constructs event from a NavigationEvent.
	BeforeEnterEvent(Router router, NavigationTrigger trigger, Location location, Class<? extends Component> navigationTarget, RouteParameters parameters, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeEnterEvent.
	BeforeEvent(NavigationEvent event, Class<? extends Component> navigationTarget, RouteParameters parameters, List<Class<? extends RouterLayout>> layouts)	Constructs event from a NavigationEvent.
	BeforeEvent(Router router, NavigationTrigger trigger, Location location, Class<? extends Component> navigationTarget, RouteParameters parameters, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeEvent.
	BeforeLeaveEvent(NavigationEvent event, Class<? extends Component> navigationTarget, RouteParameters parameters, List<Class<? extends RouterLayout>> layouts)	Constructs event from a NavigationEvent.
	BeforeLeaveEvent(Router router, NavigationTrigger trigger, Location location, Class<? extends Component> navigationTarget, RouteParameters parameters, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeLeaveEvent.
	PageTitleContext(Class<? extends Component> navigationTarget, RouteParameters routeParameters, QueryParameters queryParameters, String value)	Creates an instance of a PageTitleContext record class.
	RouteParentContext(Class<? extends Component> navigationTarget, RouteParameters routeParameters)	Creates an instance of a RouteParentContext record class.
	RouteReference(Class<? extends Component> navigationTarget, RouteParameters routeParameters)	Creates an instance of a RouteReference record class.
	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.
	RouterState(Location location, RouteParameters routeParameters, List<HasElement> activeChain, Class<? extends Component> navigationTarget)	Creates an instance of a RouterState record class.

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.
static List<RouteReference>	RouteUtil.getRouteHierarchy(RouteRegistry registry, Class<? extends Component> navigationTarget, RouteParameters parameters)	Resolves the logical route hierarchy of the given navigation target by repeatedly resolving the route parent (see RouteUtil.getRouteParent(RouteRegistry, Class, RouteParameters)), without instantiating any of the routes.
static Optional<RouteReference>	RouteUtil.getRouteParent(RouteRegistry registry, Class<? extends Component> navigationTarget, RouteParameters parameters)	Resolves the logical parent of the given navigation target, without instantiating the route or its parent.
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 for ongoing navigation.
	NavigationContext(Router router, Class<?> navigationTarget, Location location, RouteParameters parameters, Principal principal, Predicate<String> roleChecker, boolean errorHandling, boolean navigating)	Creates a new navigation context instance.