Package com.hybris.cockpitng.widgets.common

Interface WidgetComponentRenderer<PARENT,CONFIG,DATA>

Type Parameters:

PARENT - type of parent component on which renderer is able to render

CONFIG - type of configuration for renderer

DATA - type of data that may be rendered

All Known Subinterfaces:

CompareViewLayout, NotifyingWidgetComponentRenderer<PARENT,CONFIG,DATA>

All Known Implementing Classes:

AbstractCompareViewElementRenderer, AbstractCompareViewSectionHeaderRenderer, AbstractCompareViewSectionRenderer, AbstractCustomMenuActionRenderer, AbstractEditorAreaComponentRenderer, AbstractEditorAreaPanelRenderer, AbstractEditorAreaSectionRenderer, AbstractEditorAreaTabRenderer, AbstractImageBoxRenderer, AbstractImageComponentRenderer, AbstractLazyRenderer, AbstractSummaryViewItemWithIconRenderer, AbstractWidgetComponentRenderer, AttributeChooserRenderer, CompoundWidgetComponentRenderer, CountingRenderer, DefaultCompareViewAttributeRenderer, DefaultCompareViewBoxRenderer, DefaultCompareViewHeaderItemRenderer, DefaultCompareViewHeaderRenderer, DefaultCompareViewHeaderSummaryRenderer, DefaultCompareViewLayout, DefaultCompareViewSectionHeaderRenderer, DefaultCompareViewSectionRenderer, DefaultCustomViewRenderer, DefaultDataQualityGroupRenderer, DefaultDataQualityPropertyRenderer, DefaultEditorAreaPanelRenderer, DefaultEditorAreaRenderer, DefaultEditorAreaSectionRenderer, DefaultEditorAreaTabRenderer, DefaultFieldQueryFieldRenderer, DefaultFieldQueryPopupRenderer, DefaultGridBoxRenderer, DefaultListCellRenderer, DefaultListViewRenderer, DefaultPinRenderer, DefaultPreviewListCellRenderer, DefaultQuickListItemRenderer, DefaultRemoveItemRenderer, DefaultSummaryViewAssetsRenderer, DefaultSummaryViewAttributeRenderer, DefaultSummaryViewSectionRenderer, DefaultSummaryViewThumbnailRenderer, DefaultTreeViewRenderer, DefaultValidatableCustomViewRenderer, DefaultValueChooserRenderer, PermissionManagementListCellRenderer, PermissionManagementListViewRenderer, UnboundSectionRenderer

public interface WidgetComponentRenderer<PARENT,CONFIG,DATA>

API for renderers that could be used for rendering components within widgets.

Method Summary

Modifier and Type	Method	Description
default void	addRendererListener(WidgetComponentRendererListener<PARENT,CONFIG,DATA> listener)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.5
default void	removeRendererListener(WidgetComponentRendererListener<PARENT,CONFIG,DATA> listener)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.5
void	render(PARENT parent, CONFIG configuration, DATA data, DataType dataType, WidgetInstanceManager widgetInstanceManager)	Renders a component inside parent, representing given data and complying to given ui configuration.
default void	render(PARENT parent, CONFIG configuration, DATA data, DataType dataType, WidgetInstanceManager widgetInstanceManager, Context context)	Deprecated, for removal: This API element is subject to removal in a future version. since version 6.5, use render(java.lang.Object, java.lang.Object, java.lang.Object, com.hybris.cockpitng.dataaccess.facades.type.DataType, com.hybris.cockpitng.engine.WidgetInstanceManager) instead

Method Detail

addRendererListener

@Deprecated(since="6.5",
            forRemoval=true)
default void addRendererListener(WidgetComponentRendererListener<PARENT,CONFIG,DATA> listener)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.5

Registers a listener for any component rendering.

Parameters:

listener - listener to be registered

See Also:

NotifyingWidgetComponentRenderer

removeRendererListener

@Deprecated(since="6.5",
            forRemoval=true)
default void removeRendererListener(WidgetComponentRendererListener<PARENT,CONFIG,DATA> listener)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.5

Unregisters a listener for any component rendering.

Parameters:

listener - listener to be registered

See Also:

NotifyingWidgetComponentRenderer

render

void render(PARENT parent,
            CONFIG configuration,
            DATA data,
            DataType dataType,
            WidgetInstanceManager widgetInstanceManager)

Renders a component inside parent, representing given data and complying to given ui configuration. The data should be of give dataType. The renderer implementation could communicate with underlying widget via widgetInstanceManager.

Parameters:

parent - parent component on which to render

configuration - configuration of renderer

data - data to be rendered

dataType - meta information about type of data provided

widgetInstanceManager - widget manager in scope of which renderer is used

render

@Deprecated(since="6.5",
            forRemoval=true)
default void render(PARENT parent,
                    CONFIG configuration,
                    DATA data,
                    DataType dataType,
                    WidgetInstanceManager widgetInstanceManager,
                    Context context)

Deprecated, for removal: This API element is subject to removal in a future version.

since version 6.5, use render(java.lang.Object, java.lang.Object, java.lang.Object, com.hybris.cockpitng.dataaccess.facades.type.DataType, com.hybris.cockpitng.engine.WidgetInstanceManager) instead

Renders a component inside parent, representing given data and complying to given ui configuration. The data should be of give dataType. The renderer implementation could communicate with underlying widget via widgetInstanceManager.

Parameters:

parent - parent component on which to render

configuration - configuration of renderer

data - data to be rendered

dataType - meta information about type of data provided

widgetInstanceManager - widget manager in scope of which renderer is used

context - context for the renderer