001/* PrintJobAdapter.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
040
041/**
042 * Adapter class for implementing {@link javax.print.event.PrintJobListener}
043 * classes. The methods in this class do nothing by default. Subclasses may
044 * only implement the methods for the {@link javax.print.event.PrintJobEvent}s
045 * they are interested in.
046 *
047 * @author Michael Koch (konqueror@gmx.de)
048 */
049public abstract class PrintJobAdapter
050  implements PrintJobListener
051{
052  /**
053   * Constructs a <code>PrintJobAdapter</code> object.
054   */
055  public PrintJobAdapter()
056  {
057    // Do nothing here.
058  }
059
060  /**
061   * Called to notify the client that all data has been successfully transferred
062   * to the print service.
063   * <p>The default implementation does nothing.</p>
064   *
065   * @param event the event.
066   */
067  public void printDataTransferCompleted(PrintJobEvent event)
068  {
069    // Do nothing here.
070  }
071
072  /**
073   * Called to notify the client that a print job was canceled.
074   * <p>The default implementation does nothing.</p>
075   *
076   * @param event the event.
077   */
078  public void printJobCanceled(PrintJobEvent event)
079  {
080    // Do nothing here.
081  }
082
083  /**
084   * Called to notify the client that a print job was successfully completed.
085   * <p>The default implementation does nothing.</p>
086   *
087   * @param event the event.
088   */
089  public void printJobCompleted(PrintJobEvent event)
090  {
091    // Do nothing here.
092  }
093
094  /**
095   * Called to notify the client that a print job failed to complete
096   * successfully.
097   * <p>The default implementation does nothing.</p>
098   *
099   * @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}