Package io.jmix.flowui.view

Class View.BeforeCloseEvent

java.lang.Object

java.util.EventObject

com.vaadin.flow.component.ComponentEvent<View<?>>

io.jmix.flowui.view.View.BeforeCloseEvent

All Implemented Interfaces:

Serializable

Enclosing class:

View<T extends com.vaadin.flow.component.Component>

public static class View.BeforeCloseEvent
extends com.vaadin.flow.component.ComponentEvent<View<?>>

The first event in the view closing process. The view is still displayed and fully functional.

In this event listener, you can check any conditions and prevent closing using the preventClose() method of the event, for example:

     @Subscribe
     protected void onBeforeClose(BeforeCloseEvent event) {
         if (Strings.isNullOrEmpty(textField.getTypedValue())) {
             notifications.show("Input required");
             event.preventClose();
         }
     }
 

Note the event can be triggered few times for one View instance. It may happen if the user tries to navigate to the same View, which is currently opened. In this case, View.BeforeCloseEvent is triggered, because we "close" the View, however due to navigation the same instance of View will be opened. It means View.BeforeCloseEvent will be triggered again for the same View instance, when user close the View or navigates to another one.

See Also:

• View.addBeforeCloseListener(ComponentEventListener)
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final CloseAction	closeAction
protected boolean	closePrevented
protected OperationResult	closeResult

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
BeforeCloseEvent(View<?> source, CloseAction closeAction)

Method Summary

Modifier and Type	Method	Description
boolean	closedWith(StandardOutcome outcome)	Checks that view was closed with the given outcome.
CloseAction	getCloseAction()
Optional<OperationResult>	getCloseResult()
boolean	isClosePrevented()
void	preventClose()	Prevents closing of the view.
void	preventClose(OperationResult closeResult)	Prevents closing of the view.

Methods inherited from class com.vaadin.flow.component.ComponentEvent

getSource, isFromClient, unregisterListener

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

Field Details

closeAction

protected final CloseAction closeAction

closeResult

protected OperationResult closeResult

closePrevented

protected boolean closePrevented

Constructor Details

BeforeCloseEvent

public BeforeCloseEvent(View<?> source,
 CloseAction closeAction)

Method Details

getCloseAction

public CloseAction getCloseAction()

Returns:

action passed to the View.close(CloseAction) method or NavigateCloseAction

preventClose

public void preventClose()

Prevents closing of the view.

preventClose

public void preventClose(OperationResult closeResult)

Prevents closing of the view.

Parameters:

closeResult - result object returned from the View.close(CloseAction) method

isClosePrevented

public boolean isClosePrevented()

Returns:

whether the closing was prevented by invoking preventClose() method

getCloseResult

public Optional<OperationResult> getCloseResult()

Returns:

result passed to the preventClose(OperationResult) method

closedWith

public boolean closedWith(StandardOutcome outcome)

Checks that view was closed with the given outcome.