org.jplot2d.env

Class RenderEnvironment

java.lang.Object

org.jplot2d.env.Environment

org.jplot2d.env.PlotEnvironment

org.jplot2d.env.RenderEnvironment

public class RenderEnvironment
extends PlotEnvironment

This environment extends plot environment to add ability to render a plot.

Constructor Summary

Constructors

Constructor and Description
RenderEnvironment(boolean threadSafe) Construct a environment to render the given plot.

Method Summary

Modifier and Type	Method and Description
boolean	addRenderer(Renderer renderer)
void	exportComponent(PComponent comp, Renderer renderer) Export a component and all its sub-components to the given renderer.
void	exportPlot(Renderer renderer) Export plot to the given renderer.
void	exportToEPS(java.lang.String filename) Export the Plot to an EPS file.
void	exportToPDF(java.lang.String filename) Export the Plot to an PDF file.
void	exportToPNG(java.lang.String filename) Export the Plot to a PNG file.
static java.lang.String	getDefaultExportDirectory() Returns the default export directory.
java.lang.String	getExportDirectory() Returns the export directory for this environment.
java.io.File	getExportFile(java.lang.String filename) Returns the file for the given file name.
Renderer[]	getRenderers()
boolean	removeRenderer(Renderer renderer)
static void	setDefaultExportDirectory(java.lang.String dir) Sets the default export directory.
void	setExportDirectory(java.lang.String dir) Sets the export directory for this environment.

Methods inherited from class org.jplot2d.env.PlotEnvironment

canRedo, canUndo, getNotifier, getPlot, getPlotAt, getSelectableCompnentAt, getUndoLevels, redo, setNotifier, setPlot, setPlot, setUndoLevels, undo

Methods inherited from class org.jplot2d.env.Environment

addElementChangeListener, beginBatch, endBatch, endBatch, getCommandLogger, getElementChangeListeners, getProxy, removeElementChangeListener, setCommandLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderEnvironment

public RenderEnvironment(boolean threadSafe)

Construct a environment to render the given plot.

Parameters:

threadSafe - if false, all plot properties can only be changed within a single thread, such as servlet. if true, all plot properties can be safely changed by multiple threads.

Method Detail

getRenderers

public Renderer[] getRenderers()

addRenderer

public boolean addRenderer(Renderer renderer)

removeRenderer

public boolean removeRenderer(Renderer renderer)

exportPlot

public void exportPlot(Renderer renderer)

Export plot to the given renderer.

Parameters:

renderer -

exportComponent

public void exportComponent(PComponent comp,
                            Renderer renderer)

Export a component and all its sub-components to the given renderer.

Parameters:

renderer -

getDefaultExportDirectory

public static java.lang.String getDefaultExportDirectory()

Returns the default export directory.

Returns:

the default export directory

setDefaultExportDirectory

public static void setDefaultExportDirectory(java.lang.String dir)

Sets the default export directory. If the given directory is relative path, it's relative to user's home directory. The default export directory is persisted within a session.

Parameters:

dir - the default directory for exporting files

getExportDirectory

public java.lang.String getExportDirectory()

Returns the export directory for this environment. If this directory is null, the global default directory will be used when exporting a plot.

Returns:

the export directory for this environment

setExportDirectory

public void setExportDirectory(java.lang.String dir)

Sets the export directory for this environment. If the directory is null, the global default directory will be used when exporting a plot. If the given directory is a relative path, it's relative to user's home directory.

Parameters:

dir - the export directory for this environment

getExportFile

public java.io.File getExportFile(java.lang.String filename)

Returns the file for the given file name. If the given file name is already absolute, then the pathname string is simply returned. Otherwise the export directory is used as parent pathname.

Parameters:

filename - the filename

Returns:

a file object

exportToEPS

public void exportToEPS(java.lang.String filename)
                 throws java.io.IOException

Export the Plot to an EPS file.

Throws:

java.io.IOException

exportToPDF

public void exportToPDF(java.lang.String filename)
                 throws java.io.IOException

Export the Plot to an PDF file.

Throws:

java.io.IOException

exportToPNG

public void exportToPNG(java.lang.String filename)
                 throws java.io.IOException

Export the Plot to a PNG file.

Throws:

java.io.IOException