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-gwt Show documentation

This module exists solely to package all other gwt modules into a single uber jar. This makes deploying to non-mavenized targets much easier. Of course, you would be wise to inherit your dependencies individually; the uber jar is intended for projects like collide, which have complex configuration, and adding many jars would be a pain.

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);

}