We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.router.
Package com.vaadin.flow.router
package com.vaadin.flow.router
-
ClassDescription
This is abstract error view for routing exceptions.
Exception for access denied error view.
Event created after navigation completed.
A listener that may be added to the
UIusingUI.addAfterNavigationListener(AfterNavigationListener).Any attached component implementing this interface will receive an event after all navigation tasks have resolved.
Event created before navigation happens.
A listener that may be added to the
UIusingUI.addBeforeEnterListener(BeforeEnterListener).Any attached component implementing this interface will receive an event before a new navigation state is entered.
Abstract before event class that has the common functionalities for
BeforeLeaveEventandBeforeEnterEvent.Event created before navigation happens.
A listener that may be added to the
UIusingUI.addBeforeLeaveListener(BeforeLeaveListener).Any attached component implementing this interface will receive an event before leaving the current navigation state.
Default implementation for
RoutePathProvider.Event object with data related to error navigation.
ErrorParameter<T extends Exception>Navigation error parameter class containing thrown exception and possibly a custom message.
Event handling utilities.
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.
Defines route parameters for navigation targets for use in routing.
An action to be performed to set the highlight state of the target.
A set of predefined
HighlightActions.A condition to meet to determine the highlight state of the target.
A set of predefined
HighlightConditions.This is a basic default error view shown on exceptions during navigation.
Thrown to indicate that a
Locationinstance is invalid.Defines a
RouterLayoutas eligible for use as automatic layout for Flow and Hilla views.This annotation sets the priority of execution on
BeforeEnterListeners,BeforeLeaveListeners andAfterNavigationListeners.Represents a relative URL made up of path segments and query parameters, but lacking e.g.
Event created when the location changes by any of the reasons defined at
NavigationTrigger.Utility class exposing reusable utility methods for location.
Defines menu information for a route for automatically populated menu.
Data class for menu item information.
Event object with data related to navigation.
Handles navigation to a location e.g.
Contains all relevant information related to a valid navigation.
A builder class for constructing new
NavigationStateinstances.The type of user action that triggered navigation.
Exception indicating that something went wrong while resolving navigation routes.
Marks a Navigation url parameter as optional.
Defines the HTML page title for a navigation target.
Parameter deserialization utility.
Defines the parent layout for components in routing hierarchy.
Indicates that a previous view instance should be-reused when reloading a location in the same browser window/tab.
Holds query parameters information.
Defines the route template suffix for components that function as navigation targets in routing.
This is a default error view shown on access denied routing exceptions.
Defines the route alias for components that function as navigation targets in routing.
Internal annotation to enable use of multiple
RouteAliasannotations.Route data for an 'alias' route.
RouteBaseData<T extends RouteBaseData>Abstract base class for route and route alias data.
Route configuration helper class for adding, removing and reading routes from the different registries.
Data collection of information for a specific registered route target.
This is a basic default error view shown on routing exceptions.
Route parameter containing the name and the value used mainly when constructing a
RouteParametersinstance.Immutable data representing one url parameter.
Define the route parameters format flags.
Predefined regex used with template parameters.
Immutable container which stores the route parameters extracted from a navigation url received from the client.
Allows to implement a custom navigation target path generation logic for components annotated with
@Route(Route.NAMING_CONVENTION).Defines the route prefix that a Parent layout adds to a route when used in the active view chain.
The router takes care of serving content when the user navigates within a site or an application.
Callback interface for resolving
ResolveRequests to newNavigationStates.Implementations of this interface represent a parent for a navigation target components via the
Route.layout()parameter.A link that handles navigation internally using
Routerinstead of loading a new page in the browser.Result class containing the removed and added routes for the latest configuration.
Listener that gets notified when the registered routes for a
RouteRegistryare changed in some way.Marks a Navigation url parameter as a wildcard allowing 0-N parameter parts to be bound for this url parameter.