BulkEditors.EditorBuilder (CUBA 7.0 API)

java.lang.Object
- com.haulmont.cuba.gui.BulkEditors.EditorBuilder<E>

Type Parameters:

E - item type

Enclosing class:

BulkEditors
```
public static class BulkEditors.EditorBuilder<E extends Entity>
extends java.lang.Object
```
A builder that creates a new BulkEditorWindow with defined parameters.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Collection<E>`	`entities`
`protected java.lang.String`	`exclude`
`protected java.util.Map<java.lang.String,Field.Validator>`	`fieldValidators`
`protected java.util.function.Function<BulkEditors.EditorBuilder<E>,BulkEditorWindow>`	`handler`
`protected java.util.List<java.lang.String>`	`includeProperties`
`protected Screens.LaunchMode`	`launchMode`
`protected ListComponent<E>`	`listComponent`
`protected java.lang.Boolean`	`loadDynamicAttributes`
`protected com.haulmont.chile.core.model.MetaClass`	`metaClass`
`protected java.util.List<Field.Validator>`	`modelValidators`
`protected FrameOwner`	`origin`
`protected java.lang.Boolean`	`useConfirmDialog`

Constructor Summary

Constructors
Constructor and Description
`EditorBuilder(BulkEditors.EditorBuilder<E> builder)`
`EditorBuilder(com.haulmont.chile.core.model.MetaClass metaClass, java.util.Collection<E> entities, FrameOwner origin, java.util.function.Function<BulkEditors.EditorBuilder<E>,BulkEditorWindow> handler)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BulkEditorWindow`	`create()`
`java.util.Collection<E>`	`getEntities()`
`java.lang.String`	`getExclude()`
`java.util.Map<java.lang.String,Field.Validator>`	`getFieldValidators()`
`java.util.List<java.lang.String>`	`getIncludeProperties()`
`Screens.LaunchMode`	`getLaunchMode()`
`ListComponent<E>`	`getListComponent()`
`com.haulmont.chile.core.model.MetaClass`	`getMetaClass()`
`java.util.List<Field.Validator>`	`getModelValidators()`
`FrameOwner`	`getOrigin()`
`java.lang.Boolean`	`isLoadDynamicAttributes()`
`java.lang.Boolean`	`isUseConfirmDialog()`
`BulkEditors.EditorBuilder<E>`	`withExclude(java.lang.String exclude)` Sets a regular expression to exclude some fields explicitly from the list of attributes available for editing.
`BulkEditors.EditorBuilder<E>`	`withFieldValidators(java.util.Map<java.lang.String,Field.Validator> fieldValidators)` Sets a map with validators for fields that will be used for editing certain properties.
`BulkEditors.EditorBuilder<E>`	`withIncludeProperties(java.util.List<java.lang.String> includeProperties)` Sets the entity attributes to be included to bulk editor window.
`BulkEditors.EditorBuilder<E>`	`withLaunchMode(Screens.LaunchMode launchMode)` Sets screen launch mode.
`BulkEditors.EditorBuilder<E>`	`withListComponent(ListComponent<E> listComponent)` Sets the list component that displays the items to be edited.
`BulkEditors.EditorBuilder<E>`	`withLoadDynamicAttributes(java.lang.Boolean loadDynamicAttributes)` Sets whether or not the dynamic attributes of the edited entity should be displayed on the entity's bulk editor screen.
`BulkEditors.EditorBuilder<E>`	`withModelValidators(java.util.List<Field.Validator> modelValidators)` Sets a map with validators for the result of bulk editing.
`BulkEditors.EditorBuilder<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 com.haulmont.chile.core.model.MetaClass metaClass
```
  - origin
```
protected final FrameOwner origin
```
  - entities
```
protected final java.util.Collection<E extends Entity> entities
```
  - handler
```
protected final java.util.function.Function<BulkEditors.EditorBuilder<E extends Entity>,BulkEditorWindow> handler
```
  - launchMode
```
protected Screens.LaunchMode launchMode
```
  - listComponent
```
protected ListComponent<E extends Entity> listComponent
```
  - exclude
```
protected java.lang.String exclude
```
  - includeProperties
```
protected java.util.List<java.lang.String> includeProperties
```
  - fieldValidators
```
protected java.util.Map<java.lang.String,Field.Validator> fieldValidators
```
  - modelValidators
```
protected java.util.List<Field.Validator> modelValidators
```
  - loadDynamicAttributes
```
protected java.lang.Boolean loadDynamicAttributes
```
  - useConfirmDialog
```
protected java.lang.Boolean useConfirmDialog
```
- Constructor Detail
  - EditorBuilder
```
public EditorBuilder(BulkEditors.EditorBuilder<E> builder)
```
  - EditorBuilder
```
public EditorBuilder(com.haulmont.chile.core.model.MetaClass metaClass,
                     java.util.Collection<E> entities,
                     FrameOwner origin,
                     java.util.function.Function<BulkEditors.EditorBuilder<E>,BulkEditorWindow> handler)
```
- Method Detail
  - withLaunchMode
```
public BulkEditors.EditorBuilder<E> withLaunchMode(Screens.LaunchMode launchMode)
```
    Sets screen launch mode.
    
    Parameters:
    
    launchMode - the launch mode to set
    
    Returns:
    
    this builder
  - withListComponent
```
public BulkEditors.EditorBuilder<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 BulkEditors.EditorBuilder<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 BulkEditors.EditorBuilder<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 BulkEditors.EditorBuilder<E> withFieldValidators(java.util.Map<java.lang.String,Field.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 BulkEditors.EditorBuilder<E> withModelValidators(java.util.List<Field.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
  - withLoadDynamicAttributes
```
public BulkEditors.EditorBuilder<E> withLoadDynamicAttributes(java.lang.Boolean loadDynamicAttributes)
```
    Sets whether or not the dynamic attributes of the edited entity should be displayed on the entity's bulk editor screen. The default value is true.
    
    Parameters:
    
    loadDynamicAttributes - whether or not the dynamic attributes of the edited entity should be displayed
    
    Returns:
    
    this builder
  - withUseConfirmDialog
```
public BulkEditors.EditorBuilder<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
  - getOrigin
```
public FrameOwner getOrigin()
```
    Returns:
    
    a FrameOwner of bulk editor
  - getMetaClass
```
public com.haulmont.chile.core.model.MetaClass getMetaClass()
```
    Returns:
    
    a MetaClass of items
  - getEntities
```
public java.util.Collection<E> getEntities()
```
    Returns:
    
    a collection of items to be edited
  - getLaunchMode
```
public Screens.LaunchMode getLaunchMode()
```
    Returns:
    
    screen launch mode
  - getListComponent
```
public ListComponent<E> getListComponent()
```
    Returns:
    
    the list component that displays the items to be edited
  - getExclude
```
public java.lang.String getExclude()
```
    Returns:
    
    a regular expression to exclude some fields explicitly from the list of attributes available for editing
  - getIncludeProperties
```
public java.util.List<java.lang.String> getIncludeProperties()
```
    Returns:
    
    the entity attributes to be included to bulk editor window
  - getFieldValidators
```
public java.util.Map<java.lang.String,Field.Validator> getFieldValidators()
```
    Returns:
    
    a map with validators for fields that will be used for editing certain properties
  - getModelValidators
```
public java.util.List<Field.Validator> getModelValidators()
```
    Returns:
    
    a map with validators for the result of bulk editing
  - isLoadDynamicAttributes
```
public java.lang.Boolean isLoadDynamicAttributes()
```
    Returns:
    
    whether or not the dynamic attributes of the edited entity should be displayed on the entity's bulk editor screen
  - isUseConfirmDialog
```
public java.lang.Boolean isUseConfirmDialog()
```
    Returns:
    
    whether or not the confirmation dialog should be displayed to the user before saving the changes
  - create
```
public BulkEditorWindow create()
```
    Returns:
    
    a new instance of BulkEditorWindow

Class BulkEditors.EditorBuilder<E extends Entity>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

metaClass

origin

entities

handler

launchMode

listComponent

exclude

includeProperties

fieldValidators

modelValidators

loadDynamicAttributes

useConfirmDialog

Constructor Detail

EditorBuilder

EditorBuilder

Method Detail

withLaunchMode

withListComponent

withExclude

withIncludeProperties

withFieldValidators

withModelValidators

withLoadDynamicAttributes

withUseConfirmDialog

getOrigin

getMetaClass

getEntities

getLaunchMode

getListComponent

getExclude

getIncludeProperties

getFieldValidators

getModelValidators

isLoadDynamicAttributes

isUseConfirmDialog

create