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.
Class BeforeLeaveEvent
- java.lang.Object
-
- java.util.EventObject
-
- com.vaadin.flow.router.BeforeEvent
-
- com.vaadin.flow.router.BeforeLeaveEvent
-
All Implemented Interfaces:
public class BeforeLeaveEvent extends BeforeEventEvent created before navigation happens.
Since:
1.0
Author:
Vaadin Ltd
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description classBeforeLeaveEvent.ContinueNavigationActionThe action to resume a postponed
BeforeEnterEvent.
-
Field Summary
-
Fields inherited from class java.util.EventObject
source
-
-
Constructor Summary
Constructors Constructor and Description BeforeLeaveEvent(NavigationEvent event, Class<?> navigationTarget)Deprecated.
UseBeforeLeaveEvent(NavigationEvent, Class, List)instead.BeforeLeaveEvent(NavigationEvent event, Class<?> navigationTarget, List<Class<? extends RouterLayout>> layouts)Construct event from a NavigationEvent.
BeforeLeaveEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, UI ui)Deprecated.
BeforeLeaveEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, UI ui, List<Class<? extends RouterLayout>> layouts)Constructs a new BeforeNavigation Event.
-
Method Summary
All Methods Modifier and Type Method and Description BeforeLeaveEvent.ContinueNavigationActiongetContinueNavigationAction()Gets the action used to resume this event, if it was postponed.
booleanisPostponed()Checks whether this event was postponed.
BeforeLeaveEvent.ContinueNavigationActionpostpone()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, getErrorParameter, getForwardTarget, getForwardTargetParameters, getForwardTargetType, getLayouts, getLocation, getNavigationTarget, getRerouteTarget, getRouteTargetType, getSource, getTrigger, getUI, hasErrorParameter, hasForwardTarget, hasRerouteTarget, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteTo, rerouteToError, rerouteToError, rerouteToError
-
Methods inherited from class java.util.EventObject
toString
-
-
-
-
Constructor Detail
-
BeforeLeaveEvent
@Deprecated public BeforeLeaveEvent(NavigationEvent event, Class<?> navigationTarget)Deprecated. Use
BeforeLeaveEvent(NavigationEvent, Class, List)instead.Construct event from a NavigationEvent.
Parameters:
event- NavigationEvent that is on-goingnavigationTarget- Navigation target
-
BeforeLeaveEvent
public BeforeLeaveEvent(NavigationEvent event, Class<?> navigationTarget, List<Class<? extends RouterLayout>> layouts)Construct event from a NavigationEvent.
Parameters:
event- NavigationEvent that is on-goingnavigationTarget- Navigation targetlayouts- Navigation layout chain
-
BeforeLeaveEvent
@Deprecated public BeforeLeaveEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, UI ui)Deprecated. Use
BeforeLeaveEvent(Router, NavigationTrigger, Location, Class, UI, List)instead.Constructs a new BeforeNavigation Event.
Parameters:
router- the router that triggered the change, notnulltrigger- the type of user action that triggered this location change, notnulllocation- the new location, notnullnavigationTarget- navigation target classui- the UI related to the navigation
-
BeforeLeaveEvent
public BeforeLeaveEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, UI ui, List<Class<? extends RouterLayout>> layouts)Constructs a new BeforeNavigation Event.
Parameters:
router- the router that triggered the change, notnulltrigger- the type of user action that triggered this location change, notnulllocation- the new location, notnullnavigationTarget- navigation target classui- the UI related to the navigationlayouts- the layout chain for the navigation target
-
-
Method Detail
-
postpone
public BeforeLeaveEvent.ContinueNavigationAction 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
-
getContinueNavigationAction
public BeforeLeaveEvent.ContinueNavigationAction getContinueNavigationAction()Gets the action used to resume this event, if it was postponed.
Returns:
the action used to resume this event if it was postponed, or null if it is not being postponed
-
-