EditorBuilder (Jmix-ui 1.0 API)

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

Direct Known Subclasses:

EditorClassBuilder
```
public class EditorBuilder<E>
extends java.lang.Object
```
Editor 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 java.lang.Boolean`	`addFirst`
`protected CollectionContainer<E>`	`container`
`protected E`	`editedEntity`
`protected java.lang.Class<E>`	`entityClass`
`protected HasValue<E>`	`field`
`protected java.util.function.Function<EditorBuilder<E>,Screen>`	`handler`
`protected java.util.function.Consumer<E>`	`initializer`
`protected ListComponent<E>`	`listComponent`
`protected EditMode`	`mode`
`protected E`	`newEntity`
`protected OpenMode`	`openMode`
`protected ScreenOptions`	`options`
`protected FrameOwner`	`origin`
`protected DataContext`	`parentDataContext`
`protected java.lang.String`	`screenId`
`protected java.util.function.Function<E,E>`	`transformation`

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Screen`	`build()` Builds the editor screen.
`EditorBuilder<E>`	`editEntity(E entity)` Sets `EditMode` to `EDIT` and returns the builder for chaining.
`java.lang.Boolean`	`getAddFirst()` Returns if a new item will be added to the beginning or to the end of collection.
`CollectionContainer<E>`	`getContainer()` Returns container set by `withContainer(CollectionContainer)`.
`E`	`getEditedEntity()` Returns entity set by `editEntity(Object)`.
`java.lang.Class<E>`	`getEntityClass()` Returns edited entity class.
`HasValue<E>`	`getField()` Returns the field component set by `withField(HasValue)`.
`java.util.function.Consumer<E>`	`getInitializer()` Returns initializer set by `withInitializer(Consumer)`.
`ListComponent<E>`	`getListComponent()` Returns list component set by `withListComponent(ListComponent)`.
`EditMode`	`getMode()` Returns builder mode derived from previous calls to `newEntity()` or `editEntity(Object)`.
`E`	`getNewEntity()` Returns new entity set by `newEntity(Object)`.
`OpenMode`	`getOpenMode()` Returns launch mode set by `withOpenMode(OpenMode)`.
`ScreenOptions`	`getOptions()` Returns screen options set by `withOptions(ScreenOptions)`.
`FrameOwner`	`getOrigin()` Returns invoking screen.
`DataContext`	`getParentDataContext()` Returns parent data context set by `withParentDataContext(DataContext)`.
`java.lang.String`	`getScreenId()` Returns screen id set by `withScreenId(String)`.
`java.util.function.Function<E,E>`	`getTransformation()` Returns edited entity transformation.
`EditorBuilder<E>`	`newEntity()` Sets `EditMode` to `CREATE` and returns the builder for chaining.
`EditorBuilder<E>`	`newEntity(E entity)` Sets `EditMode` to `CREATE` and returns the builder for chaining.
`Screen`	`show()` Builds and shows the editor screen.
`EditorBuilder<E>`	`withAddFirst(boolean addFirst)` Defines whether a new item will be added to the beginning or to the end of collection.
`EditorBuilder<E>`	`withContainer(CollectionContainer<E> container)` Sets `CollectionContainer` and returns the builder for chaining.
`<T extends HasValue<E>> EditorBuilder<E>`	`withField(T field)` Sets the field component and returns the builder for chaining.
`EditorBuilder<E>`	`withInitializer(java.util.function.Consumer<E> initializer)` Sets code to initialize a new entity instance and returns the builder for chaining.
`EditorBuilder<E>`	`withListComponent(ListComponent<E> listComponent)` Sets list component and returns the builder for chaining.
`EditorBuilder<E>`	`withOpenMode(OpenMode openMode)` Sets `OpenMode` for the editor screen and returns the builder for chaining.
`EditorBuilder<E>`	`withOptions(ScreenOptions options)` Sets `ScreenOptions` for the editor screen and returns the builder for chaining.
`EditorBuilder<E>`	`withParentDataContext(DataContext parentDataContext)` Sets parent `DataContext` for the editor screen and returns the builder for chaining.
`<S extends Screen & EditorScreen<E>> EditorClassBuilder<E,S>`	`withScreenClass(java.lang.Class<S> screenClass)` Sets screen class and returns the `EditorClassBuilder` for chaining.
`EditorBuilder<E>`	`withScreenId(java.lang.String screenId)` Sets screen id and returns the builder for chaining.
`EditorBuilder<E>`	`withTransformation(java.util.function.Function<E,E> transformation)` Sets code to transform the edited entity after editor commit and returns the builder for chaining.

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<EditorBuilder<E>,Screen> handler
```
  - newEntity
```
protected E newEntity
```
  - editedEntity
```
protected E editedEntity
```
  - container
```
protected CollectionContainer<E> container
```
  - initializer
```
protected java.util.function.Consumer<E> initializer
```
  - transformation
```
protected java.util.function.Function<E,E> transformation
```
  - openMode
```
protected OpenMode openMode
```
  - options
```
protected ScreenOptions options
```
  - listComponent
```
protected ListComponent<E> listComponent
```
  - field
```
protected HasValue<E> field
```
  - screenId
```
protected java.lang.String screenId
```
  - parentDataContext
```
protected DataContext parentDataContext
```
  - mode
```
protected EditMode mode
```
  - addFirst
```
protected java.lang.Boolean addFirst
```
- Constructor Detail
  - EditorBuilder
```
public EditorBuilder(EditorBuilder<E> builder)
```
  - EditorBuilder
```
public EditorBuilder(FrameOwner origin,
                     java.lang.Class<E> entityClass,
                     java.util.function.Function<EditorBuilder<E>,Screen> handler)
```
- Method Detail
  - newEntity
```
public EditorBuilder<E> newEntity()
```
    Sets EditMode to CREATE and returns the builder for chaining.
    A new entity instance will be created automatically. It can be initialized by code passed to the withInitializer(Consumer) method.
    
    See Also:
    
    newEntity(Object)
  - newEntity
```
public EditorBuilder<E> newEntity(@Nullable
                                  E entity)
```
    Sets EditMode to CREATE and returns the builder for chaining.
    The new entity instance is accepted as the parameter. It can be initialized by code passed to the withInitializer(Consumer) method.
    
    Parameters:
    
    entity - new entity instance to be passed to the editor screen
    
    See Also:
    
    newEntity()
  - editEntity
```
public EditorBuilder<E> editEntity(@Nullable
                                   E entity)
```
    Sets EditMode to EDIT and returns the builder for chaining.
    
    Parameters:
    
    entity - entity instance to be passed to the editor screen
    
    See Also:
    
    newEntity()
  - withContainer
```
public EditorBuilder<E> withContainer(CollectionContainer<E> container)
```
    Sets CollectionContainer and returns the builder for chaining.
    The container is updated after the editor screen is committed. If the container is Nested, the framework automatically initializes the reference to the parent entity and sets up data contexts for editing compositions.
  - withInitializer
```
public EditorBuilder<E> withInitializer(java.util.function.Consumer<E> initializer)
```
    Sets code to initialize a new entity instance and returns the builder for chaining.
    The initializer is invoked only when EditMode is CREATE, i.e. when newEntity() or newEntity(Object) methods are invoked on the builder.
  - withTransformation
```
public EditorBuilder<E> withTransformation(@Nullable
                                           java.util.function.Function<E,E> transformation)
```
    Sets code to transform the edited entity after editor commit 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)
  - withOpenMode
```
public EditorBuilder<E> withOpenMode(OpenMode openMode)
```
    Sets OpenMode for the editor screen and returns the builder for chaining.
    For example: builder.withOpenMode(OpenMode.DIALOG).build();
  - withAddFirst
```
public EditorBuilder<E> withAddFirst(boolean addFirst)
```
    Defines whether a new item will be added to the beginning or to the end of collection. Affects only standalone containers, for nested containers new items are always added to the end.
  - withParentDataContext
```
public EditorBuilder<E> withParentDataContext(@Nullable
                                              DataContext parentDataContext)
```
    Sets parent DataContext for the editor screen and returns the builder for chaining.
    The screen will commit data to the parent context instead of directly to DataManager.
  - withOptions
```
public EditorBuilder<E> withOptions(ScreenOptions options)
```
    Sets ScreenOptions for the editor screen and returns the builder for chaining.
  - withListComponent
```
public EditorBuilder<E> withListComponent(ListComponent<E> listComponent)
```
    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.
  - withScreenId
```
public EditorBuilder<E> withScreenId(java.lang.String screenId)
```
    Sets screen id and returns the builder for chaining.
    
    Parameters:
    
    screenId - identifier of the editor screen as specified in the UiController annotation or screens.xml.
  - withScreenClass
```
public <S extends Screen & EditorScreen<E>> EditorClassBuilder<E,S> withScreenClass(java.lang.Class<S> screenClass)
```
    Sets screen class and returns the EditorClassBuilder for chaining.
    
    Parameters:
    
    screenClass - class of the screen controller
  - withField
```
public <T extends HasValue<E>> EditorBuilder<E> withField(T field)
```
    Sets the field component and returns the builder for chaining.
    If the field is set, the framework sets the committed entity to the field after successful editor commit.
  - getField
```
@Nullable
public HasValue<E> getField()
```
    Returns the field component set by withField(HasValue).
  - getScreenId
```
@Nullable
public java.lang.String getScreenId()
```
    Returns screen id set by withScreenId(String).
  - getParentDataContext
```
@Nullable
public DataContext getParentDataContext()
```
    Returns parent data context set by withParentDataContext(DataContext).
  - getEntityClass
```
public java.lang.Class<E> getEntityClass()
```
    Returns edited entity class.
  - getNewEntity
```
@Nullable
public E getNewEntity()
```
    Returns new entity set by newEntity(Object).
  - getEditedEntity
```
public E getEditedEntity()
```
    Returns entity set by editEntity(Object).
  - getContainer
```
@Nullable
public CollectionContainer<E> getContainer()
```
    Returns container set by withContainer(CollectionContainer).
  - getInitializer
```
@Nullable
public java.util.function.Consumer<E> getInitializer()
```
    Returns initializer set by withInitializer(Consumer).
  - getOpenMode
```
public OpenMode getOpenMode()
```
    Returns launch mode set by withOpenMode(OpenMode).
  - getOrigin
```
public FrameOwner getOrigin()
```
    Returns invoking screen.
  - getOptions
```
public ScreenOptions getOptions()
```
    Returns screen options set by withOptions(ScreenOptions).
  - getAddFirst
```
@Nullable
public java.lang.Boolean getAddFirst()
```
    Returns if a new item will be added to the beginning or to the end of collection. Affects only standalone containers, for nested containers new items are always added to the end.
  - getListComponent
```
@Nullable
public ListComponent<E> getListComponent()
```
    Returns list component set by withListComponent(ListComponent).
  - getMode
```
public EditMode getMode()
```
    Returns builder mode derived from previous calls to newEntity() or editEntity(Object).
  - getTransformation
```
@Nullable
public java.util.function.Function<E,E> getTransformation()
```
    Returns edited entity transformation.
  - build
```
public Screen build()
```
    Builds the editor screen. Screen should be shown using Screen.show().
  - show
```
public Screen show()
```
    Builds and shows the editor screen.

Class EditorBuilder<E>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

origin

entityClass

handler

newEntity

editedEntity

container

initializer

transformation

openMode

options

listComponent

field

screenId

parentDataContext

mode

addFirst

Constructor Detail

EditorBuilder

EditorBuilder

Method Detail

newEntity

newEntity

editEntity

withContainer

withInitializer

withTransformation

withOpenMode

withAddFirst

withParentDataContext

withOptions

withListComponent

withScreenId

withScreenClass

withField

getField

getScreenId

getParentDataContext

getEntityClass

getNewEntity

getEditedEntity

getContainer

getInitializer

getOpenMode

getOrigin

getOptions

getAddFirst

getListComponent

getMode

getTransformation

build

show