MasterDetailScreen (Jmix-ui 1.0 API)

java.lang.Object
- io.jmix.ui.screen.Screen
- - io.jmix.ui.screen.StandardLookup<T>
  - - io.jmix.ui.screen.MasterDetailScreen<T>

All Implemented Interfaces:

FrameOwner, LookupScreen<T>, MultiSelectLookupScreen
```
@ParametersAreNonnullByDefault
public abstract class MasterDetailScreen<T>
extends StandardLookup<T>
```
Displays a list of entities on the left and details of the currently selected instance on the right.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MasterDetailScreen.AfterCommitChangesEvent` Event sent after commit of data context from `commitEditorChanges()` call.
`static class`	`MasterDetailScreen.BeforeCommitChangesEvent` Event sent before commit of data context from `commitEditorChanges()` call.
`static class`	`MasterDetailScreen.InitEntityEvent<E>` Event sent before the new entity instance is set to edited entity container.
`static class`	`MasterDetailScreen.ValidationEvent` Event sent when screen is validated from `validateAdditionalRules(ValidationErrors)` call.

Nested classes/interfaces inherited from class io.jmix.ui.screen.Screen
Screen.AfterCloseEvent, Screen.AfterDetachEvent, Screen.AfterInitEvent, Screen.AfterShowEvent, Screen.BeforeCloseEvent, Screen.BeforeShowEvent, Screen.InitEvent

Nested classes/interfaces inherited from interface io.jmix.ui.screen.LookupScreen
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`	`crossFieldValidate` Indicates whether the cross-field validation is enabled.
`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 io.jmix.ui.screen.StandardLookup
selectHandler, selectValidator

Fields inherited from interface io.jmix.ui.screen.LookupScreen
LOOKUP_CANCEL_ACTION_ID, LOOKUP_ENTER_PRESSED_ACTION_ID, LOOKUP_ITEM_CLICK_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

MasterDetailScreen()

Constructors
Constructor and Description
`MasterDetailScreen()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected io.jmix.core.common.event.Subscription`	`addAfterCommitChangesListener(java.util.function.Consumer<MasterDetailScreen.AfterCommitChangesEvent> listener)` Adds a listener to `MasterDetailScreen.AfterCommitChangesEvent`.
`protected io.jmix.core.common.event.Subscription`	`addBeforeCommitChangesListener(java.util.function.Consumer<MasterDetailScreen.BeforeCommitChangesEvent> listener)` Adds a listener to `MasterDetailScreen.BeforeCommitChangesEvent`.
`protected io.jmix.core.common.event.Subscription`	`addInitEntityListener(java.util.function.Consumer<MasterDetailScreen.InitEntityEvent<T>> listener)` Adds a listener to `MasterDetailScreen.InitEntityEvent`.
`protected io.jmix.core.common.event.Subscription`	`addValidationEventListener(java.util.function.Consumer<MasterDetailScreen.ValidationEvent> listener)` Adds a listener to `MasterDetailScreen.ValidationEvent`.
`protected OperationResult`	`commitEditorChanges()` Validates editor form and commits data context.
`protected void`	`disableEditControls()` Disables edit controls.
`protected void`	`discardChanges()` Method invoked when clicking the Cancel button, discards changes and disables controls for editing.
`protected void`	`enableEditControls(boolean creating)` Enables controls for editing.
`protected ComponentContainer`	`getActionsPane()` Returns the container with edit actions (save, cancel).
`protected CollectionContainer<T>`	`getBrowseContainer()` Returns the table's data container.
`protected ComponentContainer`	`getEditBox()` Returns the right container with edit components.
`protected InstanceContainer<T>`	`getEditContainer()` Returns the edit form's data container.
`protected T`	`getEditedEntity()`
`protected InstanceLoader<T>`	`getEditLoader()` Returns the loader of the edit form's data container.
`protected java.lang.Class<T>`	`getEntityClass()` Returns the entity meta-class.
`protected Form`	`getForm()` Returns the field group.
`protected java.lang.String`	`getLockName()` Returns the name of the pessimistic lock.
`protected ComponentContainer`	`getLookupBox()` Returns the left container with browse components.
`protected ListComponent<T>`	`getTable()` Returns the browse `Table` or `DataGrid`.
`protected TabSheet`	`getTabSheet()` Returns the tab sheet with edit components.
`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 and sets it to editCt.
`protected void`	`initDataComponents()` Initializes data components.
`protected void`	`initEditComponents(boolean enabled)` Initializes edit controls, depending on if they should be enabled or disabled.
`protected void`	`initMasterDetailScreen(Screen.InitEvent event)` Method invoked on the screen initialization.
`protected void`	`initOkCancelActions()` Initializes OK/Cancel editor buttons.
`protected void`	`initShortcuts()` Adds ESCAPE shortcut that invokes cancel() method.
`protected boolean`	`isCrossFieldValidate()`
`protected boolean`	`lockIfNeeded(java.lang.Object entity)` Pessimistic lock before start of editing, if it is configured for the entity.
`protected void`	`refreshOptionsForLookupFields()` Loads options of LookupFields if any.
`protected void`	`releaseLock()` Releases pessimistic lock if the entity was locked.
`protected void`	`saveChanges()` Method invoked when clicking on the Ok button after editing an existing or creating a new record.
`protected void`	`setCrossFieldValidate(boolean crossFieldValidate)` Sets whether the cross-field validation is active.
`protected void`	`validateAdditionalRules(ValidationErrors errors)` Validates the cross-field rules if passed validation errors are empty.
`protected ValidationErrors`	`validateEditorForm()` Validates screen data.
`protected ValidationErrors`	`validateUiComponents()` Validates visible and enabled UI components.

Methods inherited from class io.jmix.ui.screen.StandardLookup
addDefaultCancelAction, addDefaultSelectAction, cancel, getLookupActionsLayout, getLookupComponent, getSelectHandler, getSelectValidator, getWindowActionOptional, initActions, select, select, setLookupComponentMultiSelect, setSelectHandler, setSelectValidator, setupCommitShortcut, setupLookupComponent

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, isSameScreen, setApplicationContext, setExtensions, setId, setScreenData, setUiEventListeners, setWindow, show

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - editing
```
protected boolean editing
```
    Indicates that the screen is in editing mode.
  - creating
```
protected boolean creating
```
    Indicates that a new instance of entity is being created.
  - justLocked
```
protected boolean justLocked
```
    Indicates that edited entity is pessimistically locked.
  - crossFieldValidate
```
protected boolean crossFieldValidate
```
    Indicates whether the cross-field validation is enabled.
- Constructor Detail
  - MasterDetailScreen
```
public MasterDetailScreen()
```
- Method Detail
  - getLookupBox
```
protected ComponentContainer getLookupBox()
```
    Returns the left container with browse components. Override if the container id differs from "lookupBox".
  - getTable
```
protected ListComponent<T> getTable()
```
    Returns the browse Table or DataGrid. Override the method if the table id differs from "table".
  - getEditBox
```
protected ComponentContainer getEditBox()
```
    Returns the right container with edit components. Override if the container id differs from "editBox".
  - getTabSheet
```
@Nullable
protected 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".
  - getForm
```
protected Form getForm()
```
    Returns the field group. Override if the field group id differs from "fieldGroup".
  - getActionsPane
```
protected ComponentContainer getActionsPane()
```
    Returns the container with edit actions (save, cancel). Override if the container id differs from "actionsPane".
  - getBrowseContainer
```
protected CollectionContainer<T> getBrowseContainer()
```
    Returns the table's data container.
  - getEditContainer
```
protected InstanceContainer<T> getEditContainer()
```
    Returns the edit form's data container.
  - getEditedEntity
```
protected T getEditedEntity()
```
    Returns:
    
    currently edited entity instance loaded to editor form
  - getEditLoader
```
protected InstanceLoader<T> getEditLoader()
```
    Returns the loader of the edit form's data container.
  - getEntityClass
```
protected java.lang.Class<T> getEntityClass()
```
    Returns the entity meta-class.
  - initMasterDetailScreen
```
protected void initMasterDetailScreen(Screen.InitEvent event)
```
    Method invoked on the screen initialization.
  - initDataComponents
```
protected void initDataComponents()
```
    Initializes data components.
    Default implementation unlinks browse loader from DataContext to prevent from the edited entity being referenced from both edit and browse data containers. Keep in mind that as a result, entities loaded in the browse table are not tracked.
  - initOkCancelActions
```
protected void initOkCancelActions()
```
    Initializes OK/Cancel editor buttons.
  - initBrowseItemChangeListener
```
protected void initBrowseItemChangeListener()
```
    Adds a listener that reloads the selected record and sets it to editCt.
  - 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.
  - initBrowseEditAction
```
protected void initBrowseEditAction()
```
    Adds an EditAction that enables controls for editing.
  - initShortcuts
```
protected void initShortcuts()
```
    Adds ESCAPE shortcut that invokes cancel() method.
  - refreshOptionsForLookupFields
```
protected void refreshOptionsForLookupFields()
```
    Loads options of LookupFields if any.
  - 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
  - lockIfNeeded
```
protected boolean lockIfNeeded(java.lang.Object entity)
```
    Pessimistic lock before start of editing, if it is configured for the entity.
  - releaseLock
```
protected void releaseLock()
```
    Releases pessimistic lock if the entity was locked.
  - getLockName
```
protected java.lang.String getLockName()
```
    Returns the name of the pessimistic lock.
  - saveChanges
```
protected void saveChanges()
```
    Method invoked when clicking on the Ok button after editing an existing or creating a new record.
  - commitEditorChanges
```
protected OperationResult commitEditorChanges()
```
    Validates editor form and commits data context.
    
    Returns:
    
    operation result
  - discardChanges
```
protected void discardChanges()
```
    Method invoked when clicking the Cancel button, discards changes and disables controls for editing.
  - isCrossFieldValidate
```
protected boolean isCrossFieldValidate()
```
    Returns:
    
    true if the cross-field validation is enabled, false otherwise
  - setCrossFieldValidate
```
protected void setCrossFieldValidate(boolean crossFieldValidate)
```
    Sets whether the cross-field validation is active. true by default.
    
    Parameters:
    
    crossFieldValidate - true to enable the cross-field validation, false otherwise
  - validateEditorForm
```
protected ValidationErrors validateEditorForm()
```
    Validates screen data. Default implementation validates visible and enabled UI components.
    Can be overridden in subclasses.
    
    Returns:
    
    validation errors
  - validateUiComponents
```
protected ValidationErrors validateUiComponents()
```
    Validates visible and enabled UI components.
    Can be overridden in subclasses.
    
    Returns:
    
    validation errors
  - validateAdditionalRules
```
protected void validateAdditionalRules(ValidationErrors errors)
```
    Validates the cross-field rules if passed validation errors are empty.
    
    Parameters:
    
    errors - errors found during components validation
  - addInitEntityListener
```
protected io.jmix.core.common.event.Subscription addInitEntityListener(java.util.function.Consumer<MasterDetailScreen.InitEntityEvent<T>> listener)
```
    Adds a listener to MasterDetailScreen.InitEntityEvent.
    
    Parameters:
    
    listener - listener
    
    Returns:
    
    subscription
  - addBeforeCommitChangesListener
```
protected io.jmix.core.common.event.Subscription addBeforeCommitChangesListener(java.util.function.Consumer<MasterDetailScreen.BeforeCommitChangesEvent> listener)
```
    Adds a listener to MasterDetailScreen.BeforeCommitChangesEvent.
    
    Parameters:
    
    listener - listener
    
    Returns:
    
    subscription
  - addAfterCommitChangesListener
```
protected io.jmix.core.common.event.Subscription addAfterCommitChangesListener(java.util.function.Consumer<MasterDetailScreen.AfterCommitChangesEvent> listener)
```
    Adds a listener to MasterDetailScreen.AfterCommitChangesEvent.
    
    Parameters:
    
    listener - listener
    
    Returns:
    
    subscription
  - addValidationEventListener
```
protected io.jmix.core.common.event.Subscription addValidationEventListener(java.util.function.Consumer<MasterDetailScreen.ValidationEvent> listener)
```
    Adds a listener to MasterDetailScreen.ValidationEvent.
    
    Parameters:
    
    listener - listener
    
    Returns:
    
    subscription

Class MasterDetailScreen<T>

Nested Class Summary

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

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

Field Summary

Fields inherited from class io.jmix.ui.screen.StandardLookup

Fields inherited from interface io.jmix.ui.screen.LookupScreen

Fields inherited from interface io.jmix.ui.screen.FrameOwner

Constructor Summary

Method Summary

Methods inherited from class io.jmix.ui.screen.StandardLookup

Methods inherited from class io.jmix.ui.screen.Screen

Methods inherited from class java.lang.Object

Field Detail

editing

creating

justLocked

crossFieldValidate

Constructor Detail

MasterDetailScreen

Method Detail

getLookupBox

getTable

getEditBox

getTabSheet

getForm

getActionsPane

getBrowseContainer

getEditContainer

getEditedEntity

getEditLoader

getEntityClass

initMasterDetailScreen

initDataComponents

initOkCancelActions

initBrowseItemChangeListener

initBrowseCreateAction

initBrowseEditAction

initShortcuts

refreshOptionsForLookupFields

enableEditControls

disableEditControls

initEditComponents

lockIfNeeded

releaseLock

getLockName

saveChanges

commitEditorChanges

discardChanges

isCrossFieldValidate

setCrossFieldValidate

validateEditorForm

validateUiComponents

validateAdditionalRules

addInitEntityListener

addBeforeCommitChangesListener

addAfterCommitChangesListener

addValidationEventListener