TPTP 4.1.0 Platform Project
Public API Specification

org.eclipse.tptp.platform.report.core.provisional
Interface IRenderer

All Known Implementing Classes:
StaticImageRenderer, SVGRenderer, SWTGraphicViewer

public interface IRenderer

An interface that defines apis needed by a device renderer to render a chart.


Field Summary
static java.lang.String OUTPUTSTREAM_IDENTIFIER
          Property key that specifies the output stream used to generate a chart.
 
Method Summary
 void render(IChart chart)
          Renders a chart based on a chart model.
 void setProperty(java.lang.String key, java.lang.Object value)
          This method provides the ability to set renderer specific parameters.
 

Field Detail

OUTPUTSTREAM_IDENTIFIER

public static final java.lang.String OUTPUTSTREAM_IDENTIFIER
Property key that specifies the output stream used to generate a chart. Note not all renderers may not support this property.

See Also:
Constant Field Values
Method Detail

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)
                 throws RendererException
This method provides the ability to set renderer specific parameters.

Parameters:
key - The parameter name.
value - The value of the parameter.
Throws:
RendererException - Throws an exception if the parameter is not supported by the renderer.

render

public void render(IChart chart)
            throws RendererException
Renders a chart based on a chart model.

Parameters:
chart - The chart model
Throws:
RendererException - Throws an exception if an error occurs during rendering.

TPTP 4.1.0 Platform Project
Public API Specification