com.vaadin.flow.router.
Enum NavigationTrigger
- java.lang.Object
-
- java.lang.Enum<NavigationTrigger>
-
- com.vaadin.flow.router.NavigationTrigger
-
All Implemented Interfaces:
public enum NavigationTrigger extends Enum<NavigationTrigger>
The type of user action that triggered navigation.
Since:
1.0
Author:
Vaadin Ltd
See Also:
LocationChangeEvent.getTrigger()
,History.HistoryStateChangeEvent.getTrigger()
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CLIENT_SIDE
Navigation was triggered by client-side.
HISTORY
Navigation was triggered by the user going forward or back in the browser's history.
PAGE_LOAD
Navigation was triggered by the user opening the application or reloading in the browser.
PROGRAMMATIC
Navigation was triggered programmatically via forward/reroute action.
ROUTER_LINK
Navigation was triggered by the user following a router link.
UI_NAVIGATE
Navigation was triggered via
UI.navigate(String, QueryParameters)
.
-
Method Summary
All Methods Modifier and Type Method Description static NavigationTrigger
valueOf​(String name)
Returns the enum constant of this type with the specified name.
static NavigationTrigger[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
PAGE_LOAD
public static final NavigationTrigger PAGE_LOAD
Navigation was triggered by the user opening the application or reloading in the browser.
-
ROUTER_LINK
public static final NavigationTrigger ROUTER_LINK
Navigation was triggered by the user following a router link.
See Also:
-
HISTORY
public static final NavigationTrigger HISTORY
Navigation was triggered by the user going forward or back in the browser's history.
-
PROGRAMMATIC
public static final NavigationTrigger PROGRAMMATIC
Navigation was triggered programmatically via forward/reroute action.
-
UI_NAVIGATE
public static final NavigationTrigger UI_NAVIGATE
Navigation was triggered via
UI.navigate(String, QueryParameters)
. It's for internal use only.
-
CLIENT_SIDE
public static final NavigationTrigger CLIENT_SIDE
Navigation was triggered by client-side.
See Also:
-
-
Method Detail
-
values
public static NavigationTrigger[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (NavigationTrigger c : NavigationTrigger.values()) System.out.println(c);
Returns:
an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static NavigationTrigger valueOf​(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-
-