libjava/java/awt/print/Printable.java

   1 /* Printable.java -- Renders a page to the print device
   2    Copyright (C) 1999, 2004  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package java.awt.print;
  39
  40 import java.awt.Graphics;
  41
  42
  43 /**
  44  * This interface provides a mechanism for the actual printing of pages to the
  45  * printer.  The object implementing this interface performs the page
  46  * rendering.
  47  *
  48  * @author Aaron M. Renn (arenn@urbanophile.com)
  49  */
  50 public interface Printable
  51 {
  52   /**
  53    * This value is returned by the <code>print()</code> method to indicate
  54    * that the requested page exists and has been printed.
  55    */
  56   int PAGE_EXISTS = 0;
  57
  58   /**
  59    * This value is returned by the <code>print()</code> method to indicate
  60    * that the requested page number does not exist.
  61    */
  62   int NO_SUCH_PAGE = 1;
  63
  64   /**
  65    * This method prints the specified page to the specified graphics
  66    * context in the specified format.  The pages are numbered starting
  67    * from zero.
  68    *
  69    * @param graphics The graphics context to render the pages on.
  70    * @param format The format in which to print the page.
  71    * @param page_number The page number to print, where numbers start at zero.
  72    *
  73    * @return <code>PAGE_EXISTS</code> if the requested page exists and was
  74    * successfully printed, <code>NO_SUCH_PAGE</code> otherwise.
  75    *
  76    * @exception PrinterException If an error occurs during printing.
  77    */
  78   int print(Graphics graphics, PageFormat format, int page_number)
  79     throws PrinterException;
  80 }