1 /* PrinterJob.java -- This job is the printer control class
2 Copyright (C) 1999 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.print;
40
41 /**
42 * This class controls printing.
43 *
44 * @author Aaron M. Renn (arenn@urbanophile.com)
45 */
46 public abstract class PrinterJob
47 {
48
49 /*
50 * Class Methods
51 */
52
53 /**
54 * Creates a new print job.
55 *
56 * @return A <code>PrinterJob</code> object for the newly created print job.
57 */
58 public static PrinterJob
getPrinterJob()59 getPrinterJob()
60 {
61 // FIXME: Need to fix this to load a default implementation instance.
62 return(null);
63 }
64
65 /*************************************************************************/
66
67 /*
68 * Constructors
69 */
70
71 /**
72 * Initializes a new instance of <code>PrinterJob</code>.
73 */
74 public
PrinterJob()75 PrinterJob()
76 {
77 ;
78 }
79
80 /*************************************************************************/
81
82 /*
83 * Instance Methods
84 */
85
86 /**
87 * Returns the number of copies to be printed.
88 *
89 * @return The number of copies to be printed.
90 */
91 public abstract int
getCopies()92 getCopies();
93
94 /*************************************************************************/
95
96 /**
97 * Sets the number of copies to be printed.
98 *
99 * @param copies The number of copies to be printed.
100 */
setCopies(int copies)101 public abstract void setCopies (int copies);
102
103 /*************************************************************************/
104
105 /**
106 * Returns the name of the print job.
107 *
108 * @return The name of the print job.
109 */
110 public abstract String
getJobName()111 getJobName();
112
113 /*************************************************************************/
114
115 /**
116 * Sets the name of the print job.
117 *
118 * @param job_name The name of the print job.
119 */
setJobName(String job_name)120 public abstract void setJobName (String job_name);
121
122 /*************************************************************************/
123
124 /**
125 * Returns the printing user name.
126 *
127 * @return The printing username.
128 */
129 public abstract String
getUserName()130 getUserName();
131
132 /*************************************************************************/
133
134 /**
135 * Cancels an in progress print job.
136 */
137 public abstract void
cancel()138 cancel();
139
140 /*************************************************************************/
141
142 /**
143 * Tests whether or not this job has been cancelled.
144 *
145 * @param <code>true</code> if this job has been cancelled, <code>false</code>
146 * otherwise.
147 */
148 public abstract boolean
isCancelled()149 isCancelled();
150
151 /*************************************************************************/
152
153 /**
154 * Returns an instance of the default page which will have the default
155 * paper and orientation.
156 *
157 * @return A default instance of <code>PageFormat</code>.
158 */
159 public PageFormat
defaultPage()160 defaultPage()
161 {
162 return(new PageFormat());
163 }
164
165 /*************************************************************************/
166
167 /**
168 * Clones the specified <code>PageFormat</code> object then alters the
169 * clone so that it represents the default page format.
170 *
171 * @param page_format The <code>PageFormat</code> to clone.
172 *
173 * @return A new default page format.
174 */
175 public abstract PageFormat
defaultPage(PageFormat page_format)176 defaultPage(PageFormat page_format);
177
178 /*************************************************************************/
179
180 /**
181 * Displays a dialog box to the user which allows the page format
182 * attributes to be modified.
183 *
184 * @param page_format The <code>PageFormat</code> object to modify.
185 *
186 * @return The modified <code>PageFormat</code>.
187 */
188 public abstract PageFormat
pageDialog(PageFormat page_format)189 pageDialog(PageFormat page_format);
190
191 /*************************************************************************/
192
193 /**
194 * Prints the pages.
195 */
print()196 public abstract void print () throws PrinterException;
197
198 /**
199 * Displays a dialog box to the user which allows the print job
200 * attributes to be modified.
201 *
202 * @return <code>false</code> if the user cancels the dialog box,
203 * <code>true</code> otherwise.
204 */
205 public abstract boolean
printDialog()206 printDialog();
207
208 /*************************************************************************/
209
210 /**
211 * This sets the pages that are to be printed.
212 *
213 * @param pageable The pages to be printed, which may not be <code>null</code>.
214 */
215 public abstract void
setPageable(Pageable pageable)216 setPageable(Pageable pageable);
217
218 /*************************************************************************/
219
220 /**
221 * Sets this specified <code>Printable</code> as the one to use for
222 * rendering the pages on the print device.
223 *
224 * @param printable The <code>Printable</code> for the print job.
225 */
226 public abstract void
setPrintable(Printable printable)227 setPrintable(Printable printable);
228
229 /*************************************************************************/
230
231 /**
232 * Sets the <code>Printable</code> and the page format for the pages
233 * to be printed.
234 *
235 * @param printable The <code>Printable</code> for the print job.
236 * @param page_format The <code>PageFormat</code> for the print job.
237 */
238 public abstract void
setPrintable(Printable printable, PageFormat page_format)239 setPrintable(Printable printable, PageFormat page_format);
240
241 /*************************************************************************/
242
243 /**
244 * Makes any alterations to the specified <code>PageFormat</code>
245 * necessary to make it work with the current printer. The alterations
246 * are made to a clone of the input object, which is then returned.
247 *
248 * @param page_format The <code>PageFormat</code> to validate.
249 *
250 * @return The validated <code>PageFormat</code>.
251 */
252 public abstract PageFormat
validatePage(PageFormat page)253 validatePage(PageFormat page);
254
255 } // class PrinterJob
256
257