blob: cdf27c18401d03cbbd61c7473bbd209acc945059 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 1996 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26package 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 */
37public 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 */
46 public abstract Graphics getGraphics();
47
48 /**
49 * Returns the dimensions of the page in pixels.
50 * The resolution of the page is chosen so that it
51 * is similar to the screen resolution.
52 */
53 public abstract Dimension getPageDimension();
54
55 /**
56 * Returns the resolution of the page in pixels per inch.
57 * Note that this doesn't have to correspond to the physical
58 * resolution of the printer.
59 */
60 public abstract int getPageResolution();
61
62 /**
63 * Returns true if the last page will be printed first.
64 */
65 public abstract boolean lastPageFirst();
66
67 /**
68 * Ends the print job and does any necessary cleanup.
69 */
70 public abstract void end();
71
72 /**
73 * Ends this print job once it is no longer referenced.
74 * @see #end
75 */
76 public void finalize() {
77 end();
78 }
79
80}