Uses of Package
com.vaadin.flow.router

Packages that use com.vaadin.flow.router

Package	Description
com.vaadin.flow.component
com.vaadin.flow.component.applayout
com.vaadin.flow.component.internal
com.vaadin.flow.component.page
com.vaadin.flow.component.webcomponent
com.vaadin.flow.di
com.vaadin.flow.router
com.vaadin.flow.router.internal
com.vaadin.flow.server
com.vaadin.flow.server.startup

Classes in com.vaadin.flow.router used by com.vaadin.flow.component

Class and Description
AfterNavigationListener A listener that may be added to the UI using UI.addAfterNavigationListener(AfterNavigationListener).
BeforeEnterListener A listener that may be added to the UI using UI.addBeforeEnterListener(BeforeEnterListener).
BeforeLeaveListener A listener that may be added to the UI using UI.addBeforeLeaveListener(BeforeLeaveListener).
HasUrlParameter Defines route parameters for navigation targets for use in routing.
QueryParameters Holds query parameters information.
RouteParameters Immutable container which stores the route parameters extracted from a navigation url received from the client.
Router The router takes care of serving content when the user navigates within a site or an application.
RouterLayout Implementations of this interface represent a parent for a navigation target components via the Route.layout() parameter.

Classes in com.vaadin.flow.router used by com.vaadin.flow.component.applayout

Class and Description
RouterLayout Implementations of this interface represent a parent for a navigation target components via the Route.layout() parameter.

Classes in com.vaadin.flow.router used by com.vaadin.flow.component.internal

Class and Description
AfterNavigationListener A listener that may be added to the UI using UI.addAfterNavigationListener(AfterNavigationListener).
BeforeEnterListener A listener that may be added to the UI using UI.addBeforeEnterListener(BeforeEnterListener).
BeforeLeaveEvent.ContinueNavigationAction The action to resume a postponed BeforeEnterEvent.
BeforeLeaveListener A listener that may be added to the UI using UI.addBeforeLeaveListener(BeforeLeaveListener).
Location Represents a relative URL made up of path segments and query parameters, but lacking e.g.
Router The router takes care of serving content when the user navigates within a site or an application.
RouterLayout Implementations of this interface represent a parent for a navigation target components via the Route.layout() parameter.

Classes in com.vaadin.flow.router used by com.vaadin.flow.component.page

Class and Description
Location Represents a relative URL made up of path segments and query parameters, but lacking e.g.
NavigationTrigger The type of user action that triggered navigation.

Classes in com.vaadin.flow.router used by com.vaadin.flow.component.webcomponent

Class and Description
HasUrlParameter Defines route parameters for navigation targets for use in routing.
QueryParameters Holds query parameters information.
Router The router takes care of serving content when the user navigates within a site or an application.
RouterLayout Implementations of this interface represent a parent for a navigation target components via the Route.layout() parameter.

Classes in com.vaadin.flow.router used by com.vaadin.flow.di

Class and Description
NavigationEvent Event object with data related to navigation.

Classes in com.vaadin.flow.router used by com.vaadin.flow.router

Class and Description
AfterNavigationEvent Event created before navigation happens.
AfterNavigationObserver Any attached component implementing this interface will receive an event after all navigation tasks have resolved.
BeforeEnterEvent Event created before navigation happens.
BeforeEnterObserver Any attached component implementing this interface will receive an event before a new navigation state is entered.
BeforeEvent Abstract before event class that has the common functionalities for BeforeLeaveEvent and BeforeEnterEvent.
BeforeLeaveEvent.ContinueNavigationAction The action to resume a postponed BeforeEnterEvent.
BeforeLeaveObserver Any attached component implementing this interface will receive an event before leaving the current navigation state.
ErrorParameter Navigation error parameter class containing thrown exception and possibly a custom message.
HasErrorParameter Defines a view that handles the exceptions for the set Exception type T.
HasUrlParameter Defines route parameters for navigation targets for use in routing.
HighlightAction An action to be performed to set the highlight state of the target.
HighlightCondition A condition to meet to determine the highlight state of the target.
InvalidLocationException Thrown to indicate that a Location instance is invalid.
Location Represents a relative URL made up of path segments and query parameters, but lacking e.g.
LocationChangeEvent Event created when the location changes by any of the reasons defined at NavigationTrigger.
NavigationEvent Event object with data related to navigation.
NavigationHandler Handles navigation to a location e.g.
NavigationState Contains all relevant information related to a valid navigation.
NavigationStateBuilder A builder class for constructing new NavigationState instances.
NavigationTrigger The type of user action that triggered navigation.
NotFoundException Exception indicating that something went wrong while resolving navigation routes.
QueryParameters Holds query parameters information.
Route Defines the route template suffix for components that function as navigation targets in routing.
RouteAliasData Route data for an 'alias' route.
RouteBaseData Abstract base class for route and route alias data.
RouteConfiguration Route configuration helper class for adding, removing and reading routes from the different registries.
RouteData Data collection of information for a specific registered route target.
RouteParam Route parameter containing the name and the value used mainly when constructing a RouteParameters instance.
RouteParameterData Immutable data representing one url parameter.
RouteParameterFormatOption Define the route parameters format flags.
RouteParameters Immutable container which stores the route parameters extracted from a navigation url received from the client.
Router The router takes care of serving content when the user navigates within a site or an application.
RouterLayout Implementations of this interface represent a parent for a navigation target components via the Route.layout() parameter.
RouterLink A link that handles navigation internally using Router instead of loading a new page in the browser.
RoutesChangedEvent Result class containing the removed and added routes for the latest configuration.
RoutesChangedListener Listener that gets notified when the registered routes for a RouteRegistry are changed in some way.

Classes in com.vaadin.flow.router used by com.vaadin.flow.router.internal

Class and Description
AfterNavigationEvent Event created before navigation happens.
BeforeEnterEvent Event created before navigation happens.
BeforeLeaveEvent Event created before navigation happens.
Location Represents a relative URL made up of path segments and query parameters, but lacking e.g.
LocationChangeEvent Event created when the location changes by any of the reasons defined at NavigationTrigger.
NavigationEvent Event object with data related to navigation.
NavigationHandler Handles navigation to a location e.g.
NavigationState Contains all relevant information related to a valid navigation.
Route Defines the route template suffix for components that function as navigation targets in routing.
RouteAlias Defines the route alias for components that function as navigation targets in routing.
RouteData Data collection of information for a specific registered route target.
RouteParameterData Immutable data representing one url parameter.
RouteParameterFormatOption Define the route parameters format flags.
RouteParameters Immutable container which stores the route parameters extracted from a navigation url received from the client.
Router The router takes care of serving content when the user navigates within a site or an application.
RouteResolver Callback interface for resolving ResolveRequests to new NavigationStates.
RouterLayout Implementations of this interface represent a parent for a navigation target components via the Route.layout() parameter.
RoutesChangedEvent Result class containing the removed and added routes for the latest configuration.
RoutesChangedListener Listener that gets notified when the registered routes for a RouteRegistry are changed in some way.

Classes in com.vaadin.flow.router used by com.vaadin.flow.server

Class and Description
AfterNavigationEvent Event created before navigation happens.
RouteData Data collection of information for a specific registered route target.
RouteParameters Immutable container which stores the route parameters extracted from a navigation url received from the client.
Router The router takes care of serving content when the user navigates within a site or an application.
RouterLayout Implementations of this interface represent a parent for a navigation target components via the Route.layout() parameter.
RoutesChangedListener Listener that gets notified when the registered routes for a RouteRegistry are changed in some way.

Classes in com.vaadin.flow.router used by com.vaadin.flow.server.startup

Class and Description
RouterLayout Implementations of this interface represent a parent for a navigation target components via the Route.layout() parameter.