Package | Description |
---|---|
com.vaadin.flow.component | |
com.vaadin.flow.router | |
com.vaadin.flow.router.internal | |
com.vaadin.flow.server |
Modifier and Type | Method and Description |
---|---|
void |
UI.navigate(Class<? extends Component> navigationTarget,
RouteParameters parameters)
Updates this UI to show the view corresponding to the given navigation
target with the specified parameters.
|
Modifier and Type | Method and 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 |
NavigationState.getRouteParameters()
Gets the route parameters map.
|
RouteParameters |
BeforeEvent.getRouteParameters()
Gets the route parameters associated with this event.
|
Modifier and Type | Method and Description |
---|---|
void |
BeforeEvent.forwardTo(Class<? extends Component> forwardTargetComponent,
RouteParameters parameters)
Forward the navigation to show the given component 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.
|
void |
BeforeEvent.rerouteTo(Class<? extends Component> routeTargetType,
RouteParameters parameters)
Reroutes the navigation to show the given component instead of the
component that is currently about to be displayed.
|
void |
RouterLink.setRoute(Class<? extends Component> navigationTarget,
RouteParameters parameters)
Set the navigation target for this link.
|
void |
RouterLink.setRoute(Router router,
Class<? extends Component> navigationTarget,
RouteParameters parameters)
Set the navigation target for this link.
|
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.
|
NavigationStateBuilder |
NavigationStateBuilder.withTarget(RouteTarget routeTarget,
RouteParameters parameters)
Assigns the given route target with the given route parameters to the
navigation state being built.
|
Constructor and Description |
---|
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,
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(String text,
Class<? extends Component> navigationTarget,
RouteParameters parameters)
Creates a new router link for the given navigation target using the given
text and parameters.
|
Modifier and Type | Method and 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.
|
Modifier and Type | Method and 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 |
ConfiguredRoutes.getRouteTarget(Class<? extends Component> target,
RouteParameters parameters)
Gets the
RouteTarget instance matching the given target component
and route parameters. |
RouteTarget |
AbstractRouteRegistry.getRouteTarget(Class<? extends Component> target,
RouteParameters parameters) |
String |
ConfiguredRoutes.getTargetUrl(Class<? extends Component> navigationTarget,
RouteParameters parameters)
Get the url path String for the given navigation target class and
parameters.
|
Optional<String> |
AbstractRouteRegistry.getTargetUrl(Class<? extends Component> navigationTarget,
RouteParameters parameters) |
Modifier and Type | Method and Description |
---|---|
RouteTarget |
SessionRouteRegistry.getRouteTarget(Class<? extends Component> target,
RouteParameters parameters) |
RouteTarget |
RouteRegistry.getRouteTarget(Class<? extends Component> target,
RouteParameters parameters)
Gets the
RouteTarget instance matching the given target component
and route parameters. |
Optional<String> |
SessionRouteRegistry.getTargetUrl(Class<? extends Component> navigationTarget,
RouteParameters parameters) |
Optional<String> |
RouteRegistry.getTargetUrl(Class<? extends Component> navigationTarget,
RouteParameters parameters)
Get the url string for given navigation target.
|
Copyright © 2025. All rights reserved.