com.hybris.cockpitng.engine.impl

Class DefaultCockpitWidgetEngine

java.lang.Object

com.hybris.cockpitng.engine.impl.DefaultCockpitWidgetEngine

All Implemented Interfaces:

CockpitWidgetEngine

Direct Known Subclasses:

AdminmodeWidgetEngine

public class DefaultCockpitWidgetEngine
extends Object
implements CockpitWidgetEngine

Default widget engine. Used in "normal" (not admin) rendering mode. For internal use only.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CP_FWD_EL
protected org.zkoss.idom.Document	documentNoView
protected org.zkoss.idom.Document	documentWithWidgetSlot
static String	FULL_WIDTH
static String	HEIGHT
static String	MONITOR_WIDGET_COUNTER_ATTRIB
static String	ON_CP_FWD_EL
static String	SCLASS_WIDGET_BODY
static String	SETTING_WIDGET_MOLD
static String	SLOT_ID
static org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>	STOP_PROPAGATION_LISTENER
static String	VIEW_ZUL Deprecated. since 1808, use DefaultCockpitComponentDefinitionService.DEFAULT_VIEW_ZUL instead
static String	WIDGET
static String	WIDGETSLOT
static String	WIDTH
static String	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 and Description
DefaultCockpitWidgetEngine()

Method Summary

Modifier and Type	Method and Description
protected void	adjustWidgetSclass(WidgetInstance widgetInstance, WidgetDefinition definition, org.zkoss.zk.ui.Component component)
protected boolean	checkVisibility(Widget widget) Decides if the given widget should be displayed or not.
protected void	createComponents(Widgetslot widgetslot)
Map<String,Object>	createLabelMap(WidgetDefinition definition, Widget widget)
void	createWidgetView(Widgetchildren widgetChildrenComponent) Same as CockpitWidgetEngine.createWidgetView(Widgetchildren, Map) with empty map as second arg.
void	createWidgetView(Widgetchildren widgetChildrenComponent, Map<String,Object> ctx) Creates the view components for the specified widgetchildren slot.
void	createWidgetView(Widgetslot widgetslot) Creates the view components for the specified widgetslot.
Map<String,WidgetChildrenContainerRenderer>	getChildrenContainerRenderer()
CockpitConfigurationService	getCockpitConfigurationService()
protected CockpitProperties	getCockpitProperties()
protected CockpitThreadContextCreator	getCockpitThreadContextCreator()
CockpitTypeUtils	getCockpitTypeUtils()
protected <T> T	getComponentDefinition(String widgetId)
protected org.zkoss.zk.ui.Desktop	getDesktop()
protected org.zkoss.idom.Document	getDocumentNoViewWidget()
protected org.zkoss.idom.Document	getDocumentWithWidgetSlot()
static String	getLabel(String key, Map<String,Object> labels)
LabelService	getLabelService()
protected String	getOutputSocketTypeMessage(WidgetSocket outputWidgetSocket, String outputSocketType)
protected WidgetTemplateRulesEngine	getRulesEngine()
protected WidgetInstance	getSessionWidgetInstance(String slotId)
SocketConnectionService	getSocketConnectionService()
protected WidgetAuthorizationService	getWidgetAuthorizationService()
protected String	getWidgetBodySclass(WidgetInstance widgetInstance)
List<WidgetConfigurationContextDecorator>	getWidgetConfigurationContextDecoratorList()
protected WidgetDefinition	getWidgetDefinition(Widget widget)
protected CockpitComponentDefinitionService	getWidgetDefinitionService()
protected WidgetInstanceFacade	getWidgetInstanceFacade()
protected WidgetLibUtils	getWidgetLibUtils()
protected String	getWidgetMoldSclass(WidgetInstance widgetInstance, WidgetDefinition definition)
protected WidgetPersistenceService	getWidgetPersistenceService()
WidgetService	getWidgetService()
protected WidgetUtils	getWidgetUtils()
protected void	injectWidgetVariables(Object widgetController, WidgetInstanceManager widgetInstanceManager)
boolean	isIndependentView(WidgetDefinition widget, String url) Checks whether provided URL points to widget's view, which is defined as not dependent from ZK framework (i.e.
protected boolean	isSocketDataTypeValid(Object object, Widget currentWidget, WidgetSocket outputWidgetSocket)
protected boolean	isSocketTypeMatching(String socketDataType, WidgetSocket.Multiplicity socketMultiplicity, Object object)
protected void	logSocketEvent(Widgetslot widgetContainer, String targetSocketId, Object data, String sourceSocketId, WidgetInstance sourceWidgetInstance)
protected WidgetInstance	lookupGroupTemplateInstance(Widget groupContainerWidget, WidgetInstance currentWidgetInstance)
protected void	renderUnattachedChildren(Widgetslot widgetslot, List<Widget> unattachedChildren)
protected WidgetSocket.Multiplicity	resolveObjectMultiplicity(Object object)
protected WidgetInstance	resolveSingleTargetInstance(WidgetInstance source, Widget target) Checks, if an event should be routed to one single instance of the target widget.
protected void	sendEventToTargetWidget(String eventName, Widget target, Object data, String sourceSocketId, WidgetInstance source)
protected void	sendEventToTargetWidgetInternal(String eventName, Object data, String sourceSocketId, WidgetInstance source, List<WidgetInstance> widgetInstances)
void	sendOutput(Widgetslot widgetslot, String outputID) Calls sendOutput(widgetslot, outputID, null)}.
void	sendOutput(Widgetslot widgetslot, String outputID, Object data) Calls sendOutput(widgetslot, outputID, data, false)}.
void	sendOutput(Widgetslot widgetslot, String outputId, Object data, boolean ignoreSockets) Sends an output event from the widget attached to the widgetslot parameter with the given outputID.
protected void	sendSocketEvent(Widgetslot widgetContainer, String eventName, Object data, String sourceSocketId, WidgetInstance sourceWidgetInstance)
void	setChildrenContainerRenderer(Map<String,WidgetChildrenContainerRenderer> childrenContainerRenderer)
void	setCockpitConfigurationService(CockpitConfigurationService cockpitConfigurationService)
void	setCockpitProperties(CockpitProperties cockpitProperties)
void	setCockpitResourceLoader(CockpitResourceLoader cockpitResourceLoader)
void	setCockpitThreadContextCreator(CockpitThreadContextCreator cockpitThreadContextCreator)
void	setCockpitTypeUtils(CockpitTypeUtils cockpitTypeUtils)
void	setComponentDefinitionService(CockpitComponentDefinitionService componentDefinitionService)
void	setLabelService(LabelService labelService)
void	setModelValueHandlerFactory(ModelValueHandlerFactory modelValueHandlerFactory)
void	setNotificationStack(NotificationStack notificationStack)
void	setRulesEngine(WidgetTemplateRulesEngine rulesEngine)
protected void	setSessionWidgetInstance(WidgetInstance instance, String slotId)
void	setSessionWidgetInstanceRegistry(SessionWidgetInstanceRegistry sessionWidgetInstanceRegistry)
void	setSocketConnectionService(SocketConnectionService socketConnectionService)
void	setWidgetAuthorizationService(WidgetAuthorizationService widgetAuthorizationService)
void	setWidgetConfigurationContextDecoratorList(List<WidgetConfigurationContextDecorator> contextDecoratorList)
void	setWidgetInstanceFacade(WidgetInstanceFacade widgetInstanceFacade)
void	setWidgetLibUtils(WidgetLibUtils widgetLibUtils)
void	setWidgetPersistenceService(WidgetPersistenceService widgetPersistenceService)
void	setWidgetService(WidgetService widgetService)
void	setWidgetUtils(WidgetUtils widgetUtils)

Methods inherited from class java.lang.Object

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

Field Detail

VIEW_ZUL

@Deprecated
public static final String VIEW_ZUL

Deprecated. since 1808, use DefaultCockpitComponentDefinitionService.DEFAULT_VIEW_ZUL instead

See Also:

Constant Field Values

MONITOR_WIDGET_COUNTER_ATTRIB

public static final String MONITOR_WIDGET_COUNTER_ATTRIB

See Also:

Constant Field Values

ON_CP_FWD_EL

public static final String ON_CP_FWD_EL

See Also:

Constant Field Values

STOP_PROPAGATION_LISTENER

public static final org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> STOP_PROPAGATION_LISTENER

WIDGET

public static final String WIDGET

See Also:

Constant Field Values

WIDTH

public static final String WIDTH

See Also:

Constant Field Values

HEIGHT

public static final String HEIGHT

See Also:

Constant Field Values

SLOT_ID

public static final String SLOT_ID

See Also:

Constant Field Values

WIDGETSLOT

public static final String WIDGETSLOT

See Also:

Constant Field Values

FULL_WIDTH

public static final String FULL_WIDTH

See Also:

Constant Field Values

SCLASS_WIDGET_BODY

public static final String SCLASS_WIDGET_BODY

See Also:

Constant Field Values

CP_FWD_EL

public static final String CP_FWD_EL

See Also:

Constant Field Values

SETTING_WIDGET_MOLD

public static final String SETTING_WIDGET_MOLD

See Also:

Constant Field Values

Y_TESTID_PATH

public static final String Y_TESTID_PATH

See Also:

Constant Field Values

documentWithWidgetSlot

protected org.zkoss.idom.Document documentWithWidgetSlot

documentNoView

protected org.zkoss.idom.Document documentNoView

Constructor Detail

DefaultCockpitWidgetEngine

public DefaultCockpitWidgetEngine()

Method Detail

getLabel

public static String getLabel(String key,
                              Map<String,Object> labels)

setNotificationStack

public void setNotificationStack(NotificationStack notificationStack)

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

checkVisibility

protected boolean checkVisibility(Widget widget)

Decides if the given widget should be displayed or not.

Parameters:

widget - The widget to check, can be null.

Returns:

true, if the widget should be displayed, false otherwise or if widget is null.

getWidgetBodySclass

protected String getWidgetBodySclass(WidgetInstance widgetInstance)

getWidgetMoldSclass

protected String getWidgetMoldSclass(WidgetInstance widgetInstance,
                                     WidgetDefinition definition)

injectWidgetVariables

protected void injectWidgetVariables(Object widgetController,
                                     WidgetInstanceManager widgetInstanceManager)
                              throws IllegalAccessException

Throws:

IllegalAccessException

createComponents

protected void createComponents(Widgetslot widgetslot)

adjustWidgetSclass

protected void adjustWidgetSclass(WidgetInstance widgetInstance,
                                  WidgetDefinition definition,
                                  org.zkoss.zk.ui.Component component)

getDocumentNoViewWidget

protected org.zkoss.idom.Document getDocumentNoViewWidget()

getDocumentWithWidgetSlot

protected org.zkoss.idom.Document getDocumentWithWidgetSlot()

createLabelMap

public Map<String,Object> createLabelMap(WidgetDefinition definition,
                                         Widget widget)

renderUnattachedChildren

protected void renderUnattachedChildren(Widgetslot widgetslot,
                                        List<Widget> unattachedChildren)

getWidgetDefinition

protected WidgetDefinition getWidgetDefinition(Widget widget)

getComponentDefinition

protected <T> T getComponentDefinition(String widgetId)

getSessionWidgetInstance

protected WidgetInstance getSessionWidgetInstance(String slotId)

setSessionWidgetInstance

protected void setSessionWidgetInstance(WidgetInstance instance,
                                        String slotId)

sendOutput

public void sendOutput(Widgetslot widgetslot,
                       String outputID)

Description copied from interface: CockpitWidgetEngine

Calls sendOutput(widgetslot, outputID, null)}.

Specified by:

sendOutput in interface CockpitWidgetEngine

sendOutput

public void sendOutput(Widgetslot widgetslot,
                       String outputID,
                       Object data)

Description copied from interface: CockpitWidgetEngine

Calls sendOutput(widgetslot, outputID, data, false)}.

Specified by:

sendOutput in interface CockpitWidgetEngine

sendOutput

public void sendOutput(Widgetslot widgetslot,
                       String outputId,
                       Object data,
                       boolean ignoreSockets)

Description copied from interface: CockpitWidgetEngine

Sends an output event from the widget attached to the widgetslot parameter with the given outputID. This method is finally called from DefaultWidgetController.sendOutput(String, Object).

Specified by:

sendOutput in interface CockpitWidgetEngine

Parameters:

widgetslot - The source widget slot

outputId - The output socket id

data - The event data

ignoreSockets - If false, the event is only sent if the output socket with outputID exists. Otherwise no check is done and the event is sent. This is only needed for internal use, especially for composed widget internal event handling.

isSocketDataTypeValid

protected boolean isSocketDataTypeValid(Object object,
                                        Widget currentWidget,
                                        WidgetSocket outputWidgetSocket)

isSocketTypeMatching

protected boolean isSocketTypeMatching(String socketDataType,
                                       WidgetSocket.Multiplicity socketMultiplicity,
                                       Object object)

resolveObjectMultiplicity

protected WidgetSocket.Multiplicity resolveObjectMultiplicity(Object object)

getOutputSocketTypeMessage

protected String getOutputSocketTypeMessage(WidgetSocket outputWidgetSocket,
                                            String outputSocketType)

lookupGroupTemplateInstance

protected WidgetInstance lookupGroupTemplateInstance(Widget groupContainerWidget,
                                                     WidgetInstance currentWidgetInstance)

sendEventToTargetWidget

protected void sendEventToTargetWidget(String eventName,
                                       Widget target,
                                       Object data,
                                       String sourceSocketId,
                                       WidgetInstance source)

sendEventToTargetWidgetInternal

protected void sendEventToTargetWidgetInternal(String eventName,
                                               Object data,
                                               String sourceSocketId,
                                               WidgetInstance source,
                                               List<WidgetInstance> widgetInstances)

resolveSingleTargetInstance

protected WidgetInstance resolveSingleTargetInstance(WidgetInstance source,
                                                     Widget target)

Checks, if an event should be routed to one single instance of the target widget.

Parameters:

source - The WidgetInstance which has sent the event.

target - The target Widget.

Returns:

The target WidgetInstance that should receive the event or null, if none could be resolved.

sendSocketEvent

protected void sendSocketEvent(Widgetslot widgetContainer,
                               String eventName,
                               Object data,
                               String sourceSocketId,
                               WidgetInstance sourceWidgetInstance)

logSocketEvent

protected void logSocketEvent(Widgetslot widgetContainer,
                              String targetSocketId,
                              Object data,
                              String sourceSocketId,
                              WidgetInstance sourceWidgetInstance)

getDesktop

protected org.zkoss.zk.ui.Desktop getDesktop()

createWidgetView

public void createWidgetView(Widgetchildren widgetChildrenComponent)

Description copied from interface: CockpitWidgetEngine

Same as CockpitWidgetEngine.createWidgetView(Widgetchildren, Map) with empty map as second arg.

Specified by:

createWidgetView in interface CockpitWidgetEngine

createWidgetView

public void createWidgetView(Widgetchildren widgetChildrenComponent,
                             Map<String,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

getChildrenContainerRenderer

public Map<String,WidgetChildrenContainerRenderer> getChildrenContainerRenderer()

setChildrenContainerRenderer

public void setChildrenContainerRenderer(Map<String,WidgetChildrenContainerRenderer> childrenContainerRenderer)

isIndependentView

public boolean isIndependentView(WidgetDefinition widget,
                                 String url)

Description copied from interface: CockpitWidgetEngine

Checks whether provided URL points to widget's view, which is defined as not dependent from ZK framework (i.e. uses pure html or some third party javascript library)

Specified by:

isIndependentView in interface CockpitWidgetEngine

Parameters:

widget - widget definition to be checked

url - requested URL

Returns:

true if a URL points to view that is defined as independent

getWidgetService

public WidgetService getWidgetService()

setWidgetService

public void setWidgetService(WidgetService widgetService)

getWidgetDefinitionService

protected CockpitComponentDefinitionService getWidgetDefinitionService()

setComponentDefinitionService

public void setComponentDefinitionService(CockpitComponentDefinitionService componentDefinitionService)

getWidgetUtils

protected WidgetUtils getWidgetUtils()

setWidgetUtils

public void setWidgetUtils(WidgetUtils widgetUtils)

getRulesEngine

protected WidgetTemplateRulesEngine getRulesEngine()

setRulesEngine

public void setRulesEngine(WidgetTemplateRulesEngine rulesEngine)

getWidgetPersistenceService

protected WidgetPersistenceService getWidgetPersistenceService()

setWidgetPersistenceService

public void setWidgetPersistenceService(WidgetPersistenceService widgetPersistenceService)

setSessionWidgetInstanceRegistry

public void setSessionWidgetInstanceRegistry(SessionWidgetInstanceRegistry sessionWidgetInstanceRegistry)

getWidgetInstanceFacade

protected WidgetInstanceFacade getWidgetInstanceFacade()

setWidgetInstanceFacade

public void setWidgetInstanceFacade(WidgetInstanceFacade widgetInstanceFacade)

getCockpitThreadContextCreator

protected CockpitThreadContextCreator getCockpitThreadContextCreator()

setCockpitThreadContextCreator

public void setCockpitThreadContextCreator(CockpitThreadContextCreator cockpitThreadContextCreator)

getWidgetLibUtils

protected WidgetLibUtils getWidgetLibUtils()

setWidgetLibUtils

public void setWidgetLibUtils(WidgetLibUtils widgetLibUtils)

setModelValueHandlerFactory

public void setModelValueHandlerFactory(ModelValueHandlerFactory modelValueHandlerFactory)

getWidgetConfigurationContextDecoratorList

public List<WidgetConfigurationContextDecorator> getWidgetConfigurationContextDecoratorList()

setWidgetConfigurationContextDecoratorList

public void setWidgetConfigurationContextDecoratorList(List<WidgetConfigurationContextDecorator> contextDecoratorList)

getCockpitConfigurationService

public CockpitConfigurationService getCockpitConfigurationService()

setCockpitConfigurationService

public void setCockpitConfigurationService(CockpitConfigurationService cockpitConfigurationService)

getWidgetAuthorizationService

protected WidgetAuthorizationService getWidgetAuthorizationService()

setWidgetAuthorizationService

public void setWidgetAuthorizationService(WidgetAuthorizationService widgetAuthorizationService)

getCockpitProperties

protected CockpitProperties getCockpitProperties()

setCockpitProperties

public void setCockpitProperties(CockpitProperties cockpitProperties)

setCockpitResourceLoader

public void setCockpitResourceLoader(CockpitResourceLoader cockpitResourceLoader)

getCockpitTypeUtils

public CockpitTypeUtils getCockpitTypeUtils()

setCockpitTypeUtils

public void setCockpitTypeUtils(CockpitTypeUtils cockpitTypeUtils)

getSocketConnectionService

public SocketConnectionService getSocketConnectionService()

setSocketConnectionService

public void setSocketConnectionService(SocketConnectionService socketConnectionService)

getLabelService

public LabelService getLabelService()

setLabelService

public void setLabelService(LabelService labelService)