Package io.jmix.flowui.screen

Class StandardLookup<T>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<T>

io.jmix.flowui.screen.Screen<ScreenLayout>

io.jmix.flowui.screen.StandardScreen

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

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.router.AfterNavigationObserver, com.vaadin.flow.router.BeforeEnterObserver, com.vaadin.flow.router.BeforeLeaveObserver, com.vaadin.flow.router.internal.AfterNavigationHandler, com.vaadin.flow.router.internal.BeforeEnterHandler, com.vaadin.flow.router.internal.BeforeLeaveHandler, LookupScreen<T>, MultiSelectLookupScreen, Serializable

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

See Also:

• Serialized Form

Nested Class Summary

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

Screen.AfterCloseEvent, Screen.AfterShowEvent, Screen.BeforeCloseEvent, Screen.BeforeShowEvent, Screen.InitEvent

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

LookupScreen.ValidationContext<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DISCARD_ACTION_DEFAULT_ID
protected static final String	LOOKUP_ACTIONS_LAYOUT_DEFAULT_ID
protected static final String	SELECT_ACTION_DEFAULT_ID
protected Consumer<Collection<T>>	selectionHandler
protected Predicate<LookupScreen.ValidationContext<T>>	selectionValidator

Constructor Summary

Constructors

Constructor	Description
StandardLookup()

Method Summary

Modifier and Type	Method	Description
OperationResult	closeWithDiscard()
protected OperationResult	doSelect(Collection<T> items)
Optional<LookupComponent<T>>	findLookupComponent()
protected Optional<Action>	getDiscardAction()
protected Optional<com.vaadin.flow.component.Component>	getLookupActionsLayout()
LookupComponent<T>	getLookupComponent()
protected Optional<Action>	getSelectAction()
Optional<Consumer<Collection<T>>>	getSelectionHandler()
Optional<Predicate<LookupScreen.ValidationContext<T>>>	getSelectionValidator()
OperationResult	handleSelection()
void	setLookupComponentMultiSelect(boolean multiSelect)	Informs a screen that a lookup component should change its selection mode, if possible.
void	setSelectionHandler(Consumer<Collection<T>> selectionHandler)
void	setSelectionValidator(Predicate<LookupScreen.ValidationContext<T>> selectionValidator)
protected void	setupCommitShortcut()
protected void	setupLookupComponent()
protected OperationResult	validateSelectedItems(Collection<T> items)

Methods inherited from class io.jmix.flowui.screen.StandardScreen

initContent

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

addAfterCloseListener, addAfterShowListener, addBeforeCloseListener, addBeforeShowListener, addInitListener, afterNavigation, beforeEnter, beforeLeave, close, close, closeWithDefaultAction, getApplicationContext, getId, getScreenActions, getScreenData, getScreenFacets, removeApplicationListeners, setApplicationContext, setId, setScreenActions, setScreenData, setScreenFacets, unregisterBackNavigation, updatePageTitle

Methods inherited from class com.vaadin.flow.component.Composite

getChildren, getContent, getElement

Methods inherited from class com.vaadin.flow.component.Component

addListener, fireEvent, from, get, getEventBus, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, scrollIntoView, set, setElement, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Field Details

LOOKUP_ACTIONS_LAYOUT_DEFAULT_ID

protected static final String LOOKUP_ACTIONS_LAYOUT_DEFAULT_ID

See Also:

• Constant Field Values

SELECT_ACTION_DEFAULT_ID

protected static final String SELECT_ACTION_DEFAULT_ID

See Also:

• Constant Field Values

DISCARD_ACTION_DEFAULT_ID

protected static final String DISCARD_ACTION_DEFAULT_ID

See Also:

• Constant Field Values

selectionHandler

protected Consumer<Collection<T>> selectionHandler

selectionValidator

protected Predicate<LookupScreen.ValidationContext<T>> selectionValidator

Constructor Details

StandardLookup

public StandardLookup()

Method Details

setupLookupComponent

protected void setupLookupComponent()

setupCommitShortcut

protected void setupCommitShortcut()

getSelectionHandler

public Optional<Consumer<Collection<T>>> getSelectionHandler()

Specified by:

getSelectionHandler in interface LookupScreen<T>

setSelectionHandler

public void setSelectionHandler(@Nullable
 Consumer<Collection<T>> selectionHandler)

Specified by:

setSelectionHandler in interface LookupScreen<T>

getLookupActionsLayout

protected Optional<com.vaadin.flow.component.Component> getLookupActionsLayout()

getLookupComponent

public LookupComponent<T> getLookupComponent()

Specified by:

getLookupComponent in interface LookupScreen<T>

findLookupComponent

public Optional<LookupComponent<T>> findLookupComponent()

Specified by:

findLookupComponent in interface LookupScreen<T>

getSelectionValidator

public Optional<Predicate<LookupScreen.ValidationContext<T>>> getSelectionValidator()

Specified by:

getSelectionValidator in interface LookupScreen<T>

setSelectionValidator

public void setSelectionValidator(@Nullable
 Predicate<LookupScreen.ValidationContext<T>> selectionValidator)

Specified by:

setSelectionValidator in interface LookupScreen<T>

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

handleSelection

public OperationResult handleSelection()

Specified by:

handleSelection in interface LookupScreen<T>

validateSelectedItems

protected OperationResult validateSelectedItems(Collection<T> items)

doSelect

protected OperationResult doSelect(Collection<T> items)

closeWithDiscard

public OperationResult closeWithDiscard()

Specified by:

closeWithDiscard in interface LookupScreen<T>

getSelectAction

protected Optional<Action> getSelectAction()

getDiscardAction

protected Optional<Action> getDiscardAction()