Package io.jmix.flowui.util

Class RemoveOperation.RemoveBuilder<E>

java.lang.Object

io.jmix.flowui.util.RemoveOperation.RemoveBuilder<E>

Type Parameters:

E - entity type

Enclosing class:

RemoveOperation

public static class RemoveOperation.RemoveBuilder<E>
extends Object

Remove builder.

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<RemoveOperation.ActionCancelledEvent<E>>	actionCancelledHandler
protected Consumer<RemoveOperation.AfterActionPerformedEvent<E>>	afterActionPerformedHandler
protected Consumer<RemoveOperation.BeforeActionPerformedEvent<E>>	beforeActionPerformedHandler
protected boolean	confirmation
protected String	confirmationMessage
protected String	confirmationTitle
protected CollectionContainer<E>	container
protected final Class<E>	entityClass
protected final Consumer<RemoveOperation.RemoveBuilder<E>>	handler
protected List<E>	items
protected ListDataComponent<E>	listDataComponent
protected RemoveOperation.Operation	operation
protected final View<?>	origin
protected Consumer<Collection<E>>	removeDelegate

Constructor Summary

Constructors

Constructor	Description
RemoveBuilder(View<?> origin, Class<E> entityClass, Consumer<RemoveOperation.RemoveBuilder<E>> actionHandler)

Method Summary

Modifier and Type	Method	Description
RemoveOperation.RemoveBuilder<E>	afterActionPerformed(Consumer<RemoveOperation.AfterActionPerformedEvent<E>> handler)
RemoveOperation.RemoveBuilder<E>	beforeActionPerformed(Consumer<RemoveOperation.BeforeActionPerformedEvent<E>> handler)
void	exclude()	Excludes items from relation: One-To-Many or Many-To-Many.
Consumer<RemoveOperation.ActionCancelledEvent<E>>	getActionCancelledHandler()
Consumer<RemoveOperation.AfterActionPerformedEvent<E>>	getAfterActionPerformedHandler()
Consumer<RemoveOperation.BeforeActionPerformedEvent<E>>	getBeforeActionPerformedHandler()
String	getConfirmationMessage()
String	getConfirmationTitle()
CollectionContainer<E>	getContainer()
Class<E>	getEntityClass()
List<E>	getItems()
ListDataComponent<E>	getListDataComponent()
RemoveOperation.Operation	getOperation()
View<?>	getOrigin()
boolean	isConfirmationRequired()
RemoveOperation.RemoveBuilder<E>	onCancel(Consumer<RemoveOperation.ActionCancelledEvent<E>> handler)
void	remove()	Removes items.
RemoveOperation.RemoveBuilder<E>	withConfirmation(boolean confirmation)	Sets whether to ask confirmation from the user.
RemoveOperation.RemoveBuilder<E>	withConfirmationMessage(String confirmationMessage)	Sets confirmation dialog message.
RemoveOperation.RemoveBuilder<E>	withConfirmationTitle(String confirmationTitle)	Sets confirmation dialog title.
RemoveOperation.RemoveBuilder<E>	withContainer(CollectionContainer<E> container)
RemoveOperation.RemoveBuilder<E>	withItems(List<E> items)
RemoveOperation.RemoveBuilder<E>	withListDataComponent(ListDataComponent<E> listDataComponent)
RemoveOperation.RemoveBuilder<E>	withRemoveDelegate(Consumer<Collection<E>> removeDelegate)	Sets the delegate to be invoked instead of DataManager to remove the entities from a storage.

Methods inherited from class java.lang.Object

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

Field Details

origin

protected final View<?> origin

entityClass

protected final Class<E> entityClass

handler

protected final Consumer<RemoveOperation.RemoveBuilder<E>> handler

operation

protected RemoveOperation.Operation operation

listDataComponent

protected ListDataComponent<E> listDataComponent

container

protected CollectionContainer<E> container

items

protected List<E> items

confirmation

protected boolean confirmation

confirmationMessage

protected String confirmationMessage

confirmationTitle

protected String confirmationTitle

beforeActionPerformedHandler

protected Consumer<RemoveOperation.BeforeActionPerformedEvent<E>> beforeActionPerformedHandler

afterActionPerformedHandler

protected Consumer<RemoveOperation.AfterActionPerformedEvent<E>> afterActionPerformedHandler

actionCancelledHandler

protected Consumer<RemoveOperation.ActionCancelledEvent<E>> actionCancelledHandler

removeDelegate

protected Consumer<Collection<E>> removeDelegate

Constructor Details

RemoveBuilder

public RemoveBuilder(View<?> origin,
 Class<E> entityClass,
 Consumer<RemoveOperation.RemoveBuilder<E>> actionHandler)

Method Details

withListDataComponent

public RemoveOperation.RemoveBuilder<E> withListDataComponent(ListDataComponent<E> listDataComponent)

withContainer

public RemoveOperation.RemoveBuilder<E> withContainer(CollectionContainer<E> container)

withItems

public RemoveOperation.RemoveBuilder<E> withItems(List<E> items)

withConfirmation

public RemoveOperation.RemoveBuilder<E> withConfirmation(boolean confirmation)

Sets whether to ask confirmation from the user.

withConfirmationMessage

public RemoveOperation.RemoveBuilder<E> withConfirmationMessage(String confirmationMessage)

Sets confirmation dialog message.

withConfirmationTitle

public RemoveOperation.RemoveBuilder<E> withConfirmationTitle(String confirmationTitle)

Sets confirmation dialog title.

beforeActionPerformed

public RemoveOperation.RemoveBuilder<E> beforeActionPerformed(Consumer<RemoveOperation.BeforeActionPerformedEvent<E>> handler)

afterActionPerformed

public RemoveOperation.RemoveBuilder<E> afterActionPerformed(Consumer<RemoveOperation.AfterActionPerformedEvent<E>> handler)

onCancel

public RemoveOperation.RemoveBuilder<E> onCancel(Consumer<RemoveOperation.ActionCancelledEvent<E>> handler)

withRemoveDelegate

public RemoveOperation.RemoveBuilder<E> withRemoveDelegate(Consumer<Collection<E>> removeDelegate)

Sets the delegate to be invoked instead of DataManager to remove the entities from a storage.

getListDataComponent

@Nullable
public ListDataComponent<E> getListDataComponent()

getContainer

@Nullable
public CollectionContainer<E> getContainer()

getItems

@Nullable
public List<E> getItems()

getConfirmationTitle

@Nullable
public String getConfirmationTitle()

getConfirmationMessage

@Nullable
public String getConfirmationMessage()

isConfirmationRequired

public boolean isConfirmationRequired()

getOrigin

public View<?> getOrigin()

getEntityClass

public Class<E> getEntityClass()

getOperation

public RemoveOperation.Operation getOperation()

getBeforeActionPerformedHandler

@Nullable
public Consumer<RemoveOperation.BeforeActionPerformedEvent<E>> getBeforeActionPerformedHandler()

getAfterActionPerformedHandler

@Nullable
public Consumer<RemoveOperation.AfterActionPerformedEvent<E>> getAfterActionPerformedHandler()

getActionCancelledHandler

@Nullable
public Consumer<RemoveOperation.ActionCancelledEvent<E>> getActionCancelledHandler()

exclude

public void exclude()

Excludes items from relation: One-To-Many or Many-To-Many.

remove

public void remove()

Removes items.