com.vaadin.flow.router.
Enum Class NavigationTrigger
All Implemented Interfaces:
The type of user action that triggered navigation.
Since:
1.0
Author:
Vaadin Ltd
See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionNavigation was triggered by client-side.
Navigation was triggered by the user going forward or back in the browser's history.
Navigation was triggered by the user opening the application or reloading in the browser.
Navigation was triggered programmatically via forward/reroute action.
Navigation is for a reload event on a preserveOnRefresh route.
Navigation was triggered via
UI.refreshCurrentRoute(boolean)
.Navigation was triggered by the user following a router link.
Navigation was triggered via
UI.navigate(String, QueryParameters)
. -
Method Summary
Modifier and TypeMethodDescriptionstatic NavigationTrigger
Returns the enum constant of this class with the specified name.
static NavigationTrigger[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
PAGE_LOAD
Navigation was triggered by the user opening the application or reloading in the browser.
-
ROUTER_LINK
Navigation was triggered by the user following a router link.
See Also:
-
HISTORY
Navigation was triggered by the user going forward or back in the browser's history.
-
PROGRAMMATIC
Navigation was triggered programmatically via forward/reroute action.
-
UI_NAVIGATE
Navigation was triggered via
UI.navigate(String, QueryParameters)
. It's for internal use only. -
CLIENT_SIDE
Navigation was triggered by client-side.
-
REFRESH
Navigation is for a reload event on a preserveOnRefresh route.
-
REFRESH_ROUTE
Navigation was triggered via
UI.refreshCurrentRoute(boolean)
. It's for internal use only.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.
Returns:
an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
Parameters:
name
- the name of the enum constant to be returned.Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-