Package io.jmix.flowui.view.builder

Class LookupWindowClassBuilder<E,V extends View<?> & LookupView<E>>

java.lang.Object

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

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

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

Type Parameters:

E - entity type

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

All Implemented Interfaces:

DialogWindowBuilder<V>, DialogWindowClassBuilder<V>

public class LookupWindowClassBuilder<E,V extends View<?> & LookupView<E>>
extends LookupWindowBuilder<E,V>
implements DialogWindowClassBuilder<V>

Provides a fluent interface to configure and open a lookup view with the specific class in a DialogWindow.

Field Summary

Fields

Modifier and Type	Field	Description
protected Class<V>	viewClass

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

container, entityClass, field, fieldCollectionValue, listDataComponent, lookupComponentMultiSelect, selectHandler, selectValidator, transformation

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

afterCloseListener, afterOpenListener, draggedListener, handler, origin, resizeListener, viewConfigurer, viewId

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Optional<Class<V>>	getViewClass()
LookupWindowClassBuilder<E,V>	withAfterCloseListener(@Nullable Consumer<DialogWindow.AfterCloseEvent<V>> listener)	Adds DialogWindow.AfterCloseEvent listener to the dialog window.
LookupWindowClassBuilder<E,V>	withAfterOpenListener(@Nullable Consumer<DialogWindow.AfterOpenEvent<V>> listener)	Adds DialogWindow.AfterOpenEvent listener to the dialog window.
LookupWindowClassBuilder<E,V>	withContainer(@Nullable CollectionContainer<E> container)	Sets CollectionContainer to updated after the lookup view is closed.
LookupWindowClassBuilder<E,V>	withDraggedListener(@Nullable com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent> listener)	Adds Dialog.DialogDraggedEvent listener to the dialog window.
<T extends com.vaadin.flow.component.HasValue<?, E>> LookupWindowClassBuilder<E,V>	withField(@Nullable T field)	Sets the field in which the framework sets the selected entity after successful lookup.
LookupWindowClassBuilder<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 LookupWindowBuilder.withContainer(CollectionContainer) method.
LookupWindowClassBuilder<E,V>	withLookupComponentMultiSelect(@Nullable Boolean lookupComponentMultiSelect)	Sets multi selection mode for the lookup component in the lookup view.
<T extends com.vaadin.flow.component.HasValue<?, Collection<E>>> LookupWindowClassBuilder<E,V>	withMultiValueField(@Nullable T field)	Sets the field in which the framework sets the selected entities after successful lookup.
LookupWindowClassBuilder<E,V>	withResizeListener(@Nullable com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogResizeEvent> listener)	Adds Dialog.DialogResizeEvent listener to the dialog window.
LookupWindowClassBuilder<E,V>	withSelectHandler(Consumer<Collection<E>> selectHandler)	Sets selection handler for the lookup view.
LookupWindowClassBuilder<E,V>	withSelectValidator(Predicate<LookupView.ValidationContext<E>> selectValidator)	Sets selection validator for the lookup view.
LookupWindowClassBuilder<E,V>	withTransformation(@Nullable Function<Collection<E>,Collection<E>> transformation)	Sets code to transform the entities after selection.
LookupWindowClassBuilder<E,V>	withViewConfigurer(@Nullable Consumer<V> configurer)	Adds configurer to the dialog window.
LookupWindowClassBuilder<E,V>	withViewId(@Nullable String viewId)	Sets identifier of the opened view as specified in the ViewController annotation.

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

getContainer, getEntityClass, getField, getListDataComponent, getLookupComponentMultiSelect, getSelectHandler, getSelectValidator, getTransformation, isFieldCollectionValue, withViewClass

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.flowui.view.builder.DialogWindowBuilder

getAfterCloseListener, getAfterOpenListener, getDraggedListener, getOrigin, getResizeListener, getViewConfigurer, getViewId

Field Details

viewClass

protected Class<V extends View<?> & LookupView<E>> viewClass

Constructor Details

LookupWindowClassBuilder

protected LookupWindowClassBuilder(LookupWindowBuilder<E,V> builder,
 Class<V> viewClass)

LookupWindowClassBuilder

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

Method Details

withViewId

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

Description copied from class: LookupWindowBuilder

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

Overrides:

withViewId in class LookupWindowBuilder<E,V extends View<?> & LookupView<E>>

Parameters:

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

Returns:

this instance for chaining

withSelectHandler

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

Description copied from class: LookupWindowBuilder

Sets selection handler for the lookup view.

Overrides:

withSelectHandler in class LookupWindowBuilder<E,V extends View<?> & LookupView<E>>

Parameters:

selectHandler - handler to set

Returns:

this instance for chaining

withSelectValidator

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

Description copied from class: LookupWindowBuilder

Sets selection validator for the lookup view.

Overrides:

withSelectValidator in class LookupWindowBuilder<E,V extends View<?> & LookupView<E>>

Parameters:

selectValidator - validator to set

Returns:

this instance for chaining

withTransformation

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

Description copied from class: LookupWindowBuilder

Sets code to transform the entities after selection.

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

Overrides:

withTransformation in class LookupWindowBuilder<E,V extends View<?> & LookupView<E>>

Parameters:

transformation - edited entity transformation object

Returns:

this instance for chaining

See Also:

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

withContainer

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

Description copied from class: LookupWindowBuilder

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.

Overrides:

withContainer in class LookupWindowBuilder<E,V extends View<?> & LookupView<E>>

Parameters:

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

Returns:

this instance for chaining

withListDataComponent

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

Description copied from class: LookupWindowBuilder

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

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

Overrides:

withListDataComponent in class LookupWindowBuilder<E,V extends View<?> & LookupView<E>>

Parameters:

listDataComponent - the component to set

Returns:

this instance for chaining

withField

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

Description copied from class: LookupWindowBuilder

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

Overrides:

withField in class LookupWindowBuilder<E,V extends View<?> & LookupView<E>>

Parameters:

field - the field to set

Returns:

this instance for chaining

withLookupComponentMultiSelect

public LookupWindowClassBuilder<E,V> withLookupComponentMultiSelect(@Nullable Boolean lookupComponentMultiSelect)

Description copied from class: LookupWindowBuilder

Sets multi selection mode for the lookup component in the lookup view.

Overrides:

withLookupComponentMultiSelect in class LookupWindowBuilder<E,V extends View<?> & LookupView<E>>

Parameters:

lookupComponentMultiSelect - whether to use multi selection for the lookup component or null to use the default selection mode

Returns:

this instance for chaining

withMultiValueField

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

Description copied from class: LookupWindowBuilder

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

Overrides:

withMultiValueField in class LookupWindowBuilder<E,V extends View<?> & LookupView<E>>

Parameters:

field - the field to set

Returns:

this instance for chaining

withAfterOpenListener

public LookupWindowClassBuilder<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 LookupWindowBuilder<E,V extends View<?> & LookupView<E>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withAfterCloseListener

public LookupWindowClassBuilder<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 LookupWindowBuilder<E,V extends View<?> & LookupView<E>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withDraggedListener

public LookupWindowClassBuilder<E,V> withDraggedListener(@Nullable com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent> listener)

Description copied from class: AbstractWindowBuilder

Adds Dialog.DialogDraggedEvent listener to the dialog window.

Overrides:

withDraggedListener in class LookupWindowBuilder<E,V extends View<?> & LookupView<E>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withResizeListener

public LookupWindowClassBuilder<E,V> withResizeListener(@Nullable com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogResizeEvent> listener)

Description copied from class: AbstractWindowBuilder

Adds Dialog.DialogResizeEvent listener to the dialog window.

Overrides:

withResizeListener in class LookupWindowBuilder<E,V extends View<?> & LookupView<E>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withViewConfigurer

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

Description copied from class: AbstractWindowBuilder

Adds configurer to the dialog window.

Overrides:

withViewConfigurer in class LookupWindowBuilder<E,V extends View<?> & LookupView<E>>

Parameters:

configurer - the configurer to add

Returns:

the instance for chaining

getViewClass

public Optional<Class<V>> getViewClass()

Specified by:

getViewClass in interface DialogWindowClassBuilder<E>

Returns:

opened view class