JavaTM 2 Platform
Std. Ed. v1.4.1

javax.print.attribute.standard
Class SheetCollate

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

public final class SheetCollate
extends EnumSyntax
implements DocAttribute, PrintRequestAttribute, PrintJobAttribute

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.

See Also:
MultipleDocumentHandling, Serialized Form

Field Summary
static SheetCollate COLLATED
          Sheets within a document appear in collated order when multiple copies are printed.
static SheetCollate UNCOLLATED
          Sheets within a document appear in uncollated order when multiple copies are printed.
 
Constructor Summary
protected SheetCollate(int value)
          Construct a new sheet collate 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 SheetCollate.
 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 SheetCollate.
 
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

UNCOLLATED

public static final SheetCollate UNCOLLATED
Sheets within a document appear in uncollated order when multiple copies are printed.


COLLATED

public static final SheetCollate COLLATED
Sheets within a document appear in collated order when multiple copies are printed.

Constructor Detail

SheetCollate

protected SheetCollate(int value)
Construct a new sheet collate enumeration value with the given integer value.

Parameters:
value - Integer value.
Method Detail

getStringTable

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

Overrides:
getStringTable in class EnumSyntax
Returns:
the string table

getEnumValueTable

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

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

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.