LookupBuilder (Jmix-ui 1.0 API)

java.lang.Object
- io.jmix.ui.builder.LookupBuilder<E>

Direct Known Subclasses:

LookupClassBuilder
```
public class LookupBuilder<E>
extends java.lang.Object
```
Lookup screen builder that is not aware of concrete screen class. It's build() method returns Screen.

Field Summary

Fields
Modifier and Type	Field and Description
`protected CollectionContainer<E>`	`container`
`protected java.lang.Class<E>`	`entityClass`
`protected HasValue`	`field`
`protected java.util.function.Function<LookupBuilder<E>,Screen>`	`handler`
`protected boolean`	`isFieldCollectionValue`
`protected ListComponent<E>`	`listComponent`
`protected OpenMode`	`openMode`
`protected ScreenOptions`	`options`
`protected FrameOwner`	`origin`
`protected java.lang.String`	`screenId`
`protected java.util.function.Consumer<java.util.Collection<E>>`	`selectHandler`
`protected java.util.function.Predicate<LookupScreen.ValidationContext<E>>`	`selectValidator`
`protected java.util.function.Function<java.util.Collection<E>,java.util.Collection<E>>`	`transformation`

Constructor Summary

Constructors
Constructor and Description
`LookupBuilder(FrameOwner origin, java.lang.Class<E> entityClass, java.util.function.Function<LookupBuilder<E>,Screen> handler)`
`LookupBuilder(LookupBuilder<E> builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Screen`	`build()` Builds the lookup screen.
`CollectionContainer<E>`	`getContainer()` Returns container set by `withContainer(CollectionContainer)`.
`java.lang.Class<E>`	`getEntityClass()` Returns class of the entity to lookup.
`HasValue`	`getField()` Returns the field component set by `withField(HasValue)`.
`ListComponent<E>`	`getListComponent()` Returns list component set by `withListComponent(ListComponent)`.
`OpenMode`	`getOpenMode()` Returns launch mode set by `withOpenMode(OpenMode)`.
`ScreenOptions`	`getOptions()` Returns screen options set by `withOptions(ScreenOptions)`.
`FrameOwner`	`getOrigin()` Returns invoking screen.
`java.lang.String`	`getScreenId()` Returns screen id set by `withScreenId(String)`.
`java.util.function.Consumer<java.util.Collection<E>>`	`getSelectHandler()` Returns selection handler set by `withSelectHandler(Consumer)`.
`java.util.function.Predicate<LookupScreen.ValidationContext<E>>`	`getSelectValidator()` Returns selection validator set by `withSelectValidator(Predicate)`.
`java.util.function.Function<java.util.Collection<E>,java.util.Collection<E>>`	`getTransformation()`
`protected boolean`	`isFieldCollectionValue()`
`Screen`	`show()` Builds and shows the lookup screen.
`LookupBuilder<E>`	`withContainer(CollectionContainer<E> container)` Sets `CollectionContainer` and returns the builder for chaining.
`<T extends HasValue<E>> LookupBuilder<E>`	`withField(T field)` Sets the field component and returns the builder for chaining.
`LookupBuilder<E>`	`withListComponent(ListComponent<E> target)` Sets list component and returns the builder for chaining.
`LookupBuilder<E>`	`withOpenMode(OpenMode openMode)` Sets `OpenMode` for the lookup screen and returns the builder for chaining.
`LookupBuilder<E>`	`withOptions(ScreenOptions options)` Sets `ScreenOptions` for the lookup screen and returns the builder for chaining.
`<S extends Screen & LookupScreen<E>> LookupClassBuilder<E,S>`	`withScreenClass(java.lang.Class<S> screenClass)` Sets screen class and returns the `LookupClassBuilder` for chaining.
`LookupBuilder<E>`	`withScreenId(java.lang.String screenId)` Sets screen id and returns the builder for chaining.
`LookupBuilder<E>`	`withSelectHandler(java.util.function.Consumer<java.util.Collection<E>> selectHandler)` Sets selection handler for the lookup screen and returns the builder for chaining.
`LookupBuilder<E>`	`withSelectValidator(java.util.function.Predicate<LookupScreen.ValidationContext<E>> selectValidator)` Sets selection validator for the lookup screen and returns the builder for chaining.
`LookupBuilder<E>`	`withTransformation(java.util.function.Function<java.util.Collection<E>,java.util.Collection<E>> transformation)` Sets code to transform entities after selection and returns the builder for chaining.
`<T extends HasValue<java.util.Collection<E>>> LookupBuilder<E>`	`withValuesField(T field)` Sets the field component with collection value type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - origin
```
protected final FrameOwner origin
```
  - entityClass
```
protected final java.lang.Class<E> entityClass
```
  - handler
```
protected final java.util.function.Function<LookupBuilder<E>,Screen> handler
```
  - selectValidator
```
protected java.util.function.Predicate<LookupScreen.ValidationContext<E>> selectValidator
```
  - transformation
```
protected java.util.function.Function<java.util.Collection<E>,java.util.Collection<E>> transformation
```
  - selectHandler
```
protected java.util.function.Consumer<java.util.Collection<E>> selectHandler
```
  - openMode
```
protected OpenMode openMode
```
  - options
```
protected ScreenOptions options
```
  - container
```
protected CollectionContainer<E> container
```
  - screenId
```
protected java.lang.String screenId
```
  - listComponent
```
protected ListComponent<E> listComponent
```
  - field
```
protected HasValue field
```
  - isFieldCollectionValue
```
protected boolean isFieldCollectionValue
```
- Constructor Detail
  - LookupBuilder
```
public LookupBuilder(LookupBuilder<E> builder)
```
  - LookupBuilder
```
public LookupBuilder(FrameOwner origin,
                     java.lang.Class<E> entityClass,
                     java.util.function.Function<LookupBuilder<E>,Screen> handler)
```
- Method Detail
  - withOpenMode
```
public LookupBuilder<E> withOpenMode(OpenMode openMode)
```
    Sets OpenMode for the lookup screen and returns the builder for chaining.
    For example: builder.withOpenMode(OpenMode.DIALOG).build();
  - withOptions
```
public LookupBuilder<E> withOptions(ScreenOptions options)
```
    Sets ScreenOptions for the lookup screen and returns the builder for chaining.
  - withSelectValidator
```
public LookupBuilder<E> withSelectValidator(java.util.function.Predicate<LookupScreen.ValidationContext<E>> selectValidator)
```
    Sets selection validator for the lookup screen and returns the builder for chaining.
  - withSelectHandler
```
public LookupBuilder<E> withSelectHandler(@Nullable
                                          java.util.function.Consumer<java.util.Collection<E>> selectHandler)
```
    Sets selection handler for the lookup screen and returns the builder for chaining.
  - withField
```
public <T extends HasValue<E>> LookupBuilder<E> withField(T field)
```
    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.
  - withValuesField
```
public <T extends HasValue<java.util.Collection<E>>> LookupBuilder<E> withValuesField(T field)
```
    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.
    
    Type Parameters:
    
    T - type of field
    
    Parameters:
    
    field - field to set
    
    Returns:
    
    the builder for chaining
  - withScreenClass
```
public <S extends Screen & LookupScreen<E>> LookupClassBuilder<E,S> withScreenClass(java.lang.Class<S> screenClass)
```
    Sets screen class and returns the LookupClassBuilder for chaining.
    
    Parameters:
    
    screenClass - class of the screen controller
  - withScreenId
```
public LookupBuilder<E> withScreenId(java.lang.String screenId)
```
    Sets screen id and returns the builder for chaining.
    
    Parameters:
    
    screenId - identifier of the lookup screen as specified in the UiController annotation or screens.xml.
  - withListComponent
```
public LookupBuilder<E> withListComponent(ListComponent<E> target)
```
    Sets list component and returns the builder for chaining.
    The component is used to get the container if it is not set explicitly by withContainer(CollectionContainer) method. Usually, the list component is a Table or DataGrid displaying the list of entities.
  - withContainer
```
public LookupBuilder<E> withContainer(CollectionContainer<E> container)
```
    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.
  - withTransformation
```
public LookupBuilder<E> withTransformation(java.util.function.Function<java.util.Collection<E>,java.util.Collection<E>> transformation)
```
    Sets code to transform entities after selection and returns the builder for chaining.
    Applied only if either field or container or listComponent is assigned.
    
    Parameters:
    
    transformation - edited entity transformation
    
    See Also:
    
    withContainer(CollectionContainer), withField(HasValue), withListComponent(ListComponent)
  - getScreenId
```
@Nullable
public java.lang.String getScreenId()
```
    Returns screen id set by withScreenId(String).
  - getOpenMode
```
public OpenMode getOpenMode()
```
    Returns launch mode set by withOpenMode(OpenMode).
  - getOptions
```
public ScreenOptions getOptions()
```
    Returns screen options set by withOptions(ScreenOptions).
  - getOrigin
```
public FrameOwner getOrigin()
```
    Returns invoking screen.
  - getEntityClass
```
public java.lang.Class<E> getEntityClass()
```
    Returns class of the entity to lookup.
  - getSelectHandler
```
@Nullable
public java.util.function.Consumer<java.util.Collection<E>> getSelectHandler()
```
    Returns selection handler set by withSelectHandler(Consumer).
  - getSelectValidator
```
@Nullable
public java.util.function.Predicate<LookupScreen.ValidationContext<E>> getSelectValidator()
```
    Returns selection validator set by withSelectValidator(Predicate).
  - getField
```
@Nullable
public HasValue getField()
```
    Returns the field component set by withField(HasValue).
  - getContainer
```
@Nullable
public CollectionContainer<E> getContainer()
```
    Returns container set by withContainer(CollectionContainer).
  - getListComponent
```
@Nullable
public ListComponent<E> getListComponent()
```
    Returns list component set by withListComponent(ListComponent).
  - getTransformation
```
@Nullable
public java.util.function.Function<java.util.Collection<E>,java.util.Collection<E>> getTransformation()
```
  - build
```
public Screen build()
```
    Builds the lookup screen. Screen should be shown using Screen.show().
  - show
```
public Screen show()
```
    Builds and shows the lookup screen.
  - isFieldCollectionValue
```
protected boolean isFieldCollectionValue()
```

Class LookupBuilder<E>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

origin

entityClass

handler

selectValidator

transformation

selectHandler

openMode

options

container

screenId

listComponent

field

isFieldCollectionValue

Constructor Detail

LookupBuilder

LookupBuilder

Method Detail

withOpenMode

withOptions

withSelectValidator

withSelectHandler

withField

withValuesField

withScreenClass

withScreenId

withListComponent

withContainer

withTransformation

getScreenId

getOpenMode

getOptions

getOrigin

getEntityClass

getSelectHandler

getSelectValidator

getField

getContainer

getListComponent

getTransformation

build

show

isFieldCollectionValue