Package io.jmix.flowui.view.builder

Class AbstractWindowBuilder<V extends View<?>>

java.lang.Object

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

Type Parameters:

V - the type of the view associated with the dialog window

All Implemented Interfaces:

DialogWindowBuilder<V>

Direct Known Subclasses:

DetailWindowBuilder, LookupWindowBuilder, WindowBuilder

public class AbstractWindowBuilder<V extends View<?>>
extends Object
implements DialogWindowBuilder<V>

A generic abstract builder class for constructing dialog windows with specific configurations and listeners.

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<DialogWindow.AfterCloseEvent<V>>	afterCloseListener
protected Consumer<DialogWindow.AfterOpenEvent<V>>	afterOpenListener
protected com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent>	draggedListener
protected final Function<AbstractWindowBuilder<V>,DialogWindow<V>>	handler
protected final View<?>	origin
protected com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogResizeEvent>	resizeListener
protected Consumer<V>	viewConfigurer
protected String	viewId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWindowBuilder(View<?> origin, Function<? extends AbstractWindowBuilder<V>,DialogWindow<V>> handler)

Method Summary

Modifier and Type	Method	Description
DialogWindow<V>	build()	Builds the dialog window.
Optional<Consumer<DialogWindow.AfterCloseEvent<V>>>	getAfterCloseListener()
Optional<Consumer<DialogWindow.AfterOpenEvent<V>>>	getAfterOpenListener()
Optional<com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent>>	getDraggedListener()
View<?>	getOrigin()
Optional<com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogResizeEvent>>	getResizeListener()
Optional<Consumer<V>>	getViewConfigurer()
Optional<String>	getViewId()
DialogWindow<V>	open()	Opens built dialog window.
AbstractWindowBuilder<V>	withAfterCloseListener(Consumer<DialogWindow.AfterCloseEvent<V>> listener)	Adds DialogWindow.AfterCloseEvent listener to the dialog window.
AbstractWindowBuilder<V>	withAfterOpenListener(Consumer<DialogWindow.AfterOpenEvent<V>> listener)	Adds DialogWindow.AfterOpenEvent listener to the dialog window.
AbstractWindowBuilder<V>	withDraggedListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent> listener)	Adds Dialog.DialogDraggedEvent listener to the dialog window.
AbstractWindowBuilder<V>	withResizeListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogResizeEvent> listener)	Adds Dialog.DialogResizeEvent listener to the dialog window.
AbstractWindowBuilder<V>	withViewConfigurer(Consumer<V> configurer)	Adds configurer to the dialog window.

Methods inherited from class java.lang.Object

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

Field Details

origin

protected final View<?> origin

handler

protected final Function<AbstractWindowBuilder<V extends View<?>>,DialogWindow<V extends View<?>>> handler

viewId

protected String viewId

afterOpenListener

protected Consumer<DialogWindow.AfterOpenEvent<V extends View<?>>> afterOpenListener

afterCloseListener

protected Consumer<DialogWindow.AfterCloseEvent<V extends View<?>>> afterCloseListener

draggedListener

protected com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent> draggedListener

resizeListener

protected com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogResizeEvent> resizeListener

viewConfigurer

protected Consumer<V extends View<?>> viewConfigurer

Constructor Details

AbstractWindowBuilder

protected AbstractWindowBuilder(View<?> origin,
 Function<? extends AbstractWindowBuilder<V>,DialogWindow<V>> handler)

Method Details

withAfterOpenListener

public AbstractWindowBuilder<V> withAfterOpenListener(@Nullable
 Consumer<DialogWindow.AfterOpenEvent<V>> listener)

Adds DialogWindow.AfterOpenEvent listener to the dialog window.

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withAfterCloseListener

public AbstractWindowBuilder<V> withAfterCloseListener(@Nullable
 Consumer<DialogWindow.AfterCloseEvent<V>> listener)

Adds DialogWindow.AfterCloseEvent listener to the dialog window.

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withDraggedListener

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

Adds Dialog.DialogDraggedEvent listener to the dialog window.

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withResizeListener

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

Adds Dialog.DialogResizeEvent listener to the dialog window.

Parameters:

listener - the listener to add

Returns:

this instance for chaining

withViewConfigurer

public AbstractWindowBuilder<V> withViewConfigurer(@Nullable
 Consumer<V> configurer)

Adds configurer to the dialog window.

Parameters:

configurer - the configurer to add

Returns:

the instance for chaining

getOrigin

public View<?> getOrigin()

Specified by:

getOrigin in interface DialogWindowBuilder<V extends View<?>>

Returns:

invoking view

getViewId

public Optional<String> getViewId()

Specified by:

getViewId in interface DialogWindowBuilder<V extends View<?>>

Returns:

identifier of the opened view as specified in the ViewController annotation

getAfterOpenListener

public Optional<Consumer<DialogWindow.AfterOpenEvent<V>>> getAfterOpenListener()

Specified by:

getAfterOpenListener in interface DialogWindowBuilder<V extends View<?>>

Returns:

after open dialog listener

getAfterCloseListener

public Optional<Consumer<DialogWindow.AfterCloseEvent<V>>> getAfterCloseListener()

Specified by:

getAfterCloseListener in interface DialogWindowBuilder<V extends View<?>>

Returns:

after close dialog listener

getDraggedListener

public Optional<com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent>> getDraggedListener()

Specified by:

getDraggedListener in interface DialogWindowBuilder<V extends View<?>>

Returns:

dialog dragged listener

getResizeListener

public Optional<com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogResizeEvent>> getResizeListener()

Specified by:

getResizeListener in interface DialogWindowBuilder<V extends View<?>>

Returns:

dialog resize listener

getViewConfigurer

public Optional<Consumer<V>> getViewConfigurer()

Specified by:

getViewConfigurer in interface DialogWindowBuilder<V extends View<?>>

Returns:

dialog view configurer

build

public DialogWindow<V> build()

Builds the dialog window. Dialog window should be shown using DialogWindow.open().

Returns:

built dialog window

open

public DialogWindow<V> open()

Opens built dialog window.

Returns:

built dialog window