Package io.jmix.flowui.view

Class NavigateCloseAction

java.lang.Object

io.jmix.flowui.view.StandardCloseAction

io.jmix.flowui.view.NavigateCloseAction

All Implemented Interfaces:

ChangeTrackerCloseAction, CloseAction

public class NavigateCloseAction
extends StandardCloseAction

A specialized close action that represents navigation away from a view, potentially checking for unsaved changes and handling events related to leaving the current view.

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.vaadin.flow.router.BeforeLeaveEvent	beforeLeaveEvent
static final String	ID

Fields inherited from class io.jmix.flowui.view.StandardCloseAction

actionId, checkForUnsavedChanges

Constructor Summary

Constructors

Constructor	Description
NavigateCloseAction(com.vaadin.flow.router.BeforeLeaveEvent beforeLeaveEvent)
NavigateCloseAction(String actionId, com.vaadin.flow.router.BeforeLeaveEvent beforeLeaveEvent)
NavigateCloseAction(String actionId, com.vaadin.flow.router.BeforeLeaveEvent beforeLeaveEvent, boolean checkForUnsavedChanges)

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.router.BeforeLeaveEvent	getBeforeLeaveEvent()	Returns the BeforeLeaveEvent associated with this action.

Methods inherited from class io.jmix.flowui.view.StandardCloseAction

getActionId, isCheckForUnsavedChanges, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

beforeLeaveEvent

protected final com.vaadin.flow.router.BeforeLeaveEvent beforeLeaveEvent

Constructor Details

NavigateCloseAction

public NavigateCloseAction(com.vaadin.flow.router.BeforeLeaveEvent beforeLeaveEvent)

NavigateCloseAction

public NavigateCloseAction(String actionId,
 com.vaadin.flow.router.BeforeLeaveEvent beforeLeaveEvent)

NavigateCloseAction

public NavigateCloseAction(String actionId,
 com.vaadin.flow.router.BeforeLeaveEvent beforeLeaveEvent,
 boolean checkForUnsavedChanges)

Method Details

getBeforeLeaveEvent

public com.vaadin.flow.router.BeforeLeaveEvent getBeforeLeaveEvent()

Returns the BeforeLeaveEvent associated with this action.

Returns:

the BeforeLeaveEvent instance tied to this action, which contains information about the navigation event and allows handling or vetoing the leave action