io.jmix.ui.component

Class Window.BeforeCloseEvent

java.lang.Object

java.util.EventObject

io.jmix.ui.component.Window.BeforeCloseEvent

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

Window

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

Event sent right before the window is closed by an external (relative to the window content) action, like the button in the window tab or by the Esc keyboard shortcut.

The way the window is closing can be obtained via getCloseOrigin(). Closing can be prevented by invoking preventWindowClose(), for example: For example:

     @Subscribe(target = Target.FRAME)
     protected void onBeforeCloseFrame(Window.BeforeCloseEvent event) {
         if (event.getCloseOrigin() == CloseOriginType.BREADCRUMBS) {
             event.preventWindowClose();
         }
     }
 

See Also:

CloseOriginType, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Window.CloseOrigin	closeOrigin
protected boolean	closePrevented

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
BeforeCloseEvent(Window source, Window.CloseOrigin closeOrigin)

Method Summary

Modifier and Type	Method and Description
Window.CloseOrigin	getCloseOrigin()
Window	getSource()
boolean	isClosePrevented()
void	preventWindowClose() Sets closePrevented flag to true and therefore prevents window close.

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

closePrevented

protected boolean closePrevented

closeOrigin

protected Window.CloseOrigin closeOrigin

Constructor Detail

BeforeCloseEvent

public BeforeCloseEvent(Window source,
                        Window.CloseOrigin closeOrigin)

Parameters:

source - the window to be closed

Method Detail

getSource

public Window getSource()

Overrides:

getSource in class java.util.EventObject

getCloseOrigin

public Window.CloseOrigin getCloseOrigin()

Returns:

value that describes the event type: close by shortcut / using close button / from breadcrumbs

See Also:

CloseOriginType

preventWindowClose

public void preventWindowClose()

Sets closePrevented flag to true and therefore prevents window close.

isClosePrevented

public boolean isClosePrevented()

Returns:

true if at least one event handler called preventWindowClose() and window will not be closed