EditorClassBuilder (Jmix-ui 1.0 API)

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

public class EditorClassBuilder<E,S extends Screen & EditorScreen<E>>
extends EditorBuilder<E>

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.function.Consumer<AfterScreenCloseEvent<S>>`	`afterCloseListener`
`protected java.util.function.Consumer<AfterScreenShowEvent<S>>`	`afterShowListener`
`protected java.lang.Class<S>`	`screenClass`

Fields inherited from class io.jmix.ui.builder.EditorBuilder
addFirst, container, editedEntity, entityClass, field, handler, initializer, listComponent, mode, newEntity, openMode, options, origin, parentDataContext, screenId, transformation

Constructor Summary

Constructors
Constructor and Description

EditorClassBuilder(EditorBuilder<E> builder, java.lang.Class<S> screenClass)

Constructors
Constructor and Description
`EditorClassBuilder(EditorBuilder<E> builder, java.lang.Class<S> screenClass)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`S`	`build()` Builds the editor screen.
`EditorClassBuilder<E,S>`	`editEntity(E entity)` Sets `EditMode` to `EDIT` and returns the builder for chaining.
`java.util.function.Consumer<AfterScreenCloseEvent<S>>`	`getAfterCloseListener()`
`java.util.function.Consumer<AfterScreenShowEvent<S>>`	`getAfterShowListener()`
`java.lang.Class<S>`	`getScreenClass()` Returns editor screen class.
`EditorClassBuilder<E,S>`	`newEntity()` Sets `EditMode` to `CREATE` and returns the builder for chaining.
`EditorClassBuilder<E,S>`	`newEntity(E entity)` Sets `EditMode` to `CREATE` and returns the builder for chaining.
`S`	`show()` Builds and shows the editor screen.
`EditorClassBuilder<E,S>`	`withAddFirst(boolean addFirst)` Defines whether a new item will be added to the beginning or to the end of collection.
`EditorClassBuilder<E,S>`	`withAfterCloseListener(java.util.function.Consumer<AfterScreenCloseEvent<S>> listener)` Adds `Screen.AfterCloseEvent` listener to the screen.
`EditorClassBuilder<E,S>`	`withAfterShowListener(java.util.function.Consumer<AfterScreenShowEvent<S>> listener)` Adds `Screen.AfterShowEvent` listener to the screen.
`EditorClassBuilder<E,S>`	`withContainer(CollectionContainer<E> container)` Sets `CollectionContainer` and returns the builder for chaining.
`<T extends HasValue<E>> EditorClassBuilder<E,S>`	`withField(T field)` Sets the field component and returns the builder for chaining.
`EditorClassBuilder<E,S>`	`withInitializer(java.util.function.Consumer<E> initializer)` Sets code to initialize a new entity instance and returns the builder for chaining.
`EditorClassBuilder<E,S>`	`withListComponent(ListComponent<E> listComponent)` Sets list component and returns the builder for chaining.
`EditorClassBuilder<E,S>`	`withOpenMode(OpenMode openMode)` Sets `OpenMode` for the editor screen and returns the builder for chaining.
`EditorClassBuilder<E,S>`	`withOptions(ScreenOptions options)` Sets `ScreenOptions` for the editor screen and returns the builder for chaining.
`EditorClassBuilder<E,S>`	`withParentDataContext(DataContext parentDataContext)` Sets parent `DataContext` for the editor screen and returns the builder for chaining.
`EditorBuilder<E>`	`withScreenId(java.lang.String screenId)` Sets screen id and returns the builder for chaining.
`EditorClassBuilder<E,S>`	`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 io.jmix.ui.builder.EditorBuilder
getAddFirst, getContainer, getEditedEntity, getEntityClass, getField, getInitializer, getListComponent, getMode, getNewEntity, getOpenMode, getOptions, getOrigin, getParentDataContext, getScreenId, getTransformation, withScreenClass

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

- Field Detail
  - screenClass
```
protected java.lang.Class<S extends Screen & EditorScreen<E>> screenClass
```
  - afterCloseListener
```
protected java.util.function.Consumer<AfterScreenCloseEvent<S extends Screen & EditorScreen<E>>> afterCloseListener
```
  - afterShowListener
```
protected java.util.function.Consumer<AfterScreenShowEvent<S extends Screen & EditorScreen<E>>> afterShowListener
```
- Constructor Detail
  - EditorClassBuilder
```
public EditorClassBuilder(EditorBuilder<E> builder,
                          java.lang.Class<S> screenClass)
```
- Method Detail
  - newEntity
```
public EditorClassBuilder<E,S> newEntity()
```
    Description copied from class: EditorBuilder
    
    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 EditorBuilder.withInitializer(Consumer) method.
    
    Overrides:
    
    newEntity in class EditorBuilder<E>
    
    See Also:
    
    EditorBuilder.newEntity(Object)
  - editEntity
```
public EditorClassBuilder<E,S> editEntity(E entity)
```
    Description copied from class: EditorBuilder
    
    Sets EditMode to EDIT and returns the builder for chaining.
    
    Overrides:
    
    editEntity in class EditorBuilder<E>
    
    Parameters:
    
    entity - entity instance to be passed to the editor screen
    
    See Also:
    
    EditorBuilder.newEntity()
  - newEntity
```
public EditorClassBuilder<E,S> newEntity(E entity)
```
    Description copied from class: EditorBuilder
    
    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 EditorBuilder.withInitializer(Consumer) method.
    
    Overrides:
    
    newEntity in class EditorBuilder<E>
    
    Parameters:
    
    entity - new entity instance to be passed to the editor screen
    
    See Also:
    
    EditorBuilder.newEntity()
  - withContainer
```
public EditorClassBuilder<E,S> withContainer(CollectionContainer<E> container)
```
    Description copied from class: EditorBuilder
    
    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.
    
    Overrides:
    
    withContainer in class EditorBuilder<E>
  - withInitializer
```
public EditorClassBuilder<E,S> withInitializer(java.util.function.Consumer<E> initializer)
```
    Description copied from class: EditorBuilder
    
    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 EditorBuilder.newEntity() or EditorBuilder.newEntity(Object) methods are invoked on the builder.
    
    Overrides:
    
    withInitializer in class EditorBuilder<E>
  - withAddFirst
```
public EditorClassBuilder<E,S> withAddFirst(boolean addFirst)
```
    Description copied from class: EditorBuilder
    
    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.
    
    Overrides:
    
    withAddFirst in class EditorBuilder<E>
  - withOpenMode
```
public EditorClassBuilder<E,S> withOpenMode(OpenMode openMode)
```
    Description copied from class: EditorBuilder
    
    Sets OpenMode for the editor screen and returns the builder for chaining.
    For example: builder.withOpenMode(OpenMode.DIALOG).build();
    
    Overrides:
    
    withOpenMode in class EditorBuilder<E>
  - withParentDataContext
```
public EditorClassBuilder<E,S> withParentDataContext(DataContext parentDataContext)
```
    Description copied from class: EditorBuilder
    
    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.
    
    Overrides:
    
    withParentDataContext in class EditorBuilder<E>
  - withOptions
```
public EditorClassBuilder<E,S> withOptions(ScreenOptions options)
```
    Description copied from class: EditorBuilder
    
    Sets ScreenOptions for the editor screen and returns the builder for chaining.
    
    Overrides:
    
    withOptions in class EditorBuilder<E>
  - withListComponent
```
public EditorClassBuilder<E,S> withListComponent(ListComponent<E> listComponent)
```
    Description copied from class: EditorBuilder
    
    Sets list component and returns the builder for chaining.
    The component is used to get the container if it is not set explicitly by EditorBuilder.withContainer(CollectionContainer) method. Usually, the list component is a Table or DataGrid displaying the list of entities.
    
    Overrides:
    
    withListComponent in class EditorBuilder<E>
  - withScreenId
```
public EditorBuilder<E> withScreenId(java.lang.String screenId)
```
    Description copied from class: EditorBuilder
    
    Sets screen id and returns the builder for chaining.
    
    Overrides:
    
    withScreenId in class EditorBuilder<E>
    
    Parameters:
    
    screenId - identifier of the editor screen as specified in the UiController annotation or screens.xml.
  - withAfterShowListener
```
public EditorClassBuilder<E,S> withAfterShowListener(java.util.function.Consumer<AfterScreenShowEvent<S>> listener)
```
    Adds Screen.AfterShowEvent listener to the screen.
    
    Parameters:
    
    listener - listener
  - withAfterCloseListener
```
public EditorClassBuilder<E,S> withAfterCloseListener(java.util.function.Consumer<AfterScreenCloseEvent<S>> listener)
```
    Adds Screen.AfterCloseEvent listener to the screen.
    
    Parameters:
    
    listener - listener
  - withTransformation
```
public EditorClassBuilder<E,S> withTransformation(@Nullable
                                                  java.util.function.Function<E,E> transformation)
```
    Description copied from class: EditorBuilder
    
    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.
    
    Overrides:
    
    withTransformation in class EditorBuilder<E>
    
    Parameters:
    
    transformation - edited entity transformation
    
    See Also:
    
    EditorBuilder.withContainer(CollectionContainer), EditorBuilder.withField(HasValue), EditorBuilder.withListComponent(ListComponent)
  - withField
```
public <T extends HasValue<E>> EditorClassBuilder<E,S> withField(T field)
```
    Description copied from class: EditorBuilder
    
    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.
    
    Overrides:
    
    withField in class EditorBuilder<E>
  - getScreenClass
```
@Nullable
public java.lang.Class<S> getScreenClass()
```
    Returns editor screen class.
  - getAfterShowListener
```
public java.util.function.Consumer<AfterScreenShowEvent<S>> getAfterShowListener()
```
    Returns:
    
    after show screen listener
  - getAfterCloseListener
```
public java.util.function.Consumer<AfterScreenCloseEvent<S>> getAfterCloseListener()
```
    Returns:
    
    after close screen listener
  - build
```
public S build()
```
    Description copied from class: EditorBuilder
    
    Builds the editor screen. Screen should be shown using Screen.show().
    
    Overrides:
    
    build in class EditorBuilder<E>
  - show
```
public S show()
```
    Description copied from class: EditorBuilder
    
    Builds and shows the editor screen.
    
    Overrides:
    
    show in class EditorBuilder<E>

Class EditorClassBuilder<E,S extends Screen & EditorScreen<E>>

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

screenClass

afterCloseListener

afterShowListener

Constructor Detail

EditorClassBuilder

Method Detail

newEntity

editEntity

newEntity

withContainer

withInitializer

withAddFirst

withOpenMode

withParentDataContext

withOptions

withListComponent

withScreenId

withAfterShowListener

withAfterCloseListener

withTransformation

withField

getScreenClass

getAfterShowListener

getAfterCloseListener

build

show