Source for javax.print.event.PrintJobAdapter

   1: /* PrintJobAdapter.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:  * Adapter class for implementing {@link javax.print.event.PrintJobListener}
  43:  * classes. The methods in this class do nothing by default. Subclasses may
  44:  * only implement the methods for the {@link javax.print.event.PrintJobEvent}s
  45:  * they are interested in.
  46:  * 
  47:  * @author Michael Koch (konqueror@gmx.de)
  48:  */
  49: public abstract class PrintJobAdapter
  50:   implements PrintJobListener
  51: {
  52:   /**
  53:    * Constructs a <code>PrintJobAdapter</code> object.
  54:    */
  55:   public PrintJobAdapter()
  56:   {
  57:     // Do nothing here.
  58:   }
  59:   
  60:   /**
  61:    * Called to notify the client that all data has been successfully transferred
  62:    * to the print service.
  63:    * <p>The default implementation does nothing.</p>
  64:    * 
  65:    * @param event the event. 
  66:    */
  67:   public void printDataTransferCompleted(PrintJobEvent event)
  68:   {
  69:     // Do nothing here.
  70:   }
  71: 
  72:   /**
  73:    * Called to notify the client that a print job was canceled. 
  74:    * <p>The default implementation does nothing.</p>
  75:    * 
  76:    * @param event the event. 
  77:    */
  78:   public void printJobCanceled(PrintJobEvent event)
  79:   {
  80:     // Do nothing here.
  81:   }
  82: 
  83:   /**
  84:    * Called to notify the client that a print job was successfully completed.
  85:    * <p>The default implementation does nothing.</p>
  86:    * 
  87:    * @param event the event. 
  88:    */
  89:   public void printJobCompleted(PrintJobEvent event)
  90:   {
  91:     // Do nothing here.
  92:   }
  93: 
  94:   /**
  95:    * Called to notify the client that a print job failed to complete
  96:    * successfully.
  97:    * <p>The default implementation does nothing.</p>
  98:    * 
  99:    * @param event the event. 
 100:    */
 101:   public void printJobFailed(PrintJobEvent event)
 102:   {
 103:     // Do nothing here.
 104:   }
 105: 
 106:   /**
 107:    * Called to notify the client that no more job events will be send.
 108:    * <p>The default implementation does nothing.</p>
 109:    * 
 110:    * @param event the event. 
 111:    */
 112:   public void printJobNoMoreEvents(PrintJobEvent event)
 113:   {
 114:     // Do nothing here.
 115:   }
 116: 
 117:   /**
 118:    * Called to notify the client that a problem occured during printing.
 119:    * This event signals problems a user might be able to fix 
 120:    * (e.g. out of paper or paper jam).
 121:    * <p>The default implementation does nothing.</p>
 122:    * 
 123:    * @param event the event. 
 124:    */
 125:   public void printJobRequiresAttention(PrintJobEvent event)
 126:   {
 127:     // Do nothing here.
 128:   }
 129: }