xapi.ui.autoui.api.UiRenderer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xapi-dev Show documentation
Show all versions of xapi-dev Show documentation
Everything needed to run a comprehensive dev environment.
Just type X_ and pick a service from autocomplete;
new dev modules will be added as they are built.
The only dev service not included in the uber jar is xapi-dev-maven,
as it includes all runtime dependencies of maven, adding ~4 seconds to build time,
and 6 megabytes to the final output jar size (without xapi-dev-maven, it's ~1MB).
The newest version!
package xapi.ui.autoui.api;
public interface UiRenderer {
/**
* Called when a renderer must render an object into a UserInterface.
*
* Calls to this method are guarded by {@link UiRendererSelector#useRenderer(UserInterface, UiRenderer, Object) UiRendererSelector.useRenderer()},
* which can be used to filter incompatible UserInterfaces and UiRenderers.
*
* The {@link UiRendererSelector} used will be the one paired with the specified UiRenderer
* inside of a {@link UiRendererOptions} annotation.
*
* @param ui -> The UserInterface to render into.
* @param ctx -> The {@link UiRenderingContext} containing the utilities needed to render the data
* @param path -> The path of the data to render; data can be retrieved from the data using the
* {@link BeanValueProvider} found in the {@link UiRenderingContext#getBeanValueProvider()}.
* @param data -> The data to render
* @return -> this, for chaining
*/
UiRenderer renderInto(UserInterface ui, UiRenderingContext ctx, String path, T data);
}