Package com.vaadin.flow.router
package com.vaadin.flow.router
-
ClassDescriptionThis 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 theUIusingUI.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 forBeforeLeaveEventandBeforeEnterEvent.Event created before navigation happens.A listener that may be added to theUIusingUI.addBeforeLeaveListener(BeforeLeaveListener).Any attached component implementing this interface will receive an event before leaving the current navigation state.Default implementation forRoutePathProvider.Resolves the page title of a navigation target dynamically through aPageTitleGenerator, without creating an instance of the navigation target.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, based on the live state of the navigation target instance.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 predefinedHighlightActions.A condition to meet to determine the highlight state of the target.A set of predefinedHighlightConditions.This is a basic default error view shown on exceptions during navigation.Thrown to indicate that aLocationinstance is invalid.Defines aRouterLayoutas eligible for use as automatic layout for Flow and Hilla views.This annotation sets the priority of execution onBeforeEnterListeners,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 atNavigationTrigger.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 newNavigationStateinstances.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 page title for a navigation target.The context handed to aPageTitleGeneratorwhen resolving a navigation target title without an instance.Resolves a navigation target title dynamically without requiring an instance of the 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 multipleRouteAliasannotations.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 aRouteParametersinstance.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.Defines the logical parent of a navigation target.The context handed to aRouteParentResolverwhen resolving the logical parent of a route without an instance.Resolves the logical parent of a route dynamically without requiring an instance of either the route or its parent.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.A reference to a route, consisting of the navigation target class and theRouteParametersit should be resolved with.Callback interface for resolvingResolveRequests to newNavigationStates.Implementations of this interface represent a parent for a navigation target components via theRoute.layout()parameter.A link that handles navigation internally usingRouterinstead of loading a new page in the browser.An immutable snapshot of a UI's current navigation state.Result class containing the removed and added routes for the latest configuration.Listener that gets notified when the registered routes for aRouteRegistryare changed in some way.Marks a Navigation url parameter as a wildcard allowing 0-N parameter parts to be bound for this url parameter.