io.jmix.ui.action.list

Class BulkEditAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.ListAction

io.jmix.ui.action.list.SecuredListAction

io.jmix.ui.action.list.BulkEditAction

All Implemented Interfaces:

Action, Action.ExecutableAction, Action.HasPrimaryState, Action.HasSecurityConstraint, Action.HasTarget, Action.SecuredAction

@StudioAction(target="io.jmix.ui.component.ListComponent",
              description="Opens an editor for changing attribute values for several entity instances at once")
 @ActionType(value="bulkEdit")
public class BulkEditAction
extends SecuredListAction
implements Action.ExecutableAction

Standard action for changing attribute values for several entity instances at once.

Should be defined for a list component (Table, DataGrid, etc.) in a screen XML descriptor.

The action instance can be parameterized using the nested properties XML element or programmatically in the screen controller.

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.action.BaseAction

BaseAction.EnabledRule

Nested classes/interfaces inherited from interface io.jmix.ui.action.Action

Action.ActionPerformedEvent, Action.AdjustWhenScreenReadOnly, Action.ExecutableAction, Action.HasPrimaryState, Action.HasSecurityConstraint, Action.HasTarget, Action.MainTabSheetAction, Action.ScreenOpeningAction, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected BulkEditors	bulkEditors
protected ColumnsMode	columnsMode
protected java.lang.String	exclude
protected FieldSorter	fieldSorter
static java.lang.String	ID
protected java.util.List<java.lang.String>	includeProperties
protected java.lang.Boolean	loadDynamicAttributes
protected io.jmix.core.Messages	messages
protected OpenMode	openMode
protected java.lang.Boolean	useConfirmDialog
protected boolean	visibleBySpecificUiPermission

Fields inherited from class io.jmix.ui.action.list.SecuredListAction

accessManager, constraintEntityOp, metadata

Fields inherited from class io.jmix.ui.action.ListAction

target

Fields inherited from class io.jmix.ui.action.AbstractAction

caption, description, enabled, eventHub, icon, id, owners, primary, shortcut, visible

Fields inherited from interface io.jmix.ui.action.Action

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor and Description
BulkEditAction()
BulkEditAction(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
void	actionPerform(Component component) Invoked by owning component to execute the action.
void	execute() Executes the action.
ColumnsMode	getColumnsMode() Returns the columns mode which defines the number of columns either it was set by setColumnsMode(ColumnsMode) or in the screen XML.
java.lang.String	getExclude() Returns a regular expression to exclude fields if it was set by setExclude(String) or in the screen XML.
java.util.List<java.lang.String>	getIncludeProperties() Returns a list entity attributes to be included to bulk editor window if it was set by setIncludeProperties(List) or in the screen XML.
java.lang.Boolean	getLoadDynamicAttributes() Returns true/false if the flag was set by setLoadDynamicAttributes(Boolean) or in the screen XML.
OpenMode	getOpenMode() Returns the bulk editor screen open mode if it was set by setOpenMode(OpenMode) or in the screen XML.
java.lang.Boolean	getUseConfirmDialog() Returns true/false if the flag was set by setUseConfirmDialog(Boolean) or in the screen XML.
protected boolean	isPermitted() Callback method which is invoked by the action to determine its enabled state.
boolean	isVisibleByUiPermissions()
protected void	setAccessManager(io.jmix.core.AccessManager accessManager)
void	setBulkEditors(BulkEditors bulkEditors)
void	setColumnsMode(ColumnsMode columnsMode) Sets the columns mode which defines the number of columns.
void	setExclude(java.lang.String exclude) Sets a regular expression to exclude some fields explicitly from the list of attributes available for editing.
void	setFieldSorter(FieldSorter fieldSorter) Sets field sorter that allows you to sort fields by custom logic.
protected void	setIcons(Icons icons)
void	setIncludeProperties(java.util.List<java.lang.String> includeProperties) Sets the entity attributes to be included to bulk editor window.
void	setLoadDynamicAttributes(java.lang.Boolean loadDynamicAttributes) Sets whether dynamic attributes of the edited entity should be displayed on the entity's bulk editor screen.
protected void	setMessages(io.jmix.core.Messages messages)
void	setOpenMode(OpenMode openMode) Sets the bulk editor screen open mode.
void	setUseConfirmDialog(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 io.jmix.ui.action.list.SecuredListAction

getConstraintEntityOp, isApplicable, setConstraintEntityOp, setMetadata

Methods inherited from class io.jmix.ui.action.ListAction

getTarget, setTarget, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

Methods inherited from class io.jmix.ui.action.BaseAction

addActionPerformedListener, addEnabledRule, isEnabledByRule, isEnabledByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setEnabledInternal, setVisible, setVisibleByUiPermissions, setVisibleInternal

Methods inherited from class io.jmix.ui.action.AbstractAction

addOwner, addPropertyChangeListener, firePropertyChange, getCaption, getDescription, getEventHub, getIcon, getId, getOwner, getOwners, getShortcutCombination, hasSubscriptions, isEnabled, isPrimary, isVisible, removeOwner, removePropertyChangeListener, setCaption, setDescription, setIcon, setPrimary, setShortcut, setShortcutCombination

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.action.Action

addOwner, addPropertyChangeListener, getCaption, getDescription, getIcon, getId, getOwner, getOwners, getShortcutCombination, isEnabled, isVisible, refreshState, removeOwner, removePropertyChangeListener, setCaption, setDescription, setEnabled, setIcon, setShortcut, setShortcutCombination, setVisible

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

messages

protected io.jmix.core.Messages messages

bulkEditors

protected BulkEditors bulkEditors

columnsMode

protected ColumnsMode columnsMode

exclude

protected java.lang.String exclude

fieldSorter

protected FieldSorter fieldSorter

includeProperties

protected java.util.List<java.lang.String> includeProperties

openMode

protected OpenMode openMode

loadDynamicAttributes

protected java.lang.Boolean loadDynamicAttributes

useConfirmDialog

protected java.lang.Boolean useConfirmDialog

visibleBySpecificUiPermission

protected boolean visibleBySpecificUiPermission

Constructor Detail

BulkEditAction

public BulkEditAction()

BulkEditAction

public BulkEditAction(java.lang.String id)

Method Detail

getColumnsMode

@Nullable
public ColumnsMode getColumnsMode()

Returns the columns mode which defines the number of columns either it was set by setColumnsMode(ColumnsMode) or in the screen XML. Otherwise returns null.

setColumnsMode

@StudioPropertiesItem(defaultValue="TWO_COLUMNS")
public void setColumnsMode(ColumnsMode columnsMode)

Sets the columns mode which defines the number of columns.

See Also:

ColumnsMode.ONE_COLUMN, ColumnsMode.TWO_COLUMNS

getExclude

@Nullable
public java.lang.String getExclude()

Returns a regular expression to exclude fields if it was set by setExclude(String) or in the screen XML. Otherwise returns null.

setExclude

@StudioPropertiesItem
public void setExclude(java.lang.String exclude)

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

setFieldSorter

public void setFieldSorter(FieldSorter fieldSorter)

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

getIncludeProperties

@Nullable
public java.util.List<java.lang.String> getIncludeProperties()

Returns a list entity attributes to be included to bulk editor window if it was set by setIncludeProperties(List) or in the screen XML. Otherwise returns null.

setIncludeProperties

@StudioPropertiesItem(type=STRING)
public void setIncludeProperties(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.

getOpenMode

@Nullable
public OpenMode getOpenMode()

Returns the bulk editor screen open mode if it was set by setOpenMode(OpenMode) or in the screen XML. Otherwise returns null.

setOpenMode

@StudioPropertiesItem(defaultValue="DIALOG")
public void setOpenMode(OpenMode openMode)

Sets the bulk editor screen open mode.

getLoadDynamicAttributes

@Nullable
public java.lang.Boolean getLoadDynamicAttributes()

Returns true/false if the flag was set by setLoadDynamicAttributes(Boolean) or in the screen XML. Otherwise returns null.

setLoadDynamicAttributes

@StudioPropertiesItem(defaultValue="true")
public void setLoadDynamicAttributes(java.lang.Boolean loadDynamicAttributes)

Sets whether dynamic attributes of the edited entity should be displayed on the entity's bulk editor screen. The default value is true.

getUseConfirmDialog

@Nullable
public java.lang.Boolean getUseConfirmDialog()

Returns true/false if the flag was set by setUseConfirmDialog(Boolean) or in the screen XML. Otherwise returns null.

setUseConfirmDialog

@StudioPropertiesItem(defaultValue="true")
public void setUseConfirmDialog(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.

setIcons

@Autowired
protected void setIcons(Icons icons)

setMessages

@Autowired
protected void setMessages(io.jmix.core.Messages messages)

setAccessManager

@Autowired
protected void setAccessManager(io.jmix.core.AccessManager accessManager)

Overrides:

setAccessManager in class SecuredListAction

isVisibleByUiPermissions

public boolean isVisibleByUiPermissions()

Specified by:

isVisibleByUiPermissions in interface Action.SecuredAction

Overrides:

isVisibleByUiPermissions in class BaseAction

setBulkEditors

@Autowired
public void setBulkEditors(BulkEditors bulkEditors)

isPermitted

protected boolean isPermitted()

Description copied from class: BaseAction

Callback method which is invoked by the action to determine its enabled state.

Overrides:

isPermitted in class SecuredListAction

Returns:

true if the action is enabled for the current user

actionPerform

public void actionPerform(Component component)

Description copied from interface: Action

Invoked by owning component to execute the action.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

Parameters:

component - invoking component

execute

public void execute()

Executes the action.

Specified by:

execute in interface Action.ExecutableAction