gomp-20050608-branch/libjava/classpath/javax/print/event/PrintJobEvent.java

   1 /* PrintEvent.java --
   2    Copyright (C) 2004, 2005  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package javax.print.event;
  39
  40 import javax.print.DocPrintJob;
  41
  42
  43 /**
  44  * <code>PrintJobEvent</code>s are generated by a print job during
  45  * print job processing to inform registered listeners about the state
  46  * of processing.
  47  *
  48  * @author Michael Koch (konqueror@gmx.de)
  49  */
  50 public class PrintJobEvent extends PrintEvent
  51 {
  52   private static final long serialVersionUID = -1711656903622072997L;
  53
  54   /** Indicates that the data transfer to the print service has completed. */
  55   public static final int DATA_TRANSFER_COMPLETE = 106;
  56
  57   /** Indicates that the print job was canceled. */
  58   public static final int JOB_CANCELED = 101;
  59
  60   /** Indicates that the print job was completed (=printed). */
  61   public static final int JOB_COMPLETE = 102;
  62
  63   /** Indicates that the print job failed to complete. */
  64   public static final int JOB_FAILED = 103;
  65
  66   /** Indicates that no more job events will be send.*/
  67   public static final int NO_MORE_EVENTS = 105;
  68
  69   /**
  70    * Indicates a situation where human intervention might be needed.
  71    * E.g. the printer run out of paper or a paper jam occured.
  72    */
  73   public static final int REQUIRES_ATTENTION = 104;
  74
  75   /** The reason (one of the defined constants). */
  76   private int reason;
  77
  78   /**
  79    * Constructs a <code>PrintJobEvent</code> object.
  80    *
  81    * @param source the source generating this event
  82    * @param reason the reason for this event
  83    */
  84   public PrintJobEvent(DocPrintJob source, int reason)
  85   {
  86     super(source);
  87     this.reason = reason;
  88   }
  89
  90   /**
  91    * Returns the reason for this event.
  92    *
  93    * @return The reason.
  94    */
  95   public int getPrintEventType()
  96   {
  97     return reason;
  98   }
  99
 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 }