Package io.jmix.flowui.view.builder

Class DetailWindowBuilder<E,V extends View<?>>

java.lang.Object

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

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

Type Parameters:

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

All Implemented Interfaces:

DialogWindowBuilder<V>

Direct Known Subclasses:

DetailWindowClassBuilder

public class DetailWindowBuilder<E,V extends View<?>>
extends AbstractWindowBuilder<V>

Provides a fluent interface to configure and open a details view in a DialogWindow.

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	addFirst
protected CollectionContainer<E>	container
protected E	editedEntity
protected final Class<E>	entityClass
protected com.vaadin.flow.component.HasValue<?,E>	field
protected Consumer<E>	initializer
protected ListDataComponent<E>	listDataComponent
protected DetailViewMode	mode
protected E	newEntity
protected DataContext	parentDataContext
protected Function<E,E>	transformation

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

afterCloseListener, afterOpenListener, handler, origin, viewId

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DetailWindowBuilder<E,V>	editEntity(E entity)	Sets DetailViewMode to EDIT and the builder for chaining.
Boolean	getAddFirst()
Optional<CollectionContainer<E>>	getContainer()
Optional<E>	getEditedEntity()
Class<E>	getEntityClass()
Optional<com.vaadin.flow.component.HasValue<?,E>>	getField()
Optional<Consumer<E>>	getInitializer()
Optional<ListDataComponent<E>>	getListDataComponent()
DetailViewMode	getMode()
Optional<E>	getNewEntity()
Optional<DataContext>	getParentDataContext()
Optional<Function<E,E>>	getTransformation()
DetailWindowBuilder<E,V>	newEntity()	Sets DetailViewMode to CREATE and the builder for chaining.
DetailWindowBuilder<E,V>	newEntity(E entity)	Sets DetailViewMode to CREATE and the builder for chaining.
DetailWindowBuilder<E,V>	withAddFirst(Boolean addFirst)	Defines whether a new item will be added to the beginning or to the end of collection.
DetailWindowBuilder<E,V>	withAfterCloseListener(Consumer<DialogWindow.AfterCloseEvent<V>> listener)	Adds DialogWindow.AfterCloseEvent listener to the dialog window.
DetailWindowBuilder<E,V>	withAfterOpenListener(Consumer<DialogWindow.AfterOpenEvent<V>> listener)	Adds DialogWindow.AfterOpenEvent listener to the dialog window.
DetailWindowBuilder<E,V>	withContainer(CollectionContainer<E> container)	Sets CollectionContainer to update after the detail view is saved.
DetailWindowBuilder<E,V>	withField(com.vaadin.flow.component.HasValue<?,E> field)	Sets the field in which the framework sets the saved entity after successful detail view saving.
DetailWindowBuilder<E,V>	withInitializer(Consumer<E> initializer)	Sets callback to initialize a new entity instance.
DetailWindowBuilder<E,V>	withListDataComponent(ListDataComponent<E> listDataComponent)	Sets list data component that is used to get the container if it is not set explicitly by withContainer(CollectionContainer) method.
DetailWindowBuilder<E,V>	withParentDataContext(DataContext parentDataContext)	Sets parent DataContext for the detail view.
DetailWindowBuilder<E,V>	withTransformation(Function<E,E> transformation)	Sets code to transform the edited entity after detail view saved.
<T extends View<?> & DetailView<E>> DetailWindowClassBuilder<E,T>	withViewClass(Class<T> viewClass)	Sets opened view class.
DetailWindowBuilder<E,V>	withViewId(String viewId)	Sets identifier of the opened view as specified in the ViewController annotation.

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

build, getAfterCloseListener, getAfterOpenListener, getOrigin, getViewId, open

Methods inherited from class java.lang.Object

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

Field Details

entityClass

protected final Class<E> entityClass

newEntity

protected E newEntity

editedEntity

protected E editedEntity

initializer

protected Consumer<E> initializer

transformation

protected Function<E,E> transformation

container

protected CollectionContainer<E> container

parentDataContext

protected DataContext parentDataContext

listDataComponent

protected ListDataComponent<E> listDataComponent

field

protected com.vaadin.flow.component.HasValue<?,E> field

addFirst

protected Boolean addFirst

mode

protected DetailViewMode mode

Constructor Details

DetailWindowBuilder

protected DetailWindowBuilder(DetailWindowBuilder<E,V> builder)

DetailWindowBuilder

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

Method Details

newEntity

public DetailWindowBuilder<E,V> newEntity()

Sets DetailViewMode to CREATE and the builder for chaining.

A new entity instance will be created automatically. It can be initialized by code passed to the withInitializer(Consumer) method.

Returns:

this instance for chaining

newEntity

public DetailWindowBuilder<E,V> newEntity(E entity)

Sets DetailViewMode to CREATE and 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 detail view

Returns:

this instance for chaining

editEntity

public DetailWindowBuilder<E,V> editEntity(E entity)

Sets DetailViewMode to EDIT and the builder for chaining.

Parameters:

entity - entity instance to be passed to the detail view

Returns:

this instance for chaining

withViewClass

public <T extends View<?> & DetailView<E>>
DetailWindowClassBuilder<E,T> withViewClass(Class<T> viewClass)

Sets opened view class.

Type Parameters:

T - view type

Parameters:

viewClass - opened view class

Returns:

DetailWindowClassBuilder instance for chaining

withViewId

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

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

Parameters:

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

Returns:

this instance for chaining

withInitializer

public DetailWindowBuilder<E,V> withInitializer(@Nullable
 Consumer<E> initializer)

Sets callback to initialize a new entity instance.

The initializer is invoked only when DetailViewMode is CREATE, i.e. when newEntity() or newEntity(Object) methods are invoked on the builder.

Parameters:

initializer - callback to initialize a new entity instance.

Returns:

this instance for chaining

withTransformation

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

Sets code to transform the edited entity after detail view saved.

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

Parameters:

transformation - edited entity transformation object

Returns:

this instance for chaining

See Also:

• withContainer(CollectionContainer)
• withField(HasValue)
• withListDataComponent(ListDataComponent)

withContainer

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

Sets CollectionContainer to update after the detail view is saved.

If the container is Nested, the framework automatically initializes the reference to the parent entity and sets up data contexts for editing compositions.

Parameters:

container - the container to update after the detail view is saved.

Returns:

this instance for chaining

withParentDataContext

public DetailWindowBuilder<E,V> withParentDataContext(@Nullable
 DataContext parentDataContext)

Sets parent DataContext for the detail view.

The view will save data to the parent context instead of directly to DataManager.

Parameters:

parentDataContext - parent data context to set

Returns:

this instance for chaining

withListDataComponent

public DetailWindowBuilder<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 withContainer(CollectionContainer) method.

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

Parameters:

listDataComponent - the component to set

Returns:

this instance for chaining

withField

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

Sets the field in which the framework sets the saved entity after successful detail view saving.

Parameters:

field - the field to set

Returns:

this instance for chaining

withAddFirst

public DetailWindowBuilder<E,V> withAddFirst(@Nullable
 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.

Parameters:

addFirst - whether a new item will be added to the beginning of collection

Returns:

this instance for chaining

withAfterOpenListener

public DetailWindowBuilder<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 AbstractWindowBuilder<V extends View<?>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withAfterCloseListener

public DetailWindowBuilder<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 AbstractWindowBuilder<V extends View<?>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

getEntityClass

public Class<E> getEntityClass()

Returns:

entity class

getNewEntity

public Optional<E> getNewEntity()

Returns:

new entity set by newEntity(Object).

getEditedEntity

public Optional<E> getEditedEntity()

Returns:

entity set by editEntity(Object).

getInitializer

public Optional<Consumer<E>> getInitializer()

Returns:

initializer set by withInitializer(Consumer).

getTransformation

public Optional<Function<E,E>> getTransformation()

Returns:

transformation set by withTransformation(Function).

getContainer

public Optional<CollectionContainer<E>> getContainer()

Returns:

container set by withContainer(CollectionContainer).

getParentDataContext

public Optional<DataContext> getParentDataContext()

Returns:

parent data context set by withParentDataContext(DataContext).

getListDataComponent

public Optional<ListDataComponent<E>> getListDataComponent()

Returns:

list data component set by withListDataComponent(ListDataComponent).

getField

public Optional<com.vaadin.flow.component.HasValue<?,E>> getField()

Returns:

field set by withField(HasValue).

getAddFirst

@Nullable
public Boolean getAddFirst()

Returns:

whether a new item will be added to the beginning of collection

getMode

public DetailViewMode getMode()

Returns:

builder mode derived from previous calls to newEntity() or editEntity(Object)