Package io.jmix.ui.screen

Class StandardLookup<T>

java.lang.Object

io.jmix.ui.screen.Screen

io.jmix.ui.screen.StandardLookup<T>

Type Parameters:

T - type of entity

All Implemented Interfaces:

FrameOwner, LookupScreen<T>, MultiSelectLookupScreen

Direct Known Subclasses:

AddConditionScreen, AllTasksBrowse, BusinessCalendarBrowse, CategoryBrowse, ContentStorageBrowse, DashboardGroupBrowse, DmnDecisionTableLookup, EmailTemplateBrowse, EntityInspectorBrowser, EntityLogBrowser, EntityTreeLookup, FormFieldLookup, ImapFolderLookup, ImapMailBoxBrowse, ImapMessageBrowse, InAppNotificationBrowse, JobModelBrowse, MasterDetailScreen, MyTasksBrowse, PersistentDashboardBrowse, ProcessDefinitionBrowse, ProcessDefinitionLookup, ProcessInstanceBrowse, ReportBrowser, ReportExecutionBrowser, ReportExecutionDialog, ReportGroupBrowser, ReportRun, ResourceRoleModelBrowse, ResourceRoleModelLookup, RowLevelRoleModelBrowse, RowLevelRoleModelLookup, SendingMessageAttachments, StartProcessScreen, TemplateBlockBrowse, TemplateBlockGroupBrowse, TemplateGroupBrowse, TenantBrowse, UserGroupBrowse, UserSessionsBrowse, WebdavDocumentBrowse, WebdavShowDocumentVersionBrowse, WidgetTemplateBrowse, WidgetTemplateGroupBrowse

public class StandardLookup<T>
extends Screen
implements LookupScreen<T>, MultiSelectLookupScreen

Base class for lookup screens.

Nested Class Summary

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	Description
protected Consumer<Collection<T>>	selectHandler
protected Predicate<LookupScreen.ValidationContext<T>>	selectValidator

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

NO_OPTIONS, WINDOW_CLOSE_ACTION, WINDOW_COMMIT_AND_CLOSE_ACTION, WINDOW_DISCARD_AND_CLOSE_ACTION

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

Constructor Summary

Constructors

Constructor	Description
StandardLookup()

Method Summary

Modifier and Type	Method	Description
protected Action	addDefaultCancelAction(Messages messages, Icons icons)
protected Action	addDefaultSelectAction(Messages messages, Icons icons)
OperationResult	cancel(Action.ActionPerformedEvent event)
protected Component	getLookupActionsLayout()
LookupComponent<T>	getLookupComponent()
Consumer<Collection<T>>	getSelectHandler()
Predicate<LookupScreen.ValidationContext<T>>	getSelectValidator()
protected Optional<Action>	getWindowActionOptional(String id)
protected void	initActions(Screen.InitEvent event)
OperationResult	select(Action.ActionPerformedEvent event)
protected OperationResult	select(Collection<T> items)
void	setLookupComponentMultiSelect(boolean multiSelect)	Informs a screen that a lookup component should change its selection mode, if possible.
void	setSelectHandler(Consumer<Collection<T>> selectHandler)	Sets selection handler for screen.
void	setSelectValidator(Predicate<LookupScreen.ValidationContext<T>> selectValidator)	Sets selection validator.
protected void	setupCommitShortcut()
protected void	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, isScreenAction, 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 Details

selectHandler

protected Consumer<Collection<T>> selectHandler

selectValidator

protected Predicate<LookupScreen.ValidationContext<T>> selectValidator

Constructor Details

StandardLookup

public StandardLookup()

Method Details

initActions

protected void initActions(Screen.InitEvent event)

getWindowActionOptional

protected Optional<Action> getWindowActionOptional(String id)

addDefaultSelectAction

protected Action addDefaultSelectAction(Messages messages,
 Icons icons)

addDefaultCancelAction

protected Action addDefaultCancelAction(Messages messages,
 Icons icons)

setupCommitShortcut

protected void setupCommitShortcut()

setupLookupComponent

protected void setupLookupComponent()

getSelectHandler

@Nullable
public Consumer<Collection<T>> getSelectHandler()

Specified by:

getSelectHandler in interface LookupScreen<T>

Returns:

selection handler

setSelectHandler

public void setSelectHandler(@Nullable
 Consumer<Collection<T>> selectHandler)

Description copied from interface: LookupScreen

Sets selection handler for screen.

Specified by:

setSelectHandler in interface LookupScreen<T>

Parameters:

selectHandler - selection handler

getSelectValidator

public Predicate<LookupScreen.ValidationContext<T>> getSelectValidator()

Specified by:

getSelectValidator in interface LookupScreen<T>

Returns:

selection validator

setSelectValidator

public void setSelectValidator(Predicate<LookupScreen.ValidationContext<T>> selectValidator)

Description copied from interface: LookupScreen

Sets selection validator.

Specified by:

setSelectValidator in interface LookupScreen<T>

Parameters:

selectValidator - selection validator

getLookupActionsLayout

@Nullable
protected Component getLookupActionsLayout()

getLookupComponent

public LookupComponent<T> getLookupComponent()

select

public OperationResult select(@Nullable
 Action.ActionPerformedEvent event)

cancel

public OperationResult cancel(@Nullable
 Action.ActionPerformedEvent event)

select

protected OperationResult select(Collection<T> items)

setLookupComponentMultiSelect

public void setLookupComponentMultiSelect(boolean multiSelect)

Description copied from interface: MultiSelectLookupScreen

Informs a screen that a lookup component should change its selection mode, if possible.

Specified by:

setLookupComponentMultiSelect in interface MultiSelectLookupScreen

Parameters:

multiSelect - true to enable multiple selections, false otherwise