com.mathworks.toolbox.javabuilder.webfigures

Class WebFigureRenderer

java.lang.Object

com.mathworks.toolbox.javabuilder.webfigures.WebFigureRenderer

public class WebFigureRenderer
extends java.lang.Object

Provides the ability to render a WebFigure object to an encoded image (PNG, JPEG, etc.) or a BufferedImage. This object owns an MCR instance, so it must be disposed when no longer needed to release native resources. Example (assumes there is a WebFigure in scope, called 'figure'): final WebFigureRenderer renderer = new WebFigureRenderer(); try { final WebFigureRenderParameters params = new WebFigureRenderParameters( figure ); params.setWidth( 300 ); params.setHeight( 200 ); final BufferedImage i = renderer.renderImage( params ); // do something interesting with the image here... } finally { renderer.dispose(); }

Constructor Summary

Constructors

Constructor and Description
WebFigureRenderer() Create a WebFigureRenderer using a new MCR instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() Release all native resources associated with this object.
byte[]	renderBytes(WebFigureRenderParameters params) Render a WebFigure, producing an encoded image (e.g.
java.awt.image.BufferedImage	renderImage(WebFigureRenderParameters params) Render a WebFigure, producing an encoded image (e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebFigureRenderer

public WebFigureRenderer()
                  throws MWException

Create a WebFigureRenderer using a new MCR instance.

Throws:

MWException - if the MCR fails to initialize

Method Detail

renderBytes

public byte[] renderBytes(WebFigureRenderParameters params)
                   throws java.io.IOException,
                          MWException,
                          com.mathworks.toolbox.javabuilder.services.ServiceException

Render a WebFigure, producing an encoded image (e.g. PNG, JPEG, etc.)

Parameters:

params - parameters to control the rendering operation

Returns:

an array of bytes containing the encoded image data

Throws:

java.io.IOException - if an error occurs while encoding the image

MWException - if an error occurs during Java-MATLAB data conversion

com.mathworks.toolbox.javabuilder.services.ServiceException - if an error occurs inside MATLAB code

renderImage

public java.awt.image.BufferedImage renderImage(WebFigureRenderParameters params)
                                         throws MWException,
                                                com.mathworks.toolbox.javabuilder.services.ServiceException

Render a WebFigure, producing an encoded image (e.g. PNG, JPEG, etc.)

Parameters:

params - parameters to control the rendering operation

Returns:

the rendered WebFigure, as a BufferedImage

Throws:

MWException - if an error occurs during Java-MATLAB data conversion

com.mathworks.toolbox.javabuilder.services.ServiceException - if an error occurs inside MATLAB code

dispose

public void dispose()

Release all native resources associated with this object. MUST BE CALLED BEFORE THIS OBJECT GOES OUT OF SCOPE