com.haulmont.cuba.gui.components

Interface Window.Editor<T extends Entity>

All Superinterfaces:

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

All Known Implementing Classes:

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

Enclosing interface:

Window

Deprecated.

@Deprecated
public static interface Window.Editor<T extends Entity>
extends Window, EditorScreen<T>, Window.Committable, LegacyFrame

Only for compatibility with old screens.

Nested Class Summary

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
static java.lang.String	NAME Deprecated.

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

ENABLE_EDITING, 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

Method Summary

Modifier and Type	Method and Description
boolean	commit() Deprecated. Called by the framework to validate the screen components and commit changes.
boolean	commit(boolean validate) Deprecated. Called by the framework to commit changes with optional validation.
T	getItem() Deprecated.
Datasource	getParentDs() Deprecated.
boolean	isCrossFieldValidate() Deprecated.
void	setCrossFieldValidate(boolean crossFieldValidate) Deprecated. Enable/disable cross field validation on Window.validateAll() call.
void	setItem(Entity item) Deprecated. Called by the framework to set an edited entity after creation of all components and datasources, and after init().
void	setParentDs(Datasource parentDs) Deprecated. This method is called by the framework to set parent datasource to commit into this datasource instead of directly to the database.

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, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

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.EditorScreen

getEditedEntity, isLocked, setEntityToEdit

Methods inherited from interface com.haulmont.cuba.gui.screen.ChangeTracker

hasUnsavedChanges

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

commitAndClose, isModified

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

NAME

@Deprecated
static final java.lang.String NAME

Deprecated.

Name that is used to register a client type specific screen implementation in ComponentsFactory

See Also:

Constant Field Values

Method Detail

getItem

T getItem()

Deprecated.

Returns:

currently edited entity instance

setItem

void setItem(Entity item)

Deprecated.

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

Parameters:

item - entity instance

commit

boolean commit()

Deprecated.

Called by the framework to validate the screen components and commit changes.

Returns:

true if commit was successful

commit

boolean commit(boolean validate)

Deprecated.

Called by the framework to commit changes with optional validation.

Parameters:

validate - false to avoid validation

Returns:

true if commit was successful

getParentDs

@Nullable
Datasource getParentDs()

Deprecated.

Returns:

parent datasource if it is set

setParentDs

void setParentDs(Datasource parentDs)

Deprecated.

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

isCrossFieldValidate

boolean isCrossFieldValidate()

Deprecated.

Returns:

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

See Also:

BeanValidation

setCrossFieldValidate

void setCrossFieldValidate(boolean crossFieldValidate)

Deprecated.

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.

Parameters:

crossFieldValidate - cross field validate flag

See Also:

BeanValidation