001/* PrintJob.java -- A print job class
002   Copyright (C) 1999, 2002, 2005  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
038
039package java.awt;
040
041import java.util.Properties;
042
043/**
044 * This abstract class represents a print job.
045 *
046 * @author Aaron M. Renn (arenn@urbanophile.com)
047 * @see Toolkit#getPrintJob(Frame, String, Properties)
048 * @since 1.0
049 * @status updated to 1.4
050 */
051public abstract class PrintJob
052{
053  /**
054   * Create a new PrintJob.
055   */
056  public PrintJob()
057  {
058  }
059
060  /**
061   * Returns a graphics context suitable for rendering the next page. The
062   * return must also implement {@link PrintGraphics}.
063   *
064   * @return a graphics context for printing the next page
065   */
066  public abstract Graphics getGraphics();
067
068  /**
069   * Returns the dimension of the page in pixels.  The resolution will be
070   * chosen to be similar to the on screen image.
071   *
072   * @return the page dimensions
073   */
074  public abstract Dimension getPageDimension();
075
076  /**
077   * Returns the resolution of the page in pixels per inch. Note that this is
078   * not necessarily the printer's resolution.
079   *
080   * @return the resolution of the page in pixels per inch
081   */
082  public abstract int getPageResolution();
083
084  /**
085   * Tests whether or not the last page will be printed first.
086   *
087   * @return true if the last page prints first
088   */
089  public abstract boolean lastPageFirst();
090
091  /**
092   * Informs the print job that printing is complete or should be aborted.
093   */
094  public abstract void end();
095
096  /**
097   * This method explicitly ends the print job in the event the job
098   * becomes un-referenced without the application having done so.
099   */
100  public void finalize()
101  {
102    end();
103  }
104} // class PrintJob