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

   1 /* PrintJobListener.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
  41 /**
  42  * Listener interface to receive processing events from a print job.
  43  * Implementations of this interface can be registered with a
  44  * {@link javax.print.DocPrintJob} instance.
  45  *
  46  * @see javax.print.event.PrintJobAdapter
  47  *
  48  * @author Michael Koch (konqueror@gmx.de)
  49  */
  50 public interface PrintJobListener
  51 {
  52   /**
  53    * Notifies the listener that all data has been successfully transferred
  54    * to the print service.
  55    *
  56    * @param event the event
  57    */
  58   void printDataTransferCompleted(PrintJobEvent event);
  59
  60   /**
  61    * Notifies the listener that a print job got canceled.
  62    *
  63    * @param event the event
  64    */
  65   void printJobCanceled(PrintJobEvent event);
  66
  67   /**
  68    * Notifies the listener that a print job has completed.
  69    *
  70    * @param event the event
  71    */
  72   void printJobCompleted(PrintJobEvent event);
  73
  74   /**
  75    * Notifies the listener that a print job has failed to complete.
  76    *
  77    * @param event the event.
  78    */
  79   void printJobFailed(PrintJobEvent event);
  80
  81   /**
  82    * Notifies the listener that no more events will be delivered.
  83    *
  84    * @param event the event
  85    */
  86   void printJobNoMoreEvents(PrintJobEvent event);
  87
  88   /**
  89    * Notifies the listener that a problem occured during printing.
  90    * This event signals problems a user might be able to fix
  91    * (e.g. out of paper or paper jam).
  92    *
  93    * @param event the event
  94    */
  95   void printJobRequiresAttention(PrintJobEvent event);
  96 }