com.haulmont.cuba.gui.components

Class AbstractEditor<T extends Entity>

java.lang.Object

com.haulmont.cuba.gui.screen.Screen

com.haulmont.cuba.gui.components.AbstractWindow

com.haulmont.cuba.gui.components.AbstractEditor<T>

All Implemented Interfaces:

ActionsHolder, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, ComponentContainer, ExpandingLayout, Frame, Frame.Wrapper, HasMargin, HasSpacing, HasSubParts, HasWindowManager, OrderedContainer, SecuredActionsHolder, SupportsExpandRatio, Window, Window.Committable, Window.Editor<T>, Window.Wrapper, ChangeTracker, LegacyFrame, EditorScreen<T>, FrameOwner

Direct Known Subclasses:

AttributeEditor, AttributeEditWindow, CategoryEditor, ConstraintEditor, ConstraintLocalizationEdit, FileEditor, GroupEditor, JmxInstanceEditor, LockEditor, MbeanInspectWindow, RoleEditor, ScheduledTaskEditor, ScreenEditorWrapper, SessionAttributeEditor, UserEditor, UserSubstitutionEditor

public class AbstractEditor<T extends Entity>
extends AbstractWindow
implements Window.Editor<T>

Base class for edit screen controllers.

Nested Class Summary

Nested classes/interfaces inherited from class com.haulmont.cuba.gui.screen.Screen

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

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Window

Window.BeforeCloseEvent, Window.BeforeCloseWithCloseButtonEvent, Window.BeforeCloseWithShortcutEvent, Window.CloseListener, Window.CloseOrigin, Window.CloseWithCommitListener, Window.Committable, Window.ContentSwitchMode, Window.Editor<T extends Entity>, Window.HasFoldersPane, Window.HasUserIndicator, Window.HasWorkArea, Window.Lookup<T extends Entity>, Window.TopLevelWindow, Window.Wrapper

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Frame

Frame.MessageMode, Frame.MessageType, Frame.NotificationType

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.ExpandingLayout

ExpandingLayout.ExpandDirection

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	commitActionPerformed
protected boolean	crossFieldValidate
protected boolean	justLocked
protected boolean	readOnly
protected boolean	showSaveNotification

Fields inherited from class com.haulmont.cuba.gui.components.AbstractWindow

frame, messages, UNKNOWN_CLOSE_ACTION_ID

Fields inherited from interface com.haulmont.cuba.gui.components.Window.Editor

NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Window

BROWSE_WINDOW_SUFFIX, CLOSE_ACTION_ID, COMMIT_ACTION_ID, CREATE_WINDOW_SUFFIX, EDITOR_WINDOW_SUFFIX, LOOKUP_WINDOW_SUFFIX, SELECT_ACTION_ID

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Fields inherited from interface com.haulmont.cuba.gui.screen.EditorScreen

WINDOW_CLOSE, WINDOW_COMMIT, WINDOW_COMMIT_AND_CLOSE

Fields inherited from interface com.haulmont.cuba.gui.screen.FrameOwner

NO_OPTIONS, WINDOW_CLOSE_ACTION, WINDOW_COMMIT_AND_CLOSE_ACTION, WINDOW_DISCARD_AND_CLOSE_ACTION

Constructor Summary

Constructors

Constructor and Description
AbstractEditor()

Method Summary

Modifier and Type	Method and Description
protected void	afterWindowApplyPostInit() Called after "postInit" in "Apply" action processing.
OperationResult	closeWithCommit() Tries to validate and commit data.
boolean	commit() Called by the framework to validate and commit changes.
boolean	commit(boolean validate) Commit changes with optional validation.
void	commitAndClose() Validate, commit and close the window if commit was successful.
protected boolean	commitInternal(boolean close)
protected Datasource	getDatasourceInternal()
T	getEditedEntity()
T	getItem()
protected MetaClass	getMetaClassForLocking(Datasource ds)
Datasource	getParentDs()
protected void	handlePreviouslyDeletedCompositionItems(Entity entity, DatasourceImplementation parentDs) This method is required for multi-level composition, when a user deletes records from nested editors, saves them and then reopens.
boolean	hasUnsavedChanges()
protected void	initCommitActions(Screen.InitEvent event)
protected void	initNewItem(T item) Hook to be implemented in subclasses.
boolean	isCrossFieldValidate()
boolean	isLocked()
boolean	isModified()
boolean	isShowSaveNotification()
protected boolean	postCommit(boolean committed, boolean close) Hook to be implemented in subclasses.
protected void	postInit() Hook to be implemented in subclasses.
protected boolean	preCommit() Hook to be implemented in subclasses.
void	releaseLock()
void	setCrossFieldValidate(boolean crossFieldValidate) Enable/disable cross field validation on Window.validateAll() call.
void	setEntityToEdit(T entity) Sets entity instance to editor.
void	setItem(Entity item) Called by the framework to set an edited entity after creation of all components and datasources, and after AbstractWindow.init(java.util.Map).
protected void	setItemInternal(Entity item)
void	setParentDs(Datasource parentDs) This method is called by the framework to set parent datasource to commit into this datasource instead of directly to the database.
void	setShowSaveNotification(boolean showSaveNotification)
void	validateAdditionalRules(ValidationErrors errors)

Methods inherited from class com.haulmont.cuba.gui.components.AbstractWindow

add, add, addAction, addAction, addBeforeWindowCloseListener, addFacet, addStyleName, addTimer, afterShow, applySettings, beforeClose, closeWithDiscard, deleteSettings, expand, expand, formatMessage, getAction, getActions, getActionsPermissions, getAlignment, getCaption, getCompanion, getComponent, getComponent, getComponent, getComponents, getComposition, getContentSwitchMode, getContext, getDescription, getDialogOptions, getDsContext, getExpandDirection, getExpandRatio, getFacet, getFacets, getFocusComponent, getFrame, getFrameOwner, getHeight, getHeightSizeUnit, getIcon, getMargin, getMaxHeight, getMaxWidth, getMessage, getMessagesPack, getMinHeight, getMinWidth, getOwnComponent, getOwnComponents, getOwnComponentsStream, getParent, getScreenHashCode, getSettings, getSpacing, getStyleName, getTimer, getWidth, getWidthSizeUnit, getWindowManager, getWrappedFrame, getWrappedWindow, getXmlDescriptor, handleValidationErrors, indexOf, init, init, isAttributeAccessControlEnabled, isCloseable, isEnabled, isEnabledRecursive, isExpanded, isResponsive, isSameScreen, isValid, isVisible, isVisibleRecursive, postValidate, preClose, ready, remove, removeAction, removeAction, removeAll, removeAllActions, removeBeforeWindowCloseListener, removeFacet, removeStyleName, resetExpanded, saveSettings, setAlignment, setCaption, setCloseable, setCompanion, setContentSwitchMode, setDescription, setDsContext, setEnabled, setExpandRatio, setFocusComponent, setFrame, setHeight, setIcon, setIconFromSet, setId, setMargin, setMaxHeight, setMaxWidth, setMessagesPack, setMinHeight, setMinWidth, setParent, setResponsive, setSpacing, setStyleName, setVisible, setWidth, setWindow, setXmlDescriptor, showValidationErrors, unwrap, unwrapComposition, validate, validate, validateAll

Methods inherited from class com.haulmont.cuba.gui.screen.Screen

addAfterCloseListener, addAfterDetachListener, addAfterInitListener, addAfterShowListener, addBeforeCloseListener, addBeforeShowListener, addInitListener, addUrlParamsChangeListener, applyDataLoadingSettings, close, closeWithDefaultAction, fireEvent, getBeanLocator, getEventHub, getExtensions, getId, getScreenData, getUiEventListeners, getWindow, isMultipleOpen, isSaveScreenHistoryOnClose, isSaveSettingsOnClose, setBeanLocator, setExtensions, setScreenData, setUiEventListeners, show

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.haulmont.cuba.gui.components.Window

addBeforeCloseWithCloseButtonListener, addBeforeCloseWithShortcutListener, addBeforeWindowCloseListener, addCloseListener, addCloseWithCommitListener, addListener, addTimer, applySettings, close, close, closeAndRun, deleteSettings, getContext, getDialogOptions, getFocusComponent, getFrameOwner, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getSettings, getTimer, getWindowManager, isCloseable, removeBeforeCloseWithCloseButtonListener, removeBeforeCloseWithShortcutListener, removeBeforeWindowCloseListener, removeCloseListener, removeCloseWithCommitListener, removeListener, saveSettings, setCloseable, setFocusComponent, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, validate, validateAll

Methods inherited from interface com.haulmont.cuba.gui.components.Frame

addFacet, getFacet, getFacetNN, getFacets, isValid, removeFacet, validate

Methods inherited from interface com.haulmont.cuba.gui.components.ExpandingLayout

expand, expand, getExpandDirection, isExpanded, resetExpanded

Methods inherited from interface com.haulmont.cuba.gui.components.OrderedContainer

add, getComponent, getComponentNN, indexOf

Methods inherited from interface com.haulmont.cuba.gui.components.ComponentContainer

add, add, focusFirstComponent, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream, remove, remove, removeAll

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.HasSpacing

getSpacing, setSpacing

Methods inherited from interface com.haulmont.cuba.gui.components.HasMargin

getMargin, setMargin, setMargin, setMargin

Methods inherited from interface com.haulmont.cuba.gui.components.ActionsHolder

addAction, addAction, getAction, getActionNN, getActions, getSubPart, removeAction, removeAction, removeAllActions

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasWindowManager

openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openFrame, openFrame, openLookup, openLookup, openLookup, openLookup, openWindow, openWindow, showMessageDialog, showNotification, showNotification, showNotification, showOptionDialog, showOptionDialog, showWebPage

Methods inherited from interface com.haulmont.cuba.gui.components.SupportsExpandRatio

getExpandRatio, setExpandRatio

Methods inherited from interface com.haulmont.cuba.gui.screen.compatibility.LegacyFrame

getCompanion, getContext, getDsContext, getMessagesPack, getXmlDescriptor, isValid, setDsContext, setMessagesPack, setXmlDescriptor, validate, validate, validateAll

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Wrapper

getComponent, getComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Frame.Wrapper

getWrappedFrame

Field Detail

showSaveNotification

protected boolean showSaveNotification

readOnly

protected boolean readOnly

justLocked

protected boolean justLocked

crossFieldValidate

protected boolean crossFieldValidate

commitActionPerformed

protected boolean commitActionPerformed

Constructor Detail

AbstractEditor

public AbstractEditor()

Method Detail

initCommitActions

protected void initCommitActions(Screen.InitEvent event)

getItem

public T getItem()

Specified by:

getItem in interface Window.Editor<T extends Entity>

Returns:

currently edited entity instance

getParentDs

@Nullable
public Datasource getParentDs()

Specified by:

getParentDs in interface Window.Editor<T extends Entity>

Returns:

parent datasource if it is set

setItem

public void setItem(Entity item)

Called by the framework to set an edited entity after creation of all components and datasources, and after AbstractWindow.init(java.util.Map).

Don't override this method in subclasses, use hooks initNewItem(com.haulmont.cuba.core.entity.Entity) and postInit() instead.

Specified by:

setItem in interface Window.Editor<T extends Entity>

Parameters:

item - entity instance

getDatasourceInternal

protected Datasource getDatasourceInternal()

setItemInternal

protected void setItemInternal(Entity item)

releaseLock

public void releaseLock()

handlePreviouslyDeletedCompositionItems

protected void handlePreviouslyDeletedCompositionItems(Entity entity,
                                                       DatasourceImplementation parentDs)

This method is required for multi-level composition, when a user deletes records from nested editors, saves them and then reopens. When an editor is opened, we reload the item from the database, hence we need to remove nested items previously deleted by the user.

setParentDs

public void setParentDs(Datasource parentDs)

Description copied from interface: Window.Editor

This method is called by the framework to set parent datasource to commit into this datasource instead of directly to the database.

Specified by:

setParentDs in interface Window.Editor<T extends Entity>

getMetaClassForLocking

protected MetaClass getMetaClassForLocking(Datasource ds)

isModified

public boolean isModified()

Specified by:

isModified in interface Window.Committable

Returns:

whether the window contains uncommitted changes

commit

public boolean commit()

Called by the framework to validate and commit changes.

Don't override this method in subclasses, use hooks AbstractWindow.postValidate(ValidationErrors), preCommit() and postCommit(boolean, boolean) instead.

Specified by:

commit in interface Window.Editor<T extends Entity>

Returns:

true if commit was successful

commit

public boolean commit(boolean validate)

Commit changes with optional validation.

Don't override this method in subclasses, use hooks AbstractWindow.postValidate(ValidationErrors), preCommit() and postCommit(boolean, boolean) instead.

Specified by:

commit in interface Window.Editor<T extends Entity>

Parameters:

validate - false to avoid validation

Returns:

true if commit was successful

commitInternal

protected boolean commitInternal(boolean close)

validateAdditionalRules

public void validateAdditionalRules(ValidationErrors errors)

Overrides:

validateAdditionalRules in class AbstractWindow

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

commitAndClose

public void commitAndClose()

Validate, commit and close the window if commit was successful. Passes Window.COMMIT_ACTION_ID to associated CloseListeners

Don't override this method in subclasses, use hooks AbstractWindow.postValidate(ValidationErrors), preCommit() and postCommit(boolean, boolean) instead.

Specified by:

commitAndClose in interface Window.Committable

setEntityToEdit

public void setEntityToEdit(T entity)

Description copied from interface: EditorScreen

Sets entity instance to editor.

Specified by:

setEntityToEdit in interface EditorScreen<T extends Entity>

Parameters:

entity - entity

getEditedEntity

public T getEditedEntity()

Specified by:

getEditedEntity in interface EditorScreen<T extends Entity>

Returns:

currently edited entity instance

hasUnsavedChanges

public boolean hasUnsavedChanges()

Specified by:

hasUnsavedChanges in interface ChangeTracker

Overrides:

hasUnsavedChanges in class AbstractWindow

Returns:

true if screen has unsaved changes

isLocked

public boolean isLocked()

Specified by:

isLocked in interface EditorScreen<T extends Entity>

Returns:

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

isCrossFieldValidate

public boolean isCrossFieldValidate()

Specified by:

isCrossFieldValidate in interface Window.Editor<T extends Entity>

Returns:

true if Editor will perform additional validation on Window.validateAll() call using BeanValidation.

See Also:

BeanValidation

setCrossFieldValidate

public void setCrossFieldValidate(boolean crossFieldValidate)

Description copied from interface: Window.Editor

Enable/disable cross field validation on Window.validateAll() call.
Cross field validation is triggered for item of main datasource with UiCrossFieldChecks group only (without Default group) when there are no other validation errors in UI components.

Cross field validation is triggered before AbstractWindow.postValidate(com.haulmont.cuba.gui.components.ValidationErrors) hook.

Specified by:

setCrossFieldValidate in interface Window.Editor<T extends Entity>

Parameters:

crossFieldValidate - cross field validate flag

See Also:

BeanValidation

initNewItem

protected void initNewItem(T item)

Hook to be implemented in subclasses. Called by setItem(com.haulmont.cuba.core.entity.Entity) when the editor is opened for a new entity instance. Allows to additionally initialize the new entity instance before setting it into the datasource.

Parameters:

item - entity instance

postInit

protected void postInit()

Hook to be implemented in subclasses. Called by setItem(com.haulmont.cuba.core.entity.Entity). At the moment of calling the main datasource is initialized and getItem() returns reloaded entity instance.
This method can be called second time by postCommit(boolean, boolean) if the window is not closed after commit. Then getItem() contains instance, returned from DataService.commit(). This is useful for initialization of components that have to show fresh information from the current instance.
Example:

 protected void postInit() {
     if (!PersistenceHelper.isNew(getItem())) {
        diffFrame.loadVersions(getItem());
        entityLogDs.refresh();
    }
 }
 

preCommit

protected boolean preCommit()

Hook to be implemented in subclasses. Called by the framework when all validation is done and datasources are going to be committed.

Returns:

true to continue, false to abort

postCommit

protected boolean postCommit(boolean committed,
                             boolean close)

Hook to be implemented in subclasses. Called by the framework after committing datasources. The default implementation notifies about commit and calls postInit() if the window is not closing.

Parameters:

committed - whether any data were actually changed and committed

close - whether the window is going to be closed

Returns:

true to continue, false to abort

afterWindowApplyPostInit

protected void afterWindowApplyPostInit()

Called after "postInit" in "Apply" action processing.

isShowSaveNotification

public boolean isShowSaveNotification()

setShowSaveNotification

public void setShowSaveNotification(boolean showSaveNotification)