2362N/A * Copyright (c) 2000, 2004, Oracle and/or its affiliates. All rights reserved. 0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 0N/A * This code is free software; you can redistribute it and/or modify it 0N/A * under the terms of the GNU General Public License version 2 only, as 2362N/A * published by the Free Software Foundation. Oracle designates this 0N/A * particular file as subject to the "Classpath" exception as provided 2362N/A * by Oracle in the LICENSE file that accompanied this code. 0N/A * This code is distributed in the hope that it will be useful, but WITHOUT 0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 0N/A * version 2 for more details (a copy is included in the LICENSE file that 0N/A * accompanied this code). 0N/A * You should have received a copy of the GNU General Public License version 0N/A * 2 along with this work; if not, write to the Free Software Foundation, 0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2362N/A * or visit www.oracle.com if you need additional information or have any 0N/A * Class SheetCollate is a printing attribute class, an enumeration, that 0N/A * specifies whether or not the media sheets of each copy of each printed 0N/A * document in a job are to be in sequence, when multiple copies of the document 0N/A * are specified by the {@link Copies Copies} attribute. When SheetCollate is 0N/A * COLLATED, each copy of each document is printed with the print-stream sheets 0N/A * in sequence. When SheetCollate is UNCOLLATED, each print-stream sheet is 0N/A * printed a number of times equal to the value of the {@link Copies Copies} 0N/A * attribute in succession. For example, suppose a document produces two media 0N/A * sheets as output, {@link Copies Copies} is 6, and SheetCollate is UNCOLLATED; 0N/A * in this case six copies of the first media sheet are printed followed by 0N/A * six copies of the second media sheet. 0N/A * Whether the effect of sheet collation is achieved by placing copies of a 0N/A * document in multiple output bins or in the same output bin with 0N/A * implementation defined document separation is implementation dependent. 0N/A * Also whether it is achieved by making multiple passes over the job or by 0N/A * using an output sorter is implementation dependent. 0N/A * If a printer does not support the SheetCollate attribute (meaning the client 0N/A * cannot specify any particular sheet collation), the printer must behave as 0N/A * though SheetCollate were always set to COLLATED. 0N/A * The SheetCollate attribute interacts with the {@link MultipleDocumentHandling 0N/A * MultipleDocumentHandling} attribute. The {@link MultipleDocumentHandling 0N/A * MultipleDocumentHandling} attribute describes the collation of entire 0N/A * documents, and the SheetCollate attribute describes the semantics of 0N/A * collating individual pages within a document. 0N/A * The effect of a SheetCollate attribute on a multidoc print job (a job with 0N/A * multiple documents) depends on whether all the docs have the same sheet 0N/A * collation specified or whether different docs have different sheet 0N/A * collations specified, and on the (perhaps defaulted) value of the {@link 0N/A * MultipleDocumentHandling MultipleDocumentHandling} attribute. 0N/A * If all the docs have the same sheet collation specified, then the following 0N/A * combinations of SheetCollate and {@link MultipleDocumentHandling 0N/A * MultipleDocumentHandling} are permitted, and the printer reports an error 0N/A * when the job is submitted if any other combination is specified: 0N/A * SheetCollate = COLLATED, {@link MultipleDocumentHandling 0N/A * MultipleDocumentHandling} = SINGLE_DOCUMENT -- All the input docs will be 0N/A * combined into one output document. Multiple copies of the output document 0N/A * will be produced with pages in collated order, i.e. pages 1, 2, 3, . . ., 0N/A * SheetCollate = COLLATED, {@link MultipleDocumentHandling 0N/A * MultipleDocumentHandling} = SINGLE_DOCUMENT_NEW_SHEET -- All the input docs 0N/A * will be combined into one output document, and the first impression of each 0N/A * input doc will always start on a new media sheet. Multiple copies of the 0N/A * output document will be produced with pages in collated order, i.e. pages 0N/A * 1, 2, 3, . . ., 1, 2, 3, . . . 0N/A * SheetCollate = COLLATED, {@link MultipleDocumentHandling 0N/A * MultipleDocumentHandling} = SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each 0N/A * input doc will remain a separate output document. Multiple copies of each 0N/A * output document (call them A, B, . . .) will be produced with each document's 0N/A * pages in collated order, but the documents themselves in uncollated order, 0N/A * i.e. pages A1, A2, A3, . . ., A1, A2, A3, . . ., B1, B2, B3, . . ., B1, B2, 0N/A * SheetCollate = COLLATED, {@link MultipleDocumentHandling 0N/A * MultipleDocumentHandling} = SEPARATE_DOCUMENTS_COLLATED_COPIES -- Each input 0N/A * doc will remain a separate output document. Multiple copies of each output 0N/A * document (call them A, B, . . .) will be produced with each document's pages 0N/A * in collated order, with the documents themselves also in collated order, i.e. 0N/A * pages A1, A2, A3, . . ., B1, B2, B3, . . ., A1, A2, A3, . . ., B1, B2, B3, 0N/A * SheetCollate = UNCOLLATED, {@link MultipleDocumentHandling 0N/A * MultipleDocumentHandling} = SINGLE_DOCUMENT -- All the input docs will be 0N/A * combined into one output document. Multiple copies of the output document 0N/A * will be produced with pages in uncollated order, i.e. pages 1, 1, . . ., 0N/A * 2, 2, . . ., 3, 3, . . . 0N/A * SheetCollate = UNCOLLATED, {@link MultipleDocumentHandling 0N/A * MultipleDocumentHandling} = SINGLE_DOCUMENT_NEW_SHEET -- All the input docs 0N/A * will be combined into one output document, and the first impression of each 0N/A * input doc will always start on a new media sheet. Multiple copies of the 0N/A * output document will be produced with pages in uncollated order, i.e. pages 0N/A * 1, 1, . . ., 2, 2, . . ., 3, 3, . . . 0N/A * SheetCollate = UNCOLLATED, {@link MultipleDocumentHandling 0N/A * MultipleDocumentHandling} = SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each 0N/A * input doc will remain a separate output document. Multiple copies of each 0N/A * output document (call them A, B, . . .) will be produced with each document's 0N/A * pages in uncollated order, with the documents themselves also in uncollated 0N/A * order, i.e. pages A1, A1, . . ., A2, A2, . . ., A3, A3, . . ., B1, B1, . . ., 0N/A * B2, B2, . . ., B3, B3, . . . 0N/A * If different docs have different sheet collations specified, then only one 0N/A * value of {@link MultipleDocumentHandling MultipleDocumentHandling} is 0N/A * permitted, and the printer reports an error when the job is submitted if any 0N/A * other value is specified: 0N/A * {@link MultipleDocumentHandling MultipleDocumentHandling} = 0N/A * SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each input doc will remain a separate 0N/A * output document. Multiple copies of each output document (call them A, B, 0N/A * . . .) will be produced with each document's pages in collated or uncollated 0N/A * order as the corresponding input doc's SheetCollate attribute specifies, and 0N/A * with the documents themselves in uncollated order. If document A had 0N/A * SheetCollate = UNCOLLATED and document B had SheetCollate = COLLATED, the 0N/A * following pages would be produced: A1, A1, . . ., A2, A2, . . ., A3, A3, 0N/A * . . ., B1, B2, B3, . . ., B1, B2, B3, . . . 0N/A * <B>IPP Compatibility:</B> SheetCollate is not an IPP attribute at present. 0N/A * @see MultipleDocumentHandling 0N/A * @author Alan Kaminsky 0N/A * Sheets within a document appear in uncollated order when multiple 0N/A * copies are printed. 0N/A * Sheets within a document appear in collated order when multiple copies 0N/A * Construct a new sheet collate enumeration value with the given integer 0N/A * @param value Integer value. 0N/A * Returns the string table for class SheetCollate. 0N/A * Returns the enumeration value table for class SheetCollate. 0N/A * Get the printing attribute class which is to be used as the "category" 0N/A * for this printing attribute value. 0N/A * For class SheetCollate, the category is class SheetCollate itself. 0N/A * @return Printing attribute class (category), an instance of class 0N/A * {@link java.lang.Class java.lang.Class}. 0N/A * Get the name of the category of which this attribute value is an 0N/A * For class SheetCollate, the category name is <CODE>"sheet-collate"</CODE>. 0N/A * @return Attribute category name. 0N/A return "sheet-collate";