javax.print
Interface DocPrintJob

All Known Subinterfaces:
CancelablePrintJob, MultiDocPrintJob

public interface DocPrintJob

DocPrintJob represents a print job which supports printing of a single document.

An instance can be obtained from every PrintService available by calling the PrintService.createPrintJob() method. A print job is bound to the print service it is created from.


Method Summary
 void addPrintJobAttributeListener(PrintJobAttributeListener listener, PrintJobAttributeSet attributes)
          Registers a listener for changes in the specified attribute set during processing of this print job.
 void addPrintJobListener(PrintJobListener listener)
          Registers a listener for events occuring during processing of this print job.
 PrintJobAttributeSet getAttributes()
          Returns the print job's attributes.
 PrintService getPrintService()
          Returns the PrintService object this print job is bound to.
 void print(Doc doc, PrintRequestAttributeSet attributes)
          Prints a document with the specified print job attributes.
 void removePrintJobAttributeListener(PrintJobAttributeListener listener)
          Removes the given listener from the listeners registered for changes in their provided attribute set during processing of this print job.
 void removePrintJobListener(PrintJobListener listener)
          Removes the given listener from the listeners registered for events occuring during processing of this print job.
 

Method Detail

addPrintJobAttributeListener

void addPrintJobAttributeListener(PrintJobAttributeListener listener,
                                  PrintJobAttributeSet attributes)
Registers a listener for changes in the specified attribute set during processing of this print job.

If the given attribute set is empty no changes will be reported. If the set is null all attributes are monitored.

Parameters:
listener - the listener to register.
attributes - the attributes to observe.
See Also:
removePrintJobAttributeListener(PrintJobAttributeListener)

addPrintJobListener

void addPrintJobListener(PrintJobListener listener)
Registers a listener for events occuring during processing of this print job.

Parameters:
listener - the listener to add, if null nothing is done.
See Also:
removePrintJobListener(PrintJobListener)

getAttributes

PrintJobAttributeSet getAttributes()
Returns the print job's attributes.

The returned set of attributes is a snapshot at the time of calling this method and will not be updated if changes to the print job's attributes happens. To monitor changes register a print job listener.

Returns:
The attributes of this print job, may be empty but never null.

getPrintService

PrintService getPrintService()
Returns the PrintService object this print job is bound to.

Returns:
The print service.

print

void print(Doc doc,
           PrintRequestAttributeSet attributes)
           throws PrintException
Prints a document with the specified print job attributes.

If the doc flavor provided by the Doc implementation is not supported by this print service a PrintException implementing the FlavorException interface will be thrown.

Parameters:
doc - the document to print
attributes - the job attributes to use. If null the default attribute values of the print service will be used.
Throws:
PrintException - if an error occurs. The thrown exception may implement refining print exception interface to provide more detail of the error.
See Also:
AttributeException, FlavorException

removePrintJobAttributeListener

void removePrintJobAttributeListener(PrintJobAttributeListener listener)
Removes the given listener from the listeners registered for changes in their provided attribute set during processing of this print job.

Parameters:
listener - the listener to remove, if null or not registered nothing will be done.
See Also:
addPrintJobAttributeListener(PrintJobAttributeListener, PrintJobAttributeSet)

removePrintJobListener

void removePrintJobListener(PrintJobListener listener)
Removes the given listener from the listeners registered for events occuring during processing of this print job.

Parameters:
listener - the listener to remove, if null or not registered nothing will be done.
See Also:
addPrintJobListener(PrintJobListener)