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

public final Class SheetCollate

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

Class SheetCollate is a printing attribute class, an enumeration, that specifies whether or not the media sheets of each copy of each printed document in a job are to be in sequence, when multiple copies of the document are specified by the Copies attribute. When SheetCollate is COLLATED, each copy of each document is printed with the print-stream sheets in sequence. When SheetCollate is UNCOLLATED, each print-stream sheet is printed a number of times equal to the value of the Copies attribute in succession. For example, suppose a document produces two media sheets as output, Copies is 6, and SheetCollate is UNCOLLATED; in this case six copies of the first media sheet are printed followed by six copies of the second media sheet.

Whether the effect of sheet collation is achieved by placing copies of a document in multiple output bins or in the same output bin with implementation defined document separation is implementation dependent. Also whether it is achieved by making multiple passes over the job or by using an output sorter is implementation dependent.

If a printer does not support the SheetCollate attribute (meaning the client cannot specify any particular sheet collation), the printer must behave as though SheetCollate were always set to COLLATED.

The SheetCollate attribute interacts with the MultipleDocumentHandling attribute. The MultipleDocumentHandling attribute describes the collation of entire documents, and the SheetCollate attribute describes the semantics of collating individual pages within a document.

The effect of a SheetCollate attribute on a multidoc print job (a job with multiple documents) depends on whether all the docs have the same sheet collation specified or whether different docs have different sheet collations specified, and on the (perhaps defaulted) value of the MultipleDocumentHandling attribute.

IPP Compatibility: SheetCollate is not an IPP attribute at present.

Author
Alan Kaminsky
See Also
MultipleDocumentHandling

Field Summary

Modifier and TypeField and Description
public static final SheetCollate
COLLATED

Sheets within a document appear in collated order when multiple copies are printed.

private static final SheetCollate[]
myEnumValueTable

The enumeration value table for class SheetCollate.

private static final String[]
myStringTable

The string table for class SheetCollate.

private static final long
serialVersionUID

Hides javax.print.attribute.EnumSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.
public static final SheetCollate
UNCOLLATED

Sheets within a document appear in uncollated order when multiple copies are printed.

Constructor Summary

AccessConstructor and Description
protected
SheetCollate(int
Integer value
value
)

Construct a new sheet collate 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 SheetCollate.

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

Inherited from javax.print.attribute.EnumSyntax:
clonegetOffsetgetValuehashCodereadResolvetoString

Field Detail

COLLATEDback to summary
public static final SheetCollate COLLATED

Sheets within a document appear in collated order when multiple copies are printed.

myEnumValueTableback to summary
private static final SheetCollate[] myEnumValueTable

The enumeration value table for class SheetCollate.

myStringTableback to summary
private static final String[] myStringTable

The string table for class SheetCollate.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.print.attribute.EnumSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations
@Serial
UNCOLLATEDback to summary
public static final SheetCollate UNCOLLATED

Sheets within a document appear in uncollated order when multiple copies are printed.

Constructor Detail

SheetCollateback to summary
protected SheetCollate(int value)

Construct a new sheet collate 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 SheetCollate, the category is class SheetCollate 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 SheetCollate.

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 SheetCollate, the category name is "sheet-collate".

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

Annotations
@Override