WebBulkEditor (Jmix-cuba 1.0 API)

java.lang.Object
- io.jmix.ui.component.impl.AbstractComponent<io.jmix.ui.widget.JmixButton>
- - io.jmix.ui.component.impl.ButtonImpl
  - - com.haulmont.cuba.web.gui.components.WebBulkEditor

All Implemented Interfaces:

BulkEditor, io.jmix.ui.component.ActionOwner, io.jmix.ui.component.AttachNotifier, io.jmix.ui.component.Button, io.jmix.ui.component.Component, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.Focusable, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper, io.jmix.ui.component.HasContextHelp, io.jmix.ui.component.HasDebugId, io.jmix.ui.component.HasHtmlCaption, io.jmix.ui.component.HasHtmlDescription, io.jmix.ui.component.HasHtmlSanitizer
```
public class WebBulkEditor
extends io.jmix.ui.component.impl.ButtonImpl
implements BulkEditor
```

Nested Class Summary
- Nested classes/interfaces inherited from interface io.jmix.ui.component.Component
  io.jmix.ui.component.Component.Alignment, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.Disposable, io.jmix.ui.component.Component.Editable, io.jmix.ui.component.Component.Focusable, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper
- Nested classes/interfaces inherited from interface io.jmix.ui.component.Button
  io.jmix.ui.component.Button.ClickEvent
- Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp
  io.jmix.ui.component.HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields
Modifier and Type	Field and Description
`protected BulkEditAction`	`bulkEditAction`
`protected io.jmix.ui.app.bulk.ColumnsMode`	`columnsMode`
`protected ConstraintOperationType`	`constraintOperationType`
`protected java.lang.String`	`exclude`
`protected java.util.Map<java.lang.String,Field.Validator>`	`fieldValidators`
`protected java.util.List<java.lang.String>`	`includeProperties`
`protected ListComponent`	`listComponent`
`protected boolean`	`loadDynamicAttributes`
`protected java.util.List<Field.Validator>`	`modelValidators`
`protected WindowManager.OpenType`	`openType`
`protected boolean`	`useConfirmDialog`

Fields inherited from class io.jmix.ui.component.impl.ButtonImpl
action, actionPropertyChangeListener, enabled, primary, shortcut, visible

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent
alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

Fields inherited from interface com.haulmont.cuba.gui.components.BulkEditor
NAME, PERMISSION

Fields inherited from interface io.jmix.ui.component.Component
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Fields inherited from interface io.jmix.ui.component.Button
NAME

Constructor Summary

Constructors
Constructor and Description

WebBulkEditor()

Constructors
Constructor and Description
`WebBulkEditor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`io.jmix.ui.app.bulk.ColumnsMode`	`getColumnsMode()`
`ConstraintOperationType`	`getConstraintOperationType()`
`java.lang.String`	`getExcludePropertiesRegex()`
`java.util.Map<java.lang.String,Field.Validator>`	`getFieldValidators()`
`java.util.List<java.lang.String>`	`getIncludeProperties()`
`ListComponent`	`getListComponent()`
`java.util.List<Field.Validator>`	`getModelValidators()`
`WindowManager.OpenType`	`getOpenType()`
`boolean`	`getUseConfirmDialog()`
`boolean`	`isLoadDynamicAttributes()`
`void`	`setColumnsMode(io.jmix.ui.app.bulk.ColumnsMode columnsMode)` Sets the columns mode which defines the number of editor columns.
`void`	`setConstraintOperationType(ConstraintOperationType constraintOperationType)` Sets the given `constraintOperationType` to the BulkEditAction.
`void`	`setExcludePropertiesRegex(java.lang.String exclude)`
`void`	`setFieldValidators(java.util.Map<java.lang.String,Field.Validator> fieldValidators)`
`void`	`setIncludeProperties(java.util.List<java.lang.String> includeProperties)` Sets entity's attributes to the bulk editor dialog.
`void`	`setListComponent(ListComponent listComponent)`
`void`	`setLoadDynamicAttributes(boolean loadDynamicAttributes)`
`void`	`setModelValidators(java.util.List<Field.Validator> modelValidators)`
`void`	`setOpenType(WindowManager.OpenType openType)`
`void`	`setUseConfirmDialog(boolean useConfirmDialog)` Set useConfirmDialog property to false if you want to disable confirm dialog and commit changes immediately.

Methods inherited from class io.jmix.ui.component.impl.ButtonImpl
addClickListener, addStyleName, afterActionPerformed, beforeActionPerformed, buttonClicked, click, createComponent, focus, getAction, getActionEventTarget, getShortcutCombination, getTabIndex, initComponent, isCaptionAsHtml, isDisableOnClick, removeStyleName, setAction, setCaptionAsHtml, setDisableOnClick, setEnabled, setIcon, setShortcut, setShortcutCombination, setTabIndex, setVisible

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent
addAttachListener, addDetachListener, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, sanitize, setAlignment, setApplicationContext, setCaption, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setFrame, setHeight, setHtmlSanitizerEnabled, setIconFromSet, setId, setParent, setResponsive, setStyleName, setValidationError, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame
getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component.HasIcon
getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.Component.Focusable
focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface io.jmix.ui.component.Component
addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption
isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.HasCaption
getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription
getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription
isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.ActionOwner
setAction

- Field Detail
  - exclude
```
protected java.lang.String exclude
```
  - includeProperties
```
protected java.util.List<java.lang.String> includeProperties
```
  - openType
```
protected WindowManager.OpenType openType
```
  - bulkEditAction
```
protected BulkEditAction bulkEditAction
```
  - listComponent
```
protected ListComponent listComponent
```
  - fieldValidators
```
protected java.util.Map<java.lang.String,Field.Validator> fieldValidators
```
  - modelValidators
```
protected java.util.List<Field.Validator> modelValidators
```
  - constraintOperationType
```
protected ConstraintOperationType constraintOperationType
```
  - loadDynamicAttributes
```
protected boolean loadDynamicAttributes
```
  - useConfirmDialog
```
protected boolean useConfirmDialog
```
  - columnsMode
```
protected io.jmix.ui.app.bulk.ColumnsMode columnsMode
```
- Constructor Detail
  - WebBulkEditor
```
public WebBulkEditor()
```
- Method Detail
  - getOpenType
```
public WindowManager.OpenType getOpenType()
```
    Specified by:
    
    getOpenType in interface BulkEditor
  - setOpenType
```
public void setOpenType(WindowManager.OpenType openType)
```
    Specified by:
    
    setOpenType in interface BulkEditor
  - getExcludePropertiesRegex
```
public java.lang.String getExcludePropertiesRegex()
```
    Specified by:
    
    getExcludePropertiesRegex in interface BulkEditor
  - setExcludePropertiesRegex
```
public void setExcludePropertiesRegex(java.lang.String exclude)
```
    Specified by:
    
    setExcludePropertiesRegex in interface BulkEditor
  - getIncludeProperties
```
public java.util.List<java.lang.String> getIncludeProperties()
```
    Specified by:
    
    getIncludeProperties in interface BulkEditor
    
    Returns:
    
    list of entity's attributes
  - setIncludeProperties
```
public void setIncludeProperties(java.util.List<java.lang.String> includeProperties)
```
    Description copied from interface: BulkEditor
    
    Sets entity's attributes to the bulk editor dialog. Unspecified attributes will not be shown.
    
    Specified by:
    
    setIncludeProperties in interface BulkEditor
    
    Parameters:
    
    includeProperties - list of entity's attributes
  - getListComponent
```
public ListComponent getListComponent()
```
    Specified by:
    
    getListComponent in interface BulkEditor
  - setListComponent
```
public void setListComponent(ListComponent listComponent)
```
    Specified by:
    
    setListComponent in interface BulkEditor
  - getFieldValidators
```
public java.util.Map<java.lang.String,Field.Validator> getFieldValidators()
```
    Specified by:
    
    getFieldValidators in interface BulkEditor
  - setFieldValidators
```
public void setFieldValidators(java.util.Map<java.lang.String,Field.Validator> fieldValidators)
```
    Specified by:
    
    setFieldValidators in interface BulkEditor
  - getModelValidators
```
public java.util.List<Field.Validator> getModelValidators()
```
    Specified by:
    
    getModelValidators in interface BulkEditor
  - setModelValidators
```
public void setModelValidators(java.util.List<Field.Validator> modelValidators)
```
    Specified by:
    
    setModelValidators in interface BulkEditor
  - setConstraintOperationType
```
public void setConstraintOperationType(ConstraintOperationType constraintOperationType)
```
    Description copied from interface: BulkEditor
    
    Sets the given constraintOperationType to the BulkEditAction.
    
    Specified by:
    
    setConstraintOperationType in interface BulkEditor
    
    Parameters:
    
    constraintOperationType - constraintOperationType
  - getConstraintOperationType
```
public ConstraintOperationType getConstraintOperationType()
```
    Specified by:
    
    getConstraintOperationType in interface BulkEditor
    
    Returns:
    
    ConstraintOperationType of the BulkEditAction
  - setLoadDynamicAttributes
```
public void setLoadDynamicAttributes(boolean loadDynamicAttributes)
```
    Specified by:
    
    setLoadDynamicAttributes in interface BulkEditor
  - isLoadDynamicAttributes
```
public boolean isLoadDynamicAttributes()
```
    Specified by:
    
    isLoadDynamicAttributes in interface BulkEditor
  - setUseConfirmDialog
```
public void setUseConfirmDialog(boolean useConfirmDialog)
```
    Description copied from interface: BulkEditor
    
    Set useConfirmDialog property to false if you want to disable confirm dialog and commit changes immediately.
    
    Specified by:
    
    setUseConfirmDialog in interface BulkEditor
    
    Parameters:
    
    useConfirmDialog - useConfirmDialog option
  - getUseConfirmDialog
```
public boolean getUseConfirmDialog()
```
    Specified by:
    
    getUseConfirmDialog in interface BulkEditor
    
    Returns:
    
    true if confirm dialog should be enabled
  - getColumnsMode
```
public io.jmix.ui.app.bulk.ColumnsMode getColumnsMode()
```
    Specified by:
    
    getColumnsMode in interface BulkEditor
    
    Returns:
    
    columns mode which defines the number of editor columns
  - setColumnsMode
```
public void setColumnsMode(io.jmix.ui.app.bulk.ColumnsMode columnsMode)
```
    Description copied from interface: BulkEditor
    
    Sets the columns mode which defines the number of editor columns.
    
    Specified by:
    
    setColumnsMode in interface BulkEditor
    
    Parameters:
    
    columnsMode - columns mode
    
    See Also:
    
    ColumnsMode.ONE_COLUMN, ColumnsMode.TWO_COLUMNS

Class WebBulkEditor

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Nested classes/interfaces inherited from interface io.jmix.ui.component.Button

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

Field Summary

Fields inherited from class io.jmix.ui.component.impl.ButtonImpl

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

Fields inherited from interface com.haulmont.cuba.gui.components.BulkEditor

Fields inherited from interface io.jmix.ui.component.Component

Fields inherited from interface io.jmix.ui.component.Button

Constructor Summary

Method Summary

Methods inherited from class io.jmix.ui.component.impl.ButtonImpl

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

Methods inherited from class java.lang.Object

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

Methods inherited from interface io.jmix.ui.component.Component.Focusable

Methods inherited from interface io.jmix.ui.component.Component

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

Methods inherited from interface io.jmix.ui.component.ActionOwner

Field Detail

exclude

includeProperties

openType

bulkEditAction

listComponent

fieldValidators

modelValidators

constraintOperationType

loadDynamicAttributes

useConfirmDialog

columnsMode

Constructor Detail

WebBulkEditor

Method Detail

getOpenType

setOpenType

getExcludePropertiesRegex

setExcludePropertiesRegex

getIncludeProperties

setIncludeProperties

getListComponent

setListComponent

getFieldValidators

setFieldValidators

getModelValidators

setModelValidators

setConstraintOperationType

getConstraintOperationType

setLoadDynamicAttributes

isLoadDynamicAttributes

setUseConfirmDialog

getUseConfirmDialog

getColumnsMode

setColumnsMode