JavaTM 2 Platform
Std. Ed. v1.4.1

javax.print.attribute.standard
Class MultipleDocumentHandling

java.lang.Object
  |
  +--javax.print.attribute.EnumSyntax
        |
        +--javax.print.attribute.standard.MultipleDocumentHandling
All Implemented Interfaces:
Attribute, Cloneable, PrintJobAttribute, PrintRequestAttribute, Serializable

public class MultipleDocumentHandling
extends EnumSyntax
implements PrintRequestAttribute, PrintJobAttribute

Class MultipleDocumentHandling is a printing attribute class, an enumeration, that controls finishing operations and the placement of one or more print-stream pages into impressions and onto media sheets. When the value of the Copies attribute exceeds 1, MultipleDocumentHandling also controls the order in which the copies that result from processing the documents are produced. This attribute is relevant only for a multidoc print job consisting of two or more individual docs.

Briefly, MultipleDocumentHandling determines the relationship between the multiple input (electronic) documents fed into a multidoc print job and the output (physical) document or documents produced by the multidoc print job. There are two possibilities:

In the detailed explanations below, if "a" represents an instance of document data, then the result of processing the data in document "a" is a sequence of media sheets represented by "a(*)".

The standard MultipleDocumentHandling values are:

SINGLE_DOCUMENT is the same as SEPARATE_DOCUMENTS_COLLATED_COPIES with respect to ordering of print-stream pages, but not media sheet generation, since SINGLE_DOCUMENT will put the first page of the next document on the back side of a sheet if an odd number of pages have been produced so far for the job, while SEPARATE_DOCUMENTS_COLLATED_COPIES always forces the next document or document copy on to a new sheet.

In addition, if a Finishings attribute of STAPLE is specified, then:

Note: None of these values provide means to produce uncollated sheets within a document, i.e., where multiple copies of sheet n are produced before sheet n+1 of the same document. To specify that, see the SheetCollate attribute.

IPP Compatibility: The category name returned by getName() is the IPP attribute name. The enumeration's integer value is the IPP enum value. The toString() method returns the IPP string representation of the attribute value.

See Also:
Copies, Finishings, NumberUp, PageRanges, SheetCollate, Sides, Serialized Form

Field Summary
static MultipleDocumentHandling SEPARATE_DOCUMENTS_COLLATED_COPIES
          Separate documents collated copies -- see above for further information.
static MultipleDocumentHandling SEPARATE_DOCUMENTS_UNCOLLATED_COPIES
          Separate documents uncollated copies -- see above for further information.
static MultipleDocumentHandling SINGLE_DOCUMENT
          Single document -- see above for further information.
static MultipleDocumentHandling SINGLE_DOCUMENT_NEW_SHEET
          Single document new sheet -- see above for further information.
 
Constructor Summary
protected MultipleDocumentHandling(int value)
          Construct a new multiple document handling enumeration value with the given integer value.
 
Method Summary
 Class getCategory()
          Get the printing attribute class which is to be used as the "category" for this printing attribute value.
protected  EnumSyntax[] getEnumValueTable()
          Returns the enumeration value table for class MultipleDocumentHandling.
 String getName()
          Get the name of the category of which this attribute value is an instance.
protected  String[] getStringTable()
          Returns the string table for class MultipleDocumentHandling.
 
Methods inherited from class javax.print.attribute.EnumSyntax
clone, getOffset, getValue, hashCode, readResolve, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

SINGLE_DOCUMENT

public static final MultipleDocumentHandling SINGLE_DOCUMENT
Single document -- see above for further information.


SEPARATE_DOCUMENTS_UNCOLLATED_COPIES

public static final MultipleDocumentHandling SEPARATE_DOCUMENTS_UNCOLLATED_COPIES
Separate documents uncollated copies -- see above for further information.


SEPARATE_DOCUMENTS_COLLATED_COPIES

public static final MultipleDocumentHandling SEPARATE_DOCUMENTS_COLLATED_COPIES
Separate documents collated copies -- see above for further information.


SINGLE_DOCUMENT_NEW_SHEET

public static final MultipleDocumentHandling SINGLE_DOCUMENT_NEW_SHEET
Single document new sheet -- see above for further information.

Constructor Detail

MultipleDocumentHandling

protected MultipleDocumentHandling(int value)
Construct a new multiple document handling enumeration value with the given integer value.

Parameters:
value - Integer value.
Method Detail

getStringTable

protected String[] getStringTable()
Returns the string table for class MultipleDocumentHandling.

Overrides:
getStringTable in class EnumSyntax
Returns:
the string table

getEnumValueTable

protected EnumSyntax[] getEnumValueTable()
Returns the enumeration value table for class MultipleDocumentHandling.

Overrides:
getEnumValueTable in class EnumSyntax
Returns:
the value table

getCategory

public final Class getCategory()
Get the printing attribute class which is to be used as the "category" for this printing attribute value.

For class MultipleDocumentHandling and any vendor-defined subclasses, the category is class MultipleDocumentHandling itself.

Specified by:
getCategory in interface Attribute
Returns:
Printing attribute class (category), an instance of class java.lang.Class.

getName

public final String getName()
Get the name of the category of which this attribute value is an instance.

For class MultipleDocumentHandling and any vendor-defined subclasses, the category name is "multiple-document-handling".

Specified by:
getName in interface Attribute
Returns:
Attribute category name.

JavaTM 2 Platform
Std. Ed. v1.4.1

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.