@NonNullApi

Package io.jmix.ui.screen

Interface Summary

Interface	Description
ChangeTracker	Screen that can contain unsaved changes.
ChangeTrackerCloseAction	An optional interface of CloseActions used in screens that may have unsaved changes on closing.
CloseAction	Marker interface for objects that describe how a Screen was closed.
EditorScreen<T>	Interface for editor screen controllers.
FrameOwner	Marker interface for UI controllers.
InstallTargetHandler
LookupScreen<E>	Interface for lookup screen controllers.
MessageBundle	Interface that provides messages from a message group bound to screen controller.
MultiSelectLookupScreen	A screen that can change selection mode of lookup component.
ReadOnlyAwareScreen	Interface for screen controllers that support read-only mode.
ScreenContext
ScreenOptions	Marker interface for objects that can be passed as screen parameters to a Screen.

Class Summary

Class	Description
Extensions	Extensions API for Screen and ScreenFragment.
LookupScreen.ValidationContext<T>	Validation data context.
MapScreenOptions
MasterDetailScreen<T>	Displays a list of entities on the left and details of the currently selected instance on the right.
MasterDetailScreen.AfterCommitChangesEvent	Event sent after commit of data context from MasterDetailScreen.commitEditorChanges() call.
MasterDetailScreen.BeforeCommitChangesEvent	Event sent before commit of data context from MasterDetailScreen.commitEditorChanges() call.
MasterDetailScreen.InitEntityEvent<E>	Event sent before the new entity instance is set to edited entity container.
MasterDetailScreen.ValidationEvent	Event sent when screen is validated from MasterDetailScreen.validateAdditionalRules(ValidationErrors) call.
PessimisticLockSupport
ReadOnlyScreensSupport	Bean that encapsulates the default logic of changing screens read-only mode.
Screen	Base class for all screen controllers.
Screen.AfterCloseEvent	Event sent after the screen is closed by its Screen.close(CloseAction) method and after Screen.AfterDetachEvent.
Screen.AfterDetachEvent	Event sent after the screen is removed from the application UI when it is closed by the user or when the user logs out.
Screen.AfterInitEvent	Event sent when the screen controller and all its declaratively defined components are created, dependency injection is completed, and all components have completed their internal initialization procedures.
Screen.AfterShowEvent	Event sent right after the screen is shown, i.e.
Screen.BeforeCloseEvent	Event sent right before the screen is closed by its Screen.close(CloseAction) method.
Screen.BeforeShowEvent	Event sent right before the screen is shown, i.e.
Screen.InitEvent	Event sent when the screen controller and all its declaratively defined components are created, and dependency injection is completed.
ScreenDependencyUtils	A class that facilitates adding dependencies such as CSS, JavaScript, HTML to the current page for screens and fragments.
ScreenFragment	Base class for all fragment controllers.
ScreenFragment.AfterInitEvent	Event sent when the fragment controller is created, dependency injection is completed, and all components have completed their internal initialization procedures.
ScreenFragment.AttachEvent	Event sent when the fragment controller is initialized and added to host screen.
ScreenFragment.DetachEvent	Event sent when the fragment controller has been removed from host screen.
ScreenFragment.InitEvent	Event sent when the fragment controller is created and dependency injection is completed.
ScreenValidation
ScreenValidation.SaveChangesDialogResult	Callbacks holder for save changes dialog.
ScreenValidation.UnsavedChangesDialogResult	Callbacks holder for unsaved changes dialog.
StandardCloseAction	A close action implementation used in the base screens provided by the framework: Screen, StandardEditor, StandardLookup.
StandardEditor<T>	Base class for editor screens.
StandardEditor.AfterCommitChangesEvent	Event sent after commit of data context from StandardEditor.commitChanges() call.
StandardEditor.BeforeCommitChangesEvent	Event sent before commit of data context from StandardEditor.commitChanges() call.
StandardEditor.InitEntityEvent<E>	Event sent before the new entity instance is set to edited entity container.
StandardEditor.ValidationEvent	Event sent when screen is validated from StandardEditor.validateAdditionalRules(ValidationErrors) call.
StandardLookup<T>	Base class for lookup screens.
UiControllerUtils	Internal methods used in Screens and Fragments implementations.

Enum Summary

Enum	Description
OpenMode	Standard launch modes of Screens.
PessimisticLockStatus
StandardOutcome	A possible outcome of screens extending StandardEditor and StandardLookup.
Target	Subscribe and Install target type.

Annotation Types Summary

Annotation Type	Description
DialogMode	Specifies parameters of DialogWindow if the window is opened as OpenMode.DIALOG.
EditedEntityContainer	Annotation for edit screen controllers which specifies a data container that contains the edited entity.
Install	Annotation for declarative handler methods in UI controllers.
InstallSubject	Sets primary subject for Install target classes.
LookupComponent	Annotation for lookup screen controllers which specifies ID of a UI component to be used for getting a value returned from the lookup.
MultipleOpen	Annotation for screen controllers that specifies if the screen can be opened multiple times from the main menu.
PrimaryEditorScreen	Annotation for edit screen controllers that sets this controller as default editor screen for entities of the specified type.
PrimaryLookupScreen	Annotation for lookup screen controllers that sets this controller as default lookup screen for entities of the specified type.
Subscribe	Annotation for declarative event handler methods in UI controllers.
UiController	Indicates that the annotated class is a screen or fragment controller.
UiDescriptor	Indicates that the annotated UiController is linked to an XML template.