001/* Interface indicating support for exporting an image.
002
003 Copyright (c) 2011-2013 The Regents of the University of California.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026
027 */
028
029package ptolemy.gui;
030
031import java.awt.print.PrinterException;
032import java.io.IOException;
033import java.io.OutputStream;
034
035///////////////////////////////////////////////////////////////////
036//// ImageExportable
037/**
038 * Interface indicating support for exporting an image.
039 * @author Edward A. Lee
040 * @version $Id$
041 * @since Ptolemy II 10.0
042 * @Pt.ProposedRating Red (cxh)
043 * @Pt.AcceptedRating Red (cxh)
044 */
045public interface ImageExportable {
046
047    /** Write an image to the specified output stream in the specified format.
048     *  Supported formats include at least "gif" and "png", standard image file formats.
049     *  The image is a rendition of the current view of the model.
050     *  @param stream The output stream to write to.
051     *  @param format The image format to generate.
052     *  @exception IOException If writing to the stream fails.
053     *  @exception PrinterException  If the specified format is not supported.
054     */
055    public void writeImage(OutputStream stream, String format)
056            throws PrinterException, IOException;
057}