javax.print

Interface DocPrintJob

Known Subinterfaces:: CancelablePrintJob, MultiDocPrintJob

Known Implementing Classes:: DocPrintJobImpl, MultiDocPrintJobImpl

public interface DocPrintJob

DocPrintJob represents a print job which supports printing of a single document.

An instance can be obtained from every PrintService available by calling the PrintService.createPrintJob() method. A print job is bound to the print service it is created from.

Method Summary
`void`	`addPrintJobAttributeListener(PrintJobAttributeListener listener, PrintJobAttributeSet attributes)` Registers a listener for changes in the specified attribute set during processing of this print job.
`void`	`addPrintJobListener(PrintJobListener listener)` Registers a listener for events occuring during processing of this print job.
`PrintJobAttributeSet`	`getAttributes()` Returns the print job's attributes.
`PrintService`	`getPrintService()` Returns the `PrintService` object this print job is bound to.
`void`	`print(Doc doc, PrintRequestAttributeSet attributes)` Prints a document with the specified print job attributes.
`void`	`removePrintJobAttributeListener(PrintJobAttributeListener listener)` Removes the given listener from the listeners registered for changes in their provided attribute set during processing of this print job.
`void`	`removePrintJobListener(PrintJobListener listener)` Removes the given listener from the listeners registered for events occuring during processing of this print job.

addPrintJobAttributeListener

public void addPrintJobAttributeListener(PrintJobAttributeListener listener,
                                         PrintJobAttributeSet attributes)

Registers a listener for changes in the specified attribute set during processing of this print job.
If the given attribute set is empty no changes will be reported. If the set is null all attributes are monitored.
Parameters:
listener - the listener to register.
attributes - the attributes to observe.
See Also:
removePrintJobAttributeListener(PrintJobAttributeListener)

addPrintJobListener

public void addPrintJobListener(PrintJobListener listener)

Registers a listener for events occuring during processing of this print job.
Parameters:
listener - the listener to add, if null nothing is done.
See Also:
removePrintJobListener(PrintJobListener)

getAttributes

public PrintJobAttributeSet getAttributes()

Returns the print job's attributes.
The returned set of attributes is a snapshot at the time of calling this method and will not be updated if changes to the print job's attributes happens. To monitor changes register a print job listener.
Returns:
The attributes of this print job, may be empty but never null.

getPrintService

public PrintService getPrintService()

Returns the PrintService object this print job is bound to.
Returns:
The print service.

print

public void print(Doc doc,
                  PrintRequestAttributeSet attributes)
            throws PrintException

Prints a document with the specified print job attributes.
If the doc flavor provided by the Doc implementation is not supported by this print service a PrintException implementing the FlavorException interface will be thrown.
Parameters:
doc - the document to print
attributes - the job attributes to use. If null the default attribute values of the print service will be used.
Throws:
PrintException - if an error occurs. The thrown exception may implement refining print exception interface to provide more detail of the error.
See Also:
AttributeException, FlavorException

removePrintJobAttributeListener

public void removePrintJobAttributeListener(PrintJobAttributeListener listener)

Removes the given listener from the listeners registered for changes in their provided attribute set during processing of this print job.
Parameters:
listener - the listener to remove, if null or not registered nothing will be done.
See Also:
addPrintJobAttributeListener(PrintJobAttributeListener,PrintJobAttributeSet)

removePrintJobListener

public void removePrintJobListener(PrintJobListener listener)

Removes the given listener from the listeners registered for events occuring during processing of this print job.
Parameters:
listener - the listener to remove, if null or not registered nothing will be done.
See Also:
addPrintJobListener(PrintJobListener)

DocPrintJob.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.

Overview Package Class Use Source Tree Index Deprecated About
Prev Class \| Next Class		Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr