Home » openjdk-7 » javax » print » attribute » standard » [javadoc | source]
public final class: SheetCollate [javadoc | source]

All Implemented Interfaces:
    PrintJobAttribute, PrintRequestAttribute, DocAttribute, Cloneable, Serializable

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.

Field Summary
public static final  SheetCollate UNCOLLATED    Sheets within a document appear in uncollated order when multiple copies are printed. 
public static final  SheetCollate COLLATED    Sheets within a document appear in collated order when multiple copies are printed. 
 protected SheetCollate(int value) 
Method from javax.print.attribute.standard.SheetCollate Summary:
getCategory,   getEnumValueTable,   getName,   getStringTable
Methods from javax.print.attribute.EnumSyntax:
clone,   getEnumValueTable,   getOffset,   getStringTable,   getValue,   hashCode,   readResolve,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.print.attribute.standard.SheetCollate Detail:
 public final Class<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.

 protected EnumSyntax[] getEnumValueTable() 
    Returns the enumeration value table for class SheetCollate.
 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".

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