PrintJobEvent (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.print.event
class PrintJobEvent

java.lang.Object
  java.util.EventObject
      javax.print.event.PrintEvent
          javax.print.event.PrintJobEvent

All Implemented Interfaces:: Serializable

public class PrintJobEvent
extends PrintEvent

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

Field Summary
`static 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.
`static int`	`JOB_CANCELED` The job was canceled by the javax.print.PrintService.
`static int`	`JOB_COMPLETE` The document cis completely printed.
`static int`	`JOB_FAILED` The print service reports that the job cannot be completed.
`static int`	`NO_MORE_EVENTS` Not all print services may be capable of delivering interesting events, or even telling when a job is complete.
`static int`	`REQUIRES_ATTENTION` The print service indicates that a - possibly transient - problem may require external intervention before the print service can continue.

Fields inherited from class java.util.EventObject
`source`

Constructor Summary
`PrintJobEvent(DocPrintJob source, int reason)` Constructs a `PrintJobEvent` object.

Method Summary
`int`	`getPrintEventType()` Gets the reason for this event.
`DocPrintJob`	`getPrintJob()` Determines the `DocPrintJob` to which this print job event pertains.

Methods inherited from class javax.print.event.PrintEvent
`toString`

Methods inherited from class java.util.EventObject
`getSource, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

DATA_TRANSFER_COMPLETE

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_CANCELED

public static final int JOB_CANCELED

The job was canceled by the {@link javax.print.PrintService PrintService}.

JOB_COMPLETE

public static final int JOB_COMPLETE

The document cis completely printed.

JOB_FAILED

public static final int JOB_FAILED

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

NO_MORE_EVENTS

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.

REQUIRES_ATTENTION

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.

Constructor Detail

PrintJobEvent

public PrintJobEvent(DocPrintJob source,
                     int reason)

Constructs a PrintJobEvent object.

Parameters:: source - a DocPrintJob object; reason - an int specifying the reason.

Method Detail

getPrintEventType

public int getPrintEventType()

Gets the reason for this event.

Returns:: reason int.

getPrintJob

public DocPrintJob getPrintJob()

Determines the DocPrintJob to which this print job event pertains.

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