PrinterJob JDK 1.6)

Hide/Show inherited methods

publicabstract void cancel ()

Cancels a print job that is in progress.

public PageFormat defaultPage ()

Creates a new PageFormat instance and sets it to a default size and orientation.

Creates a new PageFormat instance and
sets it to a default size and orientation.
Returns: a PageFormat set to a default size and orientation.

publicabstract PageFormat defaultPage (PageFormat page)

Clones the PageFormat argument and alters the clone to describe a default page size and orientation.

Clones the PageFormat argument and alters the
clone to describe a default page size and orientation.
Returns: clone of page, altered to describe a default PageFormat.
Parameters:
- page - the PageFormat to be cloned and altered

publicabstract int getCopies ()

Gets the number of copies to be printed.

publicabstract String getJobName ()

Gets the name of the document to be printed.

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 printDialog(PrintRequestAttributeSet attributes) and need a PageFormat to print a Pageable object.
Returns: a PageFormat whose settings conform with those of the current service and the specified attributes.
Parameters:
- attributes - a set of printing attributes, for example obtained from calling printDialog. If attributes is null a default PageFormat is returned.
Since: 1.6

publicstatic PrinterJob getPrinterJob ()

Creates and returns a PrinterJob which is initially associated with the default printer.

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.
Returns: a new PrinterJob.
Throws:
- SecurityException - if a security manager exists and its {@link java.lang.SecurityManager#checkPrintJobAccess} method disallows this thread from creating a print job request

public PrintService getPrintService ()

Returns the service (printer) for this printer job.

publicabstract String getUserName ()

Gets the name of the printing user.

publicabstract boolean isCancelled ()

Returns true if a print job is in progress, but is going to be cancelled at the next opportunity; otherwise returns false.

Returns true if a print job is
in progress, but is going to be cancelled
at the next opportunity; otherwise returns
false.
Returns: true if the job in progress is going to be cancelled; false otherwise.

publicstatic PrintService lookupPrintServices ()

A convenience method which looks up 2D print services.

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
PrintServiceLookup.lookupPrintServices()
and specifying a Pageable DocFlavor.
Returns: a possibly empty array of 2D print services.
Since: 1.4

publicstatic StreamPrintServiceFactory lookupStreamPrintServices (String mimeType)

A convenience method which locates factories for stream print services which can image 2D graphics.

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

StreamPrintServiceFactory.lookupStreamPrintServiceFactories()

and specifying a Pageable DocFlavor.
Returns: a possibly empty array of 2D stream print service factories.
Parameters:
- mimeType - the required output format, or null to mean any format.
Since: 1.4

publicabstract PageFormat pageDialog (PageFormat page) throws HeadlessException

Displays a dialog that allows modification of a PageFormat instance.

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.
Returns: the original page object if the dialog is cancelled; a new PageFormat object containing the format indicated by the user if the dialog is acknowledged.
Parameters:
- page - the default PageFormat presented to the user for modification
Throws:
- HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
Since: 1.2
See Also: GraphicsEnvironment.isHeadless(),

public PageFormat pageDialog (PrintRequestAttributeSet attributes) throws HeadlessException

A convenience method which displays a cross-platform page setup dialog.

publicabstract 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.

publicabstract boolean printDialog () throws HeadlessException

Presents a dialog to the user for changing the properties of the print job.

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.
Returns: true if the user does not cancel the dialog; false otherwise.
Throws:
- HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
See Also: GraphicsEnvironment.isHeadless(),

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.

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 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.
Returns: true if the user does not cancel the dialog; false otherwise.
Parameters:
- attributes - on input is application supplied attributes, on output the contents are updated to reflect user choices. This parameter may not be null.
Throws:
- HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
- NullPointerException - if attributes parameter is null.
Since: 1.4
See Also: GraphicsEnvironment.isHeadless(),

publicabstract void setCopies (int copies)

Sets the number of copies to be printed.

publicabstract void setJobName (String jobName)

Sets the name of the document to be printed.

Sets the name of the document to be printed.
The document name can not be null.
Parameters:
- jobName - the name of the document to be printed
See Also: PrinterJob.getJobName(),

publicabstract 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.

Queries document for the number of pages and
the PageFormat and Printable for each
page held in the Pageable instance,
document.
Parameters:
- document - the pages to be printed. It can not be null.
Throws:
- NullPointerException - the Pageable passed in was null.
See Also: PageFormat, Printable,

publicabstract void setPrintable (Printable painter)

Calls painter to render the pages.

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.
Parameters:
- painter - the Printable that renders each page of the document.

publicabstract void setPrintable (Printable painter, PageFormat format)

Calls painter to render the pages in the specified 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.
Parameters:
- painter - the Printable called to render each page of the document
- format - the size and orientation of each page to be printed

public void setPrintService (PrintService service) throws PrinterException

Associate this PrinterJob with a new PrintService.

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.
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: PrinterJob.getPrintService(),

publicabstract PageFormat validatePage (PageFormat page)

Returns the clone of page with its settings adjusted to be compatible with the current printer of this PrinterJob.

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.
Returns: a PageFormat that is cloned from page and whose settings are changed to conform with this PrinterJob.
Parameters:
- page - the PageFormat that is cloned and whose settings are changed to be compatible with the current printer