com.haulmont.cuba.gui

Class RemoveOperation

java.lang.Object

com.haulmont.cuba.gui.RemoveOperation

@Component(value="cuba_RemoveHelper")
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>
static class	RemoveOperation.AfterActionPerformedEvent<E>
static class	RemoveOperation.BeforeActionPerformedEvent<E>
protected static class	RemoveOperation.Operation
static class	RemoveOperation.RemoveBuilder<E extends Entity> Remove builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected DataManager	dataManager
protected EntityStates	entityStates
protected ExtendedEntities	extendedEntities
protected Messages	messages
static java.lang.String	NAME
protected WindowConfig	windowConfig

Constructor Summary

Constructors

Constructor and Description
RemoveOperation()

Method Summary

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

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

windowConfig

@Inject
protected WindowConfig windowConfig

dataManager

@Inject
protected DataManager dataManager

messages

@Inject
protected Messages messages

extendedEntities

@Inject
protected ExtendedEntities extendedEntities

entityStates

@Inject
protected EntityStates entityStates

Constructor Detail

RemoveOperation

public RemoveOperation()

Method Detail

builder

public <E extends Entity> 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 extends Entity> 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 extends Entity> 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 extends Entity> 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 extends Entity> void triggerAction(RemoveOperation.RemoveBuilder<E> builder)

performAction

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

removeItems

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

focusListComponent

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

commitIfNeeded

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

excludeItems

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

getCollectionContainer

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

performActionWithConfirmation

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