Package io.jmix.ui.component

Interface EntityAwareScreenFacet<E>

Type Parameters:

E - entity type

All Known Subinterfaces:

EditorScreenFacet<E,S>, LookupScreenFacet<E,S>

All Known Implementing Classes:

AbstractEntityAwareScreenFacet, EditorScreenFacetImpl, LookupScreenFacetImpl

public interface EntityAwareScreenFacet<E>

Interface for entity aware screen facets.

See Also:

• EditorScreenFacet
• LookupScreenFacet

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.

Method Details

setEntityClass

@StudioProperty(type=ENTITY_CLASS,
                typeParameter="E")
void setEntityClass(@Nullable
 Class<E> entityClass)

Sets entity class.

Parameters:

entityClass - entity class

getEntityClass

@Nullable
Class<E> getEntityClass()

Returns:

entity class

setListComponent

@StudioProperty(type=COMPONENT_REF,
                typeParameter="E",
                options="io.jmix.ui.component.ListComponent")
void setListComponent(@Nullable
 ListComponent<E> listComponent)

Sets list component.

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

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

getListComponent

@Nullable
ListComponent<E> getListComponent()

Returns:

list component

setEntityPicker

@StudioProperty(name="field",
                type=COMPONENT_REF,
                typeParameter="E",
                options="io.jmix.ui.component.EntityPicker")
void setEntityPicker(@Nullable
 EntityPicker<E> entityPicker)

Sets the EntityPicker component.

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

getEntityPicker

@Nullable
EntityPicker<E> getEntityPicker()

Returns:

EntityPicker

setContainer

@StudioProperty(type=COLLECTION_DATACONTAINER_REF,
                typeParameter="E")
void setContainer(@Nullable
 CollectionContainer<E> container)

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.

getContainer

@Nullable
CollectionContainer<E> getContainer()

Returns:

CollectionContainer