Package io.jmix.ui.component

Interface LookupScreenFacet<E,S extends Screen & LookupScreen<E>>

All Superinterfaces:

org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.Aware, EntityAwareScreenFacet<E>, Facet, ScreenFacet<S>

All Known Implementing Classes:

LookupScreenFacetImpl

@StudioFacet(xmlElement="lookupScreen",
             caption="LookupScreen",
             description="Prepares and shows lookup screens",
             category="Facets",
             defaultProperty="screenId",
             icon="io/jmix/ui/icon/facet/screen.svg",
             documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/facets/lookup-screen-facet.html")
public interface LookupScreenFacet<E,S extends Screen & LookupScreen<E>>
extends ScreenFacet<S>, EntityAwareScreenFacet<E>

Prepares and shows lookup screens.

Method Summary

Modifier and Type	Method	Description
Consumer<Collection<E>>	getSelectHandler()
Predicate<LookupScreen.ValidationContext<E>>	getSelectValidator()
Function<Collection<E>,Collection<E>>	getTransformation()
void	setSelectHandler(Consumer<Collection<E>> selectHandler)	Sets select handler for the lookup screen.
void	setSelectValidator(Predicate<LookupScreen.ValidationContext<E>> selectValidator)	Sets select validator for the lookup screen.
void	setTransformation(Function<Collection<E>,Collection<E>> transformation)	Sets code to transform entities after selection.

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface io.jmix.ui.component.EntityAwareScreenFacet

getContainer, getEntityClass, getEntityPicker, getListComponent, setContainer, setEntityClass, setEntityPicker, setListComponent

Methods inherited from interface io.jmix.ui.component.Facet

getId, getOwner, setId, setOwner

Methods inherited from interface io.jmix.ui.component.ScreenFacet

addAfterCloseEventListener, addAfterShowEventListener, create, getActionTarget, getButtonTarget, getOpenMode, getOptionsProvider, getProperties, getScreenClass, getScreenConfigurer, getScreenId, setActionTarget, setButtonTarget, setOpenMode, setOptionsProvider, setProperties, setScreenClass, setScreenConfigurer, setScreenId, show

Method Details

setSelectHandler

void setSelectHandler(@Nullable
 Consumer<Collection<E>> selectHandler)

Sets select handler for the lookup screen.

getSelectHandler

@Nullable
Consumer<Collection<E>> getSelectHandler()

Returns:

lookup screen select handler

setSelectValidator

void setSelectValidator(@Nullable
 Predicate<LookupScreen.ValidationContext<E>> selectValidator)

Sets select validator for the lookup screen.

getSelectValidator

@Nullable
Predicate<LookupScreen.ValidationContext<E>> getSelectValidator()

Returns:

lookup screen select validator

setTransformation

void setTransformation(@Nullable
 Function<Collection<E>,Collection<E>> transformation)

Sets code to transform entities after selection.

Applied only if either field or container or listComponent is assigned.

getTransformation

@Nullable
Function<Collection<E>,Collection<E>> getTransformation()

Returns:

selected entities transformation