001/* Printable.java -- Renders a page to the print device
002   Copyright (C) 1999, 2004  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package java.awt.print;
039
040import java.awt.Graphics;
041
042
043/**
044 * This interface provides a mechanism for the actual printing of pages to the
045 * printer.  The object implementing this interface performs the page
046 * rendering.
047 *
048 * @author Aaron M. Renn (arenn@urbanophile.com)
049 */
050public interface Printable
051{
052  /**
053   * This value is returned by the <code>print()</code> method to indicate
054   * that the requested page exists and has been printed.
055   */
056  int PAGE_EXISTS = 0;
057
058  /**
059   * This value is returned by the <code>print()</code> method to indicate
060   * that the requested page number does not exist.
061   */
062  int NO_SUCH_PAGE = 1;
063
064  /**
065   * This method prints the specified page to the specified graphics
066   * context in the specified format.  The pages are numbered starting
067   * from zero.
068   *
069   * @param graphics The graphics context to render the pages on.
070   * @param format The format in which to print the page.
071   * @param page_number The page number to print, where numbers start at zero.
072   *
073   * @return <code>PAGE_EXISTS</code> if the requested page exists and was
074   * successfully printed, <code>NO_SUCH_PAGE</code> otherwise.
075   *
076   * @exception PrinterException If an error occurs during printing.
077   */
078  int print(Graphics graphics, PageFormat format, int page_number)
079    throws PrinterException;
080}