com.hybris.cockpitng.widgets.util

Interface EditorWrappingUtils

All Known Implementing Classes:

DefaultEditorWrappingUtils

public interface EditorWrappingUtils

Utilities used to wrap editors with other

Method Summary

Modifier and Type	Method and Description
EditorBuilder	createWrappedEditor(Collection<Parameter> parameters, DataType valueType, String editorDefinitionId, WidgetInstanceManager widgetInstanceManager) Creates an editor component for specified definition identity.
EditorBuilder	createWrappedEditor(Collection<Parameter> parameters, String editorDefinitionId, DataAttribute dataAttribute, WidgetInstanceManager widgetInstanceManager, String itemPath) Creates an editor component for specified definition identity bound to specified data attribute.
boolean	isEditorWrappingEnabled(String editorDefinitionId, TypedSettingsMap widgetSettings) Checks if wrapping is enabled for specified widget.

Method Detail

createWrappedEditor

EditorBuilder createWrappedEditor(Collection<Parameter> parameters,
                                  DataType valueType,
                                  String editorDefinitionId,
                                  WidgetInstanceManager widgetInstanceManager)

Creates an editor component for specified definition identity. An editor is potentially wrapped (depending on i.e. widget settings).

Parameters:

parameters - editor parameters

valueType - type of value that is to be represented by an editor

editorDefinitionId - editor definition identity (may be null

widgetInstanceManager - instance manager for a widget that requires editor

Returns:

a prepared builder for editor of provided definition id potentially wrapped with different one

createWrappedEditor

EditorBuilder createWrappedEditor(Collection<Parameter> parameters,
                                  String editorDefinitionId,
                                  DataAttribute dataAttribute,
                                  WidgetInstanceManager widgetInstanceManager,
                                  String itemPath)

Creates an editor component for specified definition identity bound to specified data attribute. An editor is potentially wrapped (depending on i.e. widget settings)

Parameters:

parameters - editor parameters

editorDefinitionId - editor definition identity (may be null

dataAttribute - an attribute that editor is representing

widgetInstanceManager - instance manager for a widget that requires editor

itemPath - specifies a path in widgets model to an item, which attribute is to be represented by editor

Returns:

a prepared builder for editor of provided definition id potentially wrapped with different one

isEditorWrappingEnabled

boolean isEditorWrappingEnabled(String editorDefinitionId,
                                TypedSettingsMap widgetSettings)

Checks if wrapping is enabled for specified widget. Method should also check, if in case of specified editor definition wrapping is required.

Parameters:

editorDefinitionId - editor definition identity to be potentially wrapped

widgetSettings - settings of a widget

Returns:

true if editor would be wrapped, if requested