Package io.jmix.flowui.util

Class RemoveOperation

java.lang.Object

io.jmix.flowui.util.RemoveOperation

@Component("flowui_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, Screen) 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

Constructor Summary

Constructors

Constructor	Description
RemoveOperation()

Method Summary

Modifier and Type	Method	Description
<E> RemoveOperation.RemoveBuilder<E>	builder(ListDataComponent<E> listDataComponent)	Creates a remove builder using ListDataComponent component.
<E> RemoveOperation.RemoveBuilder<E>	builder(Class<E> entityClass, Screen 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(ListDataComponent<E> listDataComponent)	Excludes selected items from the ListDataComponent component without confirmation.
protected <E> void	focusListDataComponent(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(ListDataComponent<E> listDataComponent)	Removes selected items from the ListDataComponent component with confirmation dialog.
void	setDataManager(DataManager dataManager)
void	setEntityStates(EntityStates entityStates)
void	setExtendedEntities(ExtendedEntities extendedEntities)
void	setMessages(Messages messages)
void	setMetadata(Metadata metadata)
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

dataManager

protected DataManager dataManager

messages

protected Messages messages

extendedEntities

protected ExtendedEntities extendedEntities

entityStates

protected EntityStates entityStates

metadata

protected Metadata metadata

Constructor Details

RemoveOperation

public RemoveOperation()

Method Details

setDataManager

@Autowired
public void setDataManager(DataManager dataManager)

setMessages

@Autowired
public void setMessages(Messages messages)

setExtendedEntities

@Autowired
public void setExtendedEntities(ExtendedEntities extendedEntities)

setEntityStates

@Autowired
public void setEntityStates(EntityStates entityStates)

setMetadata

@Autowired
public void setMetadata(Metadata metadata)

builder

public <E> RemoveOperation.RemoveBuilder<E> builder(Class<E> entityClass,
 Screen 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(ListDataComponent<E> listDataComponent)

Creates a remove builder using ListDataComponent component.

Type Parameters:

E - type of entity

Parameters:

listDataComponent - list data component

removeSelected

public <E> void removeSelected(ListDataComponent<E> listDataComponent)

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

Type Parameters:

E - entity type

Parameters:

listDataComponent - list data component

excludeSelected

public <E> void excludeSelected(ListDataComponent<E> listDataComponent)

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

Type Parameters:

E - entity type

Parameters:

listDataComponent - list data 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)

focusListDataComponent

protected <E> void focusListDataComponent(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)