com.haulmont.cuba.gui.components

Class AbstractEditor<T extends Entity>

java.lang.Object

com.haulmont.cuba.gui.components.AbstractFrame

com.haulmont.cuba.gui.components.AbstractWindow

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

All Implemented Interfaces:

Component, Component.ActionsHolder, Component.BelongToFrame, Component.Container, Component.HasCaption, Component.HasIcon, Component.HasXmlDescriptor, Component.Margin, Component.OrderedContainer, Component.SecuredActionsHolder, Component.Spacing, Component.Wrapper, ExpandingLayout, Frame, Frame.Wrapper, Window, Window.Committable, Window.Editor, Window.Wrapper

Direct Known Subclasses:

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

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

Base class for edit screen controllers.

Nested Class Summary

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

Window.BeforeCloseEvent, Window.BeforeCloseWithCloseButtonEvent, Window.BeforeCloseWithCloseButtonListener, Window.BeforeCloseWithShortcutEvent, Window.BeforeCloseWithShortcutListener, Window.CloseListener, Window.CloseWithCommitListener, Window.Committable, Window.ContentSwitchMode, Window.Editor, Window.HasFoldersPane, Window.HasUserIndicator, Window.HasWorkArea, Window.Lookup, Window.MainWindow, Window.TopLevelWindow, Window.Wrapper

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

Frame.MessageMode, Frame.MessageType, Frame.NotificationType, Frame.UiEventListenersHolder

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.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener

Field Summary

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

NAME, WINDOW_CLOSE, WINDOW_COMMIT, WINDOW_COMMIT_AND_CLOSE

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, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
AbstractEditor()

Method Summary

Modifier and Type	Method and Description
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.
T	getItem()
Datasource	getParentDs()
boolean	isCrossFieldValidate()
boolean	isLocked()
boolean	isModified()
boolean	isShowSaveNotification()
void	setCrossFieldValidate(boolean crossFieldValidate) Enable/disable cross field validation on Window.validateAll() call.
void	setItem(Entity item) Called by the framework to set an edited entity after creation of all components and datasources, and after AbstractFrame.init(java.util.Map).
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)

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

addBeforeCloseWithCloseButtonListener, addBeforeCloseWithShortcutListener, addCloseListener, addCloseWithCommitListener, addListener, addTimer, applySettings, close, close, closeAndRun, deleteSettings, getActionsPermissions, getCaption, getContentSwitchMode, getContext, getDescription, getDialogOptions, getDsContext, getFocusComponent, getIcon, getSettings, getTimer, getWindowManager, getWrappedWindow, getXmlDescriptor, isAttributeAccessControlEnabled, ready, removeBeforeCloseWithCloseButtonListener, removeBeforeCloseWithShortcutListener, removeCloseListener, removeCloseWithCommitListener, removeListener, saveSettings, setCaption, setContentSwitchMode, setDescription, setDsContext, setFocusComponent, setIcon, setIconFromSet, setWindowManager, setXmlDescriptor, validate, validateAll

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

add, add, addAction, addAction, addStyleName, dispose, expand, expand, getAction, getActions, getAlignment, getCompanion, getComponent, getComponent, getComponent, getComponents, getComposition, getDebugId, getDialogParams, getExpandDirection, getFrame, getHeight, getHeightUnits, getId, getMargin, getMessagesPack, getOwnComponent, getOwnComponents, getParent, getRegisteredComponent, getSpacing, getStyleName, getUiEventListeners, getWidth, getWidthUnits, getWrappedFrame, indexOf, init, isEnabled, isEnabledItself, isExpanded, isResponsive, isValid, isVisible, isVisibleItself, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openFrame, openFrame, openLookup, openLookup, openLookup, openLookup, openWindow, openWindow, registerComponent, remove, removeAction, removeAction, removeAll, removeAllActions, removeStyleName, requestFocus, resetExpanded, setAlignment, setCompanion, setContext, setDebugId, setEnabled, setFrame, setHeight, setId, setMargin, setMessagesPack, setParent, setResponsive, setSpacing, setStyleName, setUiEventListeners, setVisible, setWidth, setWrappedFrame, showMessageDialog, showNotification, showNotification, showNotification, showOptionDialog, showOptionDialog, showValidationErrors, showWebPage, unregisterComponent, unwrap, unwrapComposition, validate

Methods inherited from class java.lang.Object

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

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

addBeforeCloseWithCloseButtonListener, addBeforeCloseWithShortcutListener, addCloseListener, addCloseWithCommitListener, addListener, addTimer, applySettings, close, close, closeAndRun, deleteSettings, getContentSwitchMode, getContext, getDialogOptions, getFocusComponent, getSettings, getTimer, getWindowManager, removeBeforeCloseWithCloseButtonListener, removeBeforeCloseWithShortcutListener, removeCloseListener, removeCloseWithCommitListener, removeListener, saveSettings, setContentSwitchMode, setFocusComponent, setWindowManager, validate, validateAll

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

getDialogParams, getDsContext, getMessagesPack, getRegisteredComponent, isValid, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openFrame, openFrame, openLookup, openLookup, openLookup, openLookup, openWindow, openWindow, registerComponent, setContext, setDsContext, setMessagesPack, showMessageDialog, showNotification, showNotification, showNotification, showOptionDialog, showOptionDialog, showWebPage, unregisterComponent, 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.Component.OrderedContainer

add, getComponent, getComponentNN, indexOf

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

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

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

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, 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.Component.Spacing

getSpacing, setSpacing

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

getMargin, setMargin, setMargin, setMargin

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

addAction, addAction, getAction, getActionNN, getActions, 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, getDescription, setCaption, setDescription

Constructor Detail

AbstractEditor

public AbstractEditor()

Method Detail

getItem

public T getItem()

Specified by:

getItem in interface Window.Editor

Returns:

currently edited entity instance

getParentDs

@Nullable
public Datasource getParentDs()

Specified by:

getParentDs in interface Window.Editor

Returns:

parent datasource if it is set

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

setItem

public void setItem(Entity item)

Called by the framework to set an edited entity after creation of all components and datasources, and after AbstractFrame.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

Parameters:

item - entity instance

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

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

Parameters:

validate - false to avoid validation

Returns:

true if commit was successful

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

Specified by:

commitAndClose in interface Window.Editor

isLocked

public boolean isLocked()

Specified by:

isLocked in interface Window.Editor

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

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

Parameters:

crossFieldValidate - cross field validate flag

See Also:

BeanValidation

isShowSaveNotification

public boolean isShowSaveNotification()

setShowSaveNotification

public void setShowSaveNotification(boolean showSaveNotification)