Package com.hybris.cockpitng.engine.impl

Class AdminmodeWidgetEngine

java.lang.Object

com.hybris.cockpitng.engine.impl.DefaultCockpitWidgetEngine

com.hybris.cockpitng.engine.impl.AdminmodeWidgetEngine

All Implemented Interfaces:

CockpitWidgetEngine

public class AdminmodeWidgetEngine
extends DefaultCockpitWidgetEngine

Adds additional admin mode functionality to the DefaultCockpitWidgetEngine.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ADMIN_FULLSCREEN
static java.lang.String	CP_INVISIBLE_CONTAINER_VISIBLE
static java.lang.String	DRAGGED_WIDGET
static java.lang.String	NO_SLOT_ID
static java.lang.String	TOOLBAR_COMPONENT
static java.lang.String	WIDGET_TOKEN

Fields inherited from class com.hybris.cockpitng.engine.impl.DefaultCockpitWidgetEngine

CP_FWD_EL, documentNoView, documentWithWidgetSlot, FULL_WIDTH, HEIGHT, MONITOR_WIDGET_COUNTER_ATTRIB, ON_CP_FWD_EL, SCLASS_WIDGET_BODY, SETTING_WIDGET_MOLD, SLOT_ID, STOP_PROPAGATION_LISTENER, VIEW_ZUL, WIDGET, WIDGETSLOT, WIDTH, Y_TESTID_PATH

Fields inherited from interface com.hybris.cockpitng.engine.CockpitWidgetEngine

COMPONENT_RESOURCE_PATH_PARAM, COMPONENT_ROOT_PARAM, LABELS_PARAM, WIDGET_RESOURCE_PATH_PARAM, WIDGET_ROOT_PARAM, WR_PARAM

Constructor Summary

Constructors

Constructor	Description
AdminmodeWidgetEngine()

Method Summary

Modifier and Type	Method	Description
protected void	appendChildrenSlotToolbar(Widgetchildren widgetChildrenComponent)
protected void	appendSettingsButton(org.zkoss.zk.ui.Component parent, Widgetslot widgetslot)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - please use DefaultWidgetToolbarRenderer.appendSettingsButton(Component, Widgetslot)
protected void	appendSingleSlotToolbar(Widgetslot widgetslot, Widget currentWidget)
protected void	appendWidgetToolbar(Widgetslot widgetslot)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - please use DefaultWidgetToolbarRenderer.appendWidgetToolbar(Component, WidgetDefinition, Widgetslot)
protected void	appendWidgetToolbar(Widgetslot widgetslot, org.zkoss.zk.ui.Component parent)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - please use DefaultWidgetToolbarRenderer.appendWidgetToolbar(Component, WidgetDefinition, Widgetslot)
protected void	applyRoleRestrictions(Widget widget)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - please use DefaultWidgetWizardCreationDelegate.applyRoleRestrictions(com.hybris.cockpitng.core.Widget)
protected boolean	canAppendChildrenSlotToolbar(Widget parentWidget)
protected boolean	confirmNeeded(Widget widget)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - please use DefaultWidgetToolbarRenderer.confirmNeeded(Widget)
protected org.zkoss.zul.Toolbarbutton	createAddWidgetButton(Widgetslot widgetslot)
protected void	createAddWidgetButtonInSlot(Widgetslot widgetslot)
protected void	createComponents(Widgetslot widgetslot)
protected org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>	createDropListener(Widgetslot widgetslot)
protected org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>	createDropListener(Widgetslot widgetslot, Widget currentWidget)
void	createWidgetView(Widgetchildren widgetChildrenComponent, java.util.Map<java.lang.String,java.lang.Object> ctx)	Creates the view components for the specified widgetchildren slot.
void	createWidgetView(Widgetslot widgetslot)	Creates the view components for the specified widgetslot.
protected org.zkoss.zul.Window	createWindow(Widgetslot widgetslot, Widget currentWidget)
protected void	doMoveWidget(Widgetslot targetWidgetslot, Widget targetWidget, java.lang.String targetSlotID, Widget draggedWidget, Widget oldParentWidget, Widget widgetToRemove)
protected java.util.List<java.lang.String>	getAllChildSlotIds(org.zkoss.zk.ui.Component component)
protected java.util.List<java.lang.String>	getAllSlotIds(Widgetslot widgetslot)
CockpitAdminService	getCockpitAdminService()
ConnectButtonRenderer	getConnectButtonRenderer()
java.util.List<java.lang.String>	getEmptySlotIds(Widgetslot widgetslot)	Returns IDs of widget slots that are available for new widgets.
protected java.util.List<WidgetInstance>	getFilteredWidgetInstances(java.util.List<WidgetInstance> children)	filter out widget instance that shouldn't be displayed in admin mode
protected Widgetslot	getParentWidgetslot(Widgetslot widgetslot)
protected SymbolicModeRenderer	getSymbolicModeRenderer()
protected Widget	getVisibleWidget(Widgetslot targetWidgetslot, java.lang.String targetSlotID)
java.util.List<Widget>	getVisibleWidgets(Widgetslot widgetslot)	Returns list of widget, children of the given widget slot, that are visible according to DefaultCockpitWidgetEngine.checkVisibility(Widget) method.
protected java.lang.String	getWidgetBodySclass(WidgetInstance widgetInstance)
protected WidgetPersistenceService	getWidgetPersistenceService()
WidgetToolbarRenderer	getWidgetToolbarRenderer()
WidgetWizardCreationDelegate	getWidgetWizardCreationDelegate()
protected boolean	hasDisplayedConnections(Widget widget)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - please use DefaultConnectButtonRenderer.hasDisplayedConnections(Widget)
protected boolean	isEmptyRootSlot(Widgetslot widgetslot)
protected boolean	isFullScreen(Widget currentWidget)
protected void	removeWidget(Widgetslot widgetCompnent, Widget widget)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - please use DefaultWidgetToolbarRenderer.removeWidget(Widgetslot, Widget)
protected void	renderComposedGroupButton(org.zkoss.zk.ui.Component parent, Widgetslot widgetslot)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - please use DefaultWidgetToolbarRenderer.renderComposedGroupButton(Component, Widgetslot)
protected void	renderConnectBtn(org.zkoss.zk.ui.Component parent, Widgetslot widgetslot)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - please use DefaultConnectButtonRenderer.renderConnectButton(Component, Widget, Widgetslot)
protected void	renderConnectorEntry(org.zkoss.zk.ui.Component parent, WidgetConnection widgetConnection)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - please use DefaultConnectButtonRenderer.renderConnectorEntry(Component, WidgetConnection)
protected void	renderRemoveBtn(org.zkoss.zk.ui.Component parent, Widgetslot widgetCompnent, Widget widget)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - please use DefaultWidgetToolbarRenderer.renderRemoveBtn(Component, Widgetslot, WidgetDefinition)
protected void	renderShowInvisibleChildrenButton(org.zkoss.zk.ui.Component parent, Widgetslot widgetslot, Widget currentWidget)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - please use DefaultWidgetToolbarRenderer.renderShowInvisibleChildrenButton(Component, Widgetslot)
protected void	renderTemplateButton(org.zkoss.zk.ui.Component parent, Widgetslot widgetslot)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - please use DefaultTemplateButtonRenderer.renderTemplateButton(Component, Widget, WidgetDefinition, Widgetslot)
protected void	renderUnattachedChildren(Widgetslot widgetslot, java.util.List<Widget> additionalWidgets)
void	setCockpitAdminService(CockpitAdminService cockpitAdminService)
void	setCockpitComponentDefinitionService(CockpitComponentDefinitionService cockpitComponentDefinitionService)
void	setConnectButtonRenderer(ConnectButtonRenderer connectButtonRenderer)
protected void	setInvisibleContainerVisible(Widgetslot widgetslot, boolean value)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - please use DefaultWidgetToolbarRenderer.setInvisibleContainerVisible(Widgetslot, boolean)
void	setSymbolicModeRenderer(SymbolicModeRenderer symbolicModeRenderer)
void	setWidgetPersistenceService(WidgetPersistenceService widgetPersistenceService)
void	setWidgetToolbarRenderer(WidgetToolbarRenderer widgetToolbarRenderer)
void	setWidgetWizardCreationDelegate(WidgetWizardCreationDelegate widgetWizardCreationDelegate)

Methods inherited from class com.hybris.cockpitng.engine.impl.DefaultCockpitWidgetEngine

adjustWidgetSclass, checkVisibility, createLabelMap, createWidgetInstanceManager, createWidgetView, getChildrenContainerRenderer, getCockpitConfigurationService, getCockpitProperties, getCockpitThreadContextCreator, getCockpitTypeUtils, getComponentDefinition, getDesktop, getDocumentNoViewWidget, getDocumentWithWidgetSlot, getLabel, getLabelService, getNotificationService, getOutputSocketTypeMessage, getRulesEngine, getSessionWidgetInstance, getSocketConnectionService, getWidgetAuthorizationService, getWidgetConfigurationContextDecoratorList, getWidgetDefinition, getWidgetDefinitionService, getWidgetInstanceFacade, getWidgetLibUtils, getWidgetMoldSclass, getWidgetService, getWidgetUtils, injectWidgetVariables, isIndependentView, isSocketDataTypeValid, isSocketTypeMatching, logSocketEvent, lookupGroupTemplateInstance, resolveObjectMultiplicity, resolveSingleTargetInstance, sendEventToTargetWidget, sendEventToTargetWidgetInternal, sendOutput, sendOutput, sendOutput, sendSocketEvent, setChildrenContainerRenderer, setCockpitConfigurationService, setCockpitProperties, setCockpitResourceLoader, setCockpitThreadContextCreator, setCockpitTypeUtils, setComponentDefinitionService, setLabelService, setModelValueHandlerFactory, setNotificationService, setNotificationStack, setRulesEngine, setSessionWidgetInstance, setSessionWidgetInstanceRegistry, setSocketConnectionService, setWidgetAuthorizationService, setWidgetConfigurationContextDecoratorList, setWidgetInstanceFacade, setWidgetLibUtils, setWidgetService, setWidgetUtils

Methods inherited from class java.lang.Object

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

Field Detail

NO_SLOT_ID

public static final java.lang.String NO_SLOT_ID

See Also:

Constant Field Values

DRAGGED_WIDGET

public static final java.lang.String DRAGGED_WIDGET

See Also:

Constant Field Values

TOOLBAR_COMPONENT

public static final java.lang.String TOOLBAR_COMPONENT

See Also:

Constant Field Values

ADMIN_FULLSCREEN

public static final java.lang.String ADMIN_FULLSCREEN

See Also:

Constant Field Values

WIDGET_TOKEN

public static final java.lang.String WIDGET_TOKEN

See Also:

Constant Field Values

CP_INVISIBLE_CONTAINER_VISIBLE

public static final java.lang.String CP_INVISIBLE_CONTAINER_VISIBLE

See Also:

Constant Field Values

Constructor Detail

AdminmodeWidgetEngine

public AdminmodeWidgetEngine()

Method Detail

createWidgetView

public void createWidgetView(Widgetslot widgetslot)

Description copied from interface: CockpitWidgetEngine

Creates the view components for the specified widgetslot. If no widget is attached to the slot, an error is displayed, otherwise the view representation of the attached widget is injected.

Specified by:

createWidgetView in interface CockpitWidgetEngine

Overrides:

createWidgetView in class DefaultCockpitWidgetEngine

isEmptyRootSlot

protected boolean isEmptyRootSlot(Widgetslot widgetslot)

createAddWidgetButtonInSlot

protected void createAddWidgetButtonInSlot(Widgetslot widgetslot)

createAddWidgetButton

protected org.zkoss.zul.Toolbarbutton createAddWidgetButton(Widgetslot widgetslot)

isFullScreen

protected boolean isFullScreen(Widget currentWidget)

createWindow

protected org.zkoss.zul.Window createWindow(Widgetslot widgetslot,
                                            Widget currentWidget)

getWidgetBodySclass

protected java.lang.String getWidgetBodySclass(WidgetInstance widgetInstance)

Overrides:

getWidgetBodySclass in class DefaultCockpitWidgetEngine

createComponents

protected void createComponents(Widgetslot widgetslot)

Overrides:

createComponents in class DefaultCockpitWidgetEngine

renderUnattachedChildren

protected void renderUnattachedChildren(Widgetslot widgetslot,
                                        java.util.List<Widget> additionalWidgets)

Overrides:

renderUnattachedChildren in class DefaultCockpitWidgetEngine

createDropListener

protected org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> createDropListener(Widgetslot widgetslot)

createDropListener

protected org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> createDropListener(Widgetslot widgetslot,
                                                                                              Widget currentWidget)

appendSingleSlotToolbar

protected void appendSingleSlotToolbar(Widgetslot widgetslot,
                                       Widget currentWidget)

doMoveWidget

protected void doMoveWidget(Widgetslot targetWidgetslot,
                            Widget targetWidget,
                            java.lang.String targetSlotID,
                            Widget draggedWidget,
                            Widget oldParentWidget,
                            Widget widgetToRemove)

getVisibleWidget

protected Widget getVisibleWidget(Widgetslot targetWidgetslot,
                                  java.lang.String targetSlotID)

getParentWidgetslot

protected Widgetslot getParentWidgetslot(Widgetslot widgetslot)

createWidgetView

public void createWidgetView(Widgetchildren widgetChildrenComponent,
                             java.util.Map<java.lang.String,java.lang.Object> ctx)

Description copied from interface: CockpitWidgetEngine

Creates the view components for the specified widgetchildren slot. For each matching child widget it creates a container, according to the type of the widgetchildren.

Specified by:

createWidgetView in interface CockpitWidgetEngine

Overrides:

createWidgetView in class DefaultCockpitWidgetEngine

canAppendChildrenSlotToolbar

protected boolean canAppendChildrenSlotToolbar(Widget parentWidget)

getFilteredWidgetInstances

protected java.util.List<WidgetInstance> getFilteredWidgetInstances(java.util.List<WidgetInstance> children)

filter out widget instance that shouldn't be displayed in admin mode

Parameters:

children - widget instances

Returns:

filtered widget instances

appendChildrenSlotToolbar

protected void appendChildrenSlotToolbar(Widgetchildren widgetChildrenComponent)

getEmptySlotIds

public java.util.List<java.lang.String> getEmptySlotIds(Widgetslot widgetslot)

Returns IDs of widget slots that are available for new widgets.

Parameters:

widgetslot -

Returns:

List of widget slot IDs.

getVisibleWidgets

public java.util.List<Widget> getVisibleWidgets(Widgetslot widgetslot)

Returns list of widget, children of the given widget slot, that are visible according to DefaultCockpitWidgetEngine.checkVisibility(Widget) method. By default - visible for the current authority group.

Parameters:

widgetslot -

Returns:

List of Widget

getAllSlotIds

protected java.util.List<java.lang.String> getAllSlotIds(Widgetslot widgetslot)

getAllChildSlotIds

protected java.util.List<java.lang.String> getAllChildSlotIds(org.zkoss.zk.ui.Component component)

renderRemoveBtn

@Deprecated(since="6.7",
            forRemoval=true)
protected void renderRemoveBtn(org.zkoss.zk.ui.Component parent,
                               Widgetslot widgetCompnent,
                               Widget widget)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - please use DefaultWidgetToolbarRenderer.renderRemoveBtn(Component, Widgetslot, WidgetDefinition)

confirmNeeded

@Deprecated(since="6.7",
            forRemoval=true)
protected boolean confirmNeeded(Widget widget)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - please use DefaultWidgetToolbarRenderer.confirmNeeded(Widget)

removeWidget

@Deprecated(since="6.7",
            forRemoval=true)
protected void removeWidget(Widgetslot widgetCompnent,
                            Widget widget)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - please use DefaultWidgetToolbarRenderer.removeWidget(Widgetslot, Widget)

setInvisibleContainerVisible

@Deprecated(since="6.7",
            forRemoval=true)
protected void setInvisibleContainerVisible(Widgetslot widgetslot,
                                            boolean value)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - please use DefaultWidgetToolbarRenderer.setInvisibleContainerVisible(Widgetslot, boolean)

renderComposedGroupButton

@Deprecated(since="6.7",
            forRemoval=true)
protected void renderComposedGroupButton(org.zkoss.zk.ui.Component parent,
                                         Widgetslot widgetslot)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - please use DefaultWidgetToolbarRenderer.renderComposedGroupButton(Component, Widgetslot)

appendSettingsButton

@Deprecated(since="6.7",
            forRemoval=true)
protected void appendSettingsButton(org.zkoss.zk.ui.Component parent,
                                    Widgetslot widgetslot)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - please use DefaultWidgetToolbarRenderer.appendSettingsButton(Component, Widgetslot)

appendWidgetToolbar

@Deprecated(since="6.7",
            forRemoval=true)
protected void appendWidgetToolbar(Widgetslot widgetslot)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - please use DefaultWidgetToolbarRenderer.appendWidgetToolbar(Component, WidgetDefinition, Widgetslot)

appendWidgetToolbar

@Deprecated(since="6.7",
            forRemoval=true)
protected void appendWidgetToolbar(Widgetslot widgetslot,
                                   org.zkoss.zk.ui.Component parent)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - please use DefaultWidgetToolbarRenderer.appendWidgetToolbar(Component, WidgetDefinition, Widgetslot)

applyRoleRestrictions

@Deprecated(since="6.7",
            forRemoval=true)
protected void applyRoleRestrictions(Widget widget)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - please use DefaultWidgetWizardCreationDelegate.applyRoleRestrictions(com.hybris.cockpitng.core.Widget)

renderShowInvisibleChildrenButton

@Deprecated(since="6.7",
            forRemoval=true)
protected void renderShowInvisibleChildrenButton(org.zkoss.zk.ui.Component parent,
                                                 Widgetslot widgetslot,
                                                 Widget currentWidget)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - please use DefaultWidgetToolbarRenderer.renderShowInvisibleChildrenButton(Component, Widgetslot)

hasDisplayedConnections

@Deprecated(since="6.7",
            forRemoval=true)
protected boolean hasDisplayedConnections(Widget widget)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - please use DefaultConnectButtonRenderer.hasDisplayedConnections(Widget)

renderConnectBtn

@Deprecated(since="6.7",
            forRemoval=true)
protected void renderConnectBtn(org.zkoss.zk.ui.Component parent,
                                Widgetslot widgetslot)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - please use DefaultConnectButtonRenderer.renderConnectButton(Component, Widget, Widgetslot)

renderConnectorEntry

@Deprecated(since="6.7",
            forRemoval=true)
protected void renderConnectorEntry(org.zkoss.zk.ui.Component parent,
                                    WidgetConnection widgetConnection)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - please use DefaultConnectButtonRenderer.renderConnectorEntry(Component, WidgetConnection)

renderTemplateButton

@Deprecated(since="6.7",
            forRemoval=true)
protected void renderTemplateButton(org.zkoss.zk.ui.Component parent,
                                    Widgetslot widgetslot)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - please use DefaultTemplateButtonRenderer.renderTemplateButton(Component, Widget, WidgetDefinition, Widgetslot)

getCockpitAdminService

public CockpitAdminService getCockpitAdminService()

setCockpitAdminService

public void setCockpitAdminService(CockpitAdminService cockpitAdminService)

setCockpitComponentDefinitionService

public void setCockpitComponentDefinitionService(CockpitComponentDefinitionService cockpitComponentDefinitionService)

getWidgetPersistenceService

protected WidgetPersistenceService getWidgetPersistenceService()

Overrides:

getWidgetPersistenceService in class DefaultCockpitWidgetEngine

setWidgetPersistenceService

public void setWidgetPersistenceService(WidgetPersistenceService widgetPersistenceService)

Overrides:

setWidgetPersistenceService in class DefaultCockpitWidgetEngine

getSymbolicModeRenderer

protected SymbolicModeRenderer getSymbolicModeRenderer()

setSymbolicModeRenderer

public void setSymbolicModeRenderer(SymbolicModeRenderer symbolicModeRenderer)

getConnectButtonRenderer

public ConnectButtonRenderer getConnectButtonRenderer()

setConnectButtonRenderer

public void setConnectButtonRenderer(ConnectButtonRenderer connectButtonRenderer)

getWidgetWizardCreationDelegate

public WidgetWizardCreationDelegate getWidgetWizardCreationDelegate()

setWidgetWizardCreationDelegate

public void setWidgetWizardCreationDelegate(WidgetWizardCreationDelegate widgetWizardCreationDelegate)

getWidgetToolbarRenderer

public WidgetToolbarRenderer getWidgetToolbarRenderer()

setWidgetToolbarRenderer

public void setWidgetToolbarRenderer(WidgetToolbarRenderer widgetToolbarRenderer)