io.jmix.ui.screen

Class Screen.BeforeCloseEvent

java.lang.Object

java.util.EventObject

io.jmix.ui.screen.Screen.BeforeCloseEvent

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Screen

public static class Screen.BeforeCloseEvent
extends java.util.EventObject

Event sent right before the screen is closed by its Screen.close(CloseAction) method. The screen is still displayed and fully functional. Component settings are not saved yet.

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

     @Subscribe
     protected void onBeforeClose(BeforeCloseEvent event) {
         if (Strings.isNullOrEmpty(textField.getValue())) {
             notifications.create().withCaption("Input required").show();
             event.preventWindowClose();
         }
     }
 

See Also:

Screen.addBeforeCloseListener(Consumer), Serialized Form

Field Summary

Fields

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

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
BeforeCloseEvent(Screen source, CloseAction closeAction)

Method Summary

Modifier and Type	Method and Description
boolean	closedWith(StandardOutcome outcome) Checks that screen was closed with the given outcome.
CloseAction	getCloseAction()
OperationResult	getCloseResult()
Screen	getSource()
boolean	isClosePrevented()
void	preventWindowClose() Prevents closing of the screen.
void	preventWindowClose(OperationResult closeResult) Prevents closing of the screen.

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 Detail

closeAction

protected final CloseAction closeAction

closePrevented

protected boolean closePrevented

closeResult

protected OperationResult closeResult

Constructor Detail

BeforeCloseEvent

public BeforeCloseEvent(Screen source,
                        CloseAction closeAction)

Method Detail

getSource

public Screen getSource()

Overrides:

getSource in class java.util.EventObject

getCloseAction

public CloseAction getCloseAction()

Returns:

action passed to the Screen.close(CloseAction) method of the screen.

preventWindowClose

public void preventWindowClose()

Prevents closing of the screen.

preventWindowClose

public void preventWindowClose(OperationResult closeResult)

Prevents closing of the screen.

Parameters:

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

getCloseResult

@Nullable
public OperationResult getCloseResult()

Returns:

result passed to the preventWindowClose(OperationResult) method

isClosePrevented

public boolean isClosePrevented()

Returns:

whether the closing was prevented by invoking preventWindowClose() method

closedWith

public boolean closedWith(StandardOutcome outcome)

Checks that screen was closed with the given outcome.