javax.print

Interface CancelablePrintJob

All Superinterfaces:
DocPrintJob
Known Implementing Classes:
DocPrintJobImpl, MultiDocPrintJobImpl

public interface CancelablePrintJob
extends DocPrintJob

CancelablePrintJob represents a print job which can be canceled.

It is implemented by DocPrintJobs which support to cancel a print job during processing. Clients need to explicitly test if a given DocPrintJob object from a print service implementes this interface and therefore supports cancelling.

Implementor of java print services should implement this interface if cancelling is supported by the underlying print system. If implemented the corresponding print job event PrintJobEvent.JOB_CANCELED should be delivered to registered clients. Implementations have to be thread-safe.

Method Summary

void
cancel()
Cancel the print job.

Methods inherited from interface javax.print.DocPrintJob

addPrintJobAttributeListener, addPrintJobListener, getAttributes, getPrintService, print, removePrintJobAttributeListener, removePrintJobListener

Method Details

cancel

public void cancel()
            throws PrintException
Cancel the print job.
Throws:
PrintException - if an error during cancellation occurs.

CancelablePrintJob.java -- Copyright (C) 2004, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.