BulkEditorBuilder (Jmix-ui 1.0 API)

java.lang.Object
- io.jmix.ui.bulk.BulkEditorBuilder<E>

Type Parameters:

E - item type
```
public class BulkEditorBuilder<E>
extends java.lang.Object
```
A builder that creates a new BulkEditorWindow with defined parameters.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ColumnsMode`	`columnsMode`
`protected java.util.Collection<E>`	`entities`
`protected java.lang.String`	`exclude`
`protected FieldSorter`	`fieldSorter`
`protected java.util.Map<java.lang.String,Validator<?>>`	`fieldValidators`
`protected java.util.function.Function<BulkEditorBuilder<E>,BulkEditorWindow<E>>`	`handler`
`protected java.util.List<java.lang.String>`	`includeProperties`
`protected ListComponent<E>`	`listComponent`
`protected io.jmix.core.metamodel.model.MetaClass`	`metaClass`
`protected java.util.List<Validator<?>>`	`modelValidators`
`protected OpenMode`	`openMode`
`protected FrameOwner`	`origin`
`protected java.lang.Boolean`	`useConfirmDialog`

Constructor Summary

Constructors
Constructor and Description
`BulkEditorBuilder(BulkEditorBuilder<E> builder)`
`BulkEditorBuilder(io.jmix.core.metamodel.model.MetaClass metaClass, java.util.Collection<E> entities, FrameOwner origin, java.util.function.Function<BulkEditorBuilder<E>,BulkEditorWindow<E>> handler)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BulkEditorWindow<E>`	`create()`
`ColumnsMode`	`getColumnsMode()`
`java.util.Collection<E>`	`getEntities()`
`java.lang.String`	`getExclude()`
`FieldSorter`	`getFieldSorter()`
`java.util.Map<java.lang.String,Validator<?>>`	`getFieldValidators()`
`java.util.List<java.lang.String>`	`getIncludeProperties()`
`ListComponent<E>`	`getListComponent()`
`io.jmix.core.metamodel.model.MetaClass`	`getMetaClass()`
`java.util.List<Validator<?>>`	`getModelValidators()`
`OpenMode`	`getOpenMode()`
`FrameOwner`	`getOrigin()`
`java.lang.Boolean`	`isUseConfirmDialog()`
`BulkEditorBuilder<E>`	`withColumnsMode(ColumnsMode columnsMode)` Sets the columns mode for editor which defines number of columns.
`BulkEditorBuilder<E>`	`withExclude(java.lang.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(java.util.Map<java.lang.String,Validator<?>> fieldValidators)` Sets a map with validators for fields that will be used for editing certain properties.
`BulkEditorBuilder<E>`	`withIncludeProperties(java.util.List<java.lang.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(java.util.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(java.lang.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 Detail
  - metaClass
```
protected final io.jmix.core.metamodel.model.MetaClass metaClass
```
  - origin
```
protected final FrameOwner origin
```
  - entities
```
protected final java.util.Collection<E> entities
```
  - handler
```
protected final java.util.function.Function<BulkEditorBuilder<E>,BulkEditorWindow<E>> handler
```
  - openMode
```
protected OpenMode openMode
```
  - listComponent
```
protected ListComponent<E> listComponent
```
  - exclude
```
protected java.lang.String exclude
```
  - includeProperties
```
protected java.util.List<java.lang.String> includeProperties
```
  - fieldValidators
```
protected java.util.Map<java.lang.String,Validator<?>> fieldValidators
```
  - modelValidators
```
protected java.util.List<Validator<?>> modelValidators
```
  - useConfirmDialog
```
protected java.lang.Boolean useConfirmDialog
```
  - fieldSorter
```
protected FieldSorter fieldSorter
```
  - columnsMode
```
protected ColumnsMode columnsMode
```
- Constructor Detail
  - BulkEditorBuilder
```
public BulkEditorBuilder(BulkEditorBuilder<E> builder)
```
  - BulkEditorBuilder
```
public BulkEditorBuilder(io.jmix.core.metamodel.model.MetaClass metaClass,
                         java.util.Collection<E> entities,
                         FrameOwner origin,
                         java.util.function.Function<BulkEditorBuilder<E>,BulkEditorWindow<E>> handler)
```
- Method Detail
  - 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(java.lang.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(java.util.List<java.lang.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(java.util.Map<java.lang.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(java.util.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(java.lang.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 io.jmix.core.metamodel.model.MetaClass getMetaClass()
```
    Returns:
    
    a MetaClass of items
  - getEntities
```
public java.util.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 java.lang.String getExclude()
```
    Returns:
    
    a regular expression to exclude some fields explicitly from the list of attributes available for editing
  - getIncludeProperties
```
@Nullable
public java.util.List<java.lang.String> getIncludeProperties()
```
    Returns:
    
    the entity attributes to be included to bulk editor window
  - getFieldValidators
```
@Nullable
public java.util.Map<java.lang.String,Validator<?>> getFieldValidators()
```
    Returns:
    
    a map with validators for fields that will be used for editing certain properties
  - getModelValidators
```
@Nullable
public java.util.List<Validator<?>> getModelValidators()
```
    Returns:
    
    a map with validators for the result of bulk editing
  - isUseConfirmDialog
```
@Nullable
public java.lang.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

Class BulkEditorBuilder<E>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

metaClass

origin

entities

handler

openMode

listComponent

exclude

includeProperties

fieldValidators

modelValidators

useConfirmDialog

fieldSorter

columnsMode

Constructor Detail

BulkEditorBuilder

BulkEditorBuilder

Method Detail

withOpenMode

withListComponent

withExclude

withIncludeProperties

withFieldValidators

withModelValidators

withUseConfirmDialog

withFieldSorter

withColumnsMode

getOrigin

getMetaClass

getEntities

getOpenMode

getListComponent

getExclude

getIncludeProperties

getFieldValidators

getModelValidators

isUseConfirmDialog

getFieldSorter

getColumnsMode

create