Package com.hybris.cockpitng.actions.toggle

Class AbstractToggleActionRenderer

java.lang.Object

com.hybris.cockpitng.actions.impl.DefaultActionRenderer<INPUT,OUTPUT>

com.hybris.cockpitng.actions.AbstractStatefulActionRenderer<java.lang.Object,java.lang.Object>

com.hybris.cockpitng.actions.toggle.AbstractToggleActionRenderer

All Implemented Interfaces:

CockpitActionRenderer<java.lang.Object,java.lang.Object>

Direct Known Subclasses:

FlexibleSidebarToggleActionRenderer, ToggleActionRenderer

public abstract class AbstractToggleActionRenderer
extends AbstractStatefulActionRenderer<java.lang.Object,java.lang.Object>

Nested Class Summary

Nested classes/interfaces inherited from class com.hybris.cockpitng.actions.impl.DefaultActionRenderer

DefaultActionRenderer.DefaultActionRendererEventListener<T extends org.zkoss.zk.ui.event.Event>

Field Summary

Fields inherited from class com.hybris.cockpitng.actions.impl.DefaultActionRenderer

LABEL_CONTAINER_SCLASS, tooltipText

Constructor Summary

Constructors

Constructor	Description
AbstractToggleActionRenderer()

Method Summary

Modifier and Type	Method	Description
protected void	addToggleListener(Action action, WidgetInstanceManager wim, ActionContext<java.lang.Object> context)
protected org.zkoss.zk.ui.event.EventListener<SocketEvent>	createToggleListener(Action parent, ActionContext<java.lang.Object> context)
protected abstract boolean	getDefaultActiveState(ActionContext<java.lang.Object> context)
protected abstract java.lang.Object	getOutputValue(ActionContext<java.lang.Object> ctx)	Reads action's value
protected abstract java.lang.String	getToggleInput(ActionContext<java.lang.Object> context)
protected void	initializeState(ActionContext<java.lang.Object> context)	Initializes an action state (active/inactive).
protected org.zkoss.zk.ui.event.EventListener<SocketEvent>	initializeToggleListener(Action action, ActionContext<java.lang.Object> context)
protected abstract boolean	isActionActivated(ActionContext<java.lang.Object> context, java.lang.Object inputData)
protected boolean	isActive(ActionContext<java.lang.Object> context)	Checks if action is currently active
protected abstract boolean	isInputConfigured(ActionContext<java.lang.Object> context)
void	render(org.zkoss.zk.ui.Component parent, CockpitAction<java.lang.Object,java.lang.Object> action, ActionContext<java.lang.Object> context, boolean updateMode, ActionListener<java.lang.Object> listener)
protected void	updateActiveSClasses(org.zkoss.zk.ui.HtmlBasedComponent component, boolean active)

Methods inherited from class com.hybris.cockpitng.actions.AbstractStatefulActionRenderer

addStateSocketListener, createStateSocketListener, getValue, initializeStateSocketListener, setValue

Methods inherited from class com.hybris.cockpitng.actions.impl.DefaultActionRenderer

addEventListener, addKeyboardSupport, adjustUri, checkDataCompatibleWithDefinedInput, createEventListener, createYTestId, extractIconDisabledUri, extractIconHoverUri, extractIconUri, extractKeyEvent, findActionComponent, findGroupComponent, findParentComponent, getActionBodySclass, getIconHoverUri, getIconUri, getKeyboardSupportService, getLocalizedName, getOrCreateContainer, getOrCreateIcon, getOrCreateIcon, getOrCreateLabel, getOrCreateLabel, getTooltipText, getToolTipWithCtrlKeysText, loadFromParentModel, perform, performWithConfirmationCheck, registerHoverEventsOnContainer, removeEventListeners, removeEventListeners, removeIcon, removeLabel, setTooltipText, storeInParentModel, triggerFromKeyEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractToggleActionRenderer

public AbstractToggleActionRenderer()

Method Detail

render

public void render(org.zkoss.zk.ui.Component parent,
                   CockpitAction<java.lang.Object,java.lang.Object> action,
                   ActionContext<java.lang.Object> context,
                   boolean updateMode,
                   ActionListener<java.lang.Object> listener)

Specified by:

render in interface CockpitActionRenderer<java.lang.Object,java.lang.Object>

Overrides:

render in class DefaultActionRenderer<java.lang.Object,java.lang.Object>

initializeState

protected void initializeState(ActionContext<java.lang.Object> context)

Initializes an action state (active/inactive). Action state is automatically stored in widget's model.

Parameters:

context - action context

getDefaultActiveState

protected abstract boolean getDefaultActiveState(ActionContext<java.lang.Object> context)

Parameters:

context - action context

Returns:

starting state of action

getOutputValue

protected abstract java.lang.Object getOutputValue(ActionContext<java.lang.Object> ctx)

Reads action's value

Parameters:

ctx - action context

Returns:

a value that will be sent on action perform

isActive

protected boolean isActive(ActionContext<java.lang.Object> context)

Checks if action is currently active

Parameters:

context - action context

Returns:

true if action is currently in active state

updateActiveSClasses

protected void updateActiveSClasses(org.zkoss.zk.ui.HtmlBasedComponent component,
                                    boolean active)

isActionActivated

protected abstract boolean isActionActivated(ActionContext<java.lang.Object> context,
                                             java.lang.Object inputData)

isInputConfigured

protected abstract boolean isInputConfigured(ActionContext<java.lang.Object> context)

getToggleInput

protected abstract java.lang.String getToggleInput(ActionContext<java.lang.Object> context)

addToggleListener

protected void addToggleListener(Action action,
                                 WidgetInstanceManager wim,
                                 ActionContext<java.lang.Object> context)

initializeToggleListener

protected org.zkoss.zk.ui.event.EventListener<SocketEvent> initializeToggleListener(Action action,
                                                                                    ActionContext<java.lang.Object> context)

createToggleListener

protected org.zkoss.zk.ui.event.EventListener<SocketEvent> createToggleListener(Action parent,
                                                                                ActionContext<java.lang.Object> context)