libjava/java/awt/PrintJob.java

   1 /* PrintJob.java -- A print job class
   2    Copyright (C) 1999, 2002 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
  39 package java.awt;
  40
  41 /**
  42  * This abstract class represents a print job.
  43  *
  44  * @author Aaron M. Renn <arenn@urbanophile.com>
  45  * @see Toolkit#getPrintJob(Frame, String, Properties)
  46  * @since 1.0
  47  * @status updated to 1.4
  48  */
  49 public abstract class PrintJob
  50 {
  51   /**
  52    * Create a new PrintJob.
  53    */
  54   public PrintJob()
  55   {
  56   }
  57
  58   /**
  59    * Returns a graphics context suitable for rendering the next page. The
  60    * return must also implement {@link PrintGraphics}.
  61    *
  62    * @return a graphics context for printing the next page
  63    */
  64   public abstract Graphics getGraphics();
  65
  66   /**
  67    * Returns the dimension of the page in pixels.  The resolution will be
  68    * chosen to be similar to the on screen image.
  69    *
  70    * @return the page dimensions
  71    */
  72   public abstract Dimension getPageDimension();
  73
  74   /**
  75    * Returns the resolution of the page in pixels per inch. Note that this is
  76    * not necessarily the printer's resolution.
  77    *
  78    * @return the resolution of the page in pixels per inch
  79    */
  80   public abstract int getPageResolution();
  81
  82   /**
  83    * Tests whether or not the last page will be printed first.
  84    *
  85    * @return true if the last page prints first
  86    */
  87   public abstract boolean lastPageFirst();
  88
  89   /**
  90    * Informs the print job that printing is complete or should be aborted.
  91    */
  92   public abstract void end();
  93
  94   /**
  95    * This method explicitly ends the print job in the event the job
  96    * becomes un-referenced without the application having done so.
  97    */
  98   public void finalize()
  99   {
 100     end();
 101   }
 102 } // class PrintJob