Package com.hybris.cockpitng.util.impl

Class DefaultWidgetUtils

java.lang.Object

com.hybris.cockpitng.util.impl.DefaultWidgetUtils

All Implemented Interfaces:

WidgetUtils

public class DefaultWidgetUtils
extends java.lang.Object
implements WidgetUtils

Default implementation for WidgetUtils. For internal use only.

Field Summary

Fields inherited from interface com.hybris.cockpitng.util.WidgetUtils

NOTIFIER_STACK

Constructor Summary

Constructors

Constructor	Description
DefaultWidgetUtils()

Method Summary

Modifier and Type	Method	Description
void	addGlobalEventListener(java.lang.String eventName, Widgetslot widget, org.zkoss.zk.ui.event.EventListener eventListener, java.lang.String scope)	Adds an event listener to the global event queue.
org.zkoss.zk.ui.Component	addNotifierToStack(org.zkoss.zk.ui.Component content)
org.zkoss.zk.ui.Component	addNotifierToStack(org.zkoss.zk.ui.Component content, org.zkoss.zk.ui.Component notifierStack)
void	clearWidgetLibrary()
void	dispatchGlobalEvents()	Gets all unprocessed events from the global event queue and notifies subscribers.
org.zkoss.zk.ui.Component	getCockpitRoot()	Gets the root of the current desktop.
protected java.util.Map<java.lang.String,Widgetslot>	getDesktopWidgetslotMap()
protected java.util.Set<Resettable>	getElementsToReset()
WidgetPersistenceService	getModelBasedWidgetPersistenceService()
Widgetslot	getRegisteredWidgetslot(WidgetInstance widgetInstance)	Gets the Widgetslot component for the given WidgetInstance, if it has been registered for the current Desktop.
Widgetslot	getRegisteredWidgetslot(java.lang.String widgetInstanceId)	Gets the Widgetslot component for the given widgetInstanceId, if it has been registered for the current Desktop.
org.zkoss.zk.ui.Component	getRoot()	Same as WidgetUtils.getCockpitRoot().
protected CockpitSessionService	getSessionService()
protected WidgetPersistenceService	getWidgetPersistenceService()
protected WidgetService	getWidgetService()
XMLWidgetPersistenceService	getXmlBasedWidgetPersistenceService()
boolean	isPartOfComposedWidget(Widget widget)	Checks, if the given widget is has a group widget as ancestor.
void	refreshWidgetLibrary()
void	registerWidgetslot(Widgetslot widgetslot)	Registers a Widgetslot at the current Desktop.
void	setCockpitEventQueue(CockpitEventQueue cockpitEventQueue)
void	setElementsToReset(java.util.Set<Resettable> elementsToReset)
void	setModelBasedWidgetPersistenceService(WidgetPersistenceService modelBasedWidgetPersistenceService)
void	setSessionService(CockpitSessionService sessionService)
void	setWidgetDefinitionService(CockpitComponentDefinitionService widgetDefinitionService)
void	setWidgetPersistenceService(WidgetPersistenceService widgetPersistenceService)
void	setWidgetService(WidgetService widgetService)
void	setXmlBasedWidgetPersistenceService(XMLWidgetPersistenceService xmlBasedWidgetPersistenceService)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWidgetUtils

public DefaultWidgetUtils()

Method Detail

refreshWidgetLibrary

public void refreshWidgetLibrary()

Specified by:

refreshWidgetLibrary in interface WidgetUtils

clearWidgetLibrary

public void clearWidgetLibrary()

Specified by:

clearWidgetLibrary in interface WidgetUtils

addGlobalEventListener

public void addGlobalEventListener(java.lang.String eventName,
                                   Widgetslot widget,
                                   org.zkoss.zk.ui.event.EventListener eventListener,
                                   java.lang.String scope)

Description copied from interface: WidgetUtils

Adds an event listener to the global event queue.

Specified by:

addGlobalEventListener in interface WidgetUtils

dispatchGlobalEvents

public void dispatchGlobalEvents()

Description copied from interface: WidgetUtils

Gets all unprocessed events from the global event queue and notifies subscribers.

Specified by:

dispatchGlobalEvents in interface WidgetUtils

addNotifierToStack

public org.zkoss.zk.ui.Component addNotifierToStack(org.zkoss.zk.ui.Component content)

Specified by:

addNotifierToStack in interface WidgetUtils

Parameters:

content - content component of the notify entry.

Returns:

returns a component that represents a notifier entry which will be created in the root notifier component. This component should be detached if not used anymore.

addNotifierToStack

public org.zkoss.zk.ui.Component addNotifierToStack(org.zkoss.zk.ui.Component content,
                                                    org.zkoss.zk.ui.Component notifierStack)

Specified by:

addNotifierToStack in interface WidgetUtils

Parameters:

content - content component of the notify entry

notifierStack - All notifiers will be displayed in this component. If null, no notifier entries will be created at all.

Returns:

returns a component that represents a notifier entry. This component should be detached if not used anymore.

getRegisteredWidgetslot

public Widgetslot getRegisteredWidgetslot(WidgetInstance widgetInstance)

Description copied from interface: WidgetUtils

Gets the Widgetslot component for the given WidgetInstance, if it has been registered for the current Desktop.

Specified by:

getRegisteredWidgetslot in interface WidgetUtils

getRegisteredWidgetslot

public Widgetslot getRegisteredWidgetslot(java.lang.String widgetInstanceId)

Description copied from interface: WidgetUtils

Gets the Widgetslot component for the given widgetInstanceId, if it has been registered for the current Desktop.

Specified by:

getRegisteredWidgetslot in interface WidgetUtils

registerWidgetslot

public void registerWidgetslot(Widgetslot widgetslot)

Description copied from interface: WidgetUtils

Registers a Widgetslot at the current Desktop.

Specified by:

registerWidgetslot in interface WidgetUtils

getDesktopWidgetslotMap

protected java.util.Map<java.lang.String,Widgetslot> getDesktopWidgetslotMap()

getRoot

public org.zkoss.zk.ui.Component getRoot()

Description copied from interface: WidgetUtils

Same as WidgetUtils.getCockpitRoot().

Specified by:

getRoot in interface WidgetUtils

getCockpitRoot

public org.zkoss.zk.ui.Component getCockpitRoot()

Description copied from interface: WidgetUtils

Gets the root of the current desktop.

Specified by:

getCockpitRoot in interface WidgetUtils

isPartOfComposedWidget

public boolean isPartOfComposedWidget(Widget widget)

Description copied from interface: WidgetUtils

Checks, if the given widget is has a group widget as ancestor.

Specified by:

isPartOfComposedWidget in interface WidgetUtils

getSessionService

protected CockpitSessionService getSessionService()

setSessionService

public void setSessionService(CockpitSessionService sessionService)

getXmlBasedWidgetPersistenceService

public XMLWidgetPersistenceService getXmlBasedWidgetPersistenceService()

setXmlBasedWidgetPersistenceService

public void setXmlBasedWidgetPersistenceService(XMLWidgetPersistenceService xmlBasedWidgetPersistenceService)

getModelBasedWidgetPersistenceService

public WidgetPersistenceService getModelBasedWidgetPersistenceService()

setModelBasedWidgetPersistenceService

public void setModelBasedWidgetPersistenceService(WidgetPersistenceService modelBasedWidgetPersistenceService)

getWidgetService

protected WidgetService getWidgetService()

setWidgetService

public void setWidgetService(WidgetService widgetService)

getWidgetPersistenceService

protected WidgetPersistenceService getWidgetPersistenceService()

setWidgetPersistenceService

public void setWidgetPersistenceService(WidgetPersistenceService widgetPersistenceService)

setWidgetDefinitionService

public void setWidgetDefinitionService(CockpitComponentDefinitionService widgetDefinitionService)

setCockpitEventQueue

public void setCockpitEventQueue(CockpitEventQueue cockpitEventQueue)

getElementsToReset

protected java.util.Set<Resettable> getElementsToReset()

setElementsToReset

public void setElementsToReset(java.util.Set<Resettable> elementsToReset)