info.magnolia.ui.framework.action

Class ConfirmationAction<D extends ConfirmationActionDefinition>

java.lang.Object

info.magnolia.ui.api.action.AbstractAction<D>

info.magnolia.ui.framework.action.ConfirmationAction<D>

Type Parameters:

D - ConfirmationActionDefinition.

All Implemented Interfaces:

Action

Direct Known Subclasses:

DeleteConfirmationAction

public class ConfirmationAction<D extends ConfirmationActionDefinition>
extends AbstractAction<D>

Configurable confirmation action. Can be used to intercept the actual action with user feedback. Allows configuration of a success action and a cancel action.

Constructor Summary

Constructors

Constructor and Description
ConfirmationAction(D definition, com.vaadin.data.Item item, UiContext uiContext, ActionExecutor actionExecutor, info.magnolia.i18nsystem.SimpleTranslator i18n, ContentConnector contentConnector)
ConfirmationAction(D definition, List<? extends com.vaadin.data.Item> items, UiContext uiContext, ActionExecutor actionExecutor, info.magnolia.i18nsystem.SimpleTranslator i18n, ContentConnector contentConnector)

Method Summary

Modifier and Type	Method and Description
void	execute() Executes the action.
protected String	getConfirmationHeader()
protected String	getConfirmationMessage()
protected com.vaadin.data.Item	getItem()
protected List<? extends com.vaadin.data.Item>	getItems()
protected String	getListOfItemPaths()
protected info.magnolia.i18nsystem.SimpleTranslator	getSimpleTranslator()
protected void	onError(Exception e) Class that implement CommansActionBase should use this in order to perform tasks or notification in case of error.

Methods inherited from class info.magnolia.ui.api.action.AbstractAction

getDefinition

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfirmationAction

public ConfirmationAction(D definition,
                          com.vaadin.data.Item item,
                          UiContext uiContext,
                          ActionExecutor actionExecutor,
                          info.magnolia.i18nsystem.SimpleTranslator i18n,
                          ContentConnector contentConnector)

ConfirmationAction

@Inject
public ConfirmationAction(D definition,
                                  List<? extends com.vaadin.data.Item> items,
                                  UiContext uiContext,
                                  ActionExecutor actionExecutor,
                                  info.magnolia.i18nsystem.SimpleTranslator i18n,
                                  ContentConnector contentConnector)

Method Detail

execute

public void execute()
             throws ActionExecutionException

Description copied from interface: Action

Executes the action.

Throws:

ActionExecutionException - if an error occurs performing the action

getConfirmationHeader

protected String getConfirmationHeader()
                                throws Exception

Throws:

Exception

getConfirmationMessage

protected String getConfirmationMessage()
                                 throws Exception

Throws:

Exception

getListOfItemPaths

protected String getListOfItemPaths()

onError

protected void onError(Exception e)

Class that implement CommansActionBase should use this in order to perform tasks or notification in case of error.

getItem

protected com.vaadin.data.Item getItem()

Returns:

the Item linked to this action. If this action is used for multi Item return null.

getItems

protected List<? extends com.vaadin.data.Item> getItems()

getSimpleTranslator

protected info.magnolia.i18nsystem.SimpleTranslator getSimpleTranslator()