de.hybris.platform.hmc.generic

Class AbstractActionChip<T extends HMCAction>

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.generic.AbstractActionChip<T>

All Implemented Interfaces:

Chip, Serializable, Cloneable

Direct Known Subclasses:

ItemActionChip, SearchResultActionChip, ToolbarActionChip

public abstract class AbstractActionChip<T extends HMCAction>
extends AbstractChip

Superclass of all ActionChips.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ACTION_DISABLED_ICON
static String	DEFAULT_ACTION_ICON
static String	PERFORM

Fields inherited from class de.hybris.platform.hmc.webchips.AbstractChip

CHIP_KEY, FALSE, FRAME_KEY, SHOW_JSP_COMMENTS, TRUE, USE_SOCKET_NAMING

Fields inherited from interface de.hybris.platform.hmc.webchips.Chip

DISPLAY_EVENT, FILTERED_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractActionChip(DisplayState displayState, Chip parent, String name, T action) Creates a new instance of AbstractActionChip
AbstractActionChip(DisplayState displayState, Chip parent, String name, T action, String icon, String disabledIcon) Creates a new instance of AbstractActionChip

Method Summary

Modifier and Type	Method and Description
protected abstract ActionEvent	createActionEvent() Provides a action event for the next execution.
T	getAction()
String	getConfirmationMessage()
String	getDisabledIcon()
String	getIcon()
String	getName()
String	getPerformCommandID()
String	getTooltip()
boolean	isActive()
boolean	needsConfirmation()
ActionResult	performAction() Executes the actual action by calling HMCAction.perform(ActionEvent).
void	processEvents(Map<String,List<String>> events) Handles all incoming requests for this chip.
protected void	refresh(ActionResult result) Does nothing right now.
void	setName(String name)
void	setTooltip(String tooltip)
protected void	showActionResult(ActionResult result)

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip

addEventListener, checkValid, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getMenuEntries, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueName, getProposedUniqueNameFor, getRequestFocus, getSessionIdentifier, getStringValue, getUniqueName, getWindow, goFullScreen, hasVisibleContextMenuEntries, isButtonPushed, isButtonPushed, isErrorQueueEmpty, isValid, leaveFullScreen, notifyEventListeners, notifyEventListeners, postErrorMessage, postInfoMessage, postWindowEvent, refresh, refreshChild, registerUniqueName, removeEventListener, removeInfoMessage, render, render, setClipboard, setParent, setRequestFocus, setValid, setWindowStatus, translateFormFieldToEventName, translateFormFieldToEventValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.hmc.webchips.Chip

getJSPURI

Field Detail

PERFORM

public static final String PERFORM

See Also:

Constant Field Values

DEFAULT_ACTION_ICON

public static final String DEFAULT_ACTION_ICON

See Also:

Constant Field Values

DEFAULT_ACTION_DISABLED_ICON

public static final String DEFAULT_ACTION_DISABLED_ICON

See Also:

Constant Field Values

Constructor Detail

AbstractActionChip

public AbstractActionChip(DisplayState displayState,
                          Chip parent,
                          String name,
                          T action)

Creates a new instance of AbstractActionChip

AbstractActionChip

public AbstractActionChip(DisplayState displayState,
                          Chip parent,
                          String name,
                          T action,
                          String icon,
                          String disabledIcon)

Creates a new instance of AbstractActionChip

Method Detail

getAction

public T getAction()

processEvents

public void processEvents(Map<String,List<String>> events)

Handles all incoming requests for this chip. Map contains name (String) and value (List of Strings)

getPerformCommandID

public String getPerformCommandID()

createActionEvent

protected abstract ActionEvent createActionEvent()

Provides a action event for the next execution.

refresh

protected void refresh(ActionResult result)

Does nothing right now.

Parameters:

result - the current action result

performAction

public ActionResult performAction()

Executes the actual action by calling HMCAction.perform(ActionEvent).

isActive

public boolean isActive()

setName

public void setName(String name)

needsConfirmation

public boolean needsConfirmation()

getConfirmationMessage

public String getConfirmationMessage()

getName

public String getName()

getIcon

public String getIcon()

getDisabledIcon

public String getDisabledIcon()

getTooltip

public String getTooltip()

Since:

2.20

setTooltip

public void setTooltip(String tooltip)

Since:

2.20

showActionResult

protected void showActionResult(ActionResult result)