com.haulmont.cuba.gui.components

Class EntityCombinedScreen

java.lang.Object

io.jmix.ui.screen.Screen

com.haulmont.cuba.gui.components.AbstractWindow

com.haulmont.cuba.gui.components.AbstractLookup

com.haulmont.cuba.gui.components.EntityCombinedScreen

All Implemented Interfaces:

Frame.Wrapper, HasWindowManager, Window.Lookup, Window.Wrapper, LegacyFrame, CubaLegacySettings, io.jmix.ui.component.ActionsHolder, io.jmix.ui.component.Component, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper, io.jmix.ui.component.ComponentContainer, io.jmix.ui.component.ExpandingLayout, io.jmix.ui.component.Frame, io.jmix.ui.component.HasComponents, io.jmix.ui.component.HasMargin, io.jmix.ui.component.HasSpacing, io.jmix.ui.component.HasSubParts, io.jmix.ui.component.OrderedContainer, io.jmix.ui.component.SecuredActionsHolder, io.jmix.ui.component.SupportsExpandRatio, io.jmix.ui.component.Window, io.jmix.ui.screen.ChangeTracker, io.jmix.ui.screen.FrameOwner, io.jmix.ui.screen.LookupScreen

public class EntityCombinedScreen
extends AbstractLookup

Base class for controllers of combined browser/editor screens.

Nested Class Summary

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

io.jmix.ui.screen.Screen.AfterCloseEvent, io.jmix.ui.screen.Screen.AfterDetachEvent, io.jmix.ui.screen.Screen.AfterInitEvent, io.jmix.ui.screen.Screen.AfterShowEvent, io.jmix.ui.screen.Screen.BeforeCloseEvent, io.jmix.ui.screen.Screen.BeforeShowEvent, io.jmix.ui.screen.Screen.InitEvent

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

Window.Lookup.Handler, Window.Lookup.Validator

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

Window.BeforeCloseWithCloseButtonEvent, Window.BeforeCloseWithShortcutEvent, Window.CloseListener, Window.CloseWithCommitListener, Window.Editor<T>, Window.HasFoldersPane, Window.Lookup<T>, Window.TopLevelWindow, Window.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.Window

io.jmix.ui.component.Window.BeforeCloseEvent, io.jmix.ui.component.Window.CloseOrigin, io.jmix.ui.component.Window.Committable, io.jmix.ui.component.Window.ContentSwitchMode, io.jmix.ui.component.Window.HasUserIndicator, io.jmix.ui.component.Window.HasWorkArea

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

Frame.MessageMode, Frame.MessageType, Frame.NotificationType

Nested classes/interfaces inherited from interface io.jmix.ui.component.ExpandingLayout

io.jmix.ui.component.ExpandingLayout.ExpandDirection

Nested classes/interfaces inherited from interface io.jmix.ui.screen.LookupScreen

io.jmix.ui.screen.LookupScreen.ValidationContext<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	creating Indicates that a new instance of entity is being created.
protected boolean	editing Indicates that the screen is in editing mode.
protected boolean	justLocked Indicates that edited entity is pessimistically locked.

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

frame, messages, messageTools, UNKNOWN_CLOSE_ACTION_ID

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

LOOKUP_ENTER_PRESSED_ACTION_ID, LOOKUP_ITEM_CLICK_ACTION_ID, NAME

Fields inherited from interface io.jmix.ui.component.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 io.jmix.ui.screen.LookupScreen

LOOKUP_CANCEL_ACTION_ID, LOOKUP_SELECT_ACTION_ID, LOOKUP_SELECT_CLOSE_ACTION

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

Constructor and Description
EntityCombinedScreen()

Method Summary

Modifier and Type	Method and Description
void	cancel() Method that is invoked by clicking Cancel button, discards changes and disables controls for editing.
protected void	disableEditControls() Disables edit controls.
protected void	enableEditControls(boolean creating) Enables controls for editing.
protected io.jmix.ui.component.ComponentContainer	getActionsPane() Returns the container with edit actions (save, cancel).
protected io.jmix.ui.component.ComponentContainer	getEditBox() Returns the right container with edit components.
protected FieldGroup	getFieldGroup() Returns the field group.
protected io.jmix.ui.component.ComponentContainer	getLookupBox() Returns the left container with browse components.
protected io.jmix.core.metamodel.model.MetaClass	getMetaClassForLocking(io.jmix.core.Entity item)
protected ListComponent	getTable() Returns the browse table.
protected io.jmix.ui.component.TabSheet	getTabSheet() Returns the tab sheet with edit components.
void	init(java.util.Map<java.lang.String,java.lang.Object> params) Called by the framework after creation of all components and before showing the screen.
protected void	initBrowseCreateAction() Adds a CreateAction that removes selection in table, sets a newly created item to editDs and enables controls for record editing.
protected void	initBrowseEditAction() Adds an EditAction that enables controls for editing.
protected void	initBrowseItemChangeListener() Adds a listener that reloads the selected record with the specified view and sets it to editDs.
protected void	initBrowseRemoveAction() Adds AfterRemoveHandler for table's Remove action to reset the record contained in editDs.
protected void	initEditComponents(boolean enabled) Initializes edit controls, depending on if they should be enabled or disabled.
protected void	initNewItem(io.jmix.core.Entity item) Hook to be implemented in subclasses.
protected void	initShortcuts() Adds ESCAPE shortcut that invokes cancel() method.
protected boolean	lockIfNeeded(io.jmix.core.Entity entity) Pessimistic lock before start of editing, if it is configured for the entity.
protected void	refreshOptionsForLookupFields()
protected void	releaseLock() Release pessimistic lock if it was applied.
void	save() Method that is invoked by clicking Ok button after editing an existing or creating a new record.
protected boolean	validateEditor() Validates editor fields.

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

afterInit, getLookupComponent, getSelectHandler, getSelectValidator, initLookupActions, initLookupLayout, selectItemsOnClick, setLookupComponent, setSelectHandler, setSelectValidator, setupCommitShortcut, setupLookupComponent

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

add, add, addAction, addAction, addBeforeWindowCloseListener, addFacet, addStyleName, afterShow, applyDataLoadingSettings, 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, getWidth, getWidthSizeUnit, getWindowManager, getWrappedFrame, getWrappedWindow, getXmlDescriptor, handleValidationErrors, hasUnsavedChanges, indexOf, init, initEnableEditingActionStub, isAttributeAccessControlEnabled, isCloseable, isEnabled, isEnabledRecursive, isExpanded, isResponsive, isSameScreen, isValid, isVisible, isVisibleRecursive, onAfterDetach, 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, unwrapCompositionOrNull, unwrapOrNull, validate, validate, validateAdditionalRules, validateAll, withUnwrapped, withUnwrappedComposition

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, setApplicationContext, 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.Lookup

getLookupHandler, getLookupValidator, setLookupHandler, setLookupValidator

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

addBeforeCloseWithCloseButtonListener, addBeforeCloseWithShortcutListener, addCloseListener, addListener, close, close, getContext, getDialogOptions, getWindowManager, removeBeforeCloseWithCloseButtonListener, removeBeforeCloseWithShortcutListener, removeBeforeWindowCloseListener, removeCloseListener, removeListener

Methods inherited from interface io.jmix.ui.component.Window

addBeforeWindowCloseListener, getFocusComponent, getFrameOwner, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, isCloseable, setCloseable, setFocusComponent, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, validate, validateAll

Methods inherited from interface io.jmix.ui.component.Frame

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

Methods inherited from interface io.jmix.ui.component.OrderedContainer

add, getComponent, getComponentNN, indexOf

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.HasSpacing

getSpacing, setSpacing

Methods inherited from interface io.jmix.ui.component.HasMargin

getMargin, setMargin, setMargin, setMargin

Methods inherited from interface io.jmix.ui.component.ActionsHolder

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

Methods inherited from interface io.jmix.ui.component.SupportsExpandRatio

getExpandRatio, setExpandRatio

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

expand

Methods inherited from interface io.jmix.ui.component.ExpandingLayout

expand, getExpandDirection, isExpanded, resetExpanded

Methods inherited from interface io.jmix.ui.component.ComponentContainer

add, add, remove, remove, removeAll

Methods inherited from interface io.jmix.ui.component.HasComponents

focusFirstComponent, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream

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.screen.compatibility.LegacyFrame

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

Methods inherited from interface io.jmix.ui.component.Component.Wrapper

getComponent, getComposition

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

getWrappedFrame

Field Detail

creating

protected boolean creating

Indicates that a new instance of entity is being created.

editing

protected boolean editing

Indicates that the screen is in editing mode.

justLocked

protected boolean justLocked

Indicates that edited entity is pessimistically locked.

Constructor Detail

EntityCombinedScreen

public EntityCombinedScreen()

Method Detail

getLookupBox

protected io.jmix.ui.component.ComponentContainer getLookupBox()

Returns the left container with browse components. Override if the container id differs from "lookupBox".

getTable

protected ListComponent getTable()

Returns the browse table. Override if the table id differs from "table".

getEditBox

protected io.jmix.ui.component.ComponentContainer getEditBox()

Returns the right container with edit components. Override if the container id differs from "editBox".

getTabSheet

@Nullable
protected io.jmix.ui.component.TabSheet getTabSheet()

Returns the tab sheet with edit components. Can be null if the screen contains a field group only. Override if the tab sheet id differs from "tabSheet".

getFieldGroup

protected FieldGroup getFieldGroup()

Returns the field group. Override if the field group id differs from "fieldGroup".

getActionsPane

protected io.jmix.ui.component.ComponentContainer getActionsPane()

Returns the container with edit actions (save, cancel). Override if the container id differs from "actionsPane".

init

public void init(java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from class: AbstractWindow

Called by the framework after creation of all components and before showing the screen.
Override this method and put initialization logic here.

Overrides:

init in class AbstractWindow

Parameters:

params - parameters passed from caller's code, usually from HasWindowManager.openWindow(String, WindowManager.OpenType) and similar methods, or set in screens.xml for this registered screen

initBrowseItemChangeListener

protected void initBrowseItemChangeListener()

Adds a listener that reloads the selected record with the specified view and sets it to editDs.

initBrowseCreateAction

protected void initBrowseCreateAction()

Adds a CreateAction that removes selection in table, sets a newly created item to editDs and enables controls for record editing.

initNewItem

protected void initNewItem(io.jmix.core.Entity item)

Hook to be implemented in subclasses. Called when the screen turns into editing mode for a new entity instance. Enables additional initialization of the new entity instance before setting it into the datasource.

Parameters:

item - new entity instance

initBrowseEditAction

protected void initBrowseEditAction()

Adds an EditAction that enables controls for editing.

lockIfNeeded

protected boolean lockIfNeeded(io.jmix.core.Entity entity)

Pessimistic lock before start of editing, if it is configured for the entity.

releaseLock

protected void releaseLock()

Release pessimistic lock if it was applied.

getMetaClassForLocking

protected io.jmix.core.metamodel.model.MetaClass getMetaClassForLocking(io.jmix.core.Entity item)

initBrowseRemoveAction

protected void initBrowseRemoveAction()

Adds AfterRemoveHandler for table's Remove action to reset the record contained in editDs.

initShortcuts

protected void initShortcuts()

Adds ESCAPE shortcut that invokes cancel() method.

refreshOptionsForLookupFields

protected void refreshOptionsForLookupFields()

enableEditControls

protected void enableEditControls(boolean creating)

Enables controls for editing.

Parameters:

creating - indicates that a new instance is being created

disableEditControls

protected void disableEditControls()

Disables edit controls.

initEditComponents

protected void initEditComponents(boolean enabled)

Initializes edit controls, depending on if they should be enabled or disabled.

Parameters:

enabled - if true - enables edit controls and disables controls on the left side of the splitter if false - vice versa

validateEditor

protected boolean validateEditor()

Validates editor fields.

Returns:

true if all fields are valid or false otherwise

save

public void save()

Method that is invoked by clicking Ok button after editing an existing or creating a new record.

cancel

public void cancel()

Method that is invoked by clicking Cancel button, discards changes and disables controls for editing.