Gephi Toolkit Javadoc

org.gephi.preview.spi
Interface RenderTargetBuilder

All Known Implementing Classes:
PDFRenderTargetBuilder, ProcessingRenderTargetBuilder, SVGRenderTargetBuilder

public interface RenderTargetBuilder

Builds and returns new RenderTarget instances.

Render targets are the rendering container and are built by RenderTargetBuilder implementations. Each render target is associated to it's preview model and shouldn't be reused across models. The PreviewModel provides methods to retrieve properties and dimensions of the graph.

Render targets are singleton services and implementations need to add the following annotation to be recognized by the system:

@ServiceProvider(service=RenderTargetBuilder.class)

Author:
Mathieu Bastian

Method Summary
 RenderTarget buildRenderTarget(PreviewModel previewModel)
          Builds a new render target using the properties and dimensions defined in previewModel.
 java.lang.String getName()
          Returns the name of the target builder.
 

Method Detail

buildRenderTarget

RenderTarget buildRenderTarget(PreviewModel previewModel)
Builds a new render target using the properties and dimensions defined in previewModel.

Parameters:
previewModel - the preview model to get the dimensions and properties from
Returns:
a new render target instance

getName

java.lang.String getName()
Returns the name of the target builder. This value is used by the PreviewController to identify render targets.

Returns:
the name of the target builder

Gephi Toolkit Javadoc