io.jmix.ui.screen

Class StandardEditor<T>

java.lang.Object

io.jmix.ui.screen.Screen

io.jmix.ui.screen.StandardEditor<T>

Type Parameters:

T - type of entity

All Implemented Interfaces:

ChangeTracker, EditorScreen<T>, FrameOwner, ReadOnlyAwareScreen

Direct Known Subclasses:

FilterConditionEdit, MBeanAttributeEditor, MBeanInspectScreen

public abstract class StandardEditor<T>
extends Screen
implements EditorScreen<T>, ReadOnlyAwareScreen

Base class for editor screens.
Supports pessimistic locking, cross field validation and checks for unsaved changes on close.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StandardEditor.AfterCommitChangesEvent Event sent after commit of data context from commitChanges() call.
static class	StandardEditor.BeforeCommitChangesEvent Event sent before commit of data context from commitChanges() call.
static class	StandardEditor.InitEntityEvent<E> Event sent before the new entity instance is set to edited entity container.
static class	StandardEditor.ValidationEvent Event sent when screen is validated from validateAdditionalRules(ValidationErrors) call.

Nested classes/interfaces inherited from class io.jmix.ui.screen.Screen

Screen.AfterCloseEvent, Screen.AfterDetachEvent, Screen.AfterInitEvent, Screen.AfterShowEvent, Screen.BeforeCloseEvent, Screen.BeforeShowEvent, Screen.InitEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	commitActionPerformed
protected boolean	showEnableEditingBtn
protected boolean	showSaveNotification

Fields inherited from interface io.jmix.ui.screen.EditorScreen

ENABLE_EDITING, WINDOW_CLOSE, WINDOW_COMMIT, WINDOW_COMMIT_AND_CLOSE

Fields inherited from interface io.jmix.ui.screen.FrameOwner

NO_OPTIONS, WINDOW_CLOSE_ACTION, WINDOW_COMMIT_AND_CLOSE_ACTION, WINDOW_DISCARD_AND_CLOSE_ACTION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StandardEditor()

Method Summary

Modifier and Type	Method and Description
protected io.jmix.core.common.event.Subscription	addAfterCommitChangesListener(java.util.function.Consumer<StandardEditor.AfterCommitChangesEvent> listener) Adds a listener to StandardEditor.AfterCommitChangesEvent.
protected io.jmix.core.common.event.Subscription	addBeforeCommitChangesListener(java.util.function.Consumer<StandardEditor.BeforeCommitChangesEvent> listener) Adds a listener to StandardEditor.BeforeCommitChangesEvent.
protected Action	addDefaultCloseAction(io.jmix.core.Messages messages, Icons icons)
protected Action	addDefaultCommitAction(io.jmix.core.Messages messages, Icons icons)
protected Action	addDefaultCommitAndCloseAction(io.jmix.core.Messages messages, Icons icons)
protected Action	addDefaultEnableEditingAction(io.jmix.core.Messages messages, Icons icons)
protected io.jmix.core.common.event.Subscription	addInitEntityListener(java.util.function.Consumer<StandardEditor.InitEntityEvent<T>> listener) Adds a listener to StandardEditor.InitEntityEvent.
protected io.jmix.core.common.event.Subscription	addValidationEventListener(java.util.function.Consumer<StandardEditor.ValidationEvent> listener) Adds a listener to StandardEditor.ValidationEvent.
protected void	cancel(Action.ActionPerformedEvent event)
OperationResult	closeWithCommit() Tries to validate and commit data.
OperationResult	closeWithDiscard() Ignores the unsaved changes and closes the screen with FrameOwner.WINDOW_DISCARD_AND_CLOSE_ACTION action.
protected void	commit(Action.ActionPerformedEvent event)
protected void	commitAndClose(Action.ActionPerformedEvent event)
protected OperationResult	commitChanges() Validates screen and commits data context.
protected void	disableCommitActions()
protected boolean	doNotReloadEditedEntity()
protected void	editedEntityCommitted(DataContext.PostCommitEvent event)
protected void	editedEntityModified(DataContext.ChangeEvent event)
protected void	enableEditing(Action.ActionPerformedEvent actionPerformedEvent)
T	getEditedEntity()
protected InstanceContainer<T>	getEditedEntityContainer()
protected InstanceLoader	getEditedEntityLoader()
protected java.lang.String	getSaveNotificationCaption()
protected java.util.Optional<Action>	getWindowActionOptional(java.lang.String id)
boolean	hasUnsavedChanges()
protected void	initActions(Screen.InitEvent event)
protected boolean	isCrossFieldValidate()
protected boolean	isEntityModified()
protected boolean	isEntityModifiedInParentContext()
protected boolean	isEntityModifiedRecursive(java.lang.Object entity, DataContext dataContext, java.util.HashSet<java.lang.Object> visited)
boolean	isLocked()
boolean	isReadOnly()
protected boolean	isReadOnlyDueToLock()
boolean	isShowSaveNotification()
protected void	preventUnsavedChanges(Screen.BeforeCloseEvent event)
protected void	releaseLock()
protected void	setCrossFieldValidate(boolean crossFieldValidate)
protected void	setEntityModified(boolean entityModified)
void	setEntityToEdit(T item) Sets entity instance to editor.
void	setReadOnly(boolean readOnly) Changes the read-only mode.
void	setShowSaveNotification(boolean showSaveNotification) Sets whether a notification will be shown in case of successful commit.
protected void	setupEntityToEdit()
protected void	setupLock()
protected void	setupModifiedTracking()
protected void	showSaveNotification()
protected void	validateAdditionalRules(ValidationErrors errors)
protected ValidationErrors	validateScreen() Validates screen data.
protected ValidationErrors	validateUiComponents() Validates visible and enabled UI components.

Methods inherited from class io.jmix.ui.screen.Screen

addAfterCloseListener, addAfterDetachListener, addAfterInitListener, addAfterShowListener, addBeforeCloseListener, addBeforeShowListener, addInitListener, addUrlParamsChangeListener, close, close, closeWithDefaultAction, fireEvent, getApplicationContext, getEventHub, getExtensions, getId, getScreenData, getUiEventListeners, getWindow, isMultipleOpen, isSameScreen, setApplicationContext, setExtensions, setId, setScreenData, setUiEventListeners, setWindow, show

Methods inherited from class java.lang.Object

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

Field Detail

showSaveNotification

protected boolean showSaveNotification

commitActionPerformed

protected boolean commitActionPerformed

showEnableEditingBtn

protected boolean showEnableEditingBtn

Constructor Detail

StandardEditor

protected StandardEditor()

Method Detail

initActions

protected void initActions(Screen.InitEvent event)

getWindowActionOptional

protected java.util.Optional<Action> getWindowActionOptional(java.lang.String id)

addDefaultCommitAndCloseAction

protected Action addDefaultCommitAndCloseAction(io.jmix.core.Messages messages,
                                                Icons icons)

addDefaultCommitAction

protected Action addDefaultCommitAction(io.jmix.core.Messages messages,
                                        Icons icons)

addDefaultCloseAction

protected Action addDefaultCloseAction(io.jmix.core.Messages messages,
                                       Icons icons)

addDefaultEnableEditingAction

protected Action addDefaultEnableEditingAction(io.jmix.core.Messages messages,
                                               Icons icons)

enableEditing

protected void enableEditing(Action.ActionPerformedEvent actionPerformedEvent)

setupModifiedTracking

protected void setupModifiedTracking()

editedEntityModified

protected void editedEntityModified(DataContext.ChangeEvent event)

editedEntityCommitted

protected void editedEntityCommitted(DataContext.PostCommitEvent event)

preventUnsavedChanges

protected void preventUnsavedChanges(Screen.BeforeCloseEvent event)

setupEntityToEdit

protected void setupEntityToEdit()

setupLock

protected void setupLock()

releaseLock

protected void releaseLock()

doNotReloadEditedEntity

protected boolean doNotReloadEditedEntity()

isEntityModifiedInParentContext

protected boolean isEntityModifiedInParentContext()

isEntityModifiedRecursive

protected boolean isEntityModifiedRecursive(java.lang.Object entity,
                                            DataContext dataContext,
                                            java.util.HashSet<java.lang.Object> visited)

getEditedEntityLoader

protected InstanceLoader getEditedEntityLoader()

getEditedEntityContainer

protected InstanceContainer<T> getEditedEntityContainer()

getEditedEntity

public T getEditedEntity()

Specified by:

getEditedEntity in interface EditorScreen<T>

Returns:

currently edited entity instance

setEntityToEdit

public void setEntityToEdit(T item)

Description copied from interface: EditorScreen

Sets entity instance to editor.

Specified by:

setEntityToEdit in interface EditorScreen<T>

Parameters:

item - entity

hasUnsavedChanges

public boolean hasUnsavedChanges()

Specified by:

hasUnsavedChanges in interface ChangeTracker

Returns:

true if screen has unsaved changes

commitChanges

protected OperationResult commitChanges()

Validates screen and commits data context.

Returns:

operation result

isLocked

public boolean isLocked()

Specified by:

isLocked in interface EditorScreen<T>

Returns:

true if the edited item has been pessimistically locked when the screen is opened

setEntityModified

protected void setEntityModified(boolean entityModified)

isEntityModified

protected boolean isEntityModified()

Returns:

true if user has edited entity after screen opening

isReadOnlyDueToLock

protected boolean isReadOnlyDueToLock()

Returns:

true if the editor switched to read-only mode because the entity is locked by another user

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface ReadOnlyAwareScreen

Returns:

whether a screen controller in read-only mode.

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from interface: ReadOnlyAwareScreen

Changes the read-only mode.

Specified by:

setReadOnly in interface ReadOnlyAwareScreen

Parameters:

readOnly - true to enable the read-only mode, false otherwise

disableCommitActions

protected void disableCommitActions()

isCrossFieldValidate

protected boolean isCrossFieldValidate()

Returns:

true if cross-field validation is enabled

setCrossFieldValidate

protected void setCrossFieldValidate(boolean crossFieldValidate)

validateScreen

protected ValidationErrors validateScreen()

Validates screen data. Default implementation validates visible and enabled UI components.
Can be overridden in subclasses.

Returns:

validation errors

validateUiComponents

protected ValidationErrors validateUiComponents()

Validates visible and enabled UI components.
Can be overridden in subclasses.

Returns:

validation errors

validateAdditionalRules

protected void validateAdditionalRules(ValidationErrors errors)

commitAndClose

protected void commitAndClose(Action.ActionPerformedEvent event)

commit

protected void commit(Action.ActionPerformedEvent event)

showSaveNotification

protected void showSaveNotification()

getSaveNotificationCaption

protected java.lang.String getSaveNotificationCaption()

cancel

protected void cancel(Action.ActionPerformedEvent event)

closeWithCommit

public OperationResult closeWithCommit()

Tries to validate and commit data. If data committed successfully then closes the screen with EditorScreen.WINDOW_COMMIT_AND_CLOSE action. May show validation errors or open an additional dialog before closing the screen.

Returns:

result of close request

closeWithDiscard

public OperationResult closeWithDiscard()

Ignores the unsaved changes and closes the screen with FrameOwner.WINDOW_DISCARD_AND_CLOSE_ACTION action.

Returns:

result of close request

isShowSaveNotification

public boolean isShowSaveNotification()

Returns:

whether a notification will be shown in case of successful commit

setShowSaveNotification

public void setShowSaveNotification(boolean showSaveNotification)

Sets whether a notification will be shown in case of successful commit.

Parameters:

showSaveNotification - true if a notification needs to be shown, false otherwise

addInitEntityListener

protected io.jmix.core.common.event.Subscription addInitEntityListener(java.util.function.Consumer<StandardEditor.InitEntityEvent<T>> listener)

Adds a listener to StandardEditor.InitEntityEvent.

Parameters:

listener - listener

Returns:

subscription

addBeforeCommitChangesListener

protected io.jmix.core.common.event.Subscription addBeforeCommitChangesListener(java.util.function.Consumer<StandardEditor.BeforeCommitChangesEvent> listener)

Adds a listener to StandardEditor.BeforeCommitChangesEvent.

Parameters:

listener - listener

Returns:

subscription

addAfterCommitChangesListener

protected io.jmix.core.common.event.Subscription addAfterCommitChangesListener(java.util.function.Consumer<StandardEditor.AfterCommitChangesEvent> listener)

Adds a listener to StandardEditor.AfterCommitChangesEvent.

Parameters:

listener - listener

Returns:

subscription

addValidationEventListener

protected io.jmix.core.common.event.Subscription addValidationEventListener(java.util.function.Consumer<StandardEditor.ValidationEvent> listener)

Adds a listener to StandardEditor.ValidationEvent.

Parameters:

listener - listener

Returns:

subscription