com.haulmont.cuba.gui.components

Interface EntityAwareScreenFacet<E extends Entity>

Type Parameters:

E - entity type

All Known Subinterfaces:

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

public interface EntityAwareScreenFacet<E extends Entity>

Interface for entity aware screen facets.

See Also:

EditorScreenFacet, LookupScreenFacet

Method Summary

Modifier and Type	Method and Description
CollectionContainer<E>	getContainer()
java.lang.Class<E>	getEntityClass()
ListComponent<E>	getListComponent()
PickerField<E>	getPickerField()
void	setContainer(CollectionContainer<E> container) Sets CollectionContainer.
void	setEntityClass(java.lang.Class<E> entityClass) Sets entity class.
void	setListComponent(ListComponent<E> listComponent) Sets list component.
void	setPickerField(PickerField<E> pickerField) Sets the PickerField component.

Method Detail

setEntityClass

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

Sets entity class.

Parameters:

entityClass - entity class

getEntityClass

java.lang.Class<E> getEntityClass()

Returns:

entity class

setListComponent

@StudioProperty(type=COMPONENT_REF,
                typeParameter="E",
                options="com.haulmont.cuba.gui.components.ListComponent")
void setListComponent(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

ListComponent<E> getListComponent()

Returns:

list component

setPickerField

@StudioProperty(name="field",
                type=COMPONENT_REF,
                typeParameter="E",
                options="com.haulmont.cuba.gui.components.PickerField")
void setPickerField(PickerField<E> pickerField)

Sets the PickerField component.

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

getPickerField

PickerField<E> getPickerField()

Returns:

PickerField

setContainer

@StudioProperty(type=COLLECTION_DATACONTAINER_REF,
                typeParameter="E")
void setContainer(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

CollectionContainer<E> getContainer()

Returns:

CollectionContainer