de.hybris.platform.cockpit.widgets.impl

Class DefaultWidgetContainer<T extends Widget>

java.lang.Object

de.hybris.platform.cockpit.widgets.impl.DefaultWidgetContainer<T>

All Implemented Interfaces:

WidgetContainer<T>

Direct Known Subclasses:

PortalWidgetContainer

public class DefaultWidgetContainer<T extends Widget>
extends java.lang.Object
implements WidgetContainer<T>

Constructor Summary

Constructors

Constructor and Description
DefaultWidgetContainer(WidgetFactory factory)

Method Summary

Modifier and Type	Method and Description
void	addCockpitEventAcceptor(CockpitEventAcceptor acceptor) Registers the CockpitEventAcceptor acceptor with this widget container.
void	cleanup() Performs widget cleanup i.e.
protected T	createWidget(WidgetConfig widgetConfig, java.lang.String widgetCode)
void	focusWidget(java.lang.String focusWidgetCode) Focuses the widget associated with the specified widget code.
protected java.util.List<CockpitEventAcceptor>	getCockpitEventAcceptors()
java.lang.String	getFocusedWidgetCode() Returns the widget code of the currently focused widget.
T	getWidget(java.lang.String widgetCode) Returns the widget associated with the specified widget code.
WidgetFactory	getWidgetFactory() Returns the WidgetFactory used for creating widgets.
protected java.util.Map<java.lang.String,T>	getWidgetMap()
java.util.Map<java.lang.String,T>	initialize(java.util.Map<java.lang.String,WidgetConfig> widgetConfigs) Initializes this container i.e.
protected void	notifyListeners(CockpitEvent event)
void	removeCockpitEventAcceptor(CockpitEventAcceptor acceptor) Unregisters the CockpitEventAcceptor acceptor with this widget container.
void	setWidgetFactory(WidgetFactory widgetFactory) Sets the WidgetFactory used for creating widgets.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWidgetContainer

public DefaultWidgetContainer(WidgetFactory factory)

Method Detail

getWidgetFactory

public WidgetFactory getWidgetFactory()

Description copied from interface: WidgetContainer

Returns the WidgetFactory used for creating widgets.

Specified by:

getWidgetFactory in interface WidgetContainer<T extends Widget>

Returns:

the widget factory

setWidgetFactory

public void setWidgetFactory(WidgetFactory widgetFactory)

Description copied from interface: WidgetContainer

Sets the WidgetFactory used for creating widgets.

Specified by:

setWidgetFactory in interface WidgetContainer<T extends Widget>

Parameters:

widgetFactory - the widget factory

cleanup

public void cleanup()

Description copied from interface: WidgetContainer

Performs widget cleanup i.e. unregisters any listeners etc.

Note: It is very important that this method is called when the widgets are invalidated e.g. when the widgets' parent view component has been detached from the ZK desktop.

Specified by:

cleanup in interface WidgetContainer<T extends Widget>

getWidgetMap

protected java.util.Map<java.lang.String,T> getWidgetMap()

focusWidget

public void focusWidget(java.lang.String focusWidgetCode)

Description copied from interface: WidgetContainer

Focuses the widget associated with the specified widget code.

Specified by:

focusWidget in interface WidgetContainer<T extends Widget>

Parameters:

focusWidgetCode - widget code

notifyListeners

protected void notifyListeners(CockpitEvent event)

getFocusedWidgetCode

public java.lang.String getFocusedWidgetCode()

Description copied from interface: WidgetContainer

Returns the widget code of the currently focused widget.

Specified by:

getFocusedWidgetCode in interface WidgetContainer<T extends Widget>

Returns:

code of the focused widget or null if no widget has focus

getWidget

public T getWidget(java.lang.String widgetCode)

Description copied from interface: WidgetContainer

Returns the widget associated with the specified widget code.

Specified by:

getWidget in interface WidgetContainer<T extends Widget>

Parameters:

widgetCode - widget code

Returns:

widget mapped to the code or null if no widget is mapped to the supplied key

initialize

public java.util.Map<java.lang.String,T> initialize(java.util.Map<java.lang.String,WidgetConfig> widgetConfigs)

Description copied from interface: WidgetContainer

Initializes this container i.e. creates widgets based on the supplied WidgetConfig map.

Specified by:

initialize in interface WidgetContainer<T extends Widget>

Parameters:

widgetConfigs - map containing widget codes and configurations used when creating the widgets

Returns:

map containing the created widgets mapped to their widget code

createWidget

protected T createWidget(WidgetConfig widgetConfig,
                         java.lang.String widgetCode)

addCockpitEventAcceptor

public void addCockpitEventAcceptor(CockpitEventAcceptor acceptor)

Description copied from interface: WidgetContainer

Registers the CockpitEventAcceptor acceptor with this widget container.

Specified by:

addCockpitEventAcceptor in interface WidgetContainer<T extends Widget>

Parameters:

acceptor - the event acceptor to register

removeCockpitEventAcceptor

public void removeCockpitEventAcceptor(CockpitEventAcceptor acceptor)

Description copied from interface: WidgetContainer

Unregisters the CockpitEventAcceptor acceptor with this widget container.

Specified by:

removeCockpitEventAcceptor in interface WidgetContainer<T extends Widget>

Parameters:

acceptor - the event acceptor to unregister

getCockpitEventAcceptors

protected java.util.List<CockpitEventAcceptor> getCockpitEventAcceptors()