Package io.jmix.ui.builder

Class LookupClassBuilder<E,S extends Screen & LookupScreen<E>>

java.lang.Object

io.jmix.ui.builder.LookupBuilder<E>

io.jmix.ui.builder.LookupClassBuilder<E,S>

public class LookupClassBuilder<E,S extends Screen & LookupScreen<E>>
extends LookupBuilder<E>

Lookup screen builder that knows the concrete screen class. It's build() method returns that class.

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<AfterScreenCloseEvent<S>>	afterCloseListener
protected Consumer<AfterScreenShowEvent<S>>	afterShowListener
protected Class<S>	screenClass

Fields inherited from class io.jmix.ui.builder.LookupBuilder

container, entityClass, field, handler, isFieldCollectionValue, listComponent, openMode, options, origin, screenId, selectHandler, selectValidator, transformation

Constructor Summary

Constructors

Constructor	Description
LookupClassBuilder(LookupBuilder<E> builder, Class<S> screenClass)

Method Summary

Modifier and Type	Method	Description
S	build()	Builds the lookup screen.
Consumer<AfterScreenCloseEvent<S>>	getAfterCloseListener()
Consumer<AfterScreenShowEvent<S>>	getAfterShowListener()
Class<S>	getScreenClass()	Returns lookup screen class.
S	show()	Builds and shows the lookup screen.
LookupClassBuilder<E,S>	withAfterCloseListener(Consumer<AfterScreenCloseEvent<S>> listener)	Adds Screen.AfterCloseEvent listener to the screen.
LookupClassBuilder<E,S>	withAfterShowListener(Consumer<AfterScreenShowEvent<S>> listener)	Adds Screen.AfterShowEvent listener to the screen.
LookupClassBuilder<E,S>	withContainer(CollectionContainer<E> container)	Sets CollectionContainer and returns the builder for chaining.
<T extends HasValue<E>> LookupClassBuilder<E,S>	withField(T field)	Sets the field component and returns the builder for chaining.
LookupClassBuilder<E,S>	withListComponent(ListComponent<E> target)	Sets list component and returns the builder for chaining.
LookupClassBuilder<E,S>	withOpenMode(OpenMode openMode)	Sets OpenMode for the lookup screen and returns the builder for chaining.
LookupClassBuilder<E,S>	withOptions(ScreenOptions options)	Sets ScreenOptions for the lookup screen and returns the builder for chaining.
LookupBuilder<E>	withScreenId(String screenId)	Sets screen id and returns the builder for chaining.
LookupClassBuilder<E,S>	withSelectHandler(Consumer<Collection<E>> selectHandler)	Sets selection handler for the lookup screen and returns the builder for chaining.
LookupClassBuilder<E,S>	withSelectValidator(Predicate<LookupScreen.ValidationContext<E>> selectValidator)	Sets selection validator for the lookup screen and returns the builder for chaining.
LookupClassBuilder<E,S>	withTransformation(Function<Collection<E>,Collection<E>> transformation)	Sets code to transform entities after selection and returns the builder for chaining.
<T extends HasValue<Collection<E>>> LookupClassBuilder<E,S>	withValuesField(T field)	Sets the field component with collection value type.

Methods inherited from class io.jmix.ui.builder.LookupBuilder

getContainer, getEntityClass, getField, getListComponent, getOpenMode, getOptions, getOrigin, getScreenId, getSelectHandler, getSelectValidator, getTransformation, isFieldCollectionValue, withScreenClass

Methods inherited from class java.lang.Object

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

Field Details

screenClass

protected Class<S extends Screen & LookupScreen<E>> screenClass

afterShowListener

protected Consumer<AfterScreenShowEvent<S extends Screen & LookupScreen<E>>> afterShowListener

afterCloseListener

protected Consumer<AfterScreenCloseEvent<S extends Screen & LookupScreen<E>>> afterCloseListener

Constructor Details

LookupClassBuilder

public LookupClassBuilder(LookupBuilder<E> builder,
 Class<S> screenClass)

Method Details

withOpenMode

public LookupClassBuilder<E,S> withOpenMode(OpenMode openMode)

Description copied from class: LookupBuilder

Sets OpenMode for the lookup screen and returns the builder for chaining.

For example: builder.withOpenMode(OpenMode.DIALOG).build();

Overrides:

withOpenMode in class LookupBuilder<E>

withOptions

public LookupClassBuilder<E,S> withOptions(ScreenOptions options)

Description copied from class: LookupBuilder

Sets ScreenOptions for the lookup screen and returns the builder for chaining.

Overrides:

withOptions in class LookupBuilder<E>

withSelectValidator

public LookupClassBuilder<E,S> withSelectValidator(Predicate<LookupScreen.ValidationContext<E>> selectValidator)

Description copied from class: LookupBuilder

Sets selection validator for the lookup screen and returns the builder for chaining.

Overrides:

withSelectValidator in class LookupBuilder<E>

withSelectHandler

public LookupClassBuilder<E,S> withSelectHandler(@Nullable
 Consumer<Collection<E>> selectHandler)

Description copied from class: LookupBuilder

Sets selection handler for the lookup screen and returns the builder for chaining.

Overrides:

withSelectHandler in class LookupBuilder<E>

withField

public <T extends HasValue<E>>
LookupClassBuilder<E,S> withField(T field)

Description copied from class: LookupBuilder

Sets the field component and returns the builder for chaining.

If the field is set, the framework sets the selected entity to the field after successful lookup.

Overrides:

withField in class LookupBuilder<E>

withValuesField

public <T extends HasValue<Collection<E>>>
LookupClassBuilder<E,S> withValuesField(T field)

Description copied from class: LookupBuilder

Sets the field component with collection value type.

If the field is set, the framework sets the selected entity to the field after successful lookup.

Overrides:

withValuesField in class LookupBuilder<E>

Type Parameters:

T - type of field

Parameters:

field - field to set

Returns:

the builder for chaining

withScreenId

public LookupBuilder<E> withScreenId(String screenId)

Description copied from class: LookupBuilder

Sets screen id and returns the builder for chaining.

Overrides:

withScreenId in class LookupBuilder<E>

Parameters:

screenId - identifier of the lookup screen as specified in the UiController annotation or screens.xml.

withListComponent

public LookupClassBuilder<E,S> withListComponent(ListComponent<E> target)

Description copied from class: LookupBuilder

Sets list component and returns the builder for chaining.

The component is used to get the container if it is not set explicitly by LookupBuilder.withContainer(CollectionContainer) method. Usually, the list component is a Table or DataGrid displaying the list of entities.

Overrides:

withListComponent in class LookupBuilder<E>

withContainer

public LookupClassBuilder<E,S> withContainer(CollectionContainer<E> container)

Description copied from class: LookupBuilder

Sets CollectionContainer and returns the builder for chaining.

The container is updated after the lookup screen 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 LookupBuilder<E>

withAfterShowListener

public LookupClassBuilder<E,S> withAfterShowListener(Consumer<AfterScreenShowEvent<S>> listener)

Adds Screen.AfterShowEvent listener to the screen.

Parameters:

listener - listener

withAfterCloseListener

public LookupClassBuilder<E,S> withAfterCloseListener(Consumer<AfterScreenCloseEvent<S>> listener)

Adds Screen.AfterCloseEvent listener to the screen.

Parameters:

listener - listener

withTransformation

public LookupClassBuilder<E,S> withTransformation(Function<Collection<E>,Collection<E>> transformation)

Description copied from class: LookupBuilder

Sets code to transform entities after selection and returns the builder for chaining.
Applied only if either field or container or listComponent is assigned.

Overrides:

withTransformation in class LookupBuilder<E>

Parameters:

transformation - edited entity transformation

See Also:

• LookupBuilder.withContainer(CollectionContainer)
• LookupBuilder.withField(HasValue)
• LookupBuilder.withListComponent(ListComponent)

getScreenClass

@Nullable
public Class<S> getScreenClass()

Returns lookup screen class.

getAfterShowListener

public Consumer<AfterScreenShowEvent<S>> getAfterShowListener()

Returns:

after show screen listener

getAfterCloseListener

public Consumer<AfterScreenCloseEvent<S>> getAfterCloseListener()

Returns:

after close screen listener

build

public S build()

Description copied from class: LookupBuilder

Builds the lookup screen. Screen should be shown using Screen.show().

Overrides:

build in class LookupBuilder<E>

show

public S show()

Description copied from class: LookupBuilder

Builds and shows the lookup screen.

Overrides:

show in class LookupBuilder<E>