Class PrinterJob
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.-
Constructor Summary
ConstructorDescriptionAPrinterJob
object should be created using the staticgetPrinterJob
method. -
Method Summary
Modifier and TypeMethodDescriptionabstract void
cancel()
Cancels a print job that is in progress.Creates a newPageFormat
instance and sets it to a default size and orientation.abstract PageFormat
defaultPage
(PageFormat page) Clones thePageFormat
argument and alters the clone to describe a default page size and orientation.abstract int
Gets the number of copies to be printed.abstract String
Gets the name of the document to be printed.getPageFormat
(PrintRequestAttributeSet attributes) Calculates aPageFormat
with values consistent with those supported by the currentPrintService
for this job (ie the value returned bygetPrintService()
) and media, printable area and orientation contained inattributes
.static PrinterJob
Creates and returns aPrinterJob
which is initially associated with the default printer.Returns the service (printer) for this printer job.abstract String
Gets the name of the printing user.abstract boolean
Returnstrue
if a print job is in progress, but is going to be cancelled at the next opportunity; otherwise returnsfalse
.static PrintService[]
A convenience method which looks up 2D print services.static StreamPrintServiceFactory[]
lookupStreamPrintServices
(String mimeType) A convenience method which locates factories for stream print services which can image 2D graphics.abstract PageFormat
pageDialog
(PageFormat page) Displays a dialog that allows modification of aPageFormat
instance.pageDialog
(PrintRequestAttributeSet attributes) A convenience method which displays a cross-platform page setup dialog.abstract void
print()
Prints a set of pages.void
print
(PrintRequestAttributeSet attributes) Prints a set of pages using the settings in the attribute set.abstract boolean
Presents a dialog to the user for changing the properties of the print job.boolean
printDialog
(PrintRequestAttributeSet attributes) A convenience method which displays a cross-platform print dialog for all services which are capable of printing 2D graphics using thePageable
interface.abstract void
setCopies
(int copies) Sets the number of copies to be printed.abstract void
setJobName
(String jobName) Sets the name of the document to be printed.abstract void
setPageable
(Pageable document) Queriesdocument
for the number of pages and thePageFormat
andPrintable
for each page held in thePageable
instance,document
.abstract void
setPrintable
(Printable painter) Callspainter
to render the pages.abstract void
setPrintable
(Printable painter, PageFormat format) Callspainter
to render the pages in the specifiedformat
.void
setPrintService
(PrintService service) Associate this PrinterJob with a new PrintService.abstract PageFormat
validatePage
(PageFormat page) Returns the clone ofpage
with its settings adjusted to be compatible with the current printer of thisPrinterJob
.
-
Constructor Details
-
PrinterJob
public PrinterJob()APrinterJob
object should be created using the staticgetPrinterJob
method.
-
-
Method Details
-
getPrinterJob
Creates and returns aPrinterJob
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, butgetPrintService()
will returnnull
, and callingprint
with thisPrinterJob
might generate an exception. Applications that need to determine if there are suitable printers before creating aPrinterJob
should ensure that the array returned fromlookupPrintServices
is not empty.- Returns:
- a new
PrinterJob
. - Throws:
SecurityException
- if a security manager exists and itsSecurityManager.checkPrintJobAccess()
method disallows this thread from creating a print job request
-
lookupPrintServices
A convenience method which looks up 2D print services. Services returned from this method may be installed onPrinterJob
s which support print services. Calling this method is equivalent to callingPrintServiceLookup.lookupPrintServices()
and specifying a Pageable DocFlavor.- Returns:
- a possibly empty array of 2D print services.
- Since:
- 1.4
-
lookupStreamPrintServices
A convenience method which locates factories for stream print services which can image 2D graphics. Sample usage :
Services returned from this method may be installed onFileOutputStream outstream; StreamPrintService psPrinter; String psMimeType = "application/postscript"; PrinterJob pj = PrinterJob.getPrinterJob(); StreamPrintServiceFactory[] factories = PrinterJob.lookupStreamPrintServices(psMimeType); if (factories.length > 0) { try { outstream = new File("out.ps"); psPrinter = factories[0].getPrintService(outstream); // psPrinter can now be set as the service on a PrinterJob pj.setPrintService(psPrinter) } catch (Exception e) { e.printStackTrace(); } }
PrinterJob
instances which support print services. Calling this method is equivalent to callingStreamPrintServiceFactory.lookupStreamPrintServiceFactories()
and specifying a Pageable DocFlavor.- Parameters:
mimeType
- the required output format, or null to mean any format.- Returns:
- a possibly empty array of 2D stream print service factories.
- Since:
- 1.4
-
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.- Returns:
- the service for this printer job.
- Since:
- 1.4
- See Also:
-
setPrintService
Associate this PrinterJob with a new PrintService. This method is overridden by subclasses which support specifying a Print Service. ThrowsPrinterException
if the specified service cannot support thePageable
andPrintable
interfaces necessary to support 2D printing.- Parameters:
service
- a print service that supports 2D printing- Throws:
PrinterException
- if the specified service does not support 2D printing, or this PrinterJob class does not support setting a 2D print service, or the specified service is otherwise not a valid print service.- Since:
- 1.4
- See Also:
-
setPrintable
Callspainter
to render the pages. The pages in the document to be printed by thisPrinterJob
are rendered by thePrintable
object,painter
. ThePageFormat
for each page is the default page format.- Parameters:
painter
- thePrintable
that renders each page of the document.
-
setPrintable
Callspainter
to render the pages in the specifiedformat
. The pages in the document to be printed by thisPrinterJob
are rendered by thePrintable
object,painter
. ThePageFormat
of each page isformat
.- Parameters:
painter
- thePrintable
called to render each page of the documentformat
- the size and orientation of each page to be printed
-
setPageable
Queriesdocument
for the number of pages and thePageFormat
andPrintable
for each page held in thePageable
instance,document
.- Parameters:
document
- the pages to be printed. It can not benull
.- Throws:
NullPointerException
- thePageable
passed in wasnull
.- See Also:
-
printDialog
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 useprintDialog(PrintRequestAttributeSet)
.PrinterJob implementations which can use PrintService's will update the PrintService for this PrinterJob to reflect the new service selected by the user.
- Returns:
true
if the user does not cancel the dialog;false
otherwise.- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.- See Also:
-
printDialog
A convenience method which displays a cross-platform print dialog for all services which are capable of printing 2D graphics using thePageable
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
print(PrintRequestAttributeSet)
method. If using the Pageable interface, clients which intend to use media selected by the user must create a PageFormat derived from the user's selections. If the user cancels the dialog, the attributes will not reflect any changes made by the user.- Parameters:
attributes
- on input is application supplied attributes, on output the contents are updated to reflect user choices. This parameter may not be null.- Returns:
true
if the user does not cancel the dialog;false
otherwise.- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.NullPointerException
- ifattributes
parameter is null.- Since:
- 1.4
- See Also:
-
pageDialog
Displays a dialog that allows modification of aPageFormat
instance. Thepage
argument is used to initialize controls in the page setup dialog. If the user cancels the dialog then this method returns the originalpage
object unmodified. If the user okays the dialog then this method returns a newPageFormat
object with the indicated changes. In either case, the originalpage
object is not modified.- Parameters:
page
- the defaultPageFormat
presented to the user for modification- Returns:
- the original
page
object if the dialog is cancelled; a newPageFormat
object containing the format indicated by the user if the dialog is acknowledged. - Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.- Since:
- 1.2
- See Also:
-
pageDialog
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.
- Parameters:
attributes
- on input is application supplied attributes, on output the contents are updated to reflect user choices. This parameter may not be null.- Returns:
- a page format if the user does not cancel the dialog;
null
otherwise. - Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.NullPointerException
- ifattributes
parameter is null.- Since:
- 1.4
- See Also:
-
defaultPage
Clones thePageFormat
argument and alters the clone to describe a default page size and orientation.- Parameters:
page
- thePageFormat
to be cloned and altered- Returns:
- clone of
page
, altered to describe a defaultPageFormat
.
-
defaultPage
Creates a newPageFormat
instance and sets it to a default size and orientation.- Returns:
- a
PageFormat
set to a default size and orientation.
-
getPageFormat
Calculates aPageFormat
with values consistent with those supported by the currentPrintService
for this job (ie the value returned bygetPrintService()
) and media, printable area and orientation contained inattributes
.Calling this method does not update the job. It is useful for clients that have a set of attributes obtained from
printDialog(PrintRequestAttributeSet attributes)
and need a PageFormat to print a Pageable object.- Parameters:
attributes
- a set of printing attributes, for example obtained from calling printDialog. Ifattributes
is null a default PageFormat is returned.- Returns:
- a
PageFormat
whose settings conform with those of the current service and the specified attributes. - Since:
- 1.6
-
validatePage
Returns the clone ofpage
with its settings adjusted to be compatible with the current printer of thisPrinterJob
. For example, the returnedPageFormat
could have its imageable area adjusted to fit within the physical area of the paper that is used by the current printer.- Parameters:
page
- thePageFormat
that is cloned and whose settings are changed to be compatible with the current printer- Returns:
- a
PageFormat
that is cloned frompage
and whose settings are changed to conform with thisPrinterJob
.
-
print
Prints a set of pages.- Throws:
PrinterException
- an error in the print system caused the job to be aborted.- See Also:
-
print
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:
setCopies(int)
, job name:setJobName(String)
and specifying media size and orientation though thePageFormat
object.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
attributes
parameter to this method is examined for attributes which specify media (by size), orientation, and imageable area, and those are used to construct a new PageFormat which is passed to the Printable object's print() method. SeePrintable
for an explanation of the required behaviour of a Printable to ensure optimal printing via PrinterJob. For clients of the Pageable interface, the PageFormat will always be as supplied by that interface, on a per page basis.These behaviours allow an application to directly pass the user settings returned from
printDialog(PrintRequestAttributeSet attributes
to this print() method.- Parameters:
attributes
- a set of attributes for the job- Throws:
PrinterException
- an error in the print system caused the job to be aborted.- Since:
- 1.4
- See Also:
-
setCopies
public abstract void setCopies(int copies) Sets the number of copies to be printed.- Parameters:
copies
- the number of copies to be printed- See Also:
-
getCopies
public abstract int getCopies()Gets the number of copies to be printed.- Returns:
- the number of copies to be printed.
- See Also:
-
getUserName
Gets the name of the printing user.- Returns:
- the name of the printing user
- Throws:
SecurityException
- if a security manager exists and PropertyPermission - user.name is not given in the policy file
-
setJobName
Sets the name of the document to be printed. The document name can not benull
.- Parameters:
jobName
- the name of the document to be printed- See Also:
-
getJobName
Gets the name of the document to be printed.- Returns:
- the name of the document to be printed.
- See Also:
-
cancel
public abstract void cancel()Cancels a print job that is in progress. Ifprint
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. -
isCancelled
public abstract boolean isCancelled()Returnstrue
if a print job is in progress, but is going to be cancelled at the next opportunity; otherwise returnsfalse
.- Returns:
true
if the job in progress is going to be cancelled;false
otherwise.
-