Package com.hybris.cockpitng.actions

Class ActionContext<I>

java.lang.Object

com.hybris.cockpitng.core.context.impl.DefaultCockpitContext

com.hybris.cockpitng.actions.ActionContext<I>

Type Parameters:

I - input type of the action

All Implemented Interfaces:

CockpitContext, java.io.Serializable

public class ActionContext<I>
extends DefaultCockpitContext

A context object given to a cockpit action to perform.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ACTION_UID
static java.lang.String	PARENT_WIDGET_MODEL
static java.lang.String	VIEW_MODE_PARAM
static java.lang.String	VIEWMODE_HIDDEN
static java.lang.String	VIEWMODE_ICONANDTEXT
static java.lang.String	VIEWMODE_ICONONLY
static java.lang.String	VIEWMODE_TEXTONLY

Constructor Summary

Constructors

Constructor	Description
ActionContext(ActionContext<I> context)
ActionContext(I data, ActionDefinition definition, java.util.Map<java.lang.String,java.lang.Object> parameters, java.util.Map<java.lang.String,java.lang.Object> labels)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCode()
I	getData()
ActionDefinition	getDefinition()
java.lang.String	getIconDisabledUri()
java.lang.String	getIconHoverUri()
java.lang.String	getIconUri()
java.lang.String	getLabel(java.lang.String key)
java.lang.String	getLabel(java.lang.String key, java.lang.Object[] args)
java.lang.String	getName()
java.lang.String	getTriggerOnKeys()
boolean	isHidden()
boolean	isShowIcon()
boolean	isShowIconAndText()
boolean	isShowText()
void	setData(I data)
void	setTriggerOnKeys(java.lang.String triggerOnKeys)

Methods inherited from class com.hybris.cockpitng.core.context.impl.DefaultCockpitContext

addAllParameters, clearParameters, containsParameter, getParameter, getParameterKeys, getParameters, removeParameter, setParameter, setParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hybris.cockpitng.core.context.CockpitContext

getParameterAsBoolean

Field Detail

VIEW_MODE_PARAM

public static final java.lang.String VIEW_MODE_PARAM

See Also:

Constant Field Values

VIEWMODE_ICONONLY

public static final java.lang.String VIEWMODE_ICONONLY

See Also:

Constant Field Values

VIEWMODE_ICONANDTEXT

public static final java.lang.String VIEWMODE_ICONANDTEXT

See Also:

Constant Field Values

VIEWMODE_TEXTONLY

public static final java.lang.String VIEWMODE_TEXTONLY

See Also:

Constant Field Values

VIEWMODE_HIDDEN

public static final java.lang.String VIEWMODE_HIDDEN

See Also:

Constant Field Values

PARENT_WIDGET_MODEL

public static final java.lang.String PARENT_WIDGET_MODEL

See Also:

Constant Field Values

ACTION_UID

public static final java.lang.String ACTION_UID

See Also:

Constant Field Values

Constructor Detail

ActionContext

public ActionContext(I data,
                     ActionDefinition definition,
                     java.util.Map<java.lang.String,java.lang.Object> parameters,
                     java.util.Map<java.lang.String,java.lang.Object> labels)

ActionContext

public ActionContext(ActionContext<I> context)

Method Detail

getData

public I getData()

setData

public void setData(I data)

isHidden

public boolean isHidden()

isShowIcon

public boolean isShowIcon()

isShowText

public boolean isShowText()

isShowIconAndText

public boolean isShowIconAndText()

getLabel

public java.lang.String getLabel(java.lang.String key)

getLabel

public java.lang.String getLabel(java.lang.String key,
                                 java.lang.Object[] args)

getCode

public java.lang.String getCode()

getName

public java.lang.String getName()

getIconUri

public java.lang.String getIconUri()

getIconDisabledUri

public java.lang.String getIconDisabledUri()

getIconHoverUri

public java.lang.String getIconHoverUri()

getTriggerOnKeys

public java.lang.String getTriggerOnKeys()

setTriggerOnKeys

public void setTriggerOnKeys(java.lang.String triggerOnKeys)

getDefinition

public ActionDefinition getDefinition()