Package io.jmix.ui

Class RemoveOperation

java.lang.Object

io.jmix.ui.RemoveOperation

@Component("ui_RemoveOperation")
public class RemoveOperation
extends Object

Class that provides fluent interface for removing entity instances.
Inject the class into your screen controller and use builder(Class, FrameOwner) method as an entry point.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RemoveOperation.ActionCancelledEvent<E>	Event sent when the remove operation is cancelled by user in the confirmation dialog.
static class	RemoveOperation.AfterActionPerformedEvent<E>	Event sent after selected entities are removed.
static class	RemoveOperation.BeforeActionPerformedEvent<E>	Event sent before selected entities are removed.
protected static enum	RemoveOperation.Operation
static class	RemoveOperation.RemoveBuilder<E>	Remove builder.

Field Summary

Fields

Modifier and Type	Field	Description
protected DataManager	dataManager
protected EntityStates	entityStates
protected ExtendedEntities	extendedEntities
protected Messages	messages
protected Metadata	metadata
protected WindowConfig	windowConfig

Constructor Summary

Constructors

Constructor	Description
RemoveOperation()

Method Summary

Modifier and Type	Method	Description
<E> RemoveOperation.RemoveBuilder<E>	builder(ListComponent<E> listComponent)	Creates a remove builder using list component, e.g.
<E> RemoveOperation.RemoveBuilder<E>	builder(Class<E> entityClass, FrameOwner origin)	Creates a remove builder.
protected void	commitIfNeeded(Collection<?> entitiesToRemove, CollectionContainer container, ScreenData screenData)
protected <E> void	excludeItems(RemoveOperation.RemoveBuilder<E> builder, List<E> selectedItems)
<E> void	excludeSelected(ListComponent<E> target)	Excludes selected items from the list component without confirmation.
protected <E> void	focusListComponent(RemoveOperation.RemoveBuilder<E> builder)
protected <E> CollectionContainer<E>	getCollectionContainer(RemoveOperation.RemoveBuilder<E> builder)
protected <E> void	performAction(RemoveOperation.RemoveBuilder<E> builder, List<E> selectedItems)
protected <E> void	performActionWithConfirmation(RemoveOperation.RemoveBuilder<E> builder, List<E> selectedItems)
protected <E> void	removeItems(RemoveOperation.RemoveBuilder<E> builder, List<E> selectedItems)
<E> void	removeSelected(ListComponent<E> target)	Removes selected items from the list component with confirmation dialog.
protected <E> void	triggerAction(RemoveOperation.RemoveBuilder<E> builder)

Methods inherited from class java.lang.Object

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

Field Details

windowConfig

@Autowired
protected WindowConfig windowConfig

dataManager

@Autowired
protected DataManager dataManager

messages

@Autowired
protected Messages messages

extendedEntities

@Autowired
protected ExtendedEntities extendedEntities

entityStates

@Autowired
protected EntityStates entityStates

metadata

@Autowired
protected Metadata metadata

Constructor Details

RemoveOperation

public RemoveOperation()

Method Details

builder

public <E> RemoveOperation.RemoveBuilder<E> builder(Class<E> entityClass,
 FrameOwner origin)

Creates a remove builder.

Type Parameters:

E - type of entity

Parameters:

entityClass - entity class

origin - invoking screen

builder

public <E> RemoveOperation.RemoveBuilder<E> builder(ListComponent<E> listComponent)

Creates a remove builder using list component, e.g. Table or DataGrid.

Type Parameters:

E - type of entity

Parameters:

listComponent - list component

removeSelected

public <E> void removeSelected(ListComponent<E> target)

Removes selected items from the list component with confirmation dialog.
After confirmation removes items from DB if the bound container is not nested.

Type Parameters:

E - entity type

Parameters:

target - list component

excludeSelected

public <E> void excludeSelected(ListComponent<E> target)

Excludes selected items from the list component without confirmation. Works with nested containers only.

Type Parameters:

E - entity type

Parameters:

target - list component

triggerAction

protected <E> void triggerAction(RemoveOperation.RemoveBuilder<E> builder)

performAction

protected <E> void performAction(RemoveOperation.RemoveBuilder<E> builder,
 List<E> selectedItems)

removeItems

protected <E> void removeItems(RemoveOperation.RemoveBuilder<E> builder,
 List<E> selectedItems)

focusListComponent

protected <E> void focusListComponent(RemoveOperation.RemoveBuilder<E> builder)

commitIfNeeded

protected void commitIfNeeded(Collection<?> entitiesToRemove,
 CollectionContainer container,
 ScreenData screenData)

excludeItems

protected <E> void excludeItems(RemoveOperation.RemoveBuilder<E> builder,
 List<E> selectedItems)

getCollectionContainer

protected <E> CollectionContainer<E> getCollectionContainer(RemoveOperation.RemoveBuilder<E> builder)

performActionWithConfirmation

protected <E> void performActionWithConfirmation(RemoveOperation.RemoveBuilder<E> builder,
 List<E> selectedItems)