Class PrintJobAdapter

java.lang.Object

javax.print.event.PrintJobAdapter

All Implemented Interfaces:

PrintJobListener

public abstract class PrintJobAdapter
extends Object
implements PrintJobListener

An abstract adapter class for receiving print job events. The methods in this class are empty. This class exists as a convenience for creating listener objects. Extend this class to create a PrintJobEvent listener and override the methods for the events of interest. Unlike the ComponentListener interface, this abstract interface provides empty methods so that you only need to define the methods you need, rather than all of the methods.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrintJobAdapter()	Constructor for subclasses to call.

Method Summary

Modifier and Type	Method	Description
void	printDataTransferCompleted(PrintJobEvent pje)	Called to notify the client that data has been successfully transferred to the print service, and the client may free local resources allocated for that data.
void	printJobCanceled(PrintJobEvent pje)	Called to notify the client that the job was canceled by user or program.
void	printJobCompleted(PrintJobEvent pje)	Called to notify the client that the job completed successfully.
void	printJobFailed(PrintJobEvent pje)	Called to notify the client that the job failed to complete successfully and will have to be resubmitted.
void	printJobNoMoreEvents(PrintJobEvent pje)	Called to notify the client that no more events will be delivered.
void	printJobRequiresAttention(PrintJobEvent pje)	Called to notify the client that some possibly user rectifiable problem occurs (eg printer out of paper).

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Constructor Details

PrintJobAdapter

protected PrintJobAdapter()

Constructor for subclasses to call.

Method Details

printDataTransferCompleted

public void printDataTransferCompleted(PrintJobEvent pje)

Called to notify the client that data has been successfully transferred to the print service, and the client may free local resources allocated for that data. The client should not assume that the data has been completely printed after receiving this event.

Specified by:

printDataTransferCompleted in interface PrintJobListener

Parameters:

pje - the event being notified

printJobCompleted

public void printJobCompleted(PrintJobEvent pje)

Called to notify the client that the job completed successfully.

Specified by:

printJobCompleted in interface PrintJobListener

Parameters:

pje - the event being notified

printJobFailed

public void printJobFailed(PrintJobEvent pje)

Called to notify the client that the job failed to complete successfully and will have to be resubmitted.

Specified by:

printJobFailed in interface PrintJobListener

Parameters:

pje - the event being notified

printJobCanceled

public void printJobCanceled(PrintJobEvent pje)

Called to notify the client that the job was canceled by user or program.

Specified by:

printJobCanceled in interface PrintJobListener

Parameters:

pje - the event being notified

printJobNoMoreEvents

public void printJobNoMoreEvents(PrintJobEvent pje)

Called to notify the client that no more events will be delivered. One cause of this event being generated is if the job has successfully completed, but the printing system is limited in capability and cannot verify this. This event is required to be delivered if none of the other terminal events (completed/failed/canceled) are delivered.

Specified by:

printJobNoMoreEvents in interface PrintJobListener

Parameters:

pje - the event being notified

printJobRequiresAttention

public void printJobRequiresAttention(PrintJobEvent pje)

Called to notify the client that some possibly user rectifiable problem occurs (eg printer out of paper).

Specified by:

printJobRequiresAttention in interface PrintJobListener

Parameters:

pje - the event being notified