1 /*
   2  * Copyright (c) 1996, 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package java.awt;
  27 
  28 /**
  29  * An abstract class which initiates and executes a print job.
  30  * It provides access to a print graphics object which renders
  31  * to an appropriate print device.
  32  *
  33  * @see Toolkit#getPrintJob
  34  *
  35  * @author      Amy Fowler
  36  */
  37 public abstract class PrintJob {
  38 
  39     /**
  40      * Gets a Graphics object that will draw to the next page.
  41      * The page is sent to the printer when the graphics
  42      * object is disposed.  This graphics object will also implement
  43      * the PrintGraphics interface.
  44      * @see PrintGraphics
  45      * @return the graphics context for printing the next page
  46      */
  47     public abstract Graphics getGraphics();
  48 
  49     /**
  50      * Returns the dimensions of the page in pixels.
  51      * The resolution of the page is chosen so that it
  52      * is similar to the screen resolution.
  53      *
  54      * @return the page dimension
  55      */
  56     public abstract Dimension getPageDimension();
  57 
  58     /**
  59      * Returns the resolution of the page in pixels per inch.
  60      * Note that this doesn't have to correspond to the physical
  61      * resolution of the printer.
  62      *
  63      * @return the page resolution
  64      */
  65     public abstract int getPageResolution();
  66 
  67     /**
  68      * Returns true if the last page will be printed first.
  69      *
  70      * @return {@code true} if the last page will be printed first;
  71      *         otherwise {@code false}
  72      */
  73     public abstract boolean lastPageFirst();
  74 
  75     /**
  76      * Ends the print job and does any necessary cleanup.
  77      */
  78     public abstract void end();
  79 
  80     /**
  81      * Ends this print job once it is no longer referenced.
  82      * @see #end
  83      */
  84     public void finalize() {
  85         end();
  86     }
  87 
  88 }