io.jmix.ui.screen

Class StandardEditor.BeforeCommitChangesEvent

java.lang.Object

java.util.EventObject

io.jmix.ui.screen.StandardEditor.BeforeCommitChangesEvent

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

StandardEditor<T>

public static class StandardEditor.BeforeCommitChangesEvent
extends java.util.EventObject

Event sent before commit of data context from StandardEditor.commitChanges() call.
Use this event listener to prevent commit and/or show additional dialogs to user before commit, for example:

     @Subscribe
     protected void onBeforeCommit(BeforeCommitChangesEvent event) {
         if (getEditedEntity().getDescription() == null) {
             notifications.create().withCaption("Description required").show();
             event.preventCommit();
         }
     }
 

Show dialog and resume commit after:

     @Subscribe
     protected void onBeforeCommit(BeforeCommitChangesEvent event) {
         if (getEditedEntity().getDescription() == null) {
             dialogs.createOptionDialog()
                     .withCaption("Question")
                     .withMessage("Do you want to set default description?")
                     .withActions(
                             new DialogAction(DialogAction.Type.YES).withHandler(e -> {
                                 getEditedEntity().setDescription("No description");

                                 // retry commit and resume action
                                 event.resume(commitChanges());
                             }),
                             new DialogAction(DialogAction.Type.NO).withHandler(e -> {
                                 // trigger standard commit and resume action
                                 event.resume();
                             })
                     )
                     .show();

             event.preventCommit();
         }
     }
 

See Also:

StandardEditor.addBeforeCommitChangesListener(Consumer), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	commitPrevented
protected OperationResult	commitResult
protected java.lang.Runnable	resumeAction

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
BeforeCommitChangesEvent(Screen source, java.lang.Runnable resumeAction)

Method Summary

Modifier and Type	Method and Description
OperationResult	getCommitResult()
DataContext	getDataContext()
Screen	getSource()
boolean	isCommitPrevented()
void	preventCommit() Prevents commit of the screen.
void	preventCommit(OperationResult commitResult) Prevents commit of the screen.
void	resume() Resume standard execution.
void	resume(OperationResult result) Resume with the passed result ignoring standard execution.

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

resumeAction

protected final java.lang.Runnable resumeAction

commitPrevented

protected boolean commitPrevented

commitResult

protected OperationResult commitResult

Constructor Detail

BeforeCommitChangesEvent

public BeforeCommitChangesEvent(Screen source,
                                @Nullable
                                java.lang.Runnable resumeAction)

Method Detail

getSource

public Screen getSource()

Overrides:

getSource in class java.util.EventObject

getDataContext

public DataContext getDataContext()

Returns:

data context of the screen

preventCommit

public void preventCommit()

Prevents commit of the screen.

preventCommit

public void preventCommit(OperationResult commitResult)

Prevents commit of the screen.

Parameters:

commitResult - result object that will be returned from the StandardEditor.commitChanges()} method

resume

public void resume()

Resume standard execution.

resume

public void resume(OperationResult result)

Resume with the passed result ignoring standard execution. The standard commit will not be performed.

getCommitResult

@Nullable
public OperationResult getCommitResult()

Returns:

result passed to the preventCommit(OperationResult) method

isCommitPrevented

public boolean isCommitPrevented()

Returns:

whether the commit was prevented by invoking preventCommit() method