Package com.vaadin.flow.router

Enum Class NavigationTrigger

java.lang.Object

java.lang.Enum<NavigationTrigger>

com.vaadin.flow.router.NavigationTrigger

All Implemented Interfaces:

Serializable, Comparable<NavigationTrigger>, Constable

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()

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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.
REFRESH	Navigation is for a reload event on a preserveOnRefresh route.
ROUTER_LINK	Navigation was triggered by the user following a router link.
UI_NAVIGATE	Navigation was triggered via UI.navigate(String, QueryParameters).

Method Summary

Modifier and Type	Method	Description
static NavigationTrigger	valueOf(String name)	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.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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:

• RouterLink

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.

REFRESH

public static final NavigationTrigger REFRESH

Navigation is for a reload event on a preserveOnRefresh route.

Method Details

values

public static NavigationTrigger[] 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

public static NavigationTrigger valueOf(String name)

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 name

NullPointerException - if the argument is null