xapi.ui.autoui.api

Interface UiRenderer<T>

All Known Implementing Classes:

ToHtmlUiRenderer, ToStringUiRenderer

public interface UiRenderer<T>

Method Summary

Modifier and Type	Method and Description
UiRenderer<T>	renderInto(UserInterface<?> ui, UiRenderingContext ctx, String path, T data) Called when a renderer must render an object into a UserInterface.

Method Detail

renderInto

UiRenderer<T> renderInto(UserInterface<?> ui,
                         UiRenderingContext ctx,
                         String path,
                         T data)

Called when a renderer must render an object into a UserInterface.
Calls to this method are guarded by UiRendererSelector.useRenderer(), which can be used to filter incompatible UserInterfaces and UiRenderers.
The UiRendererSelector used will be the one paired with the specified UiRenderer inside of a UiRendererOptions annotation.

Parameters:

ui - -> The UserInterface to render into.

ctx - -> The UiRenderingContext containing the utilities needed to render the data

path - -> The path of the data to render; data can be retrieved from the data using the BeanValueProvider found in the UiRenderingContext.getBeanValueProvider().

data - -> The data to render

Returns:

-> this, for chaining