Java™ Platform
Standard Ed. 6

javax.print.event
Class PrintJobAdapter

java.lang.Object
  extended by 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 null methods so that you only need to define the methods you need, rather than all of the methods.


Constructor Summary
PrintJobAdapter()
           
 
Method Summary
 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 inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PrintJobAdapter

public PrintJobAdapter()
Method Detail

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

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.

Scripting on this page tracks web page traffic, but does not change the content in any way.