com.hybris.cockpitng.components

Class DefaultCockpitActionsRenderer

java.lang.Object

com.hybris.cockpitng.components.DefaultCockpitActionsRenderer

All Implemented Interfaces:

CockpitComponentsRenderer

Direct Known Subclasses:

VerticalCockpitActionsRenderer

public class DefaultCockpitActionsRenderer
extends Object
implements CockpitComponentsRenderer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	DefaultCockpitActionsRenderer.ExtendedActionGroupEventListener<E 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 static String	ACTION_GROUP_QUALIFIER
static String	DEFAULT_QUALIFIER
static String	SCALSS_YA_EXTENDED_GROUP_CNT
static String	SCALSS_YA_SPLIT_GROUP_CNT
static String	SCALSS_YA_THREE_DOTS_GROUP_CNT
static String	SCLASS_ACTION_GROUP_POPUP
static String	SCLASS_YA_ACTION_SELECTOR_BUTTON
static String	SCLASS_YA_THREE_DOTS_GROUP_POPUP
static String	YA_CNG_EXTENDED_ACTION_CONTAINER_HOVER

Constructor Summary

Constructors

Constructor and Description
DefaultCockpitActionsRenderer()

Method Summary

Modifier and Type	Method and Description
protected String	adjustUri(ActionContext context, String uri)
protected void	cleanUpActionComponents(AbstractCockpitElementsContainer parent, Set<org.zkoss.zk.ui.HtmlBasedComponent> groupContainers)
protected String	computeGroupQualifier(ActionGroup groupConfig)
protected org.zkoss.zul.Toolbarbutton	createToolbarbuttonForActionGroupSplit(org.zkoss.zul.Popup popup)
protected String	extractIconDisabledUri(ActionContext context)
protected String	extractIconHoverUri(ActionContext context)
protected String	extractIconUri(ActionContext context)
protected String	extractParam(Action action, String paramName)
protected Optional<Action>	findExtendedActionOnActionComponents(Action extendedAction, Collection<Action> actionComponents)
protected String	generateActionUID(AbstractCockpitElementsContainer parent, ActionGroup groupConfig, Action actionConfig)
protected Optional<Action>	getFirstFromActionComponents(Set<Action> actionComponents)
protected ActionGroup	getGroupConfig(Actions configuration, String groupId)
KeyboardSupportService	getKeyboardSupportService()
LabelService	getLabelService()
protected Optional<Action>	getLastFromActionComponents(Set<Action> actionComponents)
protected Action	getOrCreateActionComponent(AbstractCockpitElementsContainer elementsContainer, org.zkoss.zk.ui.Component parent, Action actionConfig, Set<Action> actionComponents)
protected org.zkoss.zk.ui.HtmlBasedComponent	getOrCreateGroupContainer(AbstractCockpitElementsContainer parent, ActionGroup groupConfig)
protected org.zkoss.zul.Label	getOrCreateGroupLabel(org.zkoss.zk.ui.Component container)
protected boolean	groupQualifierEquals(String quali1, String quali2)
protected boolean	isOnlyOneGroup(Actions actions)
protected void	processGroupHeader(AbstractCockpitElementsContainer parent, ActionGroup groupConfig, org.zkoss.zk.ui.HtmlBasedComponent container, boolean showGroupHeader)
protected void	registerHoverEventsOnContainer(org.zkoss.zk.ui.HtmlBasedComponent container, org.zkoss.zul.Image icon, String iconUri, String iconHoverUri)
protected void	removeChildActionsNonExistingInActionComponents(Set<Action> actionComponents, List<org.zkoss.zk.ui.Component> children)
protected void	removeEventListeners(org.zkoss.zk.ui.Component container, String eventName)
protected void	removeEventListeners(org.zkoss.zk.ui.Component container, String eventName, Class type)
protected void	removeGroupLabel(org.zkoss.zk.ui.Component container)
void	render(AbstractCockpitElementsContainer parent, Object configuration)
protected Action	renderAction(AbstractCockpitElementsContainer parent, Action actionContainer, Action actionConfig) Renders single action with viewMode inherited from parent Actions tag.
protected Action	renderAction(AbstractCockpitElementsContainer parent, Action actionContainer, Action actionConfig, String viewMode) Renders single action with given viewMode.
protected void	renderAction(AbstractCockpitElementsContainer parent, ActionGroup groupConfig, org.zkoss.zk.ui.HtmlBasedComponent container, Set<Action> actionComponents, Action actionConfig)
protected void	renderAction(AbstractCockpitElementsContainer parent, ActionGroup groupConfig, org.zkoss.zk.ui.HtmlBasedComponent container, Set<Action> actionComponents, Action actionConfig, String viewMode)
protected void	renderActionGroupExtended(AbstractCockpitElementsContainer parent, ActionGroupExtended groupConfig, org.zkoss.zk.ui.HtmlBasedComponent container, Set<Action> actionComponents)
protected void	renderActionGroupExtendedClickableArea(org.zkoss.zk.ui.HtmlBasedComponent container, org.zkoss.zul.Popup popup, Action action)
protected void	renderActionGroupSplit(AbstractCockpitElementsContainer parent, ActionGroupSplit groupConfig, org.zkoss.zk.ui.HtmlBasedComponent container, Set<Action> actionComponents)
protected void	renderActionGroupThreeDots(AbstractCockpitElementsContainer parent, ActionGroupThreeDots groupConfig, org.zkoss.zk.ui.HtmlBasedComponent container, Set<Action> actionComponents)
protected void	renderActionsForPopupInActionGroupSplit(AbstractCockpitElementsContainer parent, ActionGroupSplit groupConfig, Set<Action> actionComponents, org.zkoss.zul.Popup popup, List<Action> actionsForPopup)
protected void	renderAllGroups(AbstractCockpitElementsContainer parent, Set<org.zkoss.zk.ui.HtmlBasedComponent> groupContainers, Actions actions)
protected org.zkoss.zk.ui.HtmlBasedComponent	renderGroup(AbstractCockpitElementsContainer parent, ActionGroup groupConfig, boolean showGroupHeader)
protected void	renderGroupHeader(AbstractCockpitElementsContainer parent, ActionGroup groupConfig, org.zkoss.zk.ui.HtmlBasedComponent container)
protected void	renderPrimaryAction(AbstractCockpitElementsContainer parent, ActionGroupSplit groupConfig, Set<Action> actionComponents, org.zkoss.zul.Popup popup, Action primaryAction)
protected void	renderSingleGroup(AbstractCockpitElementsContainer parent, Set<org.zkoss.zk.ui.HtmlBasedComponent> groupContainers, Actions actions)
protected Action	resolvePrimaryAction(ActionGroupSplit groupConfig)
protected boolean	resolveShowGroupHeaderWhenManyGroups(ActionGroup actionGroup)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_QUALIFIER

public static final String DEFAULT_QUALIFIER

See Also:

Constant Field Values

SCLASS_YA_ACTION_SELECTOR_BUTTON

public static final String SCLASS_YA_ACTION_SELECTOR_BUTTON

See Also:

Constant Field Values

SCALSS_YA_EXTENDED_GROUP_CNT

public static final String SCALSS_YA_EXTENDED_GROUP_CNT

See Also:

Constant Field Values

SCALSS_YA_SPLIT_GROUP_CNT

public static final String SCALSS_YA_SPLIT_GROUP_CNT

See Also:

Constant Field Values

SCALSS_YA_THREE_DOTS_GROUP_CNT

public static final String SCALSS_YA_THREE_DOTS_GROUP_CNT

See Also:

Constant Field Values

SCLASS_ACTION_GROUP_POPUP

public static final String SCLASS_ACTION_GROUP_POPUP

See Also:

Constant Field Values

SCLASS_YA_THREE_DOTS_GROUP_POPUP

public static final String SCLASS_YA_THREE_DOTS_GROUP_POPUP

See Also:

Constant Field Values

YA_CNG_EXTENDED_ACTION_CONTAINER_HOVER

public static final String YA_CNG_EXTENDED_ACTION_CONTAINER_HOVER

See Also:

Constant Field Values

ACTION_GROUP_QUALIFIER

protected static final String ACTION_GROUP_QUALIFIER

See Also:

Constant Field Values

Constructor Detail

DefaultCockpitActionsRenderer

public DefaultCockpitActionsRenderer()

Method Detail

render

public void render(AbstractCockpitElementsContainer parent,
                   Object configuration)

Specified by:

render in interface CockpitComponentsRenderer

isOnlyOneGroup

protected boolean isOnlyOneGroup(Actions actions)

renderSingleGroup

protected void renderSingleGroup(AbstractCockpitElementsContainer parent,
                                 Set<org.zkoss.zk.ui.HtmlBasedComponent> groupContainers,
                                 Actions actions)

getGroupConfig

protected ActionGroup getGroupConfig(Actions configuration,
                                     String groupId)

renderAllGroups

protected void renderAllGroups(AbstractCockpitElementsContainer parent,
                               Set<org.zkoss.zk.ui.HtmlBasedComponent> groupContainers,
                               Actions actions)

resolveShowGroupHeaderWhenManyGroups

protected boolean resolveShowGroupHeaderWhenManyGroups(ActionGroup actionGroup)

renderGroup

protected org.zkoss.zk.ui.HtmlBasedComponent renderGroup(AbstractCockpitElementsContainer parent,
                                                         ActionGroup groupConfig,
                                                         boolean showGroupHeader)

renderActionGroupThreeDots

protected void renderActionGroupThreeDots(AbstractCockpitElementsContainer parent,
                                          ActionGroupThreeDots groupConfig,
                                          org.zkoss.zk.ui.HtmlBasedComponent container,
                                          Set<Action> actionComponents)

extractParam

protected String extractParam(Action action,
                              String paramName)

processGroupHeader

protected void processGroupHeader(AbstractCockpitElementsContainer parent,
                                  ActionGroup groupConfig,
                                  org.zkoss.zk.ui.HtmlBasedComponent container,
                                  boolean showGroupHeader)

renderGroupHeader

protected void renderGroupHeader(AbstractCockpitElementsContainer parent,
                                 ActionGroup groupConfig,
                                 org.zkoss.zk.ui.HtmlBasedComponent container)

renderActionGroupExtended

protected void renderActionGroupExtended(AbstractCockpitElementsContainer parent,
                                         ActionGroupExtended groupConfig,
                                         org.zkoss.zk.ui.HtmlBasedComponent container,
                                         Set<Action> actionComponents)

getLastFromActionComponents

protected Optional<Action> getLastFromActionComponents(Set<Action> actionComponents)

getFirstFromActionComponents

protected Optional<Action> getFirstFromActionComponents(Set<Action> actionComponents)

findExtendedActionOnActionComponents

protected Optional<Action> findExtendedActionOnActionComponents(Action extendedAction,
                                                                Collection<Action> actionComponents)

renderActionGroupExtendedClickableArea

protected void renderActionGroupExtendedClickableArea(org.zkoss.zk.ui.HtmlBasedComponent container,
                                                      org.zkoss.zul.Popup popup,
                                                      Action action)

extractIconUri

protected String extractIconUri(ActionContext context)

extractIconDisabledUri

protected String extractIconDisabledUri(ActionContext context)

extractIconHoverUri

protected String extractIconHoverUri(ActionContext context)

adjustUri

protected String adjustUri(ActionContext context,
                           String uri)

registerHoverEventsOnContainer

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

removeEventListeners

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

removeEventListeners

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

renderActionGroupSplit

protected void renderActionGroupSplit(AbstractCockpitElementsContainer parent,
                                      ActionGroupSplit groupConfig,
                                      org.zkoss.zk.ui.HtmlBasedComponent container,
                                      Set<Action> actionComponents)

resolvePrimaryAction

protected Action resolvePrimaryAction(ActionGroupSplit groupConfig)

renderActionsForPopupInActionGroupSplit

protected void renderActionsForPopupInActionGroupSplit(AbstractCockpitElementsContainer parent,
                                                       ActionGroupSplit groupConfig,
                                                       Set<Action> actionComponents,
                                                       org.zkoss.zul.Popup popup,
                                                       List<Action> actionsForPopup)

renderPrimaryAction

protected void renderPrimaryAction(AbstractCockpitElementsContainer parent,
                                   ActionGroupSplit groupConfig,
                                   Set<Action> actionComponents,
                                   org.zkoss.zul.Popup popup,
                                   Action primaryAction)

createToolbarbuttonForActionGroupSplit

protected org.zkoss.zul.Toolbarbutton createToolbarbuttonForActionGroupSplit(org.zkoss.zul.Popup popup)

cleanUpActionComponents

protected void cleanUpActionComponents(AbstractCockpitElementsContainer parent,
                                       Set<org.zkoss.zk.ui.HtmlBasedComponent> groupContainers)

renderAction

protected void renderAction(AbstractCockpitElementsContainer parent,
                            ActionGroup groupConfig,
                            org.zkoss.zk.ui.HtmlBasedComponent container,
                            Set<Action> actionComponents,
                            Action actionConfig)

renderAction

protected void renderAction(AbstractCockpitElementsContainer parent,
                            ActionGroup groupConfig,
                            org.zkoss.zk.ui.HtmlBasedComponent container,
                            Set<Action> actionComponents,
                            Action actionConfig,
                            String viewMode)

generateActionUID

protected String generateActionUID(AbstractCockpitElementsContainer parent,
                                   ActionGroup groupConfig,
                                   Action actionConfig)

removeChildActionsNonExistingInActionComponents

protected void removeChildActionsNonExistingInActionComponents(Set<Action> actionComponents,
                                                               List<org.zkoss.zk.ui.Component> children)

getOrCreateGroupContainer

protected org.zkoss.zk.ui.HtmlBasedComponent getOrCreateGroupContainer(AbstractCockpitElementsContainer parent,
                                                                       ActionGroup groupConfig)

computeGroupQualifier

protected String computeGroupQualifier(ActionGroup groupConfig)

groupQualifierEquals

protected boolean groupQualifierEquals(String quali1,
                                       String quali2)

getOrCreateGroupLabel

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

removeGroupLabel

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

getOrCreateActionComponent

protected Action getOrCreateActionComponent(AbstractCockpitElementsContainer elementsContainer,
                                            org.zkoss.zk.ui.Component parent,
                                            Action actionConfig,
                                            Set<Action> actionComponents)

renderAction

protected Action renderAction(AbstractCockpitElementsContainer parent,
                              Action actionContainer,
                              Action actionConfig)

Renders single action with viewMode inherited from parent Actions tag.

renderAction

protected Action renderAction(AbstractCockpitElementsContainer parent,
                              Action actionContainer,
                              Action actionConfig,
                              String viewMode)

Renders single action with given viewMode. If viewMode is null it will take the viewMode from parent Actions tag.

getKeyboardSupportService

public KeyboardSupportService getKeyboardSupportService()

getLabelService

public LabelService getLabelService()