OpenJDK 27 · javax.print.DocPrintJob · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	addPrintJobAttributeListener(PrintJobAttributeListener the object implementing the listener interface listener, PrintJobAttributeSet the attributes to listen on, or `null` to mean all attributes that can change, as determined by the job attributes) Registers a listener for changes in the specified attributes.
public void	addPrintJobListener(PrintJobListener the object implementing the listener interface listener) Registers a listener for event occurring during this print job.
public PrintJobAttributeSet	Returns: the print job attributes getAttributes() Obtains this Print Job's set of printing attributes.
public PrintService	Returns: `PrintService` object getPrintService() Determines the `PrintService` object to which this print job object is bound.
public void	print(Doc the document to be printed. It must be a flavor supported by this PrintJob. doc, PrintRequestAttributeSet the job attributes to be applied to this print job. If this parameter is `null` then the default attributes are used. attributes) Prints a document with the specified job attributes.
public void	removePrintJobAttributeListener(PrintJobAttributeListener the object implementing the listener interface listener) Removes an attribute listener from this print job.
public void	removePrintJobListener(PrintJobListener the object implementing the listener interface listener) Removes a listener from this print job.

Method Detail

addPrintJobAttributeListener back to summary

addPrintJobAttributeListener	back to summary
public void addPrintJobAttributeListener(PrintJobAttributeListener listener, PrintJobAttributeSet attributes) Registers a listener for changes in the specified attributes. If listener is `null`, no exception is thrown and no action is performed. To determine the attribute updates that may be reported by this job, a client can call `getAttributes()` and identify the subset that are interesting and likely to be reported to the listener. Clients expecting to be updated about changes in a specific job attribute should verify it is in that set, but updates about an attribute will be made only if it changes and this is detected by the job. Also updates may be subject to batching by the job. To minimize overhead in print job processing it is recommended to listen on only that subset of attributes which are likely to change. If the specified set is empty no attribute updates will be reported to the listener. If the attribute set is `null`, then this means to listen on all dynamic attributes that the job supports. This may result in no update notifications if a job can not report any attribute updates. If listener is already registered, it will be registered again. Parameters listener:PrintJobAttributeListener the object implementing the listener interface attributes:PrintJobAttributeSet the attributes to listen on, or `null` to mean all attributes that can change, as determined by the job See Also `removePrintJobAttributeListener`

public void addPrintJobAttributeListener(PrintJobAttributeListener listener, PrintJobAttributeSet attributes)

Registers a listener for changes in the specified attributes. If listener is null, no exception is thrown and no action is performed. To determine the attribute updates that may be reported by this job, a client can call getAttributes() and identify the subset that are interesting and likely to be reported to the listener. Clients expecting to be updated about changes in a specific job attribute should verify it is in that set, but updates about an attribute will be made only if it changes and this is detected by the job. Also updates may be subject to batching by the job. To minimize overhead in print job processing it is recommended to listen on only that subset of attributes which are likely to change. If the specified set is empty no attribute updates will be reported to the listener. If the attribute set is null, then this means to listen on all dynamic attributes that the job supports. This may result in no update notifications if a job can not report any attribute updates.

If listener is already registered, it will be registered again.

Parameters

listener:PrintJobAttributeListener: the object implementing the listener interface
attributes:PrintJobAttributeSet: the attributes to listen on, or null to mean all attributes that can change, as determined by the job

See Also

removePrintJobAttributeListener

addPrintJobListener back to summary

addPrintJobListener	back to summary
public void addPrintJobListener(PrintJobListener listener) Registers a listener for event occurring during this print job. If listener is `null`, no exception is thrown and no action is performed. If listener is already registered, it will be registered again. Parameters listener:PrintJobListener the object implementing the listener interface See Also `removePrintJobListener`

public void addPrintJobListener(PrintJobListener listener)

Registers a listener for event occurring during this print job. If listener is null, no exception is thrown and no action is performed. If listener is already registered, it will be registered again.

Parameters

listener:PrintJobListener: the object implementing the listener interface

See Also

removePrintJobListener

getAttributes back to summary

getAttributes	back to summary
public PrintJobAttributeSet getAttributes() Obtains this Print Job's set of printing attributes. The returned attribute set object is unmodifiable. The returned attribute set object is a "snapshot" of this Print Job's attribute set at the time of the `getAttributes()` method call; that is, the returned attribute set's object's contents will not be updated if this Print Job's attribute set's contents change in the future. To detect changes in attribute values, call `getAttributes()` again and compare the new attribute set to the previous attribute set; alternatively, register a listener for print job events. The returned value may be an empty set but should not be `null`. Returns:PrintJobAttributeSet the print job attributes

public PrintJobAttributeSet getAttributes()

Obtains this Print Job's set of printing attributes. The returned attribute set object is unmodifiable. The returned attribute set object is a "snapshot" of this Print Job's attribute set at the time of the getAttributes() method call; that is, the returned attribute set's object's contents will not be updated if this Print Job's attribute set's contents change in the future. To detect changes in attribute values, call getAttributes() again and compare the new attribute set to the previous attribute set; alternatively, register a listener for print job events. The returned value may be an empty set but should not be null.

Returns:PrintJobAttributeSet: the print job attributes

getPrintService back to summary

getPrintService	back to summary
public PrintService getPrintService() Determines the `PrintService` object to which this print job object is bound. Returns:PrintService `PrintService` object

public PrintService getPrintService()

Determines the PrintService object to which this print job object is bound.

Returns:PrintService: PrintService object

print back to summary

print	back to summary
public void print(Doc doc, PrintRequestAttributeSet attributes) throws PrintException Prints a document with the specified job attributes. This method should only be called once for a given print job. Calling it again will not result in a new job being spooled to the printer. The service implementation will define policy for service interruption and recovery. When the print method returns, printing may not yet have completed as printing may happen asynchronously, perhaps in a different thread. Application clients which want to monitor the success or failure should register a `PrintJobListener`. Print service implementors should close any print data streams (ie `Reader` or `InputStream` implementations) that they obtain from the client doc. Robust clients may still wish to verify this. An exception is always generated if a `DocFlavor` cannot be printed. Parameters doc:Doc the document to be printed. It must be a flavor supported by this PrintJob. attributes:PrintRequestAttributeSet the job attributes to be applied to this print job. If this parameter is `null` then the default attributes are used. Exceptions PrintException: the exception additionally may implement an interface that more precisely describes the cause of the exception `FlavorException`. If the document has a flavor not supported by this print job. `AttributeException`. If one or more of the attributes are not valid for this print job.

public void print(Doc doc, PrintRequestAttributeSet attributes) throws PrintException

Prints a document with the specified job attributes. This method should only be called once for a given print job. Calling it again will not result in a new job being spooled to the printer. The service implementation will define policy for service interruption and recovery. When the print method returns, printing may not yet have completed as printing may happen asynchronously, perhaps in a different thread. Application clients which want to monitor the success or failure should register a PrintJobListener.

Print service implementors should close any print data streams (ie Reader or InputStream implementations) that they obtain from the client doc. Robust clients may still wish to verify this. An exception is always generated if a DocFlavor cannot be printed.

Parameters

doc:Doc: the document to be printed. It must be a flavor supported by this PrintJob.
attributes:PrintRequestAttributeSet: the job attributes to be applied to this print job. If this parameter is null then the default attributes are used.

Exceptions

PrintException:

the exception additionally may implement an interface that more precisely describes the cause of the exception

FlavorException. If the document has a flavor not supported by this print job.
AttributeException. If one or more of the attributes are not valid for this print job.

removePrintJobAttributeListener back to summary

removePrintJobAttributeListener	back to summary
public void removePrintJobAttributeListener(PrintJobAttributeListener listener) Removes an attribute listener from this print job. This method performs no function, nor does it throw an exception, if the listener specified by the argument was not previously added to this print job. If the listener is `null`, no exception is thrown and no action is performed. If a listener is registered more than once, even for a different set of attributes, no guarantee is made which listener is removed. Parameters listener:PrintJobAttributeListener the object implementing the listener interface See Also `addPrintJobAttributeListener`

public void removePrintJobAttributeListener(PrintJobAttributeListener listener)

Removes an attribute listener from this print job. This method performs no function, nor does it throw an exception, if the listener specified by the argument was not previously added to this print job. If the listener is null, no exception is thrown and no action is performed. If a listener is registered more than once, even for a different set of attributes, no guarantee is made which listener is removed.

Parameters

listener:PrintJobAttributeListener: the object implementing the listener interface

See Also

addPrintJobAttributeListener

removePrintJobListener back to summary

removePrintJobListener	back to summary
public void removePrintJobListener(PrintJobListener listener) Removes a listener from this print job. This method performs no function, nor does it throw an exception, if the listener specified by the argument was not previously added to this print job. If listener is `null`, no exception is thrown and no action is performed. If a listener was registered more than once only one of the registrations will be removed. Parameters listener:PrintJobListener the object implementing the listener interface See Also `addPrintJobListener`

public void removePrintJobListener(PrintJobListener listener)

Removes a listener from this print job. This method performs no function, nor does it throw an exception, if the listener specified by the argument was not previously added to this print job. If listener is null, no exception is thrown and no action is performed. If a listener was registered more than once only one of the registrations will be removed.

Parameters

listener:PrintJobListener: the object implementing the listener interface

See Also

addPrintJobListener

public Interface DocPrintJob

Method Summary

Method Detail