001/*
002 * Copyright 2006 - 2013
003 *     Stefan Balev     <stefan.balev@graphstream-project.org>
004 *     Julien Baudry    <julien.baudry@graphstream-project.org>
005 *     Antoine Dutot    <antoine.dutot@graphstream-project.org>
006 *     Yoann Pigné      <yoann.pigne@graphstream-project.org>
007 *     Guilhelm Savin   <guilhelm.savin@graphstream-project.org>
008 * 
009 * This file is part of GraphStream <http://graphstream-project.org>.
010 * 
011 * GraphStream is a library whose purpose is to handle static or dynamic
012 * graph, create them from scratch, file or any source and display them.
013 * 
014 * This program is free software distributed under the terms of two licenses, the
015 * CeCILL-C license that fits European law, and the GNU Lesser General Public
016 * License. You can  use, modify and/ or redistribute the software under the terms
017 * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following
018 * URL <http://www.cecill.info> or under the terms of the GNU LGPL as published by
019 * the Free Software Foundation, either version 3 of the License, or (at your
020 * option) any later version.
021 * 
022 * This program is distributed in the hope that it will be useful, but WITHOUT ANY
023 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
024 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
025 * 
026 * You should have received a copy of the GNU Lesser General Public License
027 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
028 * 
029 * The fact that you are presently reading this means that you have had
030 * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms.
031 */
032package org.graphstream.ui.swingViewer.util;
033
034import java.awt.Graphics2D;
035import java.io.IOException;
036
037/**
038 * A special interface for renderers that allows to replace the Graphics2D.
039 *
040 * <p>
041 * Several external libraries use to replace the {@link Graphics2D} of AWT in
042 * order to produce a file or on a printer in a given format. However it is not possible to
043 * link such libraries in the gs-core module of GraphStream. To avoid this
044 * problem, this interface defines a plug-in that must implement be able to
045 * yield a {@link Graphics2D} usable instead of the default one. 
046 * </p>
047 */
048public interface Graphics2DOutput {
049        /**
050         * The graphics to use instead of the default {@link Graphics2D} of AWT.
051         */
052        Graphics2D getGraphics();
053
054        /**
055         * Output (if needed) the results of the last painting done with the {@link Graphics2D}.
056         * @param outputName The name of the output to use, for some renderers it is a file,
057         * for others it is an URL, a string description of the output, etc. 
058         */
059        void outputTo(String outputName) throws IOException;
060}