1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
|
/* PrinterJob.java -- This job is the printer control class
Copyright (C) 1999 Free Software Foundation, Inc.
This file is part of the non-peer AWT libraries of GNU Classpath.
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Library General Public License as published
by the Free Software Foundation, either version 2 of the License, or
(at your option) any later verion.
This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; if not, write to the Free Software Foundation
Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307 USA. */
package java.awt.print;
/**
* This class controls printing.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
*/
public abstract class PrinterJob
{
/*
* Class Methods
*/
/**
* Creates a new print job.
*
* @return A <code>PrinterJob</code> object for the newly created print job.
*/
public static PrinterJob
getPrinterJob()
{
// FIXME: Need to fix this to load a default implementation instance.
return(null);
}
/*************************************************************************/
/*
* Constructors
*/
/**
* Initializes a new instance of <code>PrinterJob</code>.
*/
public
PrinterJob()
{
;
}
/*************************************************************************/
/*
* Instance Methods
*/
/**
* Returns the number of copies to be printed.
*
* @return The number of copies to be printed.
*/
public abstract int
getCopies();
/*************************************************************************/
/**
* Sets the number of copies to be printed.
*
* @param copies The number of copies to be printed.
*/
public abstract void
setCopies();
/*************************************************************************/
/**
* Returns the name of the print job.
*
* @return The name of the print job.
*/
public abstract String
getJobName();
/*************************************************************************/
/**
* Sets the name of the print job.
*
* @param job_name The name of the print job.
*/
public abstract String
setJobName(String job_name);
/*************************************************************************/
/**
* Returns the printing user name.
*
* @return The printing username.
*/
public abstract String
getUserName();
/*************************************************************************/
/**
* Cancels an in progress print job.
*/
public abstract void
cancel();
/*************************************************************************/
/**
* Tests whether or not this job has been cancelled.
*
* @param <code>true</code> if this job has been cancelled, <code>false</code>
* otherwise.
*/
public abstract boolean
isCancelled();
/*************************************************************************/
/**
* Returns an instance of the default page which will have the default
* paper and orientation.
*
* @return A default instance of <code>PageFormat</code>.
*/
public PageFormat
defaultPage()
{
return(new PageFormat());
}
/*************************************************************************/
/**
* Clones the specified <code>PageFormat</code> object then alters the
* clone so that it represents the default page format.
*
* @param page_format The <code>PageFormat</code> to clone.
*
* @return A new default page format.
*/
public abstract PageFormat
defaultPage(PageFormat page_format);
/*************************************************************************/
/**
* Displays a dialog box to the user which allows the page format
* attributes to be modified.
*
* @param page_format The <code>PageFormat</code> object to modify.
*
* @return The modified <code>PageFormat</code>.
*/
public abstract PageFormat
pageDialog(PageFormat page_format);
/*************************************************************************/
/**
* Prints the pages.
*/
public abstract void
print();
/**
* Displays a dialog box to the user which allows the print job
* attributes to be modified.
*
* @return <code>false</code> if the user cancels the dialog box,
* <code>true</code> otherwise.
*/
public abstract boolean
printDialog();
/*************************************************************************/
/**
* This sets the pages that are to be printed.
*
* @param pageable The pages to be printed, which may not be <code>null</code>.
*/
public abstract void
setPageable(Pageable pageable);
/*************************************************************************/
/**
* Sets this specified <code>Printable</code> as the one to use for
* rendering the pages on the print device.
*
* @param printable The <code>Printable</code> for the print job.
*/
public abstract void
setPrintable(Printable printable);
/*************************************************************************/
/**
* Sets the <code>Printable</code> and the page format for the pages
* to be printed.
*
* @param printable The <code>Printable</code> for the print job.
* @param page_format The <code>PageFormat</code> for the print job.
*/
public abstract void
setPrintable(Printable printable, PageFormat page_format);
/*************************************************************************/
/**
* Makes any alterations to the specified <code>PageFormat</code>
* necessary to make it work with the current printer. The alterations
* are made to a clone of the input object, which is then returned.
*
* @param page_format The <code>PageFormat</code> to validate.
*
* @return The validated <code>PageFormat</code>.
*/
public abstract PageFormat
validatePage(PageFormat page);
} // class PrinterJob
|