APIdia Launch Partner
Top Description Methods
javax.print.event

public Interface PrintJobListener

Known Direct Implementers
javax.print.event.PrintJobAdapter

Implementations of this listener interface should be attached to a DocPrintJob to monitor the status of the printer job. These callback methods may be invoked on the thread processing the print job, or a service created notification thread. In either case the client should not perform lengthy processing in these callbacks.

Method Summary

Modifier and TypeMethod and Description
public void
printDataTransferCompleted(PrintJobEvent
the job generating this event
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.

public void
printJobCanceled(PrintJobEvent
the job generating this event
pje
)

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

public void
printJobCompleted(PrintJobEvent
the job generating this event
pje
)

Called to notify the client that the job completed successfully.

public void
printJobFailed(PrintJobEvent
the job generating this event
pje
)

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

public void
printJobNoMoreEvents(PrintJobEvent
the job generating this event
pje
)

Called to notify the client that no more events will be delivered.

public void
printJobRequiresAttention(PrintJobEvent
the job generating this event
pje
)

Called to notify the client that an error has occurred that the user might be able to fix.

Method Detail

printDataTransferCompletedback to summary
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. If this event is not received the client should wait for a terminal event (completed/canceled/failed) before freeing the resources.

Parameters
pje:PrintJobEvent

the job generating this event

printJobCanceledback to summary
public void printJobCanceled(PrintJobEvent pje)

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

Parameters
pje:PrintJobEvent

the job generating this event

printJobCompletedback to summary
public void printJobCompleted(PrintJobEvent pje)

Called to notify the client that the job completed successfully.

Parameters
pje:PrintJobEvent

the job generating this event

printJobFailedback to summary
public void printJobFailed(PrintJobEvent pje)

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

Parameters
pje:PrintJobEvent

the job generating this event

printJobNoMoreEventsback to summary
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.

Parameters
pje:PrintJobEvent

the job generating this event

printJobRequiresAttentionback to summary
public void printJobRequiresAttention(PrintJobEvent pje)

Called to notify the client that an error has occurred that the user might be able to fix. One example of an error that can generate this event is when the printer runs out of paper.

Parameters
pje:PrintJobEvent

the job generating this event