Package com.vaadin.flow.router

Interface Summary

Interface	Description
AfterNavigationListener	A listener that may be added to the UI using UI.addAfterNavigationListener(AfterNavigationListener).
AfterNavigationObserver	Any attached component implementing this interface will receive an event after all navigation tasks have resolved.
BeforeEnterListener	A listener that may be added to the UI using UI.addBeforeEnterListener(BeforeEnterListener).
BeforeEnterObserver	Any attached component implementing this interface will receive an event before a new navigation state is entered.
BeforeLeaveListener	A listener that may be added to the UI using UI.addBeforeLeaveListener(BeforeLeaveListener).
BeforeLeaveObserver	Any attached component implementing this interface will receive an event before leaving the current navigation state.
HasDynamicTitle	Allows to resolve navigation target title dynamically at runtime.
HasErrorParameter<T extends Exception>	Defines a view that handles the exceptions for the set Exception type T.
HasUrlParameter<T>	Defines route parameters for navigation targets for use in routing.
HighlightAction<T>	An action to be performed to set the highlight state of the target.
HighlightCondition<T>	A condition to meet to determine the highlight state of the target.
NavigationHandler	Handles navigation to a location e.g.
RoutePathProvider	Allows to implement a custom navigation target path generation logic for components annotated with @Route(Route.NAMING_CONVENTION).
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.
RoutesChangedListener	Listener that gets notified when the registered routes for a RouteRegistry are changed in some way.

Class Summary

Class	Description
AfterNavigationEvent	Event created after navigation completed.
BeforeEnterEvent	Event created before navigation happens.
BeforeEvent	Abstract before event class that has the common functionalities for BeforeLeaveEvent and BeforeEnterEvent.
BeforeLeaveEvent	Event created before navigation happens.
DefaultRoutePathProvider	Default implementation for RoutePathProvider.
ErrorNavigationEvent	Event object with data related to error navigation.
ErrorParameter<T extends Exception>	Navigation error parameter class containing thrown exception and possibly a custom message.
EventUtil	Event handling utilities.
HighlightActions	A set of predefined HighlightActions.
HighlightConditions	A set of predefined HighlightConditions.
InternalServerError	This is a basic default error view shown on exceptions during navigation.
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.
LocationUtil	Utility class exposing reusable utility methods for location.
NavigationEvent	Event object with data related to navigation.
NavigationState	Contains all relevant information related to a valid navigation.
NavigationStateBuilder	A builder class for constructing new NavigationState instances.
ParameterDeserializer	Parameter deserialization utility.
QueryParameters	Holds query parameters information.
RouteAliasData	Route data for an 'alias' route.
RouteBaseData<T extends 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.
RouteNotFoundError	This is a basic default error view shown on routing exceptions.
RouteParam	Route parameter containing the name and the value used mainly when constructing a RouteParameters instance.
RouteParameterData	Immutable data representing one url parameter.
RouteParameterRegex	Predefined regex used with template parameters.
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.
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.

Enum Summary

Enum	Description
NavigationTrigger	The type of user action that triggered navigation.
RouteParameterFormatOption	Define the route parameters format flags.

Exception Summary

Exception	Description
InvalidLocationException	Thrown to indicate that a Location instance is invalid.
NotFoundException	Exception indicating that something went wrong while resolving navigation routes.

Annotation Types Summary

Annotation Type	Description
ListenerPriority	This annotation sets the priority of execution on BeforeEnterListeners, BeforeLeaveListeners and AfterNavigationListeners.
OptionalParameter	Marks a Navigation url parameter as optional.
PageTitle	Defines the HTML page title for a navigation target.
ParentLayout	Defines the parent layout for components in routing hierarchy.
PreserveOnRefresh	Indicates that a previous view instance should be-reused when reloading a location in the same browser window/tab.
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.
RouteAlias.Container	Internal annotation to enable use of multiple RouteAlias annotations.
RoutePrefix	Defines the route prefix that a Parent layout adds to a route when used in the active view chain.
WildcardParameter	Marks a Navigation url parameter as a wildcard allowing 0-N parameter parts to be bound for this url parameter.