Source for java.awt.PrintJob

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