RelatedEntitiesBuilder (Jmix-ui 1.0 API)

java.lang.Object
- io.jmix.ui.relatedentities.RelatedEntitiesBuilder

Direct Known Subclasses:: RelatedEntitiesClassBuilder

public class RelatedEntitiesBuilder
extends java.lang.Object

Builder class creates screen for related entities. For instance:


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

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`configurationName`
`protected java.lang.Class<?>`	`entityClass`
`protected java.util.function.Function<RelatedEntitiesBuilder,Screen>`	`handler`
`protected io.jmix.core.metamodel.model.MetaClass`	`metaClass`
`protected io.jmix.core.metamodel.model.MetaProperty`	`metaProperty`
`protected OpenMode`	`openMode`
`protected ScreenOptions`	`options`
`protected FrameOwner`	`origin`
`protected java.lang.String`	`property`
`protected java.lang.String`	`screenId`
`protected java.util.Collection<?>`	`selectedEntities`

Constructor Summary

Constructors
Constructor and Description
`RelatedEntitiesBuilder(FrameOwner origin, java.util.function.Function<RelatedEntitiesBuilder,Screen> handler)`
`RelatedEntitiesBuilder(RelatedEntitiesBuilder builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Screen`	`build()` Builds the screen.
`java.lang.String`	`getConfigurationName()`
`java.lang.Class<?>`	`getEntityClass()`
`io.jmix.core.metamodel.model.MetaClass`	`getMetaClass()`
`io.jmix.core.metamodel.model.MetaProperty`	`getMetaProperty()`
`OpenMode`	`getOpenMode()`
`ScreenOptions`	`getOptions()`
`FrameOwner`	`getOrigin()`
`java.lang.String`	`getProperty()`
`java.lang.String`	`getScreenId()`
`java.util.Collection<?>`	`getSelectedEntities()`
`RelatedEntitiesBuilder`	`withConfigurationName(java.lang.String configurationName)` Sets a name to filter configuration in opened screen.
`RelatedEntitiesBuilder`	`withEntityClass(java.lang.Class<?> entityClass)` Sets class of entity for which you want to see related entities.
`RelatedEntitiesBuilder`	`withMetaClass(io.jmix.core.metamodel.model.MetaClass metaClass)` Sets MetaClass of entity for which you want to see related entities.
`RelatedEntitiesBuilder`	`withMetaProperty(io.jmix.core.metamodel.model.MetaProperty metaProperty)` Sets MetaProperty from which you want to show related entities.
`RelatedEntitiesBuilder`	`withOpenMode(OpenMode openMode)` Sets `OpenMode` for the lookup screen and returns the builder for chaining.
`RelatedEntitiesBuilder`	`withOptions(ScreenOptions options)` Sets `ScreenOptions` for the lookup screen and returns the builder for chaining.
`RelatedEntitiesBuilder`	`withProperty(java.lang.String property)` Sets property from which you want to show related entities.
`<S extends Screen> RelatedEntitiesClassBuilder<S>`	`withScreenClass(java.lang.Class<S> screenClass)` Sets screen class and returns the `RelatedEntitiesClassBuilder` for chaining.
`RelatedEntitiesBuilder`	`withScreenId(java.lang.String screenId)` Sets screen id and returns the builder for chaining.
`RelatedEntitiesBuilder`	`withSelectedEntities(java.util.Collection<?> selectedEntities)` Sets collection of selected items.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - handler
```
protected final java.util.function.Function<RelatedEntitiesBuilder,Screen> handler
```
  - property
```
protected java.lang.String property
```
  - metaProperty
```
protected io.jmix.core.metamodel.model.MetaProperty metaProperty
```
  - entityClass
```
protected java.lang.Class<?> entityClass
```
  - metaClass
```
protected io.jmix.core.metamodel.model.MetaClass metaClass
```
  - openMode
```
protected OpenMode openMode
```
  - screenId
```
protected java.lang.String screenId
```
  - origin
```
protected FrameOwner origin
```
  - options
```
protected ScreenOptions options
```
  - selectedEntities
```
protected java.util.Collection<?> selectedEntities
```
  - configurationName
```
protected java.lang.String configurationName
```
- Constructor Detail
  - RelatedEntitiesBuilder
```
public RelatedEntitiesBuilder(RelatedEntitiesBuilder builder)
```
  - RelatedEntitiesBuilder
```
public RelatedEntitiesBuilder(FrameOwner origin,
                              java.util.function.Function<RelatedEntitiesBuilder,Screen> handler)
```
- Method Detail
  - getProperty
```
@Nullable
public java.lang.String getProperty()
```
    Returns:
    
    property set by withProperty(String)
  - getMetaProperty
```
@Nullable
public io.jmix.core.metamodel.model.MetaProperty getMetaProperty()
```
    Returns:
    
    meta property set by withMetaProperty(MetaProperty)
  - getEntityClass
```
@Nullable
public java.lang.Class<?> getEntityClass()
```
    Returns:
    
    entity class set by withEntityClass(Class)
  - getOpenMode
```
public OpenMode getOpenMode()
```
    Returns:
    
    open mode set by withOpenMode(OpenMode)
  - getScreenId
```
@Nullable
public java.lang.String getScreenId()
```
    Returns:
    
    screen id set by withScreenId(String)
  - getOrigin
```
public FrameOwner getOrigin()
```
    Returns:
    
    invoking screen
  - getOptions
```
public ScreenOptions getOptions()
```
    Returns:
    
    screen options set by withOptions(ScreenOptions)
  - getMetaClass
```
@Nullable
public io.jmix.core.metamodel.model.MetaClass getMetaClass()
```
    Returns:
    
    meta class set by withMetaClass(MetaClass)
  - getSelectedEntities
```
@Nullable
public java.util.Collection<?> getSelectedEntities()
```
    Returns:
    
    selected entities set by withSelectedEntities(Collection)
  - getConfigurationName
```
@Nullable
public java.lang.String getConfigurationName()
```
    Returns:
    
    filter caption set by withConfigurationName(String)
  - withProperty
```
public RelatedEntitiesBuilder withProperty(java.lang.String property)
```
    Sets property from which you want to show related entities.
    
    Parameters:
    
    property - property
    
    Returns:
    
    current instance of builder
  - withMetaProperty
```
public RelatedEntitiesBuilder withMetaProperty(io.jmix.core.metamodel.model.MetaProperty metaProperty)
```
    Sets MetaProperty from which you want to show related entities.
    
    Parameters:
    
    metaProperty - meta property
    
    Returns:
    
    current instance of builder
  - withEntityClass
```
public RelatedEntitiesBuilder withEntityClass(java.lang.Class<?> entityClass)
```
    Sets class of entity for which you want to see related entities.
    
    Parameters:
    
    entityClass - class
    
    Returns:
    
    current instance of builder
  - withOpenMode
```
public RelatedEntitiesBuilder withOpenMode(OpenMode openMode)
```
    Sets OpenMode for the lookup screen and returns the builder for chaining.
    For example: builder.withOpenMode(OpenMode.DIALOG).build();
    
    Parameters:
    
    openMode - open mode
    
    Returns:
    
    current instance of builder
  - withScreenId
```
public RelatedEntitiesBuilder withScreenId(java.lang.String screenId)
```
    Sets screen id and returns the builder for chaining.
    
    Parameters:
    
    screenId - identifier of the screen
    
    Returns:
    
    current instance of builder
  - withScreenClass
```
public <S extends Screen> RelatedEntitiesClassBuilder<S> withScreenClass(java.lang.Class<S> screenClass)
```
    Sets screen class and returns the RelatedEntitiesClassBuilder for chaining.
    
    Parameters:
    
    screenClass - class of the screen controller
    
    Returns:
    
    RelatedEntitiesClassBuilder with copied fields
  - withOptions
```
public RelatedEntitiesBuilder withOptions(ScreenOptions options)
```
    Sets ScreenOptions for the lookup screen and returns the builder for chaining.
    
    Parameters:
    
    options - screen options
    
    Returns:
    
    current instance of builder
  - withMetaClass
```
public RelatedEntitiesBuilder withMetaClass(io.jmix.core.metamodel.model.MetaClass metaClass)
```
    Sets MetaClass of entity for which you want to see related entities.
    
    Parameters:
    
    metaClass - meta class
    
    Returns:
    
    current instance of builder
  - withSelectedEntities
```
public RelatedEntitiesBuilder withSelectedEntities(java.util.Collection<?> selectedEntities)
```
    Sets collection of selected items.
    
    Parameters:
    
    selectedEntities - selected entities
    
    Returns:
    
    current instance of builder
  - withConfigurationName
```
public RelatedEntitiesBuilder withConfigurationName(java.lang.String configurationName)
```
    Sets a name to filter configuration in opened screen.
    
    Parameters:
    
    configurationName - a configuration name
    
    Returns:
    
    current instance of builder
  - build
```
public Screen build()
```
    Builds the screen.
    
    Returns:
    
    created screen

Class RelatedEntitiesBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

handler

property

metaProperty

entityClass

metaClass

openMode

screenId

origin

options

selectedEntities

configurationName

Constructor Detail

RelatedEntitiesBuilder

RelatedEntitiesBuilder

Method Detail

getProperty

getMetaProperty

getEntityClass

getOpenMode

getScreenId

getOrigin

getOptions

getMetaClass

getSelectedEntities

getConfigurationName

withProperty

withMetaProperty

withEntityClass

withOpenMode

withScreenId

withScreenClass

withOptions

withMetaClass

withSelectedEntities

withConfigurationName

build