com.haulmont.cuba.gui.relatedentities

Interface RelatedEntitiesAPI

All Known Implementing Classes:

RelatedEntitiesBean

public interface RelatedEntitiesAPI

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RelatedEntitiesAPI.RelatedScreenDescriptor Deprecated. Use builder(FrameOwner) to create and set up screen for related entities.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
RelatedEntitiesBuilder	builder(io.jmix.ui.screen.FrameOwner frameOwner) Creates a related screen builder.
default void	openRelatedScreen(java.util.Collection<? extends io.jmix.core.Entity> selectedEntities, io.jmix.core.metamodel.model.MetaClass metaClass, io.jmix.core.metamodel.model.MetaProperty metaProperty) Deprecated. Use builder(FrameOwner) to create and set up screen for related entities.
void	openRelatedScreen(java.util.Collection<? extends io.jmix.core.Entity> selectedEntities, io.jmix.core.metamodel.model.MetaClass metaClass, io.jmix.core.metamodel.model.MetaProperty metaProperty, RelatedEntitiesAPI.RelatedScreenDescriptor descriptor) Deprecated. Use builder(FrameOwner) to create and set up screen for related entities.
default <T extends io.jmix.core.Entity> void	openRelatedScreen(java.util.Collection<T> selectedEntities, java.lang.Class<T> clazz, java.lang.String property) Deprecated. Use builder(FrameOwner) to create and set up screen for related entities.
<T extends io.jmix.core.Entity> void	openRelatedScreen(java.util.Collection<T> selectedEntities, java.lang.Class<T> clazz, java.lang.String property, RelatedEntitiesAPI.RelatedScreenDescriptor descriptor) Deprecated. Use builder(FrameOwner) to create and set up screen for related entities.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

builder

RelatedEntitiesBuilder builder(io.jmix.ui.screen.FrameOwner frameOwner)

Creates a related screen builder.

Note, it is necessary to set MetaClass or entity class and property or MetaProperty to builder.

Example of creating screen with entity class and property:

      RelatedEntitiesBuilder builder = relatedEntitiesAPI.builder(this);
      Screen colourBrowser = builder
              .withEntityClass(Car.class)
              .withProperty("colour")
              .withSelectedEntities(carsTable.getSelected())
              .withScreenClass(ColourBrowser.class)
              .build();
      colourBrowser.show();
 

Parameters:

frameOwner - invoking screen

Returns:

builder instance

openRelatedScreen

@Deprecated
default void openRelatedScreen(java.util.Collection<? extends io.jmix.core.Entity> selectedEntities,
                                           io.jmix.core.metamodel.model.MetaClass metaClass,
                                           io.jmix.core.metamodel.model.MetaProperty metaProperty)

Deprecated. Use builder(FrameOwner) to create and set up screen for related entities.

Shows found related entities in default browse screen.

Parameters:

selectedEntities - set of entities which represents one side of relation

metaClass - metaClass of single entity from selectedEntities

metaProperty - chosen field to find related entities. Can be obtained from metaClass

openRelatedScreen

@Deprecated
void openRelatedScreen(java.util.Collection<? extends io.jmix.core.Entity> selectedEntities,
                                   io.jmix.core.metamodel.model.MetaClass metaClass,
                                   io.jmix.core.metamodel.model.MetaProperty metaProperty,
                                   @Nullable
                                   RelatedEntitiesAPI.RelatedScreenDescriptor descriptor)

Deprecated. Use builder(FrameOwner) to create and set up screen for related entities.

Shows found related entities in chosen screen.

Parameters:

selectedEntities - set of entities which represents one side of relation

metaClass - metaClass of single entity from selectedEntities

metaProperty - chosen field to find related entities. Can be obtained from metaClass

descriptor - descriptor contains screen id, WindowManager.OpenType and generated filter caption

openRelatedScreen

@Deprecated
default <T extends io.jmix.core.Entity> void openRelatedScreen(java.util.Collection<T> selectedEntities,
                                                                           java.lang.Class<T> clazz,
                                                                           java.lang.String property)

Deprecated. Use builder(FrameOwner) to create and set up screen for related entities.

Shows found related entities in default browse screen.

Parameters:

selectedEntities - set of entities which represents one side of relation

clazz - class of single entity from selectedEntities

property - chosen field to find related entities

openRelatedScreen

@Deprecated
<T extends io.jmix.core.Entity> void openRelatedScreen(java.util.Collection<T> selectedEntities,
                                                                   java.lang.Class<T> clazz,
                                                                   java.lang.String property,
                                                                   RelatedEntitiesAPI.RelatedScreenDescriptor descriptor)

Deprecated. Use builder(FrameOwner) to create and set up screen for related entities.

Shows found related entities in chosen screen.

Parameters:

selectedEntities - set of entities which represents one side of relation

clazz - class of single entity from selectedEntities

property - chosen field to find related entities

descriptor - descriptor contains screen id, WindowManager.OpenType and generated filter caption