Package io.jmix.ui.bulk

Class BulkEditorBuilder<E>

java.lang.Object

io.jmix.ui.bulk.BulkEditorBuilder<E>

Type Parameters:

E - item type

public class BulkEditorBuilder<E>
extends Object

A builder that creates a new BulkEditorWindow with defined parameters.

Field Summary

Fields

Modifier and Type	Field	Description
protected ColumnsMode	columnsMode
protected final Collection<E>	entities
protected String	exclude
protected FieldSorter	fieldSorter
protected Map<String,Validator<?>>	fieldValidators
protected final Function<BulkEditorBuilder<E>,BulkEditorWindow<E>>	handler
protected List<String>	includeProperties
protected ListComponent<E>	listComponent
protected final MetaClass	metaClass
protected List<Validator<?>>	modelValidators
protected OpenMode	openMode
protected final FrameOwner	origin
protected Boolean	useConfirmDialog

Constructor Summary

Constructors

Constructor	Description
BulkEditorBuilder(MetaClass metaClass, Collection<E> entities, FrameOwner origin, Function<BulkEditorBuilder<E>,BulkEditorWindow<E>> handler)
BulkEditorBuilder(BulkEditorBuilder<E> builder)

Method Summary

Modifier and Type	Method	Description
BulkEditorWindow<E>	create()
ColumnsMode	getColumnsMode()
Collection<E>	getEntities()
String	getExclude()
FieldSorter	getFieldSorter()
Map<String,Validator<?>>	getFieldValidators()
List<String>	getIncludeProperties()
ListComponent<E>	getListComponent()
MetaClass	getMetaClass()
List<Validator<?>>	getModelValidators()
OpenMode	getOpenMode()
FrameOwner	getOrigin()
Boolean	isUseConfirmDialog()
BulkEditorBuilder<E>	withColumnsMode(ColumnsMode columnsMode)	Sets the columns mode for editor which defines number of columns.
BulkEditorBuilder<E>	withExclude(String exclude)	Sets a regular expression to exclude some fields explicitly from the list of attributes available for editing.
BulkEditorBuilder<E>	withFieldSorter(FieldSorter fieldSorter)	Sets field sorter that allows you to sort fields by custom logic.
BulkEditorBuilder<E>	withFieldValidators(Map<String,Validator<?>> fieldValidators)	Sets a map with validators for fields that will be used for editing certain properties.
BulkEditorBuilder<E>	withIncludeProperties(List<String> includeProperties)	Sets the entity attributes to be included to bulk editor window.
BulkEditorBuilder<E>	withListComponent(ListComponent<E> listComponent)	Sets the list component that displays the items to be edited.
BulkEditorBuilder<E>	withModelValidators(List<Validator<?>> modelValidators)	Sets a map with validators for the result of bulk editing.
BulkEditorBuilder<E>	withOpenMode(OpenMode openMode)	Sets screen open mode.
BulkEditorBuilder<E>	withUseConfirmDialog(Boolean useConfirmDialog)	Sets whether or not the confirmation dialog should be displayed to the user before saving the changes.

Methods inherited from class java.lang.Object

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

Field Details

metaClass

protected final MetaClass metaClass

origin

protected final FrameOwner origin

entities

protected final Collection<E> entities

handler

protected final Function<BulkEditorBuilder<E>,BulkEditorWindow<E>> handler

openMode

protected OpenMode openMode

listComponent

protected ListComponent<E> listComponent

exclude

protected String exclude

includeProperties

protected List<String> includeProperties

fieldValidators

protected Map<String,Validator<?>> fieldValidators

modelValidators

protected List<Validator<?>> modelValidators

useConfirmDialog

protected Boolean useConfirmDialog

fieldSorter

protected FieldSorter fieldSorter

columnsMode

protected ColumnsMode columnsMode

Constructor Details

BulkEditorBuilder

public BulkEditorBuilder(BulkEditorBuilder<E> builder)

BulkEditorBuilder

public BulkEditorBuilder(MetaClass metaClass,
 Collection<E> entities,
 FrameOwner origin,
 Function<BulkEditorBuilder<E>,BulkEditorWindow<E>> handler)

Method Details

withOpenMode

public BulkEditorBuilder<E> withOpenMode(OpenMode openMode)

Sets screen open mode.

Parameters:

openMode - the open mode to set

Returns:

this builder

withListComponent

public BulkEditorBuilder<E> withListComponent(ListComponent<E> listComponent)

Sets the list component that displays the items to be edited.

Parameters:

listComponent - the list component to be used

Returns:

this builder

withExclude

public BulkEditorBuilder<E> withExclude(String exclude)

Sets a regular expression to exclude some fields explicitly from the list of attributes available for editing.

Parameters:

exclude - a regular expression

Returns:

this builder

withIncludeProperties

public BulkEditorBuilder<E> withIncludeProperties(List<String> includeProperties)

Sets the entity attributes to be included to bulk editor window. If set, other attributes will be ignored.

Parameters:

includeProperties - the entity attributes to be included to bulk editor window

Returns:

this builder

withFieldValidators

public BulkEditorBuilder<E> withFieldValidators(Map<String,Validator<?>> fieldValidators)

Sets a map with validators for fields that will be used for editing certain properties.

Parameters:

fieldValidators - a map with validators for fields that will be used for editing certain properties

Returns:

this builder

withModelValidators

public BulkEditorBuilder<E> withModelValidators(List<Validator<?>> modelValidators)

Sets a map with validators for the result of bulk editing.

Parameters:

modelValidators - a map with validators for the result of bulk editing

Returns:

this builder

withUseConfirmDialog

public BulkEditorBuilder<E> withUseConfirmDialog(Boolean useConfirmDialog)

Sets whether or not the confirmation dialog should be displayed to the user before saving the changes. The default value is true.

Parameters:

useConfirmDialog - whether or not the confirmation dialog should be displayed

Returns:

this builder

withFieldSorter

public BulkEditorBuilder<E> withFieldSorter(FieldSorter fieldSorter)

Sets field sorter that allows you to sort fields by custom logic.

Parameters:

fieldSorter - field sorter

Returns:

this builder

withColumnsMode

public BulkEditorBuilder<E> withColumnsMode(ColumnsMode columnsMode)

Sets the columns mode for editor which defines number of columns.

Parameters:

columnsMode - columns mode

Returns:

this builder

See Also:

• ColumnsMode.ONE_COLUMN
• ColumnsMode.TWO_COLUMNS

getOrigin

public FrameOwner getOrigin()

Returns:

a FrameOwner of bulk editor

getMetaClass

public MetaClass getMetaClass()

Returns:

a MetaClass of items

getEntities

public Collection<E> getEntities()

Returns:

a collection of items to be edited

getOpenMode

public OpenMode getOpenMode()

Returns:

screen launch mode

getListComponent

@Nullable
public ListComponent<E> getListComponent()

Returns:

the list component that displays the items to be edited

getExclude

@Nullable
public String getExclude()

Returns:

a regular expression to exclude some fields explicitly from the list of attributes available for editing

getIncludeProperties

@Nullable
public List<String> getIncludeProperties()

Returns:

the entity attributes to be included to bulk editor window

getFieldValidators

@Nullable
public Map<String,Validator<?>> getFieldValidators()

Returns:

a map with validators for fields that will be used for editing certain properties

getModelValidators

@Nullable
public List<Validator<?>> getModelValidators()

Returns:

a map with validators for the result of bulk editing

isUseConfirmDialog

@Nullable
public Boolean isUseConfirmDialog()

Returns:

whether or not the confirmation dialog should be displayed to the user before saving the changes

getFieldSorter

@Nullable
public FieldSorter getFieldSorter()

Returns:

field sorter

getColumnsMode

@Nullable
public ColumnsMode getColumnsMode()

Returns:

columns mode

See Also:

• ColumnsMode.ONE_COLUMN
• ColumnsMode.TWO_COLUMNS

create

public BulkEditorWindow<E> create()

Returns:

a new instance of BulkEditorWindow