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
-
Interface Summary Interface Description AfterNavigationListener A listener that may be added to the
UIusingUI.addAfterNavigationListener(AfterNavigationListener).AfterNavigationObserver Any
com.vaadin.ui.Componentimplementing this interface will be informed when they have been attached to the UI and all navigation tasks have resolved.BeforeEnterListener A listener that may be added to the
UIusingUI.addBeforeEnterListener(BeforeEnterListener).BeforeEnterObserver Any
com.vaadin.ui.Componentimplementing this interface will be informed when they are being attached to theUI.BeforeLeaveListener A listener that may be added to the
UIusingUI.addBeforeLeaveListener(BeforeLeaveListener).BeforeLeaveObserver Any
com.vaadin.ui.Componentimplementing this interface will be informed when they are being detached from theUI.HasDynamicTitle Interface for navigation targets to resolve their title dynamically at runtime.
HasErrorParameter<T extends Exception> Interface for defining a view that handles the exceptions for the set Exception type T.
HasUrlParameter<T> Interface for defining url 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.
RouteResolver Callback interface for resolving
ResolveRequests to newNavigationStates.RouterLayout Implementations of this interface represent a parent for a navigation target components via the
Route.layout()parameter. -
Class Summary Class Description AfterNavigationEvent Event created before navigation happens.
BeforeEnterEvent Event created before navigation happens.
BeforeEvent Abstract before event class that has the common functionalities for
BeforeLeaveEventandBeforeEnterEvent.BeforeLeaveEvent Event created before navigation happens.
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.NavigationEvent Event object with data related to navigation.
NavigationState Class containing all relevant information related to a valid navigation.
NavigationStateBuilder A builder class for constructing new
NavigationStateinstances.ParameterDeserializer Parameter deserialization utility.
QueryParameters Holds query parameters information.
RouteData Data collection of information for a specific registered route target.
RouteData.AliasData Data class with information pertaining to the
RouteAlias.RouteNotFoundError This is a basic default error view shown on routing exceptions.
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
Routerinstead of loading a new page in the browser. -
Enum Summary Enum Description NavigationTrigger The type of user action that triggered navigation.
-
Exception Summary Exception Description 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 andAfterNavigationListeners.OptionalParameter Annotation to mark 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.
Route Defines the route 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
RouteAliasannotations.RoutePrefix Defines the route prefix that a Parent layout adds to a route when used in the active view chain.
WildcardParameter Annotation to mark a Navigation url parameter as a wildcard allowing 0-N parameter parts to be bound for this url parameter.