de.hybris.platform.cockpit.model.editor

Class EditorHelper

java.lang.Object

de.hybris.platform.cockpit.model.editor.EditorHelper

public class EditorHelper
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EditorHelper.LanguageAwareEditorListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOWED_VALUES_LIST
static String	EVENT_SOURCE

Constructor Summary

Constructors

Constructor and Description
EditorHelper()

Method Summary

Modifier and Type	Method and Description
static CreateContext	applyReferenceRelatedAttributes(ReferenceUIEditor referenceEditor, PropertyDescriptor propertyDescriptor, Map<String,? extends Object> parameters, TypedObject currentObject, Object currentValue, String isoCode, UICockpitArea cockpitArea, UISession session)
protected static boolean	checkLanguageVisibility(TypedObject item, String languageIso)
static void	createEditor(TypedObject item, PropertyDescriptor propDescr, HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist) Convenience method for creating and rendering a UIEditor.
static void	createEditor(TypedObject item, PropertyDescriptor propDescr, HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist, EditorListener editorListener, String editorCode) Convenience method for creating and rendering a UIEditor variant specified by editorCode.
static void	createEditor(TypedObject item, PropertyDescriptor propDescr, HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist, String editorCode) Convenience method for creating and rendering a UIEditor variant specified by editorCode.
static void	createEditor(TypedObject item, PropertyDescriptor propDescr, HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist, String editorCode, Map<String,? extends Object> params) Convenience method for creating and rendering a UIEditor variant specified by editorCode.
static void	createEditor(TypedObject item, PropertyDescriptor propDescr, HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist, String editorCode, Map<String,? extends Object> params, boolean focus) Convenience method for creating and rendering a UIEditor variant specified by editorCode.
static void	createEditor(TypedObject item, PropertyDescriptor propDescr, HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist, String editorCode, Map<String,? extends Object> params, EditorListener editorListener) Convenience method for creating and rendering a UIEditor variant specified by editorCode.
static void	createEditor(TypedObject item, PropertyDescriptor propDescr, HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist, String editorCode, Map<String,? extends Object> params, EditorListener editorListener, boolean focus) Convenience method for creating and rendering a UIEditor variant specified by editorCode.
static void	createEditor(TypedObject item, PropertyDescriptor propDescr, HtmlBasedComponent parent, ObjectValueContainer valueContainer, EditorListener editorListener, boolean autoPersist) Convenience method for creating and rendering a UIEditor.
static <T> List<? extends T>	filterValues(PropertyDescriptor propDescr, List<? extends T> values) Deprecated.
static List<Object>	getAvailableValues(Map<String,? extends Object> params, PropertyDescriptor propertyDescriptor) Gets available values for a ListUIEditor using configured AvailableValuesProvider spring bean.
static TypedObject	getCatalogVersionIfPresent(TypedObject item)
static SearchType	getRootSearchType(PropertyDescriptor propDescr, UISession session)
protected static UIAccessRightService	getUIAccessRightService()
static UIEditor	getUIEditor(PropertyDescriptor propDescr, String editorCode) Convenience method for creating and retrieving a UIEditor.
static void	initializeSections(EditorConfiguration cfg, ObjectType type, TypedObject object, TypeService typeService)
static boolean	isEditable(PropertyDescriptor propDescr, boolean creationMode) Deprecated. Use UIAccessRightService's isWritable methods instead.
static Set<ObjectType>	parseTemplateCodes(String input, TypeService typeService)
static void	persistValues(TypedObject item, ObjectValueContainer valueContainer)
static void	persistValues(TypedObject item, ObjectValueContainer valueContainer, Map<String,? extends Object> params)
static ObjectTemplate	processVariantTypeCheck(ObjectTemplate type, TypedObject object, PropertyDescriptor propertyDescriptor, TypeService typeService)
static List<String>	removeHiddenLanguages(TypedObject item, Collection<String> languages)
static void	renderLocalizedEditor(TypedObject item, PropertyDescriptor propDescr, HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist, String editorCode, Map<String,? extends Object> params, boolean focus)
static void	renderLocalizedEditor(TypedObject item, PropertyDescriptor propDescr, HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist, String editorCode, Map<String,? extends Object> params, boolean focus, EditorListener editorListener)
static void	renderSingleEditor(TypedObject item, PropertyDescriptor propDescr, HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist, String editorCode, Map<String,? extends Object> params, String isoCode, boolean focus)
static void	renderSingleEditor(TypedObject item, PropertyDescriptor propDescr, HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist, String editorCode, Map<String,? extends Object> params, String isoCode, boolean focus, EditorListener editorListener)
static void	setAvailableValuesInListEditor(ListUIEditor editor, PropertyDescriptor propertyDescriptor, Map<String,? extends Object> params) Helper method to set available values in ListUIEditor editor.
static void	tryOpenContextAreaEditor(UICockpitPerspective perspective, ObjectTemplate type, Collection value, TypedObject currentObject, PropertyDescriptor propertyDescriptor, Map<String,? extends Object> parameters)

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_SOURCE

public static final String EVENT_SOURCE

See Also:

Constant Field Values

ALLOWED_VALUES_LIST

public static final String ALLOWED_VALUES_LIST

See Also:

Constant Field Values

Constructor Detail

EditorHelper

public EditorHelper()

Method Detail

applyReferenceRelatedAttributes

public static CreateContext applyReferenceRelatedAttributes(ReferenceUIEditor referenceEditor,
                                                            PropertyDescriptor propertyDescriptor,
                                                            Map<String,? extends Object> parameters,
                                                            TypedObject currentObject,
                                                            Object currentValue,
                                                            String isoCode,
                                                            UICockpitArea cockpitArea,
                                                            UISession session)

createEditor

public static void createEditor(TypedObject item,
                                PropertyDescriptor propDescr,
                                HtmlBasedComponent parent,
                                ObjectValueContainer valueContainer,
                                boolean autoPersist)
                         throws IllegalArgumentException

Convenience method for creating and rendering a UIEditor. Handles editor events and loads/stores data from/to the specified ObjectValueContainer valueContainer.

If autoPersist is true values are stored in the value container and instantly persisted.

Creates the default editor for the property type specified. Internally calls createEditor(propDescr, parent, valueContainer, null).

Parameters:

item - the item instance for which an editor is to be created

propDescr - the property descriptor for which a corresponding editor is to be created

parent - the parent component to which the editor is to be added

valueContainer - the ObjectValueContainer used for loading/storing values

autoPersist - whether values should be automatically persisted or not

Throws:

IllegalArgumentException - if the property descriptor, parent component or value container is invalid

See Also:

createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String, Map), getUIEditor(PropertyDescriptor, String)

createEditor

public static void createEditor(TypedObject item,
                                PropertyDescriptor propDescr,
                                HtmlBasedComponent parent,
                                ObjectValueContainer valueContainer,
                                boolean autoPersist,
                                EditorListener editorListener,
                                String editorCode)
                         throws IllegalArgumentException

Convenience method for creating and rendering a UIEditor variant specified by editorCode. Handles editor events and loads/stores data from/to the specified ObjectValueContainer valueContainer.

If autoPersist is true values are stored in the value container and instantly persisted.

In order to create the default editor for the specified property use createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean) instead.

Parameters:

item - the item instance for which an editor is to be created

propDescr - the property descriptor for which a corresponding editor is to be created

parent - the parent component to which the editor is to be added

valueContainer - the ObjectValueContainer used for loading/storing values

autoPersist - whether values should be automatically persisted or not

editorListener - current editor listener instance EditorListener

editorCode - the editor variant to be created or null for the default one

Throws:

IllegalArgumentException - if the property descriptor, parent component or value container is invalid

See Also:

createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, EditorListener, boolean), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String, Map, EditorListener), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String, Map, EditorListener, boolean), getUIEditor(PropertyDescriptor, String)

createEditor

public static void createEditor(TypedObject item,
                                PropertyDescriptor propDescr,
                                HtmlBasedComponent parent,
                                ObjectValueContainer valueContainer,
                                boolean autoPersist,
                                String editorCode)
                         throws IllegalArgumentException

Convenience method for creating and rendering a UIEditor variant specified by editorCode. Handles editor events and loads/stores data from/to the specified ObjectValueContainer valueContainer.

If autoPersist is true values are stored in the value container and instantly persisted.

In order to create the default editor for the specified property use createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean) instead.

Parameters:

item - the item instance for which an editor is to be created

propDescr - the property descriptor for which a corresponding editor is to be created

parent - the parent component to which the editor is to be added

valueContainer - the ObjectValueContainer used for loading/storing values

autoPersist - whether values should be automatically persisted or not

editorCode - the editor variant to be created or null for the default one

Throws:

IllegalArgumentException - if the property descriptor, parent component or value container is invalid

See Also:

createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String, Map), getUIEditor(PropertyDescriptor, String)

createEditor

public static void createEditor(TypedObject item,
                                PropertyDescriptor propDescr,
                                HtmlBasedComponent parent,
                                ObjectValueContainer valueContainer,
                                boolean autoPersist,
                                String editorCode,
                                Map<String,? extends Object> params)
                         throws IllegalArgumentException

Convenience method for creating and rendering a UIEditor variant specified by editorCode. Handles editor events and loads/stores data from/to the specified ObjectValueContainer valueContainer.

If autoPersist is true values are stored in the value container and instantly persisted.

In order to create the default editor for the specified property use createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean) instead.

Parameters:

item - the item instance for which an editor is to be created

propDescr - the property descriptor for which a corresponding editor is to be created

parent - the parent component to which the editor is to be added

valueContainer - the ObjectValueContainer used for loading/storing values

autoPersist - whether values should be automatically persisted or not

editorCode - the editor variant to be created or null for the default one

params - creation parameters

Throws:

IllegalArgumentException - if the property descriptor, parent component or value container is invalid

See Also:

createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String, Map, boolean), getUIEditor(PropertyDescriptor, String)

createEditor

public static void createEditor(TypedObject item,
                                PropertyDescriptor propDescr,
                                HtmlBasedComponent parent,
                                ObjectValueContainer valueContainer,
                                boolean autoPersist,
                                String editorCode,
                                Map<String,? extends Object> params,
                                boolean focus)
                         throws IllegalArgumentException

Convenience method for creating and rendering a UIEditor variant specified by editorCode. Handles editor events and loads/stores data from/to the specified ObjectValueContainer valueContainer.

If autoPersist is true values are stored in the value container and instantly persisted.

In order to create the default editor for the specified property use createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean) instead.

Parameters:

item - the item instance for which an editor is to be created

propDescr - the property descriptor for which a corresponding editor is to be created

parent - the parent component to which the editor is to be added

valueContainer - the ObjectValueContainer used for loading/storing values

autoPersist - whether values should be automatically persisted or not

editorCode - the editor variant to be created or null for the default one

params - creation parameters

focus - whether the created editor should be given initial focus or not

Throws:

IllegalArgumentException - if the property descriptor, parent component or value container is invalid

See Also:

createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean), getUIEditor(PropertyDescriptor, String)

createEditor

public static void createEditor(TypedObject item,
                                PropertyDescriptor propDescr,
                                HtmlBasedComponent parent,
                                ObjectValueContainer valueContainer,
                                boolean autoPersist,
                                String editorCode,
                                Map<String,? extends Object> params,
                                EditorListener editorListener)
                         throws IllegalArgumentException

Convenience method for creating and rendering a UIEditor variant specified by editorCode. Handles editor events and loads/stores data from/to the specified ObjectValueContainer valueContainer.

If autoPersist is true values are stored in the value container and instantly persisted.

In order to create the default editor for the specified property use createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean) instead.

Parameters:

item - the item instance for which an editor is to be created

propDescr - the property descriptor for which a corresponding editor is to be created

parent - the parent component to which the editor is to be added

valueContainer - the ObjectValueContainer used for loading/storing values

autoPersist - whether values should be automatically persisted or not

editorCode - the editor variant to be created or null for the default one

params - creation parameters

editorListener - current editor listener instance EditorListener

Throws:

IllegalArgumentException - if the property descriptor, parent component or value container is invalid

See Also:

createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, EditorListener, boolean), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, EditorListener, String), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String, Map, EditorListener, boolean), getUIEditor(PropertyDescriptor, String)

createEditor

public static void createEditor(TypedObject item,
                                PropertyDescriptor propDescr,
                                HtmlBasedComponent parent,
                                ObjectValueContainer valueContainer,
                                boolean autoPersist,
                                String editorCode,
                                Map<String,? extends Object> params,
                                EditorListener editorListener,
                                boolean focus)
                         throws IllegalArgumentException

Convenience method for creating and rendering a UIEditor variant specified by editorCode. Handles editor events and loads/stores data from/to the specified ObjectValueContainer valueContainer.

If autoPersist is true values are stored in the value container and instantly persisted.

In order to create the default editor for the specified property use createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean) instead.

Parameters:

item - the item instance for which an editor is to be created

propDescr - the property descriptor for which a corresponding editor is to be created

parent - the parent component to which the editor is to be added

valueContainer - the ObjectValueContainer used for loading/storing values

autoPersist - whether values should be automatically persisted or not

editorCode - the editor variant to be created or null for the default one

params - creation parameters

editorListener - current editor listener instance EditorListener

focus - whether the created editor should be given initial focus or not

Throws:

IllegalArgumentException - if the property descriptor, parent component or value container is invalid

See Also:

createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, EditorListener, boolean), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, EditorListener, String), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String, Map, EditorListener), getUIEditor(PropertyDescriptor, String)

createEditor

public static void createEditor(TypedObject item,
                                PropertyDescriptor propDescr,
                                HtmlBasedComponent parent,
                                ObjectValueContainer valueContainer,
                                EditorListener editorListener,
                                boolean autoPersist)
                         throws IllegalArgumentException

Convenience method for creating and rendering a UIEditor. Handles editor events and loads/stores data from/to the specified ObjectValueContainer valueContainer.

If autoPersist is true values are stored in the value container and instantly persisted.

Creates the default editor for the property type specified. Internally calls createEditor(propDescr, parent, valueContainer, null).

Parameters:

item - the item instance for which an editor is to be created

propDescr - the property descriptor for which a corresponding editor is to be created

parent - the parent component to which the editor is to be added

valueContainer - the ObjectValueContainer used for loading/storing values

editorListener - current editor listener instance EditorListener

autoPersist - whether values should be automatically persisted or not

Throws:

IllegalArgumentException - if the property descriptor, parent component or value container is invalid

See Also:

createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, EditorListener, String), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String, Map, EditorListener), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String, Map, EditorListener, boolean), getUIEditor(PropertyDescriptor, String)

filterValues

@Deprecated
public static <T> List<? extends T> filterValues(PropertyDescriptor propDescr,
                                                             List<? extends T> values)

Deprecated.

getRootSearchType

public static SearchType getRootSearchType(PropertyDescriptor propDescr,
                                           UISession session)

getUIAccessRightService

protected static UIAccessRightService getUIAccessRightService()

getUIEditor

public static UIEditor getUIEditor(PropertyDescriptor propDescr,
                                   String editorCode)
                            throws IllegalArgumentException

Convenience method for creating and retrieving a UIEditor.

Note: If no editor variant is found with the code editorCode, the default editor for the specified property is returned.

Parameters:

propDescr - the property descriptor for which a corresponding editor is to be retrieved

editorCode - the editor variant to be used

Returns:

a new UIEditor instance for the specified property and - if available - for the specified editor variant

Throws:

IllegalArgumentException - if the property descriptor is invalid

See Also:

createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String, Map), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String, Map, boolean), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, EditorListener, boolean), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, EditorListener, String), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String, Map, EditorListener), createEditor(TypedObject, PropertyDescriptor, HtmlBasedComponent, ObjectValueContainer, boolean, String, Map, EditorListener, boolean)

initializeSections

public static void initializeSections(EditorConfiguration cfg,
                                      ObjectType type,
                                      TypedObject object,
                                      TypeService typeService)

isEditable

@Deprecated
public static boolean isEditable(PropertyDescriptor propDescr,
                                             boolean creationMode)

Deprecated. Use UIAccessRightService's isWritable methods instead.

Returns whether the specified property is editable or not.

Parameters:

propDescr - the property descriptor

Returns:

true if the property is editable, false otherwise

persistValues

public static void persistValues(TypedObject item,
                                 ObjectValueContainer valueContainer)
                          throws ValueHandlerException

Throws:

ValueHandlerException

persistValues

public static void persistValues(TypedObject item,
                                 ObjectValueContainer valueContainer,
                                 Map<String,? extends Object> params)
                          throws ValueHandlerException

Throws:

ValueHandlerException

processVariantTypeCheck

public static ObjectTemplate processVariantTypeCheck(ObjectTemplate type,
                                                     TypedObject object,
                                                     PropertyDescriptor propertyDescriptor,
                                                     TypeService typeService)

tryOpenContextAreaEditor

public static void tryOpenContextAreaEditor(UICockpitPerspective perspective,
                                            ObjectTemplate type,
                                            Collection value,
                                            TypedObject currentObject,
                                            PropertyDescriptor propertyDescriptor,
                                            Map<String,? extends Object> parameters)

parseTemplateCodes

public static final Set<ObjectType> parseTemplateCodes(String input,
                                                       TypeService typeService)

renderLocalizedEditor

public static void renderLocalizedEditor(TypedObject item,
                                         PropertyDescriptor propDescr,
                                         HtmlBasedComponent parent,
                                         ObjectValueContainer valueContainer,
                                         boolean autoPersist,
                                         String editorCode,
                                         Map<String,? extends Object> params,
                                         boolean focus)

checkLanguageVisibility

protected static boolean checkLanguageVisibility(TypedObject item,
                                                 String languageIso)

renderLocalizedEditor

public static void renderLocalizedEditor(TypedObject item,
                                         PropertyDescriptor propDescr,
                                         HtmlBasedComponent parent,
                                         ObjectValueContainer valueContainer,
                                         boolean autoPersist,
                                         String editorCode,
                                         Map<String,? extends Object> params,
                                         boolean focus,
                                         EditorListener editorListener)

renderSingleEditor

public static void renderSingleEditor(TypedObject item,
                                      PropertyDescriptor propDescr,
                                      HtmlBasedComponent parent,
                                      ObjectValueContainer valueContainer,
                                      boolean autoPersist,
                                      String editorCode,
                                      Map<String,? extends Object> params,
                                      String isoCode,
                                      boolean focus)

renderSingleEditor

public static void renderSingleEditor(TypedObject item,
                                      PropertyDescriptor propDescr,
                                      HtmlBasedComponent parent,
                                      ObjectValueContainer valueContainer,
                                      boolean autoPersist,
                                      String editorCode,
                                      Map<String,? extends Object> params,
                                      String isoCode,
                                      boolean focus,
                                      EditorListener editorListener)

getAvailableValues

public static List<Object> getAvailableValues(Map<String,? extends Object> params,
                                              PropertyDescriptor propertyDescriptor)

Gets available values for a ListUIEditor using configured AvailableValuesProvider spring bean. Spring bean's name is passed as a value of the ALLOWED_VALUES_LIST configuration parameter - ALLOWED_VALUES_LIST

setAvailableValuesInListEditor

public static void setAvailableValuesInListEditor(ListUIEditor editor,
                                                  PropertyDescriptor propertyDescriptor,
                                                  Map<String,? extends Object> params)

Helper method to set available values in ListUIEditor editor. First it tries to use configured AvailableValuesProvider spring bean to get a list of available values. If no bean is configured, it uses TypeService.getAvailableValues(PropertyDescriptor) method.

Parameters:

editor - target editor.

propertyDescriptor - The property descriptor of the property to be set with one of the "available values".

params - keeps the set of parameters configured for the editor.

getCatalogVersionIfPresent

public static TypedObject getCatalogVersionIfPresent(TypedObject item)

removeHiddenLanguages

public static List<String> removeHiddenLanguages(TypedObject item,
                                                 Collection<String> languages)