APIdia Launch Partner
Top Description Fields Constructors Methods
javax.print.attribute.standard

public Class MultipleDocumentHandling

extends EnumSyntax
implements PrintRequestAttribute, PrintJobAttribute
Class Inheritance
All Implemented Interfaces
javax.print.attribute.PrintJobAttribute, javax.print.attribute.Attribute, java.io.Serializable, javax.print.attribute.PrintRequestAttribute
Imports
java.io.Serial, javax.print.attribute.Attribute, .EnumSyntax, .PrintJobAttribute, .PrintRequestAttribute

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.

Authors
David Mendenhall, Alan Kaminsky
See Also
Copies, Finishings, NumberUp, PageRanges, SheetCollate, Sides

Field Summary

Modifier and TypeField and Description
private static final MultipleDocumentHandling[]
myEnumValueTable

The enumeration value table for class MultipleDocumentHandling.

private static final String[]
myStringTable

The string table for class MultipleDocumentHandling.

public static final MultipleDocumentHandling
SEPARATE_DOCUMENTS_COLLATED_COPIES

Separate documents collated copies -- see above for further information.

public static final MultipleDocumentHandling
SEPARATE_DOCUMENTS_UNCOLLATED_COPIES

Separate documents uncollated copies -- see above for further information.

private static final long
serialVersionUID

Hides javax.print.attribute.EnumSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.
public static final MultipleDocumentHandling
SINGLE_DOCUMENT

Single document -- see above for further information.

public static final MultipleDocumentHandling
SINGLE_DOCUMENT_NEW_SHEET

Single document new sheet -- see above for further information.

Constructor Summary

AccessConstructor and Description
protected
MultipleDocumentHandling(int
Integer value
value
)

Construct a new multiple document handling enumeration value with the given integer value.

Method Summary

Modifier and TypeMethod and Description
public final Class<? extends Attribute>

Returns:

printing attribute class (category), an instance of class java.lang.Class
getCategory
()

Implements javax.print.attribute.Attribute.getCategory.

Get the printing attribute class which is to be used as the "category" for this printing attribute value.

protected EnumSyntax[]
getEnumValueTable()

Overrides javax.print.attribute.EnumSyntax.getEnumValueTable.

Returns the enumeration value table for class MultipleDocumentHandling.

public final String

Returns:

attribute category name
getName
()

Implements javax.print.attribute.Attribute.getName.

Get the name of the category of which this attribute value is an instance.

protected String[]
getStringTable()

Overrides javax.print.attribute.EnumSyntax.getStringTable.

Returns the string table for class MultipleDocumentHandling.

Inherited from javax.print.attribute.EnumSyntax:
clonegetOffsetgetValuehashCodereadResolvetoString

Field Detail

myEnumValueTableback to summary
private static final MultipleDocumentHandling[] myEnumValueTable

The enumeration value table for class MultipleDocumentHandling.

myStringTableback to summary
private static final String[] myStringTable

The string table for class MultipleDocumentHandling.

SEPARATE_DOCUMENTS_COLLATED_COPIESback to summary
public static final MultipleDocumentHandling SEPARATE_DOCUMENTS_COLLATED_COPIES

Separate documents collated copies -- see above for further information.

SEPARATE_DOCUMENTS_UNCOLLATED_COPIESback to summary
public static final MultipleDocumentHandling SEPARATE_DOCUMENTS_UNCOLLATED_COPIES

Separate documents uncollated copies -- see above for further information.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.print.attribute.EnumSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations
@Serial
SINGLE_DOCUMENTback to summary
public static final MultipleDocumentHandling SINGLE_DOCUMENT

Single document -- see above for further information.

SINGLE_DOCUMENT_NEW_SHEETback to summary
public static final MultipleDocumentHandling SINGLE_DOCUMENT_NEW_SHEET

Single document new sheet -- see above for further information.

Constructor Detail

MultipleDocumentHandlingback to summary
protected MultipleDocumentHandling(int value)

Construct a new multiple document handling enumeration value with the given integer value.

Parameters
value:int

Integer value

Method Detail

getCategoryback to summary
public final Class<? extends Attribute> getCategory()

Implements javax.print.attribute.Attribute.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.

Returns:Class<? extends Attribute>

printing attribute class (category), an instance of class java.lang.Class

Annotations
@Override
getEnumValueTableback to summary
protected EnumSyntax[] getEnumValueTable()

Overrides javax.print.attribute.EnumSyntax.getEnumValueTable.

Returns the enumeration value table for class MultipleDocumentHandling.

Annotations
@Override
getNameback to summary
public final String getName()

Implements javax.print.attribute.Attribute.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".

Returns:String

attribute category name

Annotations
@Override
getStringTableback to summary
protected String[] getStringTable()

Overrides javax.print.attribute.EnumSyntax.getStringTable.

Returns the string table for class MultipleDocumentHandling.

Annotations
@Override