Package io.jmix.flowui.view.builder

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

java.lang.Object

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

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

Type Parameters:

E - shown entity type

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

All Implemented Interfaces:

DialogWindowBuilder<V>

Direct Known Subclasses:

ReadWindowClassBuilder

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable E	entity
protected final Class<E>	entityClass

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

afterCloseListener, afterOpenListener, draggedListener, handler, origin, resizeListener, viewConfigurer, viewId

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Optional<E>	getEntity()
Class<E>	getEntityClass()
ReadWindowBuilder<E,V>	readEntity(E entity)	Sets the entity instance to show and returns the builder for chaining.
ReadWindowBuilder<E,V>	withAfterCloseListener(@Nullable Consumer<DialogWindow.AfterCloseEvent<V>> listener)	Adds DialogWindow.AfterCloseEvent listener to the dialog window.
ReadWindowBuilder<E,V>	withAfterOpenListener(@Nullable Consumer<DialogWindow.AfterOpenEvent<V>> listener)	Adds DialogWindow.AfterOpenEvent listener to the dialog window.
ReadWindowBuilder<E,V>	withDraggedListener(@Nullable com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent> listener)	Adds Dialog.DialogDraggedEvent listener to the dialog window.
ReadWindowBuilder<E,V>	withResizeListener(@Nullable com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogResizeEvent> listener)	Adds Dialog.DialogResizeEvent listener to the dialog window.
<T extends View<?> & ReadView<E>> ReadWindowClassBuilder<E,T>	withViewClass(Class<T> viewClass)	Sets the opened view class.
ReadWindowBuilder<E,V>	withViewConfigurer(@Nullable Consumer<V> configurer)	Adds configurer to the dialog window.
ReadWindowBuilder<E,V>	withViewId(@Nullable 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, getDraggedListener, getOrigin, getResizeListener, getViewConfigurer, 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

entity

protected @Nullable E entity

Constructor Details

ReadWindowBuilder

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

ReadWindowBuilder

protected ReadWindowBuilder(ReadWindowBuilder<E,V> builder)

Method Details

readEntity

public ReadWindowBuilder<E,V> readEntity(E entity)

Sets the entity instance to show and returns the builder for chaining.

Parameters:

entity - entity instance to show

Returns:

this instance for chaining

withViewClass

public <T extends View<?> & ReadView<E>>
ReadWindowClassBuilder<E,T> withViewClass(Class<T> viewClass)

Sets the opened view class.

Type Parameters:

T - view type

Parameters:

viewClass - opened view class

Returns:

ReadWindowClassBuilder instance for chaining

withViewId

public ReadWindowBuilder<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

withAfterOpenListener

public ReadWindowBuilder<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 ReadWindowBuilder<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

withDraggedListener

public ReadWindowBuilder<E,V> withDraggedListener(@Nullable com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent> listener)

Description copied from class: AbstractWindowBuilder

Adds Dialog.DialogDraggedEvent listener to the dialog window.

Overrides:

withDraggedListener in class AbstractWindowBuilder<V extends View<?>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withResizeListener

public ReadWindowBuilder<E,V> withResizeListener(@Nullable com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogResizeEvent> listener)

Description copied from class: AbstractWindowBuilder

Adds Dialog.DialogResizeEvent listener to the dialog window.

Overrides:

withResizeListener in class AbstractWindowBuilder<V extends View<?>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withViewConfigurer

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

Description copied from class: AbstractWindowBuilder

Adds configurer to the dialog window.

Overrides:

withViewConfigurer in class AbstractWindowBuilder<V extends View<?>>

Parameters:

configurer - the configurer to add

Returns:

the instance for chaining

getEntityClass

public Class<E> getEntityClass()

Returns:

the class of the shown entity

getEntity

public Optional<E> getEntity()

Returns:

the entity instance to show, or an empty Optional if it is not set