ptolemy.gui

Interface ImageExportable

All Known Implementing Classes:

ActorGraphFrame, AudioViewer, BasicGraphFrame, CaseGraphFrame, Console.ConsoleFrame, DebugListenerTableau.DebugListenerFrame, EditablePlotMLApplication, EditIconFrame, ExtendedGraphFrame, FmvAutomatonGraphFrame, FSMGraphFrame, GTFrame, HistogramMLApplication, InterfaceAutomatonGraphFrame, MatchResultViewer, NavigableActorGraphFrame, OntologyGraphFrame, OntologySolverGraphFrame, PlotApplication, PlotFrame, PlotMLApplication, PlotMLFrame, PlotTableauFrame, PteraGraphFrame, PxgraphApplication, TextEditor, TextEditorForStringAttributes, TransformationEditor

public interface ImageExportable

Interface indicating support for exporting an image.

Since:

Ptolemy II 10.0

Version:

$Id: ImageExportable.java 67784 2013-10-26 16:53:27Z cxh $

Author:

Edward A. Lee

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (cxh)

Method Summary

Modifier and Type	Method and Description
void	writeImage(java.io.OutputStream stream, java.lang.String format) Write an image to the specified output stream in the specified format.

Method Detail

writeImage

void writeImage(java.io.OutputStream stream,
                java.lang.String format)
         throws java.awt.print.PrinterException,
                java.io.IOException

Write an image to the specified output stream in the specified format. Supported formats include at least "gif" and "png", standard image file formats. The image is a rendition of the current view of the model.

Parameters:

stream - The output stream to write to.

format - The image format to generate.

Throws:

java.io.IOException - If writing to the stream fails.

java.awt.print.PrinterException - If the specified format is not supported.