Package io.jmix.ui.relatedentities

Class RelatedEntitiesClassBuilder<S extends Screen>

java.lang.Object

io.jmix.ui.relatedentities.RelatedEntitiesBuilder

io.jmix.ui.relatedentities.RelatedEntitiesClassBuilder<S>

public class RelatedEntitiesClassBuilder<S extends Screen>
extends RelatedEntitiesBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected Class<S>	screenClass

Fields inherited from class io.jmix.ui.relatedentities.RelatedEntitiesBuilder

configurationName, entityClass, handler, metaClass, metaProperty, openMode, options, origin, property, screenId, selectedEntities

Constructor Summary

Constructors

Constructor	Description
RelatedEntitiesClassBuilder(RelatedEntitiesBuilder builder, Class<S> screenClass)

Method Summary

Modifier and Type	Method	Description
S	build()	Builds the screen.
Class<S>	getScreenClass()
RelatedEntitiesClassBuilder<S>	withConfigurationName(String configurationName)	Sets a name to filter configuration in opened screen.
RelatedEntitiesClassBuilder<S>	withEntityClass(Class entityClass)	Sets class of entity for which you want to see related entities.
RelatedEntitiesClassBuilder<S>	withMetaClass(MetaClass metaClass)	Sets MetaClass of entity for which you want to see related entities.
RelatedEntitiesClassBuilder<S>	withMetaProperty(MetaProperty metaProperty)	Sets MetaProperty from which you want to show related entities.
RelatedEntitiesClassBuilder<S>	withOpenMode(OpenMode openMode)	Sets OpenMode for the lookup screen and returns the builder for chaining.
RelatedEntitiesClassBuilder<S>	withOptions(ScreenOptions options)	Sets ScreenOptions for the lookup screen and returns the builder for chaining.
RelatedEntitiesClassBuilder<S>	withProperty(String property)	Sets property from which you want to show related entities.
RelatedEntitiesClassBuilder<S>	withScreenId(String screenId)	Sets screen id and returns the builder for chaining.
RelatedEntitiesClassBuilder<S>	withSelectedEntities(Collection<?> selectedEntities)	Sets collection of selected items.

Methods inherited from class io.jmix.ui.relatedentities.RelatedEntitiesBuilder

getConfigurationName, getEntityClass, getMetaClass, getMetaProperty, getOpenMode, getOptions, getOrigin, getProperty, getScreenId, getSelectedEntities, withScreenClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

screenClass

protected Class<S extends Screen> screenClass

Constructor Details

RelatedEntitiesClassBuilder

public RelatedEntitiesClassBuilder(RelatedEntitiesBuilder builder,
 Class<S> screenClass)

Method Details

withProperty

public RelatedEntitiesClassBuilder<S> withProperty(String property)

Description copied from class: RelatedEntitiesBuilder

Sets property from which you want to show related entities.

Overrides:

withProperty in class RelatedEntitiesBuilder

Parameters:

property - property

Returns:

current instance of builder

withMetaProperty

public RelatedEntitiesClassBuilder<S> withMetaProperty(MetaProperty metaProperty)

Description copied from class: RelatedEntitiesBuilder

Sets MetaProperty from which you want to show related entities.

Overrides:

withMetaProperty in class RelatedEntitiesBuilder

Parameters:

metaProperty - meta property

Returns:

current instance of builder

withEntityClass

public RelatedEntitiesClassBuilder<S> withEntityClass(Class entityClass)

Description copied from class: RelatedEntitiesBuilder

Sets class of entity for which you want to see related entities.

Overrides:

withEntityClass in class RelatedEntitiesBuilder

Parameters:

entityClass - class

Returns:

current instance of builder

withOpenMode

public RelatedEntitiesClassBuilder<S> withOpenMode(OpenMode openMode)

Description copied from class: RelatedEntitiesBuilder

Sets OpenMode for the lookup screen and returns the builder for chaining.

For example: builder.withOpenMode(OpenMode.DIALOG).build();

Overrides:

withOpenMode in class RelatedEntitiesBuilder

Parameters:

openMode - open mode

Returns:

current instance of builder

withScreenId

public RelatedEntitiesClassBuilder<S> withScreenId(String screenId)

Description copied from class: RelatedEntitiesBuilder

Sets screen id and returns the builder for chaining.

Overrides:

withScreenId in class RelatedEntitiesBuilder

Parameters:

screenId - identifier of the screen

Returns:

current instance of builder

withOptions

public RelatedEntitiesClassBuilder<S> withOptions(ScreenOptions options)

Description copied from class: RelatedEntitiesBuilder

Sets ScreenOptions for the lookup screen and returns the builder for chaining.

Overrides:

withOptions in class RelatedEntitiesBuilder

Parameters:

options - screen options

Returns:

current instance of builder

withMetaClass

public RelatedEntitiesClassBuilder<S> withMetaClass(MetaClass metaClass)

Description copied from class: RelatedEntitiesBuilder

Sets MetaClass of entity for which you want to see related entities.

Overrides:

withMetaClass in class RelatedEntitiesBuilder

Parameters:

metaClass - meta class

Returns:

current instance of builder

withSelectedEntities

public RelatedEntitiesClassBuilder<S> withSelectedEntities(Collection<?> selectedEntities)

Description copied from class: RelatedEntitiesBuilder

Sets collection of selected items.

Overrides:

withSelectedEntities in class RelatedEntitiesBuilder

Parameters:

selectedEntities - selected entities

Returns:

current instance of builder

withConfigurationName

public RelatedEntitiesClassBuilder<S> withConfigurationName(String configurationName)

Description copied from class: RelatedEntitiesBuilder

Sets a name to filter configuration in opened screen.

Overrides:

withConfigurationName in class RelatedEntitiesBuilder

Parameters:

configurationName - a configuration name

Returns:

current instance of builder

getScreenClass

public Class<S> getScreenClass()

Returns:

screen class

build

public S build()

Description copied from class: RelatedEntitiesBuilder

Builds the screen.

Overrides:

build in class RelatedEntitiesBuilder

Returns:

created screen