io.jmix.ui.screen

Interface EditorScreen<T>

Type Parameters:

T - type of entity

All Superinterfaces:

ChangeTracker

All Known Implementing Classes:

FilterConditionEdit, GroupFilterConditionEdit, JpqlFilterConditionEdit, LogicalFilterConditionEdit, MBeanAttributeEditor, MBeanInspectScreen, PropertyFilterConditionEdit, StandardEditor

public interface EditorScreen<T>
extends ChangeTracker

Interface for editor screen controllers.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENABLE_EDITING Name of action that enables screen editing, i.e.
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.

Method Summary

Modifier and Type	Method and Description
T	getEditedEntity()
boolean	isLocked()
void	setEntityToEdit(T entity) Sets entity instance to editor.

Methods inherited from interface io.jmix.ui.screen.ChangeTracker

hasUnsavedChanges

Field Detail

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

ENABLE_EDITING

static final java.lang.String ENABLE_EDITING

Name of action that enables screen editing, i.e. sets the 'readOnly' mode to false.

See Also:

Constant Field Values

Method Detail

setEntityToEdit

void setEntityToEdit(T entity)

Sets entity instance to editor.

Parameters:

entity - entity

getEditedEntity

T getEditedEntity()

Returns:

currently edited entity instance

isLocked

boolean isLocked()

Returns:

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