Package io.jmix.flowui.view.builder

Class WindowBuilder<V extends View<?>>

java.lang.Object

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

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

Type Parameters:

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

All Implemented Interfaces:

DialogWindowBuilder<V>, DialogWindowClassBuilder<V>

public class WindowBuilder<V extends View<?>>
extends AbstractWindowBuilder<V>
implements DialogWindowClassBuilder<V>

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Class<V>	viewClass

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

afterCloseListener, afterOpenListener, handler, origin, viewConfigurer, viewId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WindowBuilder(WindowBuilder<V> builder, Class<V> viewClass)
	WindowBuilder(View<?> origin, Class<V> viewClass, Function<? extends WindowBuilder<V>,DialogWindow<V>> handler)
	WindowBuilder(View<?> origin, String viewId, Function<? extends WindowBuilder<V>,DialogWindow<V>> handler)

Method Summary

Modifier and Type	Method	Description
Optional<Class<V>>	getViewClass()
WindowBuilder<V>	withAfterCloseListener(Consumer<DialogWindow.AfterCloseEvent<V>> listener)	Adds DialogWindow.AfterCloseEvent listener to the dialog window.
WindowBuilder<V>	withAfterOpenListener(Consumer<DialogWindow.AfterOpenEvent<V>> listener)	Adds DialogWindow.AfterOpenEvent listener to the dialog window.
<T extends View<?>> WindowBuilder<T>	withViewClass(Class<T> viewClass)
WindowBuilder<V>	withViewConfigurer(Consumer<V> configurer)	Adds configurer to the dialog window.
WindowBuilder<V>	withViewId(String viewId)

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<?>> viewClass

Constructor Details

WindowBuilder

protected WindowBuilder(WindowBuilder<V> builder,
 Class<V> viewClass)

WindowBuilder

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

WindowBuilder

public WindowBuilder(View<?> origin,
 String viewId,
 Function<? extends WindowBuilder<V>,DialogWindow<V>> handler)

Method Details

withAfterOpenListener

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

withViewConfigurer

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

withViewId

public WindowBuilder<V> withViewId(@Nullable
 String viewId)

withViewClass

public <T extends View<?>> WindowBuilder<T> withViewClass(Class<T> viewClass)

getViewClass

public Optional<Class<V>> getViewClass()

Specified by:

getViewClass in interface DialogWindowClassBuilder<V extends View<?>>

Returns:

opened view class