Package io.jmix.ui.component.impl

Class AbstractEntityAwareScreenFacet<E,S extends Screen>

java.lang.Object

io.jmix.ui.component.impl.AbstractFacet

io.jmix.ui.component.impl.AbstractScreenFacet<S>

io.jmix.ui.component.impl.AbstractEntityAwareScreenFacet<E,S>

All Implemented Interfaces:

EntityAwareScreenFacet<E>, Facet, ScreenFacet<S>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

EditorScreenFacetImpl, LookupScreenFacetImpl

public abstract class AbstractEntityAwareScreenFacet<E,S extends Screen>
extends AbstractScreenFacet<S>
implements EntityAwareScreenFacet<E>

Field Summary

Fields

Modifier and Type	Field	Description
protected CollectionContainer<E>	container
protected Class<E>	entityClass
protected EntityPicker<E>	entityPicker
protected ListComponent<E>	listComponent

Fields inherited from class io.jmix.ui.component.impl.AbstractScreenFacet

actionId, afterCloseListeners, afterShowListeners, applicationContext, buttonId, openMode, optionsProvider, properties, screen, screenClass, screenConfigurer, screenId

Fields inherited from class io.jmix.ui.component.impl.AbstractFacet

id, owner

Constructor Summary

Constructors

Constructor	Description
AbstractEntityAwareScreenFacet()

Method Summary

Modifier and Type	Method	Description
CollectionContainer<E>	getContainer()
Class<E>	getEntityClass()
EntityPicker<E>	getEntityPicker()
ListComponent<E>	getListComponent()
void	setContainer(CollectionContainer<E> container)	Sets CollectionContainer.
void	setEntityClass(Class<E> entityClass)	Sets entity class.
void	setEntityPicker(EntityPicker<E> entityPicker)	Sets the EntityPicker component.
void	setListComponent(ListComponent<E> listComponent)	Sets list component.

Methods inherited from class io.jmix.ui.component.impl.AbstractScreenFacet

addAfterCloseEventListener, addAfterShowEventListener, applyScreenConfigurer, getActionTarget, getButtonTarget, getOpenMode, getOptionsProvider, getProperties, getScreenClass, getScreenConfigurer, getScreenId, getScreenOptions, initScreenListeners, injectScreenProperties, internalRemoveAfterCloseEventListener, internalRemoveAfterShowEventListener, setActionTarget, setApplicationContext, setButtonTarget, setOpenMode, setOptionsProvider, setOwner, setProperties, setScreenClass, setScreenConfigurer, setScreenId, subscribe, subscribeOnAction, subscribeOnButton

Methods inherited from class io.jmix.ui.component.impl.AbstractFacet

getEventHub, getId, getOwner, hasSubscriptions, publish, setId, unsubscribe

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.ui.component.Facet

getId, getOwner, setId

Methods inherited from interface io.jmix.ui.component.ScreenFacet

create, show

Field Details

entityClass

protected Class<E> entityClass

entityPicker

protected EntityPicker<E> entityPicker

listComponent

protected ListComponent<E> listComponent

container

protected CollectionContainer<E> container

Constructor Details

AbstractEntityAwareScreenFacet

public AbstractEntityAwareScreenFacet()

Method Details

setEntityClass

public void setEntityClass(@Nullable
 Class<E> entityClass)

Description copied from interface: EntityAwareScreenFacet

Sets entity class.

Specified by:

setEntityClass in interface EntityAwareScreenFacet<E>

Parameters:

entityClass - entity class

getEntityClass

@Nullable
public Class<E> getEntityClass()

Specified by:

getEntityClass in interface EntityAwareScreenFacet<E>

Returns:

entity class

setListComponent

public void setListComponent(@Nullable
 ListComponent<E> listComponent)

Description copied from interface: EntityAwareScreenFacet

Sets list component.

The component is used to get the container if it is not set explicitly by EntityAwareScreenFacet.setContainer(CollectionContainer) method.

Usually, the list component is a Table or DataGrid displaying the list of entities.

Specified by:

setListComponent in interface EntityAwareScreenFacet<E>

getListComponent

@Nullable
public ListComponent<E> getListComponent()

Specified by:

getListComponent in interface EntityAwareScreenFacet<E>

Returns:

list component

setEntityPicker

public void setEntityPicker(@Nullable
 EntityPicker<E> entityPicker)

Description copied from interface: EntityAwareScreenFacet

Sets the EntityPicker component.

If the field is set, the framework sets the committed entity to the field after successful editor commit.

Specified by:

setEntityPicker in interface EntityAwareScreenFacet<E>

getEntityPicker

@Nullable
public EntityPicker<E> getEntityPicker()

Specified by:

getEntityPicker in interface EntityAwareScreenFacet<E>

Returns:

EntityPicker

setContainer

public void setContainer(@Nullable
 CollectionContainer<E> container)

Description copied from interface: EntityAwareScreenFacet

Sets CollectionContainer.

The container is updated after the screen is committed. If the container is Nested, the framework automatically initializes the reference to the parent entity and sets up data contexts for editing compositions.

Specified by:

setContainer in interface EntityAwareScreenFacet<E>

getContainer

@Nullable
public CollectionContainer<E> getContainer()

Specified by:

getContainer in interface EntityAwareScreenFacet<E>

Returns:

CollectionContainer