com.hybris.cockpitng.actions.splitlayoutchooser

Class SplitLayoutChooserAction

java.lang.Object

com.hybris.cockpitng.engine.impl.AbstractComponentWidgetAdapterAware

com.hybris.cockpitng.actions.splitlayoutchooser.SplitLayoutChooserAction

All Implemented Interfaces:

CockpitAction<Object,Object>, ComponentWidgetAdapterAware

public class SplitLayoutChooserAction
extends AbstractComponentWidgetAdapterAware
implements CockpitAction<Object,Object>

Action responsible for choosing split layout compositions.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	SELECTED_LAYOUT_KEY

Constructor Summary

Constructors

Constructor and Description
SplitLayoutChooserAction()

Method Summary

Modifier and Type	Method and Description
boolean	canPerform(ActionContext<Object> ctx) Returns true if the action can be performed for the given context, false otherwise.
String	getConfirmationMessage(ActionContext<Object> ctx) Returns the confirmation message to be shown to the user in the confirmation dialog if confirmation is needed (see CockpitAction.needsConfirmation(ActionContext)).
boolean	needsConfirmation(ActionContext<Object> ctx) Returns true if the action should be confirmed by user before being performed, false otherwise.
ActionResult<Object>	perform(ActionContext<Object> ctx) Performs the action.

Methods inherited from class com.hybris.cockpitng.engine.impl.AbstractComponentWidgetAdapterAware

addSocketInputEventListener, getComponentID, handleSocketInputEvent, initialize, initializeDefaultEventListeners, registerStubInstance, sendOutput, setComponentID, unregisterStubInstance

Methods inherited from class java.lang.Object

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

Field Detail

SELECTED_LAYOUT_KEY

protected static final String SELECTED_LAYOUT_KEY

See Also:

Constant Field Values

Constructor Detail

SplitLayoutChooserAction

public SplitLayoutChooserAction()

Method Detail

perform

public ActionResult<Object> perform(ActionContext<Object> ctx)

Description copied from interface: CockpitAction

Performs the action.

Specified by:

perform in interface CockpitAction<Object,Object>

Parameters:

ctx - context containing the data and other information

Returns:

the action result

canPerform

public boolean canPerform(ActionContext<Object> ctx)

Description copied from interface: CockpitAction

Returns true if the action can be performed for the given context, false otherwise.

Specified by:

canPerform in interface CockpitAction<Object,Object>

Parameters:

ctx - context containing the data and other information

Returns:

true if the action can be performed for the given context, false otherwise

needsConfirmation

public boolean needsConfirmation(ActionContext<Object> ctx)

Description copied from interface: CockpitAction

Returns true if the action should be confirmed by user before being performed, false otherwise. This is evaluated by the action renderer.

Specified by:

needsConfirmation in interface CockpitAction<Object,Object>

Parameters:

ctx - context containing the data and other information

Returns:

true if the action should be confirmed by user before being performed, false otherwise

getConfirmationMessage

public String getConfirmationMessage(ActionContext<Object> ctx)

Description copied from interface: CockpitAction

Returns the confirmation message to be shown to the user in the confirmation dialog if confirmation is needed (see CockpitAction.needsConfirmation(ActionContext)).

Specified by:

getConfirmationMessage in interface CockpitAction<Object,Object>

Parameters:

ctx - context containing the data and other information

Returns:

the confirmation message to be shown to the user in the confirmation dialog

See Also:

CockpitAction.needsConfirmation(ActionContext)