AbstractToggleAction (cockpitng 20.05.0-RC3 API)

java.lang.Object
- com.hybris.cockpitng.engine.impl.AbstractComponentWidgetAdapterAware
- - com.hybris.cockpitng.actions.AbstractStatefulAction<java.lang.Object,java.lang.Object>
  - - com.hybris.cockpitng.actions.toggle.AbstractToggleAction

All Implemented Interfaces:

CockpitAction<java.lang.Object,java.lang.Object>, ComponentWidgetAdapterAware

Direct Known Subclasses:

FlexibleSidebarToggleAction, ToggleAction
```
public abstract class AbstractToggleAction
extends AbstractStatefulAction<java.lang.Object,java.lang.Object>
```

Field Summary

Fields
Modifier and Type Field Description

protected static java.lang.String MODEL_ACTIVE

protected static java.lang.String MODEL_VALUE

Constructor Summary

Constructors
Constructor Description

AbstractToggleAction()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract java.lang.String`	`getOutputSocket(ActionContext<java.lang.Object> ctx)`
`ActionResult<java.lang.Object>`	`perform(ActionContext<java.lang.Object> ctx)`	Performs the action.
`protected java.lang.Object`	`restoreOutputValue(ActionContext<java.lang.Object> ctx)`	Reads action's output value from parent's widget model.

Methods inherited from class com.hybris.cockpitng.actions.AbstractStatefulAction
getActionUID, getValue, restoreModelValue, setValue, storeModelValue

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

Methods inherited from interface com.hybris.cockpitng.actions.CockpitAction
canPerform, getConfirmationMessage, needsConfirmation

- Field Detail
  - MODEL_VALUE
```
protected static final java.lang.String MODEL_VALUE
```
    See Also:
    
    Constant Field Values
  - MODEL_ACTIVE
```
protected static final java.lang.String MODEL_ACTIVE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractToggleAction
```
public AbstractToggleAction()
```
- Method Detail
  - perform
```
public ActionResult<java.lang.Object> perform(ActionContext<java.lang.Object> ctx)
```
    Description copied from interface: CockpitAction
    
    Performs the action.
    
    Parameters:
    
    ctx - context containing the data and other information
    
    Returns:
    
    the action result
  - restoreOutputValue
```
protected java.lang.Object restoreOutputValue(ActionContext<java.lang.Object> ctx)
```
    Reads action's output value from parent's widget model.
    
    Parameters:
    
    ctx - action context
    
    Returns:
    
    value read from model
  - getOutputSocket
```
protected abstract java.lang.String getOutputSocket(ActionContext<java.lang.Object> ctx)
```
    Parameters:
    
    ctx - action context
    
    Returns:
    
    name of output socket for action value