de.hybris.platform.cockpit.widgets.renderers

Interface WidgetRenderer<T extends Widget>

Type Parameters:

T - widget type

All Known Implementing Classes:

PlatformLinksWidgetRenderer

public interface WidgetRenderer<T extends Widget>

A widget renderer is responsible for rendering the caption and content of a widget.

Method Summary

Modifier and Type	Method and Description
HtmlBasedComponent	createCaption(T widget) Creates and returns the widget's caption component.
HtmlBasedComponent	createContent(T widget) Creates and returns the widget's (main) content component.

Method Detail

createCaption

HtmlBasedComponent createCaption(T widget)

Creates and returns the widget's caption component.

Note: The renderer is not responsible for attaching the caption component to the passed widget instance. This is handled automatically during the widget initialization process.

Parameters:

widget - the widget component

Returns:

the created caption component

createContent

HtmlBasedComponent createContent(T widget)

Creates and returns the widget's (main) content component.

Note: The renderer is not responsible for attaching the content component to the passed widget instance. This is handled automatically during the widget initialization process.
However, some widgets (e.g. InputWidget) need to be able to access specific content components (e.g. input component) for updating purposes etc, which means that the renderer needs to pass those components to the widget directly. Please see InputWidget#setInputComponent(org.zkoss.zul.impl.api.InputElement) for an example.

Parameters:

widget - the widget component

Returns:

the created content component