Package io.jmix.flowui.view.builder

Class LookupWindowBuilder<E,V extends View<?>>

java.lang.Object

io.jmix.flowui.view.builder.AbstractWindowBuilder<V>

io.jmix.flowui.view.builder.LookupWindowBuilder<E,V>

Type Parameters:

V - a view type which is opened in a dialog window

All Implemented Interfaces:

DialogWindowBuilder<V>

Direct Known Subclasses:

LookupWindowClassBuilder

public class LookupWindowBuilder<E,V extends View<?>>
extends AbstractWindowBuilder<V>

Provides a fluent interface to configure and open a lookup view in a DialogWindow.

Field Summary

Fields

Modifier and Type	Field	Description
protected CollectionContainer<E>	container
protected final Class<E>	entityClass
protected com.vaadin.flow.component.HasValue	field
protected boolean	fieldCollectionValue
protected ListDataComponent<E>	listDataComponent
protected Consumer<Collection<E>>	selectHandler
protected Predicate<LookupView.ValidationContext<E>>	selectValidator
protected Function<Collection<E>,Collection<E>>	transformation

Fields inherited from class io.jmix.flowui.view.builder.AbstractWindowBuilder

afterCloseListener, afterOpenListener, handler, origin, viewConfigurer, viewId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LookupWindowBuilder(LookupWindowBuilder<E,V> builder)
	LookupWindowBuilder(View<?> origin, Class<E> entityClass, Function<? extends LookupWindowBuilder<E,V>,DialogWindow<V>> handler)

Method Summary

Modifier and Type	Method	Description
Optional<CollectionContainer<E>>	getContainer()
Class<E>	getEntityClass()
Optional<com.vaadin.flow.component.HasValue>	getField()
Optional<ListDataComponent<E>>	getListDataComponent()
Optional<Consumer<Collection<E>>>	getSelectHandler()
Optional<Predicate<LookupView.ValidationContext<E>>>	getSelectValidator()
Optional<Function<Collection<E>,Collection<E>>>	getTransformation()
boolean	isFieldCollectionValue()
LookupWindowBuilder<E,V>	withAfterCloseListener(Consumer<DialogWindow.AfterCloseEvent<V>> listener)	Adds DialogWindow.AfterCloseEvent listener to the dialog window.
LookupWindowBuilder<E,V>	withAfterOpenListener(Consumer<DialogWindow.AfterOpenEvent<V>> listener)	Adds DialogWindow.AfterOpenEvent listener to the dialog window.
LookupWindowBuilder<E,V>	withContainer(CollectionContainer<E> container)	Sets CollectionContainer to updated after the lookup view is closed.
<T extends com.vaadin.flow.component.HasValue<?, E>> LookupWindowBuilder<E,V>	withField(T field)	Sets the field in which the framework sets the selected entity after successful lookup.
LookupWindowBuilder<E,V>	withListDataComponent(ListDataComponent<E> listDataComponent)	Sets list data component that is used to get the container if it is not set explicitly by withContainer(CollectionContainer) method.
<T extends com.vaadin.flow.component.HasValue<?, Collection<E>>> LookupWindowBuilder<E,V>	withMultiValueField(T field)	Sets the field in which the framework sets the selected entities after successful lookup.
LookupWindowBuilder<E,V>	withSelectHandler(Consumer<Collection<E>> selectHandler)	Sets selection handler for the lookup view.
LookupWindowBuilder<E,V>	withSelectValidator(Predicate<LookupView.ValidationContext<E>> selectValidator)	Sets selection validator for the lookup view.
LookupWindowBuilder<E,V>	withTransformation(Function<Collection<E>,Collection<E>> transformation)	Sets code to transform the entities after selection.
<T extends View<?> & LookupView<E>> LookupWindowClassBuilder<E,T>	withViewClass(Class<T> viewClass)	Sets opened view class.
LookupWindowBuilder<E,V>	withViewConfigurer(Consumer<V> configurer)	Adds configurer to the dialog window.
LookupWindowBuilder<E,V>	withViewId(String viewId)	Sets identifier of the opened view as specified in the ViewController annotation.

Methods inherited from class io.jmix.flowui.view.builder.AbstractWindowBuilder

build, getAfterCloseListener, getAfterOpenListener, getOrigin, getViewConfigurer, getViewId, open

Methods inherited from class java.lang.Object

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

Field Details

entityClass

protected final Class<E> entityClass

selectHandler

protected Consumer<Collection<E>> selectHandler

selectValidator

protected Predicate<LookupView.ValidationContext<E>> selectValidator

transformation

protected Function<Collection<E>,Collection<E>> transformation

container

protected CollectionContainer<E> container

listDataComponent

protected ListDataComponent<E> listDataComponent

field

protected com.vaadin.flow.component.HasValue field

fieldCollectionValue

protected boolean fieldCollectionValue

Constructor Details

LookupWindowBuilder

protected LookupWindowBuilder(LookupWindowBuilder<E,V> builder)

LookupWindowBuilder

public LookupWindowBuilder(View<?> origin,
 Class<E> entityClass,
 Function<? extends LookupWindowBuilder<E,V>,DialogWindow<V>> handler)

Method Details

withViewId

public LookupWindowBuilder<E,V> withViewId(@Nullable
 String viewId)

Sets identifier of the opened view as specified in the ViewController annotation.

Parameters:

viewId - identifier of the opened view as specified in the ViewController annotation

Returns:

this instance for chaining

withViewClass

public <T extends View<?> & LookupView<E>>
LookupWindowClassBuilder<E,T> withViewClass(Class<T> viewClass)

Sets opened view class.

Type Parameters:

T - view type

Parameters:

viewClass - opened view class

Returns:

LookupWindowClassBuilder instance for chaining

withSelectHandler

public LookupWindowBuilder<E,V> withSelectHandler(Consumer<Collection<E>> selectHandler)

Sets selection handler for the lookup view.

Parameters:

selectHandler - handler to set

Returns:

this instance for chaining

withSelectValidator

public LookupWindowBuilder<E,V> withSelectValidator(Predicate<LookupView.ValidationContext<E>> selectValidator)

Sets selection validator for the lookup view.

Parameters:

selectValidator - validator to set

Returns:

this instance for chaining

withTransformation

public LookupWindowBuilder<E,V> withTransformation(@Nullable
 Function<Collection<E>,Collection<E>> transformation)

Sets code to transform the entities after selection.

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

Parameters:

transformation - edited entity transformation object

Returns:

this instance for chaining

See Also:

• withContainer(CollectionContainer)
• withField(HasValue)
• withMultiValueField(HasValue)
• withListDataComponent(ListDataComponent)

withContainer

public LookupWindowBuilder<E,V> withContainer(@Nullable
 CollectionContainer<E> container)

Sets CollectionContainer to updated after the lookup view is closed.

If the container is Nested, the framework automatically initializes the reference to the parent entity and sets up data contexts for added One-To-Many and Many-To-Many relations.

Parameters:

container - the container to update after the lookup view is closed

Returns:

this instance for chaining

withListDataComponent

public LookupWindowBuilder<E,V> withListDataComponent(@Nullable
 ListDataComponent<E> listDataComponent)

Sets list data component that is used to get the container if it is not set explicitly by withContainer(CollectionContainer) method.

Usually, the list component is a DataGrid displaying the list of entities.

Parameters:

listDataComponent - the component to set

Returns:

this instance for chaining

withField

public <T extends com.vaadin.flow.component.HasValue<?,
E>>
LookupWindowBuilder<E,V> withField(@Nullable
 T field)

Sets the field in which the framework sets the selected entity after successful lookup.

Parameters:

field - the field to set

Returns:

this instance for chaining

withMultiValueField

public <T extends com.vaadin.flow.component.HasValue<?,
Collection<E>>>
LookupWindowBuilder<E,V> withMultiValueField(@Nullable
 T field)

Sets the field in which the framework sets the selected entities after successful lookup.

Parameters:

field - the field to set

Returns:

this instance for chaining

withAfterOpenListener

public LookupWindowBuilder<E,V> withAfterOpenListener(@Nullable
 Consumer<DialogWindow.AfterOpenEvent<V>> listener)

Description copied from class: AbstractWindowBuilder

Adds DialogWindow.AfterOpenEvent listener to the dialog window.

Overrides:

withAfterOpenListener in class AbstractWindowBuilder<V extends View<?>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withAfterCloseListener

public LookupWindowBuilder<E,V> withAfterCloseListener(@Nullable
 Consumer<DialogWindow.AfterCloseEvent<V>> listener)

Description copied from class: AbstractWindowBuilder

Adds DialogWindow.AfterCloseEvent listener to the dialog window.

Overrides:

withAfterCloseListener in class AbstractWindowBuilder<V extends View<?>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withViewConfigurer

public LookupWindowBuilder<E,V> withViewConfigurer(@Nullable
 Consumer<V> configurer)

Description copied from class: AbstractWindowBuilder

Adds configurer to the dialog window.

Overrides:

withViewConfigurer in class AbstractWindowBuilder<V extends View<?>>

Parameters:

configurer - the configurer to add

Returns:

the instance for chaining

getEntityClass

public Class<E> getEntityClass()

Returns:

entity class

getSelectHandler

public Optional<Consumer<Collection<E>>> getSelectHandler()

Returns:

select handler set by withSelectHandler(Consumer).

getSelectValidator

public Optional<Predicate<LookupView.ValidationContext<E>>> getSelectValidator()

Returns:

select validator set by withSelectValidator(Predicate).

getTransformation

public Optional<Function<Collection<E>,Collection<E>>> getTransformation()

Returns:

transformation set by withTransformation(Function).

getContainer

public Optional<CollectionContainer<E>> getContainer()

Returns:

container set by withContainer(CollectionContainer).

getListDataComponent

public Optional<ListDataComponent<E>> getListDataComponent()

Returns:

list data component set by withListDataComponent(ListDataComponent).

getField

public Optional<com.vaadin.flow.component.HasValue> getField()

Returns:

field set by either withField(HasValue) or withMultiValueField(HasValue).

isFieldCollectionValue

public boolean isFieldCollectionValue()

Returns:

whether a field stores multiple values