| public abstract class java.awt.print PrinterJob
|
Java SE 6 |
PrinterJob class is the principal class that controls
printing. An application calls methods in this class to set up a job,
optionally to invoke a print dialog with the user, and then to print
the pages of the job.
| Constructors | |
|---|---|
| public | PrinterJob() A PrinterJob object should be created using the
static method.
|
| Methods | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract public void | cancel() Cancels a print job that is in progress. If print has been called but has not
returned then this method signals
that the job should be cancelled at the next
chance. If there is no print job in progress then
this call does nothing.
| ||||||||||||
| abstract public PageFormat | defaultPage(PageFormat page) Clones the PageFormat argument and alters the
clone to describe a default page size and orientation.
| ||||||||||||
| public PageFormat | defaultPage() Creates a new PageFormat instance and
sets it to a default size and orientation.
| ||||||||||||
| public static PrintService[] | lookupPrintServices() A convenience method which looks up 2D print services. Services returned from this method may be installed on PrinterJobs which support print services.
Calling this method is equivalent to calling
DocFlavor, AttributeSet)
and specifying a Pageable DocFlavor.
| ||||||||||||
| public static StreamPrintServiceFactory[] | lookupStreamPrintServices(String mimeType) A convenience method which locates factories for stream print services which can image 2D graphics. Sample usage :
FileOutputStream outstream;
StreamPrintService psPrinter;
String psMimeType = "application/postscript";
StreamPrintServiceFactory[] factories =
PrinterJob.lookupStreamPrintServices(psMimeType);
if (factories.length > 0) {
try {
outstream = new File("out.ps");
psPrinter = factories[0].getPrintService(fos);
// psPrinter can now be set as the service on a PrinterJob
} catch (FileNotFoundException e) {
}
}
Services returned from this method may be installed on
PrinterJob instances which support print services.
Calling this method is equivalent to calling
and specifying a Pageable DocFlavor.
| ||||||||||||
| abstract public PageFormat | pageDialog(PageFormat page) throws HeadlessException Displays a dialog that allows modification of a PageFormat instance.
The page argument is used to initialize controls
in the page setup dialog.
If the user cancels the dialog then this method returns the
original page object unmodified.
If the user okays the dialog then this method returns a new
PageFormat object with the indicated changes.
In either case, the original page object is
not modified.
| ||||||||||||
| public PageFormat | pageDialog(PrintRequestAttributeSet attributes) throws HeadlessException A convenience method which displays a cross-platform page setup dialog. The choices available will reflect the print service currently set on this PrinterJob. The attributes parameter on input will reflect the client's required initial selections in the user dialog. Attributes which are not specified display using the default for the service. On return it will reflect the user's choices. Selections may be updated by the implementation to be consistent with the supported values for the currently selected print service. The return value will be a PageFormat equivalent to the selections in the PrintRequestAttributeSet. If the user cancels the dialog, the attributes will not reflect any changes made by the user, and the return value will be null.
| ||||||||||||
| abstract public void | print() throws PrinterException Prints a set of pages.
| ||||||||||||
| public void | print(PrintRequestAttributeSet attributes) throws PrinterException Prints a set of pages using the settings in the attribute set. The default implementation ignores the attribute set.
Note that some attributes may be set directly on the PrinterJob
by equivalent method calls, (for example), copies:
If a supported attribute-value is specified in this attribute set,
it will take precedence over the API settings for this print()
operation only.
The following behaviour is specified for PageFormat:
If a client uses the Printable interface, then the
These behaviours allow an application to directly pass the
user settings returned from
| ||||||||||||
| abstract public boolean | printDialog() throws HeadlessException Presents a dialog to the user for changing the properties of the print job. This method will display a native dialog if a native print service is selected, and user choice of printers will be restricted to these native print services. To present the cross platform print dialog for all services, including native ones instead use printDialog(PrintRequestAttributeSet).
PrinterJob implementations which can use PrintService's will update the PrintService for this PrinterJob to reflect the new service selected by the user.
| ||||||||||||
| public boolean | printDialog(PrintRequestAttributeSet attributes) throws HeadlessException A convenience method which displays a cross-platform print dialog for all services which are capable of printing 2D graphics using the Pageable interface. The selected printer when the
dialog is initially displayed will reflect the print service currently
attached to this print job.
If the user changes the print service, the PrinterJob will be
updated to reflect this, unless the user cancels the dialog.
As well as allowing the user to select the destination printer,
the user can also select values of various print request attributes.
The attributes parameter on input will reflect the applications required initial selections in the user dialog. Attributes not specified display using the default for the service. On return it will reflect the user's choices. Selections may be updated by the implementation to be consistent with the supported values for the currently selected print service. As the user scrolls to a new print service selection, the values copied are based on the settings for the previous service, together with any user changes. The values are not based on the original settings supplied by the client.
With the exception of selected printer, the PrinterJob state is
not updated to reflect the user's changes.
For the selections to affect a printer job, the attributes must
be specified in the call to the
| ||||||||||||
| abstract public PageFormat | validatePage(PageFormat page) Returns the clone of page with its settings
adjusted to be compatible with the current printer of this
PrinterJob. For example, the returned
PageFormat could have its imageable area
adjusted to fit within the physical area of the paper that
is used by the current printer.
| ||||||||||||
| Properties | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| abstract public boolean | isCancelled() Returns true if a print job is
in progress, but is going to be cancelled
at the next opportunity; otherwise returns
false.
| ||||||||
| abstract public void | setCopies(int copies) Sets the number of copies to be printed.
| ||||||||
| abstract public int | getCopies() Gets the number of copies to be printed.
| ||||||||
| abstract public void | setJobName(String jobName) Sets the name of the document to be printed. The document name can not be null.
| ||||||||
| abstract public String | getJobName() Gets the name of the document to be printed.
| ||||||||
| abstract public void | setPageable(Pageable document) throws NullPointerException Queries document for the number of pages and
the PageFormat and Printable for each
page held in the Pageable instance,
document.
| ||||||||
| public PageFormat | getPageFormat(PrintRequestAttributeSet attributes) Calculates a PageFormat with values consistent with those
supported by the current PrintService for this job
(ie the value returned by getPrintService()) and media,
printable area and orientation contained in attributes.
Calling this method does not update the job.
It is useful for clients that have a set of attributes obtained from
| ||||||||
| abstract public void | setPrintable(Printable painter) Calls painter to render the pages. The pages in the
document to be printed by this
PrinterJob are rendered by the Printable
object, painter. The PageFormat for each page
is the default page format.
| ||||||||
| abstract public void | setPrintable(Printable painter, PageFormat format) Calls painter to render the pages in the specified
format. The pages in the document to be printed by
this PrinterJob are rendered by the
Printable object, painter. The
PageFormat of each page is format.
| ||||||||
| public static PrinterJob | getPrinterJob() Creates and returns a PrinterJob which is initially
associated with the default printer.
If no printers are available on the system, a PrinterJob will still
be returned from this method, but getPrintService()
will return null, and calling
print with this PrinterJob might
generate an exception. Applications that need to determine if
there are suitable printers before creating a PrinterJob
should ensure that the array returned from
lookupPrintServices is not empty.
| ||||||||
| public void | setPrintService(PrintService service) throws PrinterException Associate this PrinterJob with a new PrintService. This method is overridden by subclasses which support specifying a Print Service. Throws PrinterException if the specified service
cannot support the Pageable and
Printable interfaces necessary to support 2D printing.
| ||||||||
| public PrintService | getPrintService() Returns the service (printer) for this printer job. Implementations of this class which do not support print services may return null. null will also be returned if no printers are available.
| ||||||||
| abstract public String | getUserName() Gets the name of the printing user.
| ||||||||
| About DocWeb · Bundles · Export · Export All | Top 10 · Statistics · Login |
| About Sun · Contact · Privacy · Terms of Use · Trademarks | Java SE 6 · Copyright © 1994-2013 Sun Microsystems, Inc.All rights reserved. Use is subject to license terms |
![]() |
![]() |
|