001/* PrintEvent.java -- 
002   Copyright (C) 2004, 2005  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.print.event;
039
040import javax.print.DocPrintJob;
041
042
043/**
044 * <code>PrintJobEvent</code>s are generated by a print job during
045 * print job processing to inform registered listeners about the state
046 * of processing.
047 * 
048 * @author Michael Koch (konqueror@gmx.de)
049 */
050public class PrintJobEvent extends PrintEvent
051{
052  private static final long serialVersionUID = -1711656903622072997L;
053  
054  /** Indicates that the data transfer to the print service has completed. */
055  public static final int DATA_TRANSFER_COMPLETE = 106;
056  
057  /** Indicates that the print job was canceled. */
058  public static final int JOB_CANCELED = 101;
059  
060  /** Indicates that the print job was completed (=printed). */
061  public static final int JOB_COMPLETE = 102;
062  
063  /** Indicates that the print job failed to complete. */
064  public static final int JOB_FAILED = 103;
065  
066  /** Indicates that no more job events will be send.*/
067  public static final int NO_MORE_EVENTS = 105;
068  
069  /** 
070   * Indicates a situation where human intervention might be needed.
071   * E.g. the printer run out of paper or a paper jam occured.
072   */
073  public static final int REQUIRES_ATTENTION = 104;
074  
075  /** The reason (one of the defined constants). */
076  private int reason;
077  
078  /**
079   * Constructs a <code>PrintJobEvent</code> object.
080   * 
081   * @param source the source generating this event
082   * @param reason the reason for this event
083   */
084  public PrintJobEvent(DocPrintJob source, int reason)
085  {
086    super(source);
087    this.reason = reason;
088  }
089
090  /**
091   * Returns the reason for this event.
092   * 
093   * @return The reason.
094   */
095  public int getPrintEventType()
096  {
097    return reason;
098  }
099
100  /**
101   * Returns the print job that generated this event.
102   * 
103   * @return The print job.
104   */ 
105  public DocPrintJob getPrintJob()
106  {
107    return (DocPrintJob) getSource();
108  }
109}