Package io.jmix.tabbedmode.builder

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

java.lang.Object

io.jmix.tabbedmode.builder.AbstractViewBuilder<V,ReadViewBuilder<E,V>>

io.jmix.tabbedmode.builder.ReadViewBuilder<E,V>

Type Parameters:

E - shown entity type

V - a view type which is opened

Direct Known Subclasses:

ReadViewBuilderAdapter

public class ReadViewBuilder<E,V extends View<?>>
extends AbstractViewBuilder<V,ReadViewBuilder<E,V>>

Provides a fluent interface to configure and open a read view of an entity.

Field Summary

Fields

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

Fields inherited from class io.jmix.tabbedmode.builder.AbstractViewBuilder

afterCloseListener, buildHandler, builtView, openHandler, openMode, origin, readyListener, viewClass, viewConfigurer, viewId

Constructor Summary

Constructors

Constructor	Description
ReadViewBuilder(View<?> origin, Class<E> entityClass, Class<V> viewClass, Function<ReadViewBuilder<E,V>,V> buildHandler, Consumer<ViewOpeningContext> openHandler)
ReadViewBuilder(View<?> origin, Class<E> entityClass, String viewId, Function<ReadViewBuilder<E,V>,V> buildHandler, Consumer<ViewOpeningContext> openHandler)
ReadViewBuilder(View<?> origin, Class<E> entityClass, Function<ReadViewBuilder<E,V>,V> buildHandler, Consumer<ViewOpeningContext> openHandler)

Method Summary

Modifier and Type	Method	Description
Optional<E>	getEntity()
Class<E>	getEntityClass()
ReadViewBuilder<E,V>	readEntity(E entity)	Sets the entity instance to show and returns the builder for chaining.

Methods inherited from class io.jmix.tabbedmode.builder.AbstractViewBuilder

build, createViewOpeningContext, getAfterCloseListener, getOpenMode, getOrigin, getReadyListener, getViewClass, getViewConfigurer, getViewId, open, withAfterCloseListener, withOpenMode, withReadyListener, withViewConfigurer

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

ReadViewBuilder

public ReadViewBuilder(View<?> origin,
 Class<E> entityClass,
 Function<ReadViewBuilder<E,V>,V> buildHandler,
 Consumer<ViewOpeningContext> openHandler)

ReadViewBuilder

public ReadViewBuilder(View<?> origin,
 Class<E> entityClass,
 String viewId,
 Function<ReadViewBuilder<E,V>,V> buildHandler,
 Consumer<ViewOpeningContext> openHandler)

ReadViewBuilder

public ReadViewBuilder(View<?> origin,
 Class<E> entityClass,
 Class<V> viewClass,
 Function<ReadViewBuilder<E,V>,V> buildHandler,
 Consumer<ViewOpeningContext> openHandler)

Method Details

readEntity

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

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