Package com.vaadin.flow.router

Class BeforeEnterEvent

java.lang.Object

java.util.EventObject

com.vaadin.flow.router.BeforeEvent

com.vaadin.flow.router.BeforeEnterEvent

All Implemented Interfaces:

Serializable

public class BeforeEnterEvent
extends BeforeEvent

Event created before navigation happens.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
BeforeEnterEvent(NavigationEvent event, Class<?> navigationTarget, RouteParameters parameters, List<Class<? extends RouterLayout>> layouts)	Constructs event from a NavigationEvent.
BeforeEnterEvent(NavigationEvent event, Class<?> navigationTarget, List<Class<? extends RouterLayout>> layouts)	Constructs event from a NavigationEvent.
BeforeEnterEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeEnterEvent.
BeforeEnterEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, RouteParameters parameters, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeEnterEvent.

Method Summary

Modifier and Type	Method	Description
boolean	isRefreshEvent()	Check if event is for a refresh of a preserveOnRefresh view.

Methods inherited from class com.vaadin.flow.router.BeforeEvent

forwardTo, forwardTo, forwardTo, forwardTo, forwardTo, forwardTo, forwardTo, forwardToUrl, getErrorParameter, getExternalForwardUrl, getForwardTarget, getForwardTargetParameters, getForwardTargetRouteParameters, getForwardTargetType, getForwardUrl, getLayouts, getLocation, getNavigationTarget, getRerouteTarget, getRerouteTargetParameters, getRerouteTargetRouteParameters, getRerouteTargetType, getRerouteUrl, getRouteParameters, getRouteTargetType, getSource, getTrigger, getUI, getUnknownForward, getUnknownReroute, hasErrorParameter, hasExternalForwardUrl, hasForwardTarget, hasRerouteTarget, hasUnknownForward, hasUnknownReroute, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteToError, rerouteToError, rerouteToError

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

BeforeEnterEvent

public BeforeEnterEvent(NavigationEvent event,
                        Class<?> navigationTarget,
                        List<Class<? extends RouterLayout>> layouts)

Constructs event from a NavigationEvent.

Parameters:

event - NavigationEvent that is on-going, not null

navigationTarget - navigation target, not null

layouts - navigation layout chain, not null

BeforeEnterEvent

public BeforeEnterEvent(NavigationEvent event,
                        Class<?> navigationTarget,
                        RouteParameters parameters,
                        List<Class<? extends RouterLayout>> layouts)

Constructs event from a NavigationEvent.

Parameters:

event - NavigationEvent that is on-going, not null

navigationTarget - navigation target, not null

parameters - route parameters, not null

layouts - navigation layout chain, not null

BeforeEnterEvent

public BeforeEnterEvent(Router router,
                        NavigationTrigger trigger,
                        Location location,
                        Class<?> navigationTarget,
                        UI ui,
                        List<Class<? extends RouterLayout>> layouts)

Constructs a new BeforeEnterEvent.

Parameters:

router - the router that triggered the change, not null

trigger - the type of user action that triggered this location change, not null

location - the new location, not null

navigationTarget - navigation target class, not null

ui - the UI related to the navigation, not null

layouts - the layout chain for the navigation target, not null

BeforeEnterEvent

public BeforeEnterEvent(Router router,
                        NavigationTrigger trigger,
                        Location location,
                        Class<?> navigationTarget,
                        RouteParameters parameters,
                        UI ui,
                        List<Class<? extends RouterLayout>> layouts)

Constructs a new BeforeEnterEvent.

Parameters:

router - the router that triggered the change, not null

trigger - the type of user action that triggered this location change, not null

location - the new location, not null

navigationTarget - navigation target class, not null

parameters - route parameters, not null

ui - the UI related to the navigation, not null

layouts - the layout chain for the navigation target, not null

Method Detail

isRefreshEvent

public boolean isRefreshEvent()

Check if event is for a refresh of a preserveOnRefresh view.

Returns:

true if refresh of a preserve on refresh view