com.hybris.cockpitng.actions.impl

Class DefaultActionRenderer<I,O>

java.lang.Object

com.hybris.cockpitng.actions.impl.DefaultActionRenderer<I,O>

All Implemented Interfaces:

CockpitActionRenderer<I,O>

Direct Known Subclasses:

AbstractStatefulActionRenderer, CreateActionRenderer, CreatePermissionActionRenderer, DragAndDropConfigActionRenderer, LogoAction, MessageActionRenderer, SplitLayoutChooserActionRenderer

public class DefaultActionRenderer<I,O>
extends Object
implements CockpitActionRenderer<I,O>

Default renderer for cockpit action. Shows an icon (action icon uri) with tooltip text (action name).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	DefaultActionRenderer.DefaultActionRendererEventListener<T extends org.zkoss.zk.ui.event.Event> Marker interface for events created by action renderer.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	tooltipText

Constructor Summary

Constructors

Constructor and Description
DefaultActionRenderer()

Method Summary

Modifier and Type	Method and Description
protected void	addEventListener(org.zkoss.zk.ui.Component container, org.zkoss.zk.ui.event.EventListener<? extends org.zkoss.zk.ui.event.Event> eventListener)
protected void	addKeyboardSupport(org.zkoss.zk.ui.Component component, CockpitAction<I,O> cockpitAction, ActionContext<I> ctx, org.zkoss.zk.ui.event.EventListener onClickEventListener)
protected String	adjustUri(ActionContext<I> context, String uri)
protected boolean	checkDataCompatibleWithDefinedInput(CockpitAction<I,O> action, ActionContext<I> context)
protected org.zkoss.zk.ui.event.EventListener<? extends org.zkoss.zk.ui.event.Event>	createEventListener(CockpitAction<I,O> action, ActionContext<I> context, ActionListener<O> listener)
protected String	createYTestId(ActionContext<I> context) Creates a default ytestid
protected String	extractIconDisabledUri(ActionContext<I> context)
protected String	extractIconHoverUri(ActionContext<I> context)
protected String	extractIconUri(ActionContext<I> context)
protected org.zkoss.zk.ui.event.KeyEvent	extractKeyEvent(org.zkoss.zk.ui.event.Event event) Extracts KeyEvent from given event.
protected org.zkoss.zk.ui.HtmlBasedComponent	findActionComponent(org.zkoss.zk.ui.Component component)
protected org.zkoss.zk.ui.HtmlBasedComponent	findGroupComponent(org.zkoss.zk.ui.Component component)
protected <C extends org.zkoss.zk.ui.Component> C	findParentComponent(org.zkoss.zk.ui.Component component, Class<C> clazz)
protected String	getActionBodySclass(ActionContext<I> context) Creates a default sclass
protected String	getIconHoverUri(ActionContext<I> context, boolean canPerform)
protected String	getIconUri(ActionContext<I> context, boolean canPerform)
KeyboardSupportService	getKeyboardSupportService()
protected String	getLocalizedName(ActionContext<?> context)
protected org.zkoss.zk.ui.HtmlBasedComponent	getOrCreateContainer(org.zkoss.zk.ui.Component parent)
protected org.zkoss.zul.Image	getOrCreateIcon(org.zkoss.zk.ui.Component container)
protected org.zkoss.zul.Label	getOrCreateLabel(org.zkoss.zk.ui.Component container)
String	getTooltipText()
protected String	getToolTipWithCtrlKeysText(String toolTipToDecorate, ActionContext<I> ctx)
protected <T> T	loadFromParentModel(ActionContext<?> context, String key, Class<T> _clazz)
protected void	perform(CockpitAction<I,O> action, ActionContext<I> context, ActionListener<O> listener)
protected void	performWithConfirmationCheck(CockpitAction<I,O> action, ActionContext<I> context, ActionListener<O> listener)
protected void	registerHoverEventsOnContainer(org.zkoss.zk.ui.HtmlBasedComponent container, org.zkoss.zul.Image icon, boolean showIcon, String iconUri, String iconHoverUri)
protected void	removeEventListeners(org.zkoss.zk.ui.Component container, String eventName) Removes all even listeners of a given type from the container if they are assignable from com.hybris.cockpitng.actions.impl.DefaultActionRenderer.DefaultActionRendererEventListener.
protected void	removeEventListeners(org.zkoss.zk.ui.Component container, String eventName, Class type) Removes all even listeners of a given type from the container if they are assignable from the given type.
protected void	removeIcon(org.zkoss.zk.ui.Component container)
protected void	removeLabel(org.zkoss.zk.ui.Component container)
void	render(org.zkoss.zk.ui.Component parent, CockpitAction<I,O> action, ActionContext<I> context, boolean updateMode, ActionListener<O> listener)
void	setTooltipText(String tooltipText)
protected void	storeInParentModel(Object value, ActionContext<?> context, String key)
protected void	triggerFromKeyEvent(org.zkoss.zk.ui.event.KeyEvent keyEvent, CockpitAction<I,O> cockpitAction, ActionContext<I> ctx, org.zkoss.zk.ui.Component container, org.zkoss.zk.ui.event.EventListener onClickEventListener)

Methods inherited from class java.lang.Object

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

Field Detail

tooltipText

protected String tooltipText

Constructor Detail

DefaultActionRenderer

public DefaultActionRenderer()

Method Detail

render

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

Specified by:

render in interface CockpitActionRenderer<I,O>

checkDataCompatibleWithDefinedInput

protected boolean checkDataCompatibleWithDefinedInput(CockpitAction<I,O> action,
                                                      ActionContext<I> context)

getTooltipText

public String getTooltipText()

setTooltipText

public void setTooltipText(String tooltipText)

registerHoverEventsOnContainer

protected void registerHoverEventsOnContainer(org.zkoss.zk.ui.HtmlBasedComponent container,
                                              org.zkoss.zul.Image icon,
                                              boolean showIcon,
                                              String iconUri,
                                              String iconHoverUri)

removeEventListeners

protected void removeEventListeners(org.zkoss.zk.ui.Component container,
                                    String eventName)

Removes all even listeners of a given type from the container if they are assignable from com.hybris.cockpitng.actions.impl.DefaultActionRenderer.DefaultActionRendererEventListener.

Parameters:

container - a component from which the listeners should be removed

eventName - name of the event on which the listeners are registered

See Also:

DefaultActionRenderer.DefaultActionRendererEventListener

removeEventListeners

protected void removeEventListeners(org.zkoss.zk.ui.Component container,
                                    String eventName,
                                    Class type)

Removes all even listeners of a given type from the container if they are assignable from the given type.

Parameters:

container - a component from which the listeners should be removed

eventName - name of the event on which the listeners are registered

type - type to which the target listeners should be assignable

createYTestId

protected String createYTestId(ActionContext<I> context)

Creates a default ytestid

Returns:

ytestid

getActionBodySclass

protected String getActionBodySclass(ActionContext<I> context)

Creates a default sclass

Returns:

default sclass

perform

protected void perform(CockpitAction<I,O> action,
                       ActionContext<I> context,
                       ActionListener<O> listener)

performWithConfirmationCheck

protected void performWithConfirmationCheck(CockpitAction<I,O> action,
                                            ActionContext<I> context,
                                            ActionListener<O> listener)

getOrCreateContainer

protected org.zkoss.zk.ui.HtmlBasedComponent getOrCreateContainer(org.zkoss.zk.ui.Component parent)

getOrCreateIcon

protected org.zkoss.zul.Image getOrCreateIcon(org.zkoss.zk.ui.Component container)

removeIcon

protected void removeIcon(org.zkoss.zk.ui.Component container)

getOrCreateLabel

protected org.zkoss.zul.Label getOrCreateLabel(org.zkoss.zk.ui.Component container)

removeLabel

protected void removeLabel(org.zkoss.zk.ui.Component container)

addKeyboardSupport

protected void addKeyboardSupport(org.zkoss.zk.ui.Component component,
                                  CockpitAction<I,O> cockpitAction,
                                  ActionContext<I> ctx,
                                  org.zkoss.zk.ui.event.EventListener onClickEventListener)

getToolTipWithCtrlKeysText

protected String getToolTipWithCtrlKeysText(String toolTipToDecorate,
                                            ActionContext<I> ctx)

extractKeyEvent

protected org.zkoss.zk.ui.event.KeyEvent extractKeyEvent(org.zkoss.zk.ui.event.Event event)

Extracts KeyEvent from given event.

Parameters:

event - event to cast.

Returns:

KeyEvent or null if given event is not KeyEvent nor Forward Event with origin KeyEvent

triggerFromKeyEvent

protected void triggerFromKeyEvent(org.zkoss.zk.ui.event.KeyEvent keyEvent,
                                   CockpitAction<I,O> cockpitAction,
                                   ActionContext<I> ctx,
                                   org.zkoss.zk.ui.Component container,
                                   org.zkoss.zk.ui.event.EventListener onClickEventListener)

createEventListener

protected org.zkoss.zk.ui.event.EventListener<? extends org.zkoss.zk.ui.event.Event> createEventListener(CockpitAction<I,O> action,
                                                                                                         ActionContext<I> context,
                                                                                                         ActionListener<O> listener)

addEventListener

protected void addEventListener(org.zkoss.zk.ui.Component container,
                                org.zkoss.zk.ui.event.EventListener<? extends org.zkoss.zk.ui.event.Event> eventListener)

getIconHoverUri

protected String getIconHoverUri(ActionContext<I> context,
                                 boolean canPerform)

getIconUri

protected String getIconUri(ActionContext<I> context,
                            boolean canPerform)

extractIconUri

protected String extractIconUri(ActionContext<I> context)

extractIconHoverUri

protected String extractIconHoverUri(ActionContext<I> context)

extractIconDisabledUri

protected String extractIconDisabledUri(ActionContext<I> context)

adjustUri

protected String adjustUri(ActionContext<I> context,
                           String uri)

getLocalizedName

protected String getLocalizedName(ActionContext<?> context)

storeInParentModel

protected void storeInParentModel(Object value,
                                  ActionContext<?> context,
                                  String key)

loadFromParentModel

protected <T> T loadFromParentModel(ActionContext<?> context,
                                    String key,
                                    Class<T> _clazz)

findParentComponent

protected <C extends org.zkoss.zk.ui.Component> C findParentComponent(org.zkoss.zk.ui.Component component,
                                                                      Class<C> clazz)

findActionComponent

protected org.zkoss.zk.ui.HtmlBasedComponent findActionComponent(org.zkoss.zk.ui.Component component)

findGroupComponent

protected org.zkoss.zk.ui.HtmlBasedComponent findGroupComponent(org.zkoss.zk.ui.Component component)

getKeyboardSupportService

public KeyboardSupportService getKeyboardSupportService()