Package io.jmix.flowui.view

Interface LookupView<E>

Type Parameters:

E - entity class

All Known Implementing Classes:

AddConditionView, AllTasksView, BusinessCalendarListView, CategoryListView, ContentStorageListView, DmnDecisionTableListView, DmnDecisionTableLookupView, EmailAttachmentFragment, EntityAttributesFragment, EntityInspectorListView, EntityLogView, EntityTreeNodeListView, ExecutionListenersFragment, ExtensionPropertiesFragment, FormFieldLookup, InAppNotificationListView, JobModelListView, JpqlParametersFragment, MessageTemplateBlockListView, MessageTemplateGroupListView, MessageTemplateListView, MultiValueSelectDialog, MyTasksListView, ProcessDefinitionLookupView, ProcessInstanceListView, ReportExecutionDialog, ReportExecutionListView, ReportGroupListView, ReportListView, ReportRunView, ResourceRoleModelListView, ResourceRoleModelLookupView, RowLevelRoleModelListView, RowLevelRoleModelLookupView, SendingMessageAttachmentsListView, StandardListView, StartProcessView, TenantListView, UserGroupListView, UserSessionsView, WebdavDocumentListView, WebdavDocumentVersionsLookupView

public interface LookupView<E>

Interface of views that display a list of entities and can return instances selected by the user.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LookupView.ValidationContext<E>	Context object which is passed to the selection validator set by setSelectionValidator(Predicate).

Method Summary

Modifier and Type	Method	Description
OperationResult	closeWithDiscard()	Close the view without selection.
Optional<LookupComponent<E>>	findLookupComponent()
LookupComponent<E>	getLookupComponent()
Optional<Consumer<Collection<E>>>	getSelectionHandler()
Optional<Predicate<LookupView.ValidationContext<E>>>	getSelectionValidator()
OperationResult	handleSelection()	Handle selected entities.
void	setSelectionHandler(Consumer<Collection<E>> selectionHandler)	Sets selection handler for screen.
void	setSelectionValidator(Predicate<LookupView.ValidationContext<E>> selectionValidator)	Sets selection validator.

Method Details

handleSelection

OperationResult handleSelection()

Handle selected entities.

closeWithDiscard

OperationResult closeWithDiscard()

Close the view without selection.

getLookupComponent

LookupComponent<E> getLookupComponent()

Returns:

a component that is used to select entities of this view

Throws:

IllegalStateException - if such a component is not defined

findLookupComponent

Optional<LookupComponent<E>> findLookupComponent()

Returns:

an optional component that is used to select entities of this view

getSelectionHandler

Optional<Consumer<Collection<E>>> getSelectionHandler()

Returns:

selection handler

setSelectionHandler

void setSelectionHandler(@Nullable
 Consumer<Collection<E>> selectionHandler)

Sets selection handler for screen.

Parameters:

selectionHandler - selection handler

getSelectionValidator

Optional<Predicate<LookupView.ValidationContext<E>>> getSelectionValidator()

Returns:

selection validator

setSelectionValidator

void setSelectionValidator(@Nullable
 Predicate<LookupView.ValidationContext<E>> selectionValidator)

Sets selection validator.

Parameters:

selectionValidator - selection validator