com.vaadin.flow.router.NavigationEvent API 14.1.16 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.router.

java.lang.Object
- java.util.EventObject
- - com.vaadin.flow.router.NavigationEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ErrorNavigationEvent
```
public class NavigationEvent
extends EventObject
```
Event object with data related to navigation.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Field Summary
- Fields inherited from class java.util.EventObject
  source

Constructor Summary

Constructors
Constructor and Description
`NavigationEvent(Router router, Location location, UI ui, NavigationTrigger trigger)` Creates a new navigation event.

Method Summary

All Methods
Modifier and Type	Method and Description
`Location`	`getLocation()` Gets the new location.
`Router`	`getSource()`
`NavigationTrigger`	`getTrigger()` Gets the type of user action that triggered this navigation event.
`UI`	`getUI()` Gets the UI in which the navigation occurs.

Methods inherited from class java.util.EventObject
toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - NavigationEvent
```
public NavigationEvent(Router router,
                       Location location,
                       UI ui,
                       NavigationTrigger trigger)
```
    Creates a new navigation event.
    
    Parameters:
    
    router - the router handling the navigation, not null
    
    location - the new location, not null
    
    ui - the UI in which the navigation occurs, not null
    
    trigger - the type of user action that triggered this navigation event, not null
- Method Detail
  - getSource
```
public Router getSource()
```
    Overrides:
    
    getSource in class EventObject
  - getLocation
```
public Location getLocation()
```
    Gets the new location.
    
    Returns:
    
    the new location, not null
  - getUI
```
public UI getUI()
```
    Gets the UI in which the navigation occurs.
    
    Returns:
    
    the UI of the navigation
  - getTrigger
```
public NavigationTrigger getTrigger()
```
    Gets the type of user action that triggered this navigation event.
    
    Returns:
    
    the type of user action that triggered this navigation event, not null