de.hybris.platform.cockpit.util

Class ViewUpdateUtils

java.lang.Object

de.hybris.platform.cockpit.util.ViewUpdateUtils

public class ViewUpdateUtils
extends java.lang.Object

Utility class for adding a "self update" feature to zk components

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ViewUpdateUtils.UpdateCallbackObject An object that can be attached to a zk component

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MODIFIED_ITEM_KEY
static java.lang.String	MODIFIED_PROPERTIES_KEY

Constructor Summary

Constructors

Constructor and Description
ViewUpdateUtils()

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.Object>	createItemPropertyContext(TypedObject item, java.util.Collection<PropertyDescriptor> modifiedProperties) Convenience method to create a context map that can be checked later by isMatchingItemPropertyContext(Map, TypedObject, PropertyDescriptor) and isUpdateNeeded(Map, TypedObject, PropertyDescriptor, TypeService, ValueService).
static boolean	isMatchingItemPropertyContext(java.util.Map<java.lang.String,java.lang.Object> ctx, TypedObject item, PropertyDescriptor propertyDescriptor) Checks, if a TypedObject and PropertyDescriptor is contained in the given context
static boolean	isUpdateNeeded(java.util.Map<java.lang.String,java.lang.Object> ctx, TypedObject item, PropertyDescriptor propertyDescriptor, TypeService typeService, ValueService valueService) Utility method to check, if an update is needed regarding to changes of an item.
static void	performViewUpdate(Component component, java.util.Map<java.lang.String,java.lang.Object> ctx, boolean recursive) Try to update the current zk component, according to the attached ViewUpdateUtils.UpdateCallbackObject object.
static void	setUpdateCallback(Component component, ViewUpdateUtils.UpdateCallbackObject updateCallbackObject) Attaches an ViewUpdateUtils.UpdateCallbackObject object to a zk component
static void	suppressNextUpdateOn(Component component) Marks the given zk component to prevent an update at the next run of performViewUpdate(Component, Map, boolean).

Methods inherited from class java.lang.Object

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

Field Detail

MODIFIED_PROPERTIES_KEY

public static final java.lang.String MODIFIED_PROPERTIES_KEY

See Also:

Constant Field Values

MODIFIED_ITEM_KEY

public static final java.lang.String MODIFIED_ITEM_KEY

See Also:

Constant Field Values

Constructor Detail

ViewUpdateUtils

public ViewUpdateUtils()

Method Detail

performViewUpdate

public static void performViewUpdate(Component component,
                                     java.util.Map<java.lang.String,java.lang.Object> ctx,
                                     boolean recursive)

Try to update the current zk component, according to the attached ViewUpdateUtils.UpdateCallbackObject object. If recursive is set to true, also recursively updates the child components.

Parameters:

component - the zk component to update

ctx - additional context parameters, which are passed to the ViewUpdateUtils.UpdateCallbackObject.update(Component, Map) method.

recursive - true, if the update should include all child components

setUpdateCallback

public static void setUpdateCallback(Component component,
                                     ViewUpdateUtils.UpdateCallbackObject updateCallbackObject)

Attaches an ViewUpdateUtils.UpdateCallbackObject object to a zk component

Parameters:

component - the zk component

updateCallbackObject - an instance of ViewUpdateUtils.UpdateCallbackObject

suppressNextUpdateOn

public static void suppressNextUpdateOn(Component component)

Marks the given zk component to prevent an update at the next run of performViewUpdate(Component, Map, boolean). This is pretty useful e.g. when changing a value in a cockpit editor which usually causes an item changed event that again may the reason for re-rendering the editor. In most cases this is not necessary, since the change is immediately reflected to the editor and a re-rendering will lose the focus on it.

Parameters:

component - the component

isUpdateNeeded

public static boolean isUpdateNeeded(java.util.Map<java.lang.String,java.lang.Object> ctx,
                                     TypedObject item,
                                     PropertyDescriptor propertyDescriptor,
                                     TypeService typeService,
                                     ValueService valueService)

Utility method to check, if an update is needed regarding to changes of an item. Calls isMatchingItemPropertyContext(Map, TypedObject, PropertyDescriptor) and does some additionally tests, if the changed item may be referenced by the property

Parameters:

ctx - a map that contains informations about modified item and properties, mapped to the keys MODIFIED_ITEM_KEY and MODIFIED_PROPERTIES_KEY

item - the item that should be checked against the context

propertyDescriptor - the property the should be checked against the context

typeService - the typeService

Returns:

true, if update is needed

isMatchingItemPropertyContext

public static boolean isMatchingItemPropertyContext(java.util.Map<java.lang.String,java.lang.Object> ctx,
                                                    TypedObject item,
                                                    PropertyDescriptor propertyDescriptor)

Checks, if a TypedObject and PropertyDescriptor is contained in the given context

Parameters:

ctx - a map that contains informations about modified item and properties, mapped to the keys MODIFIED_ITEM_KEY and MODIFIED_PROPERTIES_KEY

item - the item that should be checked against the context

propertyDescriptor - the property the should be checked against the context

Returns:

true, if the context contains item and property

createItemPropertyContext

public static java.util.Map<java.lang.String,java.lang.Object> createItemPropertyContext(TypedObject item,
                                                                                         java.util.Collection<PropertyDescriptor> modifiedProperties)

Convenience method to create a context map that can be checked later by isMatchingItemPropertyContext(Map, TypedObject, PropertyDescriptor) and isUpdateNeeded(Map, TypedObject, PropertyDescriptor, TypeService, ValueService).

Parameters:

item - the item that should be added to the context

modifiedProperties - the properties that should be added to the context

Returns:

the context map