This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.print.attribute.standard
class SheetCollate
- All Implemented Interfaces:
- Serializable, Cloneable, DocAttribute, PrintJobAttribute, PrintRequestAttribute
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 {@link Copies 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 {@link Copies Copies}
attribute in succession. For example, suppose a document produces two media
sheets as output, {@link Copies 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 {@link MultipleDocumentHandling
MultipleDocumentHandling} attribute. The {@link MultipleDocumentHandling
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 {@link
MultipleDocumentHandling MultipleDocumentHandling} attribute.
-
If all the docs have the same sheet collation specified, then the following
combinations of SheetCollate and {@link MultipleDocumentHandling
MultipleDocumentHandling} are permitted, and the printer reports an error
when the job is submitted if any other combination is specified:
-
SheetCollate = COLLATED, {@link MultipleDocumentHandling
MultipleDocumentHandling} = SINGLE_DOCUMENT -- All the input docs will be
combined into one output document. Multiple copies of the output document
will be produced with pages in collated order, i.e. pages 1, 2, 3, . . .,
1, 2, 3, . . .
-
SheetCollate = COLLATED, {@link MultipleDocumentHandling
MultipleDocumentHandling} = SINGLE_DOCUMENT_NEW_SHEET -- All the input docs
will be combined into one output document, and the first impression of each
input doc will always start on a new media sheet. Multiple copies of the
output document will be produced with pages in collated order, i.e. pages
1, 2, 3, . . ., 1, 2, 3, . . .
-
SheetCollate = COLLATED, {@link MultipleDocumentHandling
MultipleDocumentHandling} = SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each
input doc will remain a separate output document. Multiple copies of each
output document (call them A, B, . . .) will be produced with each document's
pages in collated order, but the documents themselves in uncollated order,
i.e. pages A1, A2, A3, . . ., A1, A2, A3, . . ., B1, B2, B3, . . ., B1, B2,
B3, . . .
-
SheetCollate = COLLATED, {@link MultipleDocumentHandling
MultipleDocumentHandling} = SEPARATE_DOCUMENTS_COLLATED_COPIES -- Each input
doc will remain a separate output document. Multiple copies of each output
document (call them A, B, . . .) will be produced with each document's pages
in collated order, with the documents themselves also in collated order, i.e.
pages A1, A2, A3, . . ., B1, B2, B3, . . ., A1, A2, A3, . . ., B1, B2, B3,
. . .
-
SheetCollate = UNCOLLATED, {@link MultipleDocumentHandling
MultipleDocumentHandling} = SINGLE_DOCUMENT -- All the input docs will be
combined into one output document. Multiple copies of the output document
will be produced with pages in uncollated order, i.e. pages 1, 1, . . .,
2, 2, . . ., 3, 3, . . .
-
SheetCollate = UNCOLLATED, {@link MultipleDocumentHandling
MultipleDocumentHandling} = SINGLE_DOCUMENT_NEW_SHEET -- All the input docs
will be combined into one output document, and the first impression of each
input doc will always start on a new media sheet. Multiple copies of the
output document will be produced with pages in uncollated order, i.e. pages
1, 1, . . ., 2, 2, . . ., 3, 3, . . .
-
SheetCollate = UNCOLLATED, {@link MultipleDocumentHandling
MultipleDocumentHandling} = SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each
input doc will remain a separate output document. Multiple copies of each
output document (call them A, B, . . .) will be produced with each document's
pages in uncollated order, with the documents themselves also in uncollated
order, i.e. pages A1, A1, . . ., A2, A2, . . ., A3, A3, . . ., B1, B1, . . .,
B2, B2, . . ., B3, B3, . . .
-
If different docs have different sheet collations specified, then only one
value of {@link MultipleDocumentHandling MultipleDocumentHandling} is
permitted, and the printer reports an error when the job is submitted if any
other value is specified:
-
{@link MultipleDocumentHandling MultipleDocumentHandling} =
SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each input doc will remain a separate
output document. Multiple copies of each output document (call them A, B,
. . .) will be produced with each document's pages in collated or uncollated
order as the corresponding input doc's SheetCollate attribute specifies, and
with the documents themselves in uncollated order. If document A had
SheetCollate = UNCOLLATED and document B had SheetCollate = COLLATED, the
following pages would be produced: A1, A1, . . ., A2, A2, . . ., A3, A3,
. . ., B1, B2, B3, . . ., B1, B2, B3, . . .
IPP Compatibility: SheetCollate is not an IPP attribute at present.
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 |
Construct a new sheet collate enumeration value with the given integer
value.
|
Method Summary |
Class |
Get the printing attribute class which is to be used as the "category"
for this printing attribute value.
|
protected EnumSyntax[] |
Returns the enumeration value table for class SheetCollate.
|
String |
Get the name of the category of which this attribute value is an
instance.
|
protected String[] |
Returns the string table for class SheetCollate.
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
COLLATED
public static final SheetCollate COLLATED
-
Sheets within a document appear in collated order when multiple copies
are printed.
UNCOLLATED
public static final SheetCollate UNCOLLATED
-
Sheets within a document appear in uncollated order when multiple
copies are printed.
SheetCollate
protected SheetCollate(int value)
-
Construct a new sheet collate enumeration value with the given integer
value.
- Parameters:
value
- Integer value.
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.
- Returns:
- Printing attribute class (category), an instance of class
{@link java.lang.Class java.lang.Class}.
getEnumValueTable
protected EnumSyntax[] getEnumValueTable()
-
Returns the enumeration value table for class SheetCollate.
- Overrides:
getEnumValueTable
in class EnumSyntax
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"
.
- Returns:
- Attribute category name.
getStringTable
protected String[] getStringTable()
-
Returns the string table for class SheetCollate.
- Overrides:
getStringTable
in class EnumSyntax
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.