com.haulmont.cuba.gui.components

Interface Window.Editor

All Superinterfaces:

Component, Component.ActionsHolder, Component.BelongToFrame, Component.Container, Component.HasCaption, Component.HasIcon, Component.Margin, Component.OrderedContainer, Component.Spacing, ExpandingLayout, Frame, Window, Window.Committable

All Known Implementing Classes:

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

Enclosing interface:

Window

public static interface Window.Editor
extends Window.Committable

Represents an edit screen.

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

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

Modifier and Type	Field and Description
static java.lang.String	NAME Name that is used to register a client type specific screen implementation in ComponentsFactory
static java.lang.String	WINDOW_CLOSE Name of action that closes the screen.
static java.lang.String	WINDOW_COMMIT Name of action that commits changes.
static java.lang.String	WINDOW_COMMIT_AND_CLOSE Name of action that commits changes and closes the screen.

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

Method Summary

Modifier and Type	Method and Description
boolean	commit() Called by the framework to validate the screen components and commit changes.
boolean	commit(boolean validate) Called by the framework to commit changes with optional validation.
void	commitAndClose() Called by the framework to validate, commit and close the screen if commit was successful.
Entity	getItem()
Datasource	getParentDs()
boolean	isCrossFieldValidate()
boolean	isLocked()
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 init().
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.

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

isModified

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

Field Detail

NAME

static final java.lang.String NAME

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

See Also:

Constant Field Values

WINDOW_COMMIT

static final java.lang.String WINDOW_COMMIT

Name of action that commits changes.
If the screen doesn't contain a component with WINDOW_COMMIT_AND_CLOSE ID, this action also closes the screen after commit.

See Also:

Constant Field Values

WINDOW_COMMIT_AND_CLOSE

static final java.lang.String WINDOW_COMMIT_AND_CLOSE

Name of action that commits changes and closes the screen.

See Also:

Constant Field Values

WINDOW_CLOSE

static final java.lang.String WINDOW_CLOSE

Name of action that closes the screen.

See Also:

Constant Field Values

Method Detail

getItem

Entity getItem()

Returns:

currently edited entity instance

getParentDs

@Nullable
Datasource getParentDs()

Returns:

parent datasource if it is set

setParentDs

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.

setItem

void setItem(Entity item)

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()

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

Returns:

true if commit was successful

commit

boolean commit(boolean validate)

Called by the framework to commit changes with optional validation.

Parameters:

validate - false to avoid validation

Returns:

true if commit was successful

commitAndClose

void commitAndClose()

Called by the framework to validate, commit and close the screen if commit was successful.
Passes Window.COMMIT_ACTION_ID to associated Window.CloseListeners.

Specified by:

commitAndClose in interface Window.Committable

isLocked

boolean isLocked()

Returns:

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

isCrossFieldValidate

boolean isCrossFieldValidate()

Returns:

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

See Also:

BeanValidation

setCrossFieldValidate

void setCrossFieldValidate(boolean crossFieldValidate)

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