Package io.jmix.flowui.view.builder

Class ReadWindowClassBuilder<E,V extends View<?> & ReadView<E>>

java.lang.Object

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

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

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

Type Parameters:

E - shown entity type

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

All Implemented Interfaces:

DialogWindowBuilder<V>, DialogWindowClassBuilder<V>

@NullMarked
public class ReadWindowClassBuilder<E,V extends View<?> & ReadView<E>>
extends ReadWindowBuilder<E,V>
implements DialogWindowClassBuilder<V>

Provides a fluent interface to configure and open a read 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.ReadWindowBuilder

entity, 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	ReadWindowClassBuilder(ReadWindowBuilder<E,V> builder, Class<V> viewClass)
	ReadWindowClassBuilder(View<?> origin, Class<E> entityClass, Class<V> viewClass, Function<? extends ReadWindowClassBuilder<E,V>,DialogWindow<V>> handler)

Method Summary

Modifier and Type	Method	Description
Optional<Class<V>>	getViewClass()
ReadWindowClassBuilder<E,V>	readEntity(E entity)	Sets the entity instance to show and returns the builder for chaining.
ReadWindowClassBuilder<E,V>	withAfterCloseListener(@Nullable Consumer<DialogWindow.AfterCloseEvent<V>> listener)	Adds DialogWindow.AfterCloseEvent listener to the dialog window.
ReadWindowClassBuilder<E,V>	withAfterOpenListener(@Nullable Consumer<DialogWindow.AfterOpenEvent<V>> listener)	Adds DialogWindow.AfterOpenEvent listener to the dialog window.
ReadWindowClassBuilder<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.
ReadWindowClassBuilder<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.
ReadWindowClassBuilder<E,V>	withViewConfigurer(@Nullable Consumer<V> configurer)	Adds configurer to the dialog window.
ReadWindowClassBuilder<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.ReadWindowBuilder

getEntity, getEntityClass, withViewClass

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

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

getAfterCloseListener, getAfterOpenListener, getDraggedListener, getOrigin, getResizeListener, getViewConfigurer, getViewId

Field Details

viewClass

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

Constructor Details

ReadWindowClassBuilder

protected ReadWindowClassBuilder(ReadWindowBuilder<E,V> builder,
 Class<V> viewClass)

ReadWindowClassBuilder

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

Method Details

readEntity

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

Description copied from class: ReadWindowBuilder

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

Overrides:

readEntity in class ReadWindowBuilder<E,V extends View<?> & ReadView<E>>

Parameters:

entity - entity instance to show

Returns:

this instance for chaining

withViewId

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

Description copied from class: ReadWindowBuilder

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

Overrides:

withViewId in class ReadWindowBuilder<E,V extends View<?> & ReadView<E>>

Parameters:

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

Returns:

this instance for chaining

withAfterOpenListener

public ReadWindowClassBuilder<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 ReadWindowBuilder<E,V extends View<?> & ReadView<E>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withAfterCloseListener

public ReadWindowClassBuilder<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 ReadWindowBuilder<E,V extends View<?> & ReadView<E>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withDraggedListener

public ReadWindowClassBuilder<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 ReadWindowBuilder<E,V extends View<?> & ReadView<E>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withResizeListener

public ReadWindowClassBuilder<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 ReadWindowBuilder<E,V extends View<?> & ReadView<E>>

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withViewConfigurer

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

Description copied from class: AbstractWindowBuilder

Adds configurer to the dialog window.

Overrides:

withViewConfigurer in class ReadWindowBuilder<E,V extends View<?> & ReadView<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