OpenJDK 27 · sun.print.PSStreamPrintJob · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private transient ArrayList<PrintJobAttributeListener>	attrListeners
private int	copies
private Doc	doc
private boolean	fidelity
private InputStream	instream
private PrinterJob	job
private PrintJobAttributeSet	jobAttrSet
private transient ArrayList<PrintJobListener>	jobListeners
private String	jobName
private transient ArrayList<PrintJobAttributeSet>	listenedAttributeSets
private MediaSize	mediaSize
private OrientationRequested	orient
private boolean	printing
private boolean	printReturned
private Reader	reader
private PrintRequestAttributeSet	reqAttrSet
private PSStreamPrintService	service

Access	Constructor and Description
pack-priv	PSStreamPrintJob(PSStreamPrintService service)

Method Summary

Modifier and Type	Method and Description
public void	addPrintJobAttributeListener(PrintJobAttributeListener listener, PrintJobAttributeSet attributes) Implements javax.print.DocPrintJob.addPrintJobAttributeListener. Registers a listener for changes in the specified attributes.
public void	addPrintJobListener(PrintJobListener listener) Implements javax.print.DocPrintJob.addPrintJobListener. Registers a listener for event occurring during this print job.
public void	cancel() Implements javax.print.CancelablePrintJob.cancel. Stops further processing of a print job.
private void	closeDataStreams()
public PrintJobAttributeSet	getAttributes() Implements javax.print.DocPrintJob.getAttributes. Obtains this Print Job's set of printing attributes.
private void	getAttributeValues(DocFlavor flavor)
public PrintService	getPrintService() Implements javax.print.DocPrintJob.getPrintService. Determines the `PrintService` object to which this print job object is bound.
private synchronized void	initializeAttributeSets(Doc doc, PrintRequestAttributeSet reqSet)
private void	notifyEvent(int reason)
public void	pageableJob(Pageable pageable, PrintRequestAttributeSet attributes)
public void	print(Doc doc, PrintRequestAttributeSet attributes) Implements javax.print.DocPrintJob.print. Prints a document with the specified job attributes.
public void	printableJob(Printable printable, PrintRequestAttributeSet attributes)
public void	removePrintJobAttributeListener(PrintJobAttributeListener listener) Implements javax.print.DocPrintJob.removePrintJobAttributeListener. Removes an attribute listener from this print job.
public void	removePrintJobListener(PrintJobListener listener) Implements javax.print.DocPrintJob.removePrintJobListener. Removes a listener from this print job.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

attrListeners	back to summary
private transient ArrayList<PrintJobAttributeListener> attrListeners

copies	back to summary
private int copies

doc	back to summary
private Doc doc

fidelity	back to summary
private boolean fidelity

instream	back to summary
private InputStream instream

job	back to summary
private PrinterJob job

jobAttrSet	back to summary
private PrintJobAttributeSet jobAttrSet

jobListeners	back to summary
private transient ArrayList<PrintJobListener> jobListeners

jobName	back to summary
private String jobName

listenedAttributeSets	back to summary
private transient ArrayList<PrintJobAttributeSet> listenedAttributeSets

mediaSize	back to summary
private MediaSize mediaSize

orient	back to summary
private OrientationRequested orient

printing	back to summary
private boolean printing

printReturned	back to summary
private boolean printReturned

reader	back to summary
private Reader reader

reqAttrSet	back to summary
private PrintRequestAttributeSet reqAttrSet

service	back to summary
private PSStreamPrintService service

PSStreamPrintJob	back to summary
pack-priv PSStreamPrintJob(PSStreamPrintService service)

Method Detail

addPrintJobAttributeListener back to summary

addPrintJobAttributeListener	back to summary
public void addPrintJobAttributeListener(PrintJobAttributeListener listener, PrintJobAttributeSet attributes) Implements javax.print.DocPrintJob.addPrintJobAttributeListener. Doc from javax.print.DocPrintJob.addPrintJobAttributeListener. 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.

public void addPrintJobAttributeListener(PrintJobAttributeListener listener, PrintJobAttributeSet attributes)

Implements javax.print.DocPrintJob.addPrintJobAttributeListener.

Doc from javax.print.DocPrintJob.addPrintJobAttributeListener.

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.

addPrintJobListener back to summary

addPrintJobListener	back to summary
public void addPrintJobListener(PrintJobListener listener) Implements javax.print.DocPrintJob.addPrintJobListener. Doc from javax.print.DocPrintJob.addPrintJobListener. 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.

public void addPrintJobListener(PrintJobListener listener)

Implements javax.print.DocPrintJob.addPrintJobListener.

Doc from javax.print.DocPrintJob.addPrintJobListener.

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.

cancel back to summary

cancel	back to summary
public void cancel() throws PrintException Implements javax.print.CancelablePrintJob.cancel. Doc from javax.print.CancelablePrintJob.cancel. Stops further processing of a print job. If a service supports this method it cannot be concluded that job cancellation will always succeed. A job may not be able to be cancelled once it has reached and passed some point in its processing. A successful cancellation means only that the entire job was not printed, some portion may already have printed when cancel returns. The service will throw a `PrintException` if the cancellation did not succeed. A job which has not yet been submitted for printing should throw this exception. Cancelling an already successfully cancelled Print Job is not considered an error and will always succeed. Cancellation in some services may be a lengthy process, involving requests to a server and processing of its print queue. Clients may wish to execute cancel in a thread which does not affect application execution. Exceptions PrintException: if the job could not be successfully cancelled

public void cancel() throws PrintException

Implements javax.print.CancelablePrintJob.cancel.

Doc from javax.print.CancelablePrintJob.cancel.

Stops further processing of a print job.

If a service supports this method it cannot be concluded that job cancellation will always succeed. A job may not be able to be cancelled once it has reached and passed some point in its processing. A successful cancellation means only that the entire job was not printed, some portion may already have printed when cancel returns.

The service will throw a PrintException if the cancellation did not succeed. A job which has not yet been submitted for printing should throw this exception. Cancelling an already successfully cancelled Print Job is not considered an error and will always succeed.

Cancellation in some services may be a lengthy process, involving requests to a server and processing of its print queue. Clients may wish to execute cancel in a thread which does not affect application execution.

Exceptions

PrintException:: if the job could not be successfully cancelled

closeDataStreams	back to summary
private void closeDataStreams()

getAttributes back to summary

getAttributes	back to summary
public PrintJobAttributeSet getAttributes() Implements javax.print.DocPrintJob.getAttributes. Doc from javax.print.DocPrintJob.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`.

public PrintJobAttributeSet getAttributes()

Implements javax.print.DocPrintJob.getAttributes.

Doc from javax.print.DocPrintJob.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.

getAttributeValues	back to summary
private void getAttributeValues(DocFlavor flavor) throws PrintException

getPrintService back to summary

getPrintService	back to summary
public PrintService getPrintService() Implements javax.print.DocPrintJob.getPrintService. Doc from javax.print.DocPrintJob.getPrintService. Determines the `PrintService` object to which this print job object is bound.

public PrintService getPrintService()

Implements javax.print.DocPrintJob.getPrintService.

Doc from javax.print.DocPrintJob.getPrintService.

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

initializeAttributeSets	back to summary
private synchronized void initializeAttributeSets(Doc doc, PrintRequestAttributeSet reqSet)

notifyEvent	back to summary
private void notifyEvent(int reason)

pageableJob	back to summary
public void pageableJob(Pageable pageable, PrintRequestAttributeSet attributes) throws PrintException

print back to summary

print	back to summary
public void print(Doc doc, PrintRequestAttributeSet attributes) throws PrintException Implements javax.print.DocPrintJob.print. Doc from javax.print.DocPrintJob.print. 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. 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

Implements javax.print.DocPrintJob.print.

Doc from javax.print.DocPrintJob.print.

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.

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.

printableJob	back to summary
public void printableJob(Printable printable, PrintRequestAttributeSet attributes) throws PrintException

removePrintJobAttributeListener back to summary

removePrintJobAttributeListener	back to summary
public void removePrintJobAttributeListener(PrintJobAttributeListener listener) Implements javax.print.DocPrintJob.removePrintJobAttributeListener. Doc from javax.print.DocPrintJob.removePrintJobAttributeListener. 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.

public void removePrintJobAttributeListener(PrintJobAttributeListener listener)

Implements javax.print.DocPrintJob.removePrintJobAttributeListener.

Doc from javax.print.DocPrintJob.removePrintJobAttributeListener.

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.

removePrintJobListener back to summary

removePrintJobListener	back to summary
public void removePrintJobListener(PrintJobListener listener) Implements javax.print.DocPrintJob.removePrintJobListener. Doc from javax.print.DocPrintJob.removePrintJobListener. 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.

public void removePrintJobListener(PrintJobListener listener)

Implements javax.print.DocPrintJob.removePrintJobListener.

Doc from javax.print.DocPrintJob.removePrintJobListener.

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.

public Class PSStreamPrintJob

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail