io.jmix.ui

Class RemoveOperation

java.lang.Object

io.jmix.ui.RemoveOperation

@Component(value="ui_RemoveOperation")
public class RemoveOperation
extends java.lang.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 and 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 class	RemoveOperation.Operation
static class	RemoveOperation.RemoveBuilder<E> Remove builder.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RemoveOperation()

Method Summary

Modifier and Type	Method and Description
<E> RemoveOperation.RemoveBuilder<E>	builder(java.lang.Class<E> entityClass, FrameOwner origin) Creates a remove builder.
<E> RemoveOperation.RemoveBuilder<E>	builder(ListComponent<E> listComponent) Creates a remove builder using list component, e.g.
protected void	commitIfNeeded(java.util.Collection<?> entitiesToRemove, CollectionContainer container, ScreenData screenData)
protected <E> void	excludeItems(RemoveOperation.RemoveBuilder<E> builder, java.util.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, java.util.List<E> selectedItems)
protected <E> void	performActionWithConfirmation(RemoveOperation.RemoveBuilder<E> builder, java.util.List<E> selectedItems)
protected <E> void	removeItems(RemoveOperation.RemoveBuilder<E> builder, java.util.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 Detail

windowConfig

@Autowired
protected WindowConfig windowConfig

dataManager

@Autowired
protected io.jmix.core.DataManager dataManager

messages

@Autowired
protected io.jmix.core.Messages messages

extendedEntities

@Autowired
protected io.jmix.core.ExtendedEntities extendedEntities

entityStates

@Autowired
protected io.jmix.core.EntityStates entityStates

metadata

@Autowired
protected io.jmix.core.Metadata metadata

Constructor Detail

RemoveOperation

public RemoveOperation()

Method Detail

builder

public <E> RemoveOperation.RemoveBuilder<E> builder(java.lang.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,
                                 java.util.List<E> selectedItems)

removeItems

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

focusListComponent

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

commitIfNeeded

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

excludeItems

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

getCollectionContainer

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

performActionWithConfirmation

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