We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.router.
Package com.vaadin.flow.router
Class BeforeLeaveEvent
java.lang.Object
java.util.EventObject
com.vaadin.flow.router.BeforeEvent
com.vaadin.flow.router.BeforeLeaveEvent
All Implemented Interfaces:
Event created before navigation happens.
Since:
1.0
Author:
Vaadin Ltd
See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from class java.util.EventObject
source -
Constructor Summary
ConstructorsConstructorDescriptionBeforeLeaveEvent(NavigationEvent event, Class<?> navigationTarget, RouteParameters parameters, List<Class<? extends RouterLayout>> layouts) Constructs event from a NavigationEvent.
BeforeLeaveEvent(NavigationEvent event, Class<?> navigationTarget, List<Class<? extends RouterLayout>> layouts) Constructs event from a NavigationEvent.
BeforeLeaveEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, UI ui, List<Class<? extends RouterLayout>> layouts) Constructs a new BeforeLeaveEvent.
BeforeLeaveEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, RouteParameters parameters, UI ui, List<Class<? extends RouterLayout>> layouts) Constructs a new BeforeLeaveEvent.
-
Method Summary
Modifier and TypeMethodDescriptionGets the action used to resume this event, if it was postponed.
booleanChecks whether this event was postponed.
postpone()Initiates the postponement of the current navigation transition, allowing a listener to e.g.
Methods inherited from class com.vaadin.flow.router.BeforeEvent
forwardTo, forwardTo, forwardTo, forwardTo, forwardTo, forwardTo, forwardTo, forwardTo, forwardTo, forwardTo, forwardTo, forwardTo, forwardTo, forwardTo, forwardToUrl, getErrorParameter, getExternalForwardUrl, getForwardTarget, getForwardTargetRouteParameters, getForwardTargetType, getForwardUrl, getLayouts, getLocation, getNavigationTarget, getRedirectQueryParameters, getRerouteTarget, getRerouteTargetRouteParameters, getRerouteTargetType, getRerouteUrl, getRouteParameters, getSource, getTrigger, getUI, getUnknownForward, getUnknownReroute, hasErrorParameter, hasExternalForwardUrl, hasForwardTarget, hasRedirectQueryParameters, hasRerouteTarget, hasUnknownForward, hasUnknownReroute, isUseForwardCallback, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteToError, rerouteToError, rerouteToErrorMethods inherited from class java.util.EventObject
toString
-
Constructor Details
-
Method Details
-
postpone
Initiates the postponement of the current navigation transition, allowing a listener to e.g. display a confirmation dialog before finishing the transition.
This is only valid while leaving (deactivating) a page; if the method is called while entering / activating the new page, it will throw an
IllegalStateException.Returns:
the action to run when the transition is to be resumed, or null
-
isPostponed
public boolean isPostponed()Checks whether this event was postponed.
Returns:
true if the event was postponed, false otherwise
-