APIdia Launch Partner
Top Description Fields Constructors Methods
javax.print.event

public Class PrintJobEvent

extends PrintEvent
Class Inheritance
Imports
java.io.Serial, javax.print.DocPrintJob

Class PrintJobEvent encapsulates common events a print job reports to let a listener know of progress in the processing of the DocPrintJob.

Field Summary

Modifier and TypeField and Description
public static final int
DATA_TRANSFER_COMPLETE

The job is not necessarily printed yet, but the data has been transferred successfully from the client to the print service.

public static final int
JOB_CANCELED

The job was canceled by the PrintService.

public static final int
JOB_COMPLETE

The document is completely printed.

public static final int
JOB_FAILED

The print service reports that the job cannot be completed.

public static final int
NO_MORE_EVENTS

Not all print services may be capable of delivering interesting events, or even telling when a job is complete.

private int
public static final int
REQUIRES_ATTENTION

The print service indicates that a - possibly transient - problem may require external intervention before the print service can continue.

private static final long
serialVersionUID

Hides javax.print.event.PrintEvent.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

AccessConstructor and Description
public
PrintJobEvent(DocPrintJob
a DocPrintJob object
source
,
int
an int specifying the reason
reason
)

Constructs a PrintJobEvent object.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

reason int
getPrintEventType
()

Gets the reason for this event.

public DocPrintJob

Returns:

the DocPrintJob object that represents the print job that reports the events encapsulated by this PrintJobEvent
getPrintJob
()

Determines the DocPrintJob to which this print job event pertains.

Inherited from javax.print.event.PrintEvent:
toString

Field Detail

DATA_TRANSFER_COMPLETEback to summary
public static final int DATA_TRANSFER_COMPLETE

The job is not necessarily printed yet, but the data has been transferred successfully from the client to the print service. The client may free data resources.

JOB_CANCELEDback to summary
public static final int JOB_CANCELED

The job was canceled by the PrintService.

JOB_COMPLETEback to summary
public static final int JOB_COMPLETE

The document is completely printed.

JOB_FAILEDback to summary
public static final int JOB_FAILED

The print service reports that the job cannot be completed. The application must resubmit the job.

NO_MORE_EVENTSback to summary
public static final int NO_MORE_EVENTS

Not all print services may be capable of delivering interesting events, or even telling when a job is complete. This message indicates the print job has no further information or communication with the print service. This message should always be delivered if a terminal event (completed/failed/canceled) is not delivered. For example, if messages such as JOB_COMPLETE have NOT been received before receiving this message, the only inference that should be drawn is that the print service does not support delivering such an event.

reasonback to summary
private int reason
REQUIRES_ATTENTIONback to summary
public static final int REQUIRES_ATTENTION

The print service indicates that a - possibly transient - problem may require external intervention before the print service can continue. One example of an event that can generate this message is when the printer runs out of paper.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.print.event.PrintEvent.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations
@Serial

Constructor Detail

PrintJobEventback to summary
public PrintJobEvent(DocPrintJob source, int reason)

Constructs a PrintJobEvent object.

Parameters
source:DocPrintJob

a DocPrintJob object

reason:int

an int specifying the reason

Exceptions
IllegalArgumentException:
if source is null

Method Detail

getPrintEventTypeback to summary
public int getPrintEventType()

Gets the reason for this event.

Returns:int

reason int

getPrintJobback to summary
public DocPrintJob getPrintJob()

Determines the DocPrintJob to which this print job event pertains.

Returns:DocPrintJob

the DocPrintJob object that represents the print job that reports the events encapsulated by this PrintJobEvent