Package io.jmix.flowui.view.builder

Class DetailWindowClassBuilder<E,V extends View<?> & DetailView<E>>

java.lang.Object

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

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

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

Type Parameters:

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

E - edited entity type

All Implemented Interfaces:

DialogWindowBuilder<V>, DialogWindowClassBuilder<V>

public class DetailWindowClassBuilder<E,V extends View<?> & DetailView<E>>
extends DetailWindowBuilder<E,V>
implements DialogWindowClassBuilder<V>

Provides a fluent interface to configure and open a details view with the specific class in a DialogWindow.

Field Summary

Fields

Modifier and Type	Field	Description
protected Class<V>	viewClass

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

addFirst, container, editedEntity, entityClass, field, initializer, listDataComponent, mode, newEntity, parentDataContext, transformation

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

afterCloseListener, afterOpenListener, handler, origin, viewConfigurer, viewId

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DetailWindowClassBuilder<E,V>	editEntity(E entity)	Sets DetailViewMode to EDIT and the builder for chaining.
Optional<Class<V>>	getViewClass()
DetailWindowClassBuilder<E,V>	newEntity()	Sets DetailViewMode to CREATE and the builder for chaining.
DetailWindowClassBuilder<E,V>	newEntity(E entity)	Sets DetailViewMode to CREATE and the builder for chaining.
DetailWindowClassBuilder<E,V>	withAddFirst(Boolean addFirst)	Defines whether a new item will be added to the beginning or to the end of collection.
DetailWindowClassBuilder<E,V>	withAfterCloseListener(Consumer<DialogWindow.AfterCloseEvent<V>> listener)	Adds DialogWindow.AfterCloseEvent listener to the dialog window.
DetailWindowClassBuilder<E,V>	withAfterOpenListener(Consumer<DialogWindow.AfterOpenEvent<V>> listener)	Adds DialogWindow.AfterOpenEvent listener to the dialog window.
DetailWindowClassBuilder<E,V>	withContainer(CollectionContainer<E> container)	Sets CollectionContainer to update after the detail view is saved.
DetailWindowClassBuilder<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.
DetailWindowClassBuilder<E,V>	withInitializer(Consumer<E> initializer)	Sets callback to initialize a new entity instance.
DetailWindowClassBuilder<E,V>	withListDataComponent(ListDataComponent<E> listDataComponent)	Sets list data component that is used to get the container if it is not set explicitly by DetailWindowBuilder.withContainer(CollectionContainer) method.
DetailWindowClassBuilder<E,V>	withParentDataContext(DataContext parentDataContext)	Sets parent DataContext for the detail view.
DetailWindowClassBuilder<E,V>	withTransformation(Function<E,E> transformation)	Sets code to transform the edited entity after detail view saved.
DetailWindowClassBuilder<E,V>	withViewConfigurer(Consumer<V> configurer)	Adds configurer to the dialog window.
DetailWindowClassBuilder<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.DetailWindowBuilder

getAddFirst, getContainer, getEditedEntity, getEntityClass, getField, getInitializer, getListDataComponent, getMode, getNewEntity, getParentDataContext, getTransformation, withViewClass

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

build, getAfterCloseListener, getAfterOpenListener, getOrigin, getViewConfigurer, getViewId, open

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.flowui.view.builder.DialogWindowBuilder

getAfterCloseListener, getAfterOpenListener, getOrigin, getViewConfigurer, getViewId

Field Details

viewClass

protected Class<V extends View<?> & DetailView<E>> viewClass

Constructor Details

DetailWindowClassBuilder

protected DetailWindowClassBuilder(DetailWindowBuilder<E,V> builder,
 Class<V> viewClass)

DetailWindowClassBuilder

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

Method Details

newEntity

public DetailWindowClassBuilder<E,V> newEntity()

Description copied from class: DetailWindowBuilder

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 DetailWindowBuilder.withInitializer(Consumer) method.

Overrides:

newEntity in class DetailWindowBuilder<E,V extends View<?> & DetailView<E>>

Returns:

this instance for chaining

newEntity

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

Description copied from class: DetailWindowBuilder

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 DetailWindowBuilder.withInitializer(Consumer) method.

Overrides:

newEntity in class DetailWindowBuilder<E,V extends View<?> & DetailView<E>>

Parameters:

entity - new entity instance to be passed to the detail view

Returns:

this instance for chaining

editEntity

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

Description copied from class: DetailWindowBuilder

Sets DetailViewMode to EDIT and the builder for chaining.

Overrides:

editEntity in class DetailWindowBuilder<E,V extends View<?> & DetailView<E>>

Parameters:

entity - entity instance to be passed to the detail view

Returns:

this instance for chaining

withViewId

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

Description copied from class: DetailWindowBuilder

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

Overrides:

withViewId in class DetailWindowBuilder<E,V extends View<?> & DetailView<E>>

Parameters:

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

Returns:

this instance for chaining

withInitializer

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

Description copied from class: DetailWindowBuilder

Sets callback to initialize a new entity instance.

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

Overrides:

withInitializer in class DetailWindowBuilder<E,V extends View<?> & DetailView<E>>

Parameters:

initializer - callback to initialize a new entity instance.

Returns:

this instance for chaining

withTransformation

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

Description copied from class: DetailWindowBuilder

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

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

Overrides:

withTransformation in class DetailWindowBuilder<E,V extends View<?> & DetailView<E>>

Parameters:

transformation - edited entity transformation object

Returns:

this instance for chaining

See Also:

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

withContainer

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

Description copied from class: DetailWindowBuilder

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.

Overrides:

withContainer in class DetailWindowBuilder<E,V extends View<?> & DetailView<E>>

Parameters:

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

Returns:

this instance for chaining

withParentDataContext

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

Description copied from class: DetailWindowBuilder

Sets parent DataContext for the detail view.

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

Overrides:

withParentDataContext in class DetailWindowBuilder<E,V extends View<?> & DetailView<E>>

Parameters:

parentDataContext - parent data context to set

Returns:

this instance for chaining

withListDataComponent

public DetailWindowClassBuilder<E,V> withListDataComponent(@Nullable
 ListDataComponent<E> listDataComponent)

Description copied from class: DetailWindowBuilder

Sets list data component that is used to get the container if it is not set explicitly by DetailWindowBuilder.withContainer(CollectionContainer) method.

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

Overrides:

withListDataComponent in class DetailWindowBuilder<E,V extends View<?> & DetailView<E>>

Parameters:

listDataComponent - the component to set

Returns:

this instance for chaining

withField

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

Description copied from class: DetailWindowBuilder

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

Overrides:

withField in class DetailWindowBuilder<E,V extends View<?> & DetailView<E>>

Parameters:

field - the field to set

Returns:

this instance for chaining

withAddFirst

public DetailWindowClassBuilder<E,V> withAddFirst(@Nullable
 Boolean addFirst)

Description copied from class: DetailWindowBuilder

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 DetailWindowBuilder<E,V extends View<?> & DetailView<E>>

Parameters:

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

Returns:

this instance for chaining

withAfterOpenListener

public DetailWindowClassBuilder<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 DetailWindowBuilder<E,V extends View<?> & DetailView<E>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withAfterCloseListener

public DetailWindowClassBuilder<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 DetailWindowBuilder<E,V extends View<?> & DetailView<E>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withViewConfigurer

public DetailWindowClassBuilder<E,V> withViewConfigurer(@Nullable
 Consumer<V> configurer)

Description copied from class: AbstractWindowBuilder

Adds configurer to the dialog window.

Overrides:

withViewConfigurer in class DetailWindowBuilder<E,V extends View<?> & DetailView<E>>

Parameters:

configurer - the configurer to add

Returns:

the instance for chaining

getViewClass

public Optional<Class<V>> getViewClass()

Specified by:

getViewClass in interface DialogWindowClassBuilder<E>

Returns:

opened view class