RelatedEntitiesBuilder (CUBA 7.2 API)

java.lang.Object
- com.haulmont.cuba.gui.relatedentities.RelatedEntitiesBuilder

Direct Known Subclasses:: RelatedEntitiesClassBuilder

public class RelatedEntitiesBuilder
extends java.lang.Object

Builder class creates screen for related entities. For instance:


      RelatedEntitiesBuilder builder = relatedEntitiesAPI.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.Class`	`entityClass`
`protected java.lang.String`	`filterCaption`
`protected java.util.function.Function<RelatedEntitiesBuilder,Screen>`	`handler`
`protected Screens.LaunchMode`	`launchMode`
`protected MetaClass`	`metaClass`
`protected MetaProperty`	`metaProperty`
`protected ScreenOptions`	`options`
`protected FrameOwner`	`origin`
`protected java.lang.String`	`property`
`protected java.lang.String`	`screenId`
`protected java.util.Collection<? extends Entity>`	`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.Class`	`getEntityClass()`
`java.lang.String`	`getFilterCaption()`
`Screens.LaunchMode`	`getLaunchMode()`
`MetaClass`	`getMetaClass()`
`MetaProperty`	`getMetaProperty()`
`ScreenOptions`	`getOptions()`
`FrameOwner`	`getOrigin()`
`java.lang.String`	`getProperty()`
`java.lang.String`	`getScreenId()`
`java.util.Collection<? extends Entity>`	`getSelectedEntities()`
`RelatedEntitiesBuilder`	`withEntityClass(java.lang.Class entityClass)` Sets class of entity for which you want to see related entities.
`RelatedEntitiesBuilder`	`withFilterCaption(java.lang.String filterCaption)` Sets caption to filter in opened screen.
`RelatedEntitiesBuilder`	`withLaunchMode(Screens.LaunchMode launchMode)` Sets `Screens.LaunchMode` for the related entities screen and returns the builder for chaining.
`RelatedEntitiesBuilder`	`withMetaClass(MetaClass metaClass)` Sets MetaClass of entity for which you want to see related entities.
`RelatedEntitiesBuilder`	`withMetaProperty(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<? extends Entity> 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 MetaProperty metaProperty
```
  - entityClass
```
protected java.lang.Class entityClass
```
  - metaClass
```
protected MetaClass metaClass
```
  - launchMode
```
protected Screens.LaunchMode launchMode
```
  - screenId
```
protected java.lang.String screenId
```
  - origin
```
protected FrameOwner origin
```
  - options
```
protected ScreenOptions options
```
  - selectedEntities
```
protected java.util.Collection<? extends Entity> selectedEntities
```
  - filterCaption
```
protected java.lang.String filterCaption
```
- Constructor Detail
  - RelatedEntitiesBuilder
```
public RelatedEntitiesBuilder(RelatedEntitiesBuilder builder)
```
  - RelatedEntitiesBuilder
```
public RelatedEntitiesBuilder(FrameOwner origin,
                              java.util.function.Function<RelatedEntitiesBuilder,Screen> handler)
```
- Method Detail
  - getProperty
```
public java.lang.String getProperty()
```
    Returns:
    
    property set by withProperty(String)
  - getMetaProperty
```
public MetaProperty getMetaProperty()
```
    Returns:
    
    meta property set by withMetaProperty(MetaProperty)
  - getEntityClass
```
public java.lang.Class getEntityClass()
```
    Returns:
    
    entity class set by withEntityClass(Class)
  - getLaunchMode
```
public Screens.LaunchMode getLaunchMode()
```
    Returns:
    
    launch mode set by withLaunchMode(Screens.LaunchMode)
  - getScreenId
```
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
```
public MetaClass getMetaClass()
```
    Returns:
    
    meta class set by withMetaClass(MetaClass)
  - getSelectedEntities
```
public java.util.Collection<? extends Entity> getSelectedEntities()
```
    Returns:
    
    selected entities set by withSelectedEntities(Collection)
  - getFilterCaption
```
public java.lang.String getFilterCaption()
```
    Returns:
    
    filter caption set by withFilterCaption(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(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
  - withLaunchMode
```
public RelatedEntitiesBuilder withLaunchMode(Screens.LaunchMode launchMode)
```
    Sets Screens.LaunchMode for the related entities screen and returns the builder for chaining.
    For example: builder.withLaunchMode(OpenMode.DIALOG).build();
    
    Parameters:
    
    launchMode - launch mode
    
    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(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<? extends Entity> selectedEntities)
```
    Sets collection of selected items.
    
    Parameters:
    
    selectedEntities - selected entities
    
    Returns:
    
    current instance of builder
  - withFilterCaption
```
public RelatedEntitiesBuilder withFilterCaption(java.lang.String filterCaption)
```
    Sets caption to filter in opened screen.
    
    Parameters:
    
    filterCaption - caption
    
    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

launchMode

screenId

origin

options

selectedEntities

filterCaption

Constructor Detail

RelatedEntitiesBuilder

RelatedEntitiesBuilder

Method Detail

getProperty

getMetaProperty

getEntityClass

getLaunchMode

getScreenId

getOrigin

getOptions

getMetaClass

getSelectedEntities

getFilterCaption

withProperty

withMetaProperty

withEntityClass

withLaunchMode

withOpenMode

withScreenId

withScreenClass

withOptions

withMetaClass

withSelectedEntities

withFilterCaption

build