com.hybris.cockpitng.admin.impl

Class DefaultCockpitAdminService

java.lang.Object

com.hybris.cockpitng.admin.impl.DefaultCockpitAdminService

All Implemented Interfaces:

CockpitAdminService

public class DefaultCockpitAdminService
extends Object
implements CockpitAdminService

Provides functionality for cockpitNG admin mode.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COCKPIT_SHOW_CONNECTIONS_FLAG
static String	COCKPIT_SYMBOLIC_ADMIN_MODE

Fields inherited from interface com.hybris.cockpitng.admin.CockpitAdminService

ADMINMODE_SCLASS, ADMINMODE_SYMBOLIC_SCLASS

Constructor Summary

Constructors

Constructor and Description
DefaultCockpitAdminService()

Method Summary

Modifier and Type	Method and Description
boolean	canReceiveFrom(WidgetSocket inputSocket, WidgetSocket outputSocket) Checks if outputSocket from srcWidget can be connected with inputSocket from targetWidget according to data type.
boolean	canReceiveFrom(WidgetSocket inputSocket, Widget targetWidget, WidgetSocket outputSocket, Widget srcWidget) Checks if outputSocket from srcWidget can be connected with inputSocket from targetWidget according to data type.
protected WidgetDefinition	createGroupDefinitionTemplate(Widget widget)
org.zkoss.zul.Window	createSettingsWizard(org.zkoss.zk.ui.Component parent, Widgetslot widgetslot, Widget widget, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> closeCallback) Creates a popup of settings for given widget
void	createVirtualSocket(Widget widget) Deprecated. since 6.5
protected AuthorityGroupService	getAdminModeAuthorityGroupService()
protected List<Object>	getClipboardWidgets(Object widgetClipboardAttribute)
ModalWindowStack	getModalWindowStack()
NotificationStack	getNotificationStack()
protected CockpitSessionService	getSessionService()
String	getWidgetToolbarColor()
protected boolean	hasConnections(Widget widget)
boolean	isAdminMode()
boolean	isAdminModePermitted()
boolean	isInClipboard(Widget widget) Checks if given widget is already in the clipboard
boolean	isShowConnectionsFlagEnabled() Checks showConnections flag status
boolean	isSymbolicAdminFlagEnabled()
boolean	isSymbolicAdminMode()
protected void	logWarningForManyInstancesIfNecessary(int widgetInstancesSize)
void	moveWidgetToClipboard(Widget widget) Adds the specified widget to the clipboard and removes it from the widget tree.
protected List<String[]>	parseSocketInfo(String propsStr)
protected void	pasteWidgetToClipboard(Widget widget)
protected org.zkoss.zul.TreeModel<Object>	prepareTreeModel(WidgetDefinition definition)
void	refreshCockpit() Clears the widget session cache, which results in recalculating the widget tree after the next page refresh.
void	removeWidgetFromClipboard(Widget node) Removes a widget from the widget clipboard, if it's present there.
protected void	removeWidgetSlotFromView(Widgetslot slot)
void	renderWidgetClipboard(org.zkoss.zk.ui.Component clipboardComponent, org.zkoss.zul.Caption caption) Render content of widget clipboard.
org.zkoss.zk.ui.Component	renderWidgetDefinitionInfo(org.zkoss.zk.ui.Component parent, WidgetDefinition widgetDefinition) Renders an area of widget definition information
void	setAdminMode(boolean adminMode, org.zkoss.zk.ui.Component ref) Enable or disable the admin mode.
void	setAdminModeAuthorityGroupService(AuthorityGroupService adminModeAuthorityGroupService)
void	setCockpitProperties(CockpitProperties cockpitProperties)
void	setCockpitUserService(CockpitUserService cockpitUserService)
void	setImpersonationPreviewHelper(ImpersonationPreviewHelper impersonationPreviewHelper)
void	setModalWindowStack(ModalWindowStack modalWindowStack)
void	setNotificationStack(NotificationStack notificationStack)
void	setSessionService(CockpitSessionService sessionService)
void	setSessionWidgetInstanceRegistry(SessionWidgetInstanceRegistry sessionWidgetInstanceRegistry)
void	setShowConnectionsFlagEnabled(boolean enabled) Sets showConnections flag.
void	setSocketConnectionService(SocketConnectionService socketConnectionService)
void	setSymbolicAdminFlag(boolean enabled) Sets symbolic adminmode flag.
void	setTypedSettingsRenderer(TypedSettingsRenderer typedSettingsRenderer)
void	setWidgetDefinitionService(CockpitComponentDefinitionService widgetDefinitionService)
void	setWidgetInstanceService(WidgetInstanceService widgetInstanceService)
void	setWidgetLibUtils(WidgetLibUtils widgetLibUtils)
void	setWidgetPersistenceService(WidgetPersistenceService widgetPersistenceService)
void	setWidgetService(WidgetService widgetService)
void	setWidgetToolbarColor(String color, org.zkoss.zk.ui.Component ref) Sets a new Color to the toolbar.
void	setWidgetUtils(WidgetUtils widgetUtils)
void	setXmlBasedWidgetPersistenceService(XMLWidgetPersistenceService xmlBasedWidgetPersistenceService)
void	showAddWidgetWizard(org.zkoss.zk.ui.Component ref, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> selectListener) Opens a wizard for adding a widget to a slot.
void	showGroupWidgetWizard(Widget widget, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> onCloseListener) Opens a wizard where the admin user can group a widget and its children into one single widget.
void	showWidgetConnectionWizard(Widget source, Widget target, org.zkoss.zk.ui.Component ref) Opens a wizard where a user can connect two widgets.
void	showWidgetMultiConnectionWizard(Widget widget, org.zkoss.zk.ui.Component ref) Shows a wizard for configuration of input/output sockets.
protected void	storeWidgetInWidgetTree(WidgetInstance instance)
void	toggleAdminMode(org.zkoss.zk.ui.Component slot) Toggles backoffice's admin mode
protected void	updateClipboard()

Methods inherited from class java.lang.Object

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

Field Detail

COCKPIT_SYMBOLIC_ADMIN_MODE

public static final String COCKPIT_SYMBOLIC_ADMIN_MODE

See Also:

Constant Field Values

COCKPIT_SHOW_CONNECTIONS_FLAG

public static final String COCKPIT_SHOW_CONNECTIONS_FLAG

See Also:

Constant Field Values

Constructor Detail

DefaultCockpitAdminService

public DefaultCockpitAdminService()

Method Detail

refreshCockpit

public void refreshCockpit()

Description copied from interface: CockpitAdminService

Clears the widget session cache, which results in recalculating the widget tree after the next page refresh.

Specified by:

refreshCockpit in interface CockpitAdminService

isSymbolicAdminMode

public boolean isSymbolicAdminMode()

Specified by:

isSymbolicAdminMode in interface CockpitAdminService

Returns:

true, if symbolic adminmode is currently enabled.

setSymbolicAdminFlag

public void setSymbolicAdminFlag(boolean enabled)

Description copied from interface: CockpitAdminService

Sets symbolic adminmode flag.

Specified by:

setSymbolicAdminFlag in interface CockpitAdminService

Parameters:

enabled - indicates whether symbolic admin mode should be enabled

isSymbolicAdminFlagEnabled

public boolean isSymbolicAdminFlagEnabled()

Specified by:

isSymbolicAdminFlagEnabled in interface CockpitAdminService

Returns:

true, if symbolic adminmode flag is true.

isAdminMode

public boolean isAdminMode()

Specified by:

isAdminMode in interface CockpitAdminService

Returns:

true, if adminmode is currently enabled.

isAdminModePermitted

public boolean isAdminModePermitted()

Specified by:

isAdminModePermitted in interface CockpitAdminService

Returns:

true, if adminmode is allowed for current session user.

setAdminMode

public void setAdminMode(boolean adminMode,
                         org.zkoss.zk.ui.Component ref)

Description copied from interface: CockpitAdminService

Enable or disable the admin mode.

Specified by:

setAdminMode in interface CockpitAdminService

Parameters:

adminMode - True, if adminmode should be enable, false otherwise.

ref - An arbitrary Component which is attached to the current page.

getWidgetToolbarColor

public String getWidgetToolbarColor()

Specified by:

getWidgetToolbarColor in interface CockpitAdminService

Returns:

the current color string used for the widget toolbars in a CSS readable RGB representation.

removeWidgetFromClipboard

public void removeWidgetFromClipboard(Widget node)

Description copied from interface: CockpitAdminService

Removes a widget from the widget clipboard, if it's present there.

Specified by:

removeWidgetFromClipboard in interface CockpitAdminService

Parameters:

node - The widget that should be removed.

isInClipboard

public boolean isInClipboard(Widget widget)

Description copied from interface: CockpitAdminService

Checks if given widget is already in the clipboard

Specified by:

isInClipboard in interface CockpitAdminService

Parameters:

widget - The widget that should be checked

Returns:

true, if the specified widget is in clipboard.

moveWidgetToClipboard

public void moveWidgetToClipboard(Widget widget)

Description copied from interface: CockpitAdminService

Adds the specified widget to the clipboard and removes it from the widget tree.

Specified by:

moveWidgetToClipboard in interface CockpitAdminService

Parameters:

widget - which should be moved to clipboard

logWarningForManyInstancesIfNecessary

protected void logWarningForManyInstancesIfNecessary(int widgetInstancesSize)

removeWidgetSlotFromView

protected void removeWidgetSlotFromView(Widgetslot slot)

storeWidgetInWidgetTree

protected void storeWidgetInWidgetTree(WidgetInstance instance)

pasteWidgetToClipboard

protected void pasteWidgetToClipboard(Widget widget)

getClipboardWidgets

protected List<Object> getClipboardWidgets(Object widgetClipboardAttribute)

updateClipboard

protected void updateClipboard()

renderWidgetClipboard

public void renderWidgetClipboard(org.zkoss.zk.ui.Component clipboardComponent,
                                  org.zkoss.zul.Caption caption)

Description copied from interface: CockpitAdminService

Render content of widget clipboard.

Specified by:

renderWidgetClipboard in interface CockpitAdminService

Parameters:

clipboardComponent - clipborad component

caption - clipborad caption

showGroupWidgetWizard

public void showGroupWidgetWizard(Widget widget,
                                  org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> onCloseListener)

Description copied from interface: CockpitAdminService

Opens a wizard where the admin user can group a widget and its children into one single widget.

Specified by:

showGroupWidgetWizard in interface CockpitAdminService

Parameters:

widget - The root widget of the new widget group.

onCloseListener - An EventListener which is called when the wizard is closed by the user.

prepareTreeModel

protected org.zkoss.zul.TreeModel<Object> prepareTreeModel(WidgetDefinition definition)

createGroupDefinitionTemplate

protected WidgetDefinition createGroupDefinitionTemplate(Widget widget)

showWidgetConnectionWizard

public void showWidgetConnectionWizard(Widget source,
                                       Widget target,
                                       org.zkoss.zk.ui.Component ref)

Description copied from interface: CockpitAdminService

Opens a wizard where a user can connect two widgets.

Specified by:

showWidgetConnectionWizard in interface CockpitAdminService

Parameters:

source - The source widget, i.e. the widget that may fire the event.

target - The target widget, i.e. the widget that should receive the event.

ref - An arbitrary Component which is attached to the current page.

showWidgetMultiConnectionWizard

public void showWidgetMultiConnectionWizard(Widget widget,
                                            org.zkoss.zk.ui.Component ref)

Description copied from interface: CockpitAdminService

Shows a wizard for configuration of input/output sockets.

Specified by:

showWidgetMultiConnectionWizard in interface CockpitAdminService

Parameters:

widget - widget under configuration

ref - parent component

createVirtualSocket

@Deprecated
public void createVirtualSocket(Widget widget)

Deprecated. since 6.5

Parameters:

widget -

hasConnections

protected boolean hasConnections(Widget widget)

renderWidgetDefinitionInfo

public org.zkoss.zk.ui.Component renderWidgetDefinitionInfo(org.zkoss.zk.ui.Component parent,
                                                            WidgetDefinition widgetDefinition)

Description copied from interface: CockpitAdminService

Renders an area of widget definition information

Specified by:

renderWidgetDefinitionInfo in interface CockpitAdminService

Parameters:

parent - a component parent to which a component is appended

widgetDefinition - a widget definition containing information to display

Returns:

created Component

createSettingsWizard

public org.zkoss.zul.Window createSettingsWizard(org.zkoss.zk.ui.Component parent,
                                                 Widgetslot widgetslot,
                                                 Widget widget,
                                                 org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> closeCallback)

Description copied from interface: CockpitAdminService

Creates a popup of settings for given widget

Specified by:

createSettingsWizard in interface CockpitAdminService

Parameters:

parent - a component parent to which a component is appended

widgetslot - a slot of the widget

widget - a widget from which settings to display are taken

closeCallback - a function which is called when settings popup is being close

Returns:

created Window

showAddWidgetWizard

public void showAddWidgetWizard(org.zkoss.zk.ui.Component ref,
                                org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> selectListener)

Description copied from interface: CockpitAdminService

Opens a wizard for adding a widget to a slot. Shows all widgets in the repository.

Specified by:

showAddWidgetWizard in interface CockpitAdminService

Parameters:

ref - An arbitrary Component which is attached to the current page.

selectListener - An EventListener which is called when a widget has been selected in the wizard.

parseSocketInfo

protected List<String[]> parseSocketInfo(String propsStr)

setWidgetToolbarColor

public void setWidgetToolbarColor(String color,
                                  org.zkoss.zk.ui.Component ref)

Description copied from interface: CockpitAdminService

Sets a new Color to the toolbar.

Specified by:

setWidgetToolbarColor in interface CockpitAdminService

Parameters:

color - the new color

ref - An arbitrary Component which is attached to the current page.

canReceiveFrom

public boolean canReceiveFrom(WidgetSocket inputSocket,
                              Widget targetWidget,
                              WidgetSocket outputSocket,
                              Widget srcWidget)

Description copied from interface: CockpitAdminService

Checks if outputSocket from srcWidget can be connected with inputSocket from targetWidget according to data type.

Specified by:

canReceiveFrom in interface CockpitAdminService

Parameters:

inputSocket - - WidgetSocket represents input socket

targetWidget - - (@link Widget represents target widget

outputSocket - - WidgetSocket represents output socket

srcWidget - - (@link Widget represents source widget

Returns:

true, if the targetWidget.

canReceiveFrom

public boolean canReceiveFrom(WidgetSocket inputSocket,
                              WidgetSocket outputSocket)

Description copied from interface: CockpitAdminService

Checks if outputSocket from srcWidget can be connected with inputSocket from targetWidget according to data type.

Specified by:

canReceiveFrom in interface CockpitAdminService

Parameters:

inputSocket - - WidgetSocket represents input socket

outputSocket - - WidgetSocket represents output socket

Returns:

true, if the targetWidget.

getSessionService

protected CockpitSessionService getSessionService()

setSessionService

public void setSessionService(CockpitSessionService sessionService)

setWidgetService

public void setWidgetService(WidgetService widgetService)

setWidgetDefinitionService

public void setWidgetDefinitionService(CockpitComponentDefinitionService widgetDefinitionService)

getNotificationStack

public NotificationStack getNotificationStack()

setNotificationStack

public void setNotificationStack(NotificationStack notificationStack)

getModalWindowStack

public ModalWindowStack getModalWindowStack()

setModalWindowStack

public void setModalWindowStack(ModalWindowStack modalWindowStack)

setWidgetPersistenceService

public void setWidgetPersistenceService(WidgetPersistenceService widgetPersistenceService)

setXmlBasedWidgetPersistenceService

public void setXmlBasedWidgetPersistenceService(XMLWidgetPersistenceService xmlBasedWidgetPersistenceService)

setWidgetUtils

public void setWidgetUtils(WidgetUtils widgetUtils)

setWidgetInstanceService

public void setWidgetInstanceService(WidgetInstanceService widgetInstanceService)

setSessionWidgetInstanceRegistry

public void setSessionWidgetInstanceRegistry(SessionWidgetInstanceRegistry sessionWidgetInstanceRegistry)

setWidgetLibUtils

public void setWidgetLibUtils(WidgetLibUtils widgetLibUtils)

setSocketConnectionService

public void setSocketConnectionService(SocketConnectionService socketConnectionService)

setCockpitProperties

public void setCockpitProperties(CockpitProperties cockpitProperties)

setTypedSettingsRenderer

public void setTypedSettingsRenderer(TypedSettingsRenderer typedSettingsRenderer)

getAdminModeAuthorityGroupService

protected AuthorityGroupService getAdminModeAuthorityGroupService()

Returns:

the adminModeAuthorityGroupService

setAdminModeAuthorityGroupService

public void setAdminModeAuthorityGroupService(AuthorityGroupService adminModeAuthorityGroupService)

Parameters:

adminModeAuthorityGroupService - the adminModeAuthorityGroupService to set

setImpersonationPreviewHelper

public void setImpersonationPreviewHelper(ImpersonationPreviewHelper impersonationPreviewHelper)

Parameters:

impersonationPreviewHelper - the impersonationPreviewHelper to set

setCockpitUserService

public void setCockpitUserService(CockpitUserService cockpitUserService)

isShowConnectionsFlagEnabled

public boolean isShowConnectionsFlagEnabled()

Description copied from interface: CockpitAdminService

Checks showConnections flag status

Specified by:

isShowConnectionsFlagEnabled in interface CockpitAdminService

Returns:

true, if showConnections flag is true.

setShowConnectionsFlagEnabled

public void setShowConnectionsFlagEnabled(boolean enabled)

Description copied from interface: CockpitAdminService

Sets showConnections flag.

Specified by:

setShowConnectionsFlagEnabled in interface CockpitAdminService

Parameters:

enabled - - value for showConnections flag

toggleAdminMode

public void toggleAdminMode(org.zkoss.zk.ui.Component slot)

Description copied from interface: CockpitAdminService

Toggles backoffice's admin mode

Specified by:

toggleAdminMode in interface CockpitAdminService

Parameters:

slot - parent component