Package com.hybris.cockpitng.widgets.util

Interface EditorWrappingUtils

  • All Known Implementing Classes:
    DefaultEditorWrappingUtils
    public interface EditorWrappingUtils
    Utilities used to wrap editors with other

    • Method Detail

      • createWrappedEditor

        EditorBuilder createWrappedEditor​(java.util.Collection<Parameter> parameters,
                                  DataType valueType,
                                  java.lang.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​(java.util.Collection<Parameter> parameters,
                                  java.lang.String editorDefinitionId,
                                  DataAttribute dataAttribute,
                                  WidgetInstanceManager widgetInstanceManager,
                                  java.lang.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

      • createWrappedEditor

        EditorBuilder createWrappedEditor​(java.util.Collection<Parameter> parameters,
                                  java.lang.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
        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

      • isEditorWrappingEnabled

        boolean isEditorWrappingEnabled​(java.lang.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