com.hybris.cockpitng.engine.impl

Class DefaultWidgetInstanceFacade

java.lang.Object

com.hybris.cockpitng.engine.impl.DefaultWidgetInstanceFacade

All Implemented Interfaces:

WidgetInstanceFacade

Direct Known Subclasses:

AdminWidgetInstanceFacade

public class DefaultWidgetInstanceFacade
extends Object
implements WidgetInstanceFacade

Implementation of the WidgetInstanceFacade for the default widget engine.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHILD_INDEX

Constructor Summary

Constructors

Constructor and Description
DefaultWidgetInstanceFacade()

Method Summary

Modifier and Type	Method and Description
boolean	canCreateInstance(Widget widget, WidgetInstance parentInstance) Checks if a new instance of the given widget can be created.
boolean	canRemoveInstance(WidgetInstance instance) Checks if the given instance can be removed.
WidgetInstance	createWidgetInstance(Widget widget, WidgetInstance parentInstance) Creates new widget instance as a child of the given parent.
WidgetInstance	createWidgetInstance(Widget widget, WidgetInstance parentInstance, Object creator) Creates new widget instance as a child of the given parent with assigned creator.
List<Widget>	getPossibleWidgets(WidgetInstance parentInstance, String slotId) Returns a list of all possible widgets that instances can be created of.
WidgetInstance	getRootWidgetInstance(Widget rootWidget) Returns a widget instance for the given root widget.
Comparator<Widget>	getWidgetIndexComparator()
List<WidgetInstance>	getWidgetInstances(WidgetInstance parentInstance) Returns a list of all child widget instances of the given parent.
List<WidgetInstance>	getWidgetInstances(WidgetInstance parentInstance, String slotId, boolean isSingleSlot) Returns a list of all instances of the given widget belonging to the given parent and assigned to the given slotId.
List<WidgetInstance>	getWidgetInstances(Widget widget, WidgetInstance parentInstance) Returns a list of all instances of the given widget belonging to the given parent.
WidgetInstanceService	getWidgetInstanceService()
void	removeWidgetInstance(WidgetInstance instance) Removes given widget instance from the widget tree.
void	setWidgetIndexComparator(Comparator<Widget> widgetIndexComparator)
void	setWidgetInstanceService(WidgetInstanceService widgetInstanceService)

Methods inherited from class java.lang.Object

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

Field Detail

CHILD_INDEX

public static final String CHILD_INDEX

See Also:

Constant Field Values

Constructor Detail

DefaultWidgetInstanceFacade

public DefaultWidgetInstanceFacade()

Method Detail

getRootWidgetInstance

public WidgetInstance getRootWidgetInstance(Widget rootWidget)

Description copied from interface: WidgetInstanceFacade

Returns a widget instance for the given root widget.

Specified by:

getRootWidgetInstance in interface WidgetInstanceFacade

Parameters:

rootWidget - the widget from which root is returned

Returns:

the root widget instance

getWidgetInstances

public List<WidgetInstance> getWidgetInstances(WidgetInstance parentInstance,
                                               String slotId,
                                               boolean isSingleSlot)

Description copied from interface: WidgetInstanceFacade

Returns a list of all instances of the given widget belonging to the given parent and assigned to the given slotId.

Specified by:

getWidgetInstances in interface WidgetInstanceFacade

Parameters:

parentInstance - the WidgetInstance from which Widget Instances will be returned

slotId - assigned slotId from which slot instances will be returned

isSingleSlot - whether slot is single or not

Returns:

list of all instances of the given widget belonging to the given parent and assigned to the given slotId

getWidgetInstances

public List<WidgetInstance> getWidgetInstances(WidgetInstance parentInstance)

Description copied from interface: WidgetInstanceFacade

Returns a list of all child widget instances of the given parent.

Specified by:

getWidgetInstances in interface WidgetInstanceFacade

Parameters:

parentInstance - WidgetInstance based on which child instances are returned

Returns:

child widget instances

getWidgetInstances

public List<WidgetInstance> getWidgetInstances(Widget widget,
                                               WidgetInstance parentInstance)

Description copied from interface: WidgetInstanceFacade

Returns a list of all instances of the given widget belonging to the given parent.

Specified by:

getWidgetInstances in interface WidgetInstanceFacade

Parameters:

widget - the parent from which instances will be returned

parentInstance - the WidgetInstance from which Widget Instances will be returned

Returns:

child widget instances

createWidgetInstance

public WidgetInstance createWidgetInstance(Widget widget,
                                           WidgetInstance parentInstance,
                                           Object creator)

Description copied from interface: WidgetInstanceFacade

Creates new widget instance as a child of the given parent with assigned creator.

Specified by:

createWidgetInstance in interface WidgetInstanceFacade

Parameters:

widget - a widget to create widget instance

parentInstance - Widget Instance in which new widget instance will be created

creator - assigned creator

Returns:

created Widget Instance

createWidgetInstance

public WidgetInstance createWidgetInstance(Widget widget,
                                           WidgetInstance parentInstance)

Description copied from interface: WidgetInstanceFacade

Creates new widget instance as a child of the given parent.

Specified by:

createWidgetInstance in interface WidgetInstanceFacade

Parameters:

widget - a widget to create widget instance

parentInstance - Widget Instance in which new widget instance will be created

Returns:

created Widget Instance

removeWidgetInstance

public void removeWidgetInstance(WidgetInstance instance)

Description copied from interface: WidgetInstanceFacade

Removes given widget instance from the widget tree. View model will be removed as well. All child instances will be removed as well.

Specified by:

removeWidgetInstance in interface WidgetInstanceFacade

Parameters:

instance - Widget Instance to be removed form the widget tree

canCreateInstance

public boolean canCreateInstance(Widget widget,
                                 WidgetInstance parentInstance)

Description copied from interface: WidgetInstanceFacade

Checks if a new instance of the given widget can be created. It might be disabled by user visibility rule.

Specified by:

canCreateInstance in interface WidgetInstanceFacade

Parameters:

widget - check will be done if this widget can be created

parentInstance - Widget Instance in which creation possibility will be tested

Returns:

true if a given widget instance can be created

canRemoveInstance

public boolean canRemoveInstance(WidgetInstance instance)

Description copied from interface: WidgetInstanceFacade

Checks if the given instance can be removed.

Specified by:

canRemoveInstance in interface WidgetInstanceFacade

Parameters:

instance - test if this instance can be removed

Returns:

true if removal is possible

getPossibleWidgets

public List<Widget> getPossibleWidgets(WidgetInstance parentInstance,
                                       String slotId)

Description copied from interface: WidgetInstanceFacade

Returns a list of all possible widgets that instances can be created of.

Specified by:

getPossibleWidgets in interface WidgetInstanceFacade

Parameters:

parentInstance - Widget Instance in which Widgets could be possibly created

slotId - slotId name in which Widgets could be possibly created

Returns:

a list of all possible widgets that instances can be created of

getWidgetInstanceService

public WidgetInstanceService getWidgetInstanceService()

setWidgetInstanceService

public void setWidgetInstanceService(WidgetInstanceService widgetInstanceService)

getWidgetIndexComparator

public Comparator<Widget> getWidgetIndexComparator()

setWidgetIndexComparator

public void setWidgetIndexComparator(Comparator<Widget> widgetIndexComparator)