src/share/classes/javax/print/attribute/standard/SheetCollate.java

Print this page


   1 /*
   2  * Copyright (c) 2000, 2004, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  60  * collating individual pages within a document.
  61  * <P>
  62  * The effect of a SheetCollate attribute on a multidoc print job (a job with
  63  * multiple documents) depends on whether all the docs have the same sheet
  64  * collation specified or whether different docs have different sheet
  65  * collations specified, and on the (perhaps defaulted) value of the {@link
  66  * MultipleDocumentHandling MultipleDocumentHandling} attribute.
  67  * <UL>
  68  * <LI>
  69  * If all the docs have the same sheet collation specified, then the following
  70  * combinations of SheetCollate and {@link MultipleDocumentHandling
  71  * MultipleDocumentHandling} are permitted, and the printer reports an error
  72  * when the job is submitted if any other combination is specified:
  73  * <UL>
  74  * <LI>
  75  * SheetCollate = COLLATED, {@link MultipleDocumentHandling
  76  * MultipleDocumentHandling} = SINGLE_DOCUMENT -- All the input docs will be
  77  * combined into one output document. Multiple copies of the output document
  78  * will be produced with pages in collated order, i.e. pages 1, 2, 3, . . .,
  79  * 1, 2, 3, . . .
  80  * <P>
  81  * <LI>
  82  * SheetCollate = COLLATED, {@link MultipleDocumentHandling
  83  * MultipleDocumentHandling} = SINGLE_DOCUMENT_NEW_SHEET -- All the input docs
  84  * will be combined into one output document, and the first impression of each
  85  * input doc will always start on a new media sheet. Multiple copies of the
  86  * output document will be produced with pages in collated order, i.e. pages
  87  * 1, 2, 3, . . ., 1, 2, 3, . . .
  88  * <P>
  89  * <LI>
  90  * SheetCollate = COLLATED, {@link MultipleDocumentHandling
  91  * MultipleDocumentHandling} = SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each
  92  * input doc will remain a separate output document. Multiple copies of each
  93  * output document (call them A, B, . . .) will be produced with each document's
  94  * pages in collated order, but the documents themselves in uncollated order,
  95  * i.e. pages A1, A2, A3, . . ., A1, A2, A3, . . ., B1, B2, B3, . . ., B1, B2,
  96  * B3, . . .
  97  * <P>
  98  * <LI>
  99  * SheetCollate = COLLATED, {@link MultipleDocumentHandling
 100  * MultipleDocumentHandling} = SEPARATE_DOCUMENTS_COLLATED_COPIES -- Each input
 101  * doc will remain a separate output document. Multiple copies of each output
 102  * document (call them A, B, . . .) will be produced with each document's pages
 103  * in collated order, with the documents themselves also in collated order, i.e.
 104  * pages A1, A2, A3, . . ., B1, B2, B3, . . ., A1, A2, A3, . . ., B1, B2, B3,
 105  * . . .
 106  * <P>
 107  * <LI>
 108  * SheetCollate = UNCOLLATED, {@link MultipleDocumentHandling
 109  * MultipleDocumentHandling} = SINGLE_DOCUMENT -- All the input docs will be
 110  * combined into one output document. Multiple copies of the output document
 111  * will be produced with pages in uncollated order, i.e. pages 1, 1, . . .,
 112  * 2, 2, . . ., 3, 3, . . .
 113  * <P>
 114  * <LI>
 115  * SheetCollate = UNCOLLATED, {@link MultipleDocumentHandling
 116  * MultipleDocumentHandling} = SINGLE_DOCUMENT_NEW_SHEET -- All the input docs
 117  * will be combined into one output document, and the first impression of each
 118  * input doc will always start on a new media sheet. Multiple copies of the
 119  * output document will be produced with pages in uncollated order, i.e. pages
 120  * 1, 1, . . ., 2, 2, . . ., 3, 3, . . .
 121  * <P>
 122  * <LI>
 123  * SheetCollate = UNCOLLATED, {@link MultipleDocumentHandling
 124  * MultipleDocumentHandling} = SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each
 125  * input doc will remain a separate output document. Multiple copies of each
 126  * output document (call them A, B, . . .) will be produced with each document's
 127  * pages in uncollated order, with the documents themselves also in uncollated
 128  * order, i.e. pages A1, A1, . . ., A2, A2, . . ., A3, A3, . . ., B1, B1, . . .,
 129  * B2, B2, . . ., B3, B3, . . .
 130  * </UL>
 131  * <P>
 132  * <LI>
 133  * If different docs have different sheet collations specified, then only one
 134  * value of {@link MultipleDocumentHandling MultipleDocumentHandling} is
 135  * permitted, and the printer reports an error when the job is submitted if any
 136  * other value is specified:
 137  * <UL>
 138  * <LI>
 139  * {@link MultipleDocumentHandling MultipleDocumentHandling} =
 140  * SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each input doc will remain a separate
 141  * output document. Multiple copies of each output document (call them A, B,
 142  * . . .) will be produced with each document's pages in collated or uncollated
 143  * order as the corresponding input doc's SheetCollate attribute specifies, and
 144  * with the documents themselves in uncollated order. If document A had
 145  * SheetCollate = UNCOLLATED and document B had SheetCollate = COLLATED, the
 146  * following pages would be produced: A1, A1, . . ., A2, A2, . . ., A3, A3,
 147  * . . ., B1, B2, B3, . . ., B1, B2, B3, . . .
 148  * </UL>
 149  * </UL>
 150  * <P>
 151  * <B>IPP Compatibility:</B> SheetCollate is not an IPP attribute at present.


   1 /*
   2  * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  60  * collating individual pages within a document.
  61  * <P>
  62  * The effect of a SheetCollate attribute on a multidoc print job (a job with
  63  * multiple documents) depends on whether all the docs have the same sheet
  64  * collation specified or whether different docs have different sheet
  65  * collations specified, and on the (perhaps defaulted) value of the {@link
  66  * MultipleDocumentHandling MultipleDocumentHandling} attribute.
  67  * <UL>
  68  * <LI>
  69  * If all the docs have the same sheet collation specified, then the following
  70  * combinations of SheetCollate and {@link MultipleDocumentHandling
  71  * MultipleDocumentHandling} are permitted, and the printer reports an error
  72  * when the job is submitted if any other combination is specified:
  73  * <UL>
  74  * <LI>
  75  * SheetCollate = COLLATED, {@link MultipleDocumentHandling
  76  * MultipleDocumentHandling} = SINGLE_DOCUMENT -- All the input docs will be
  77  * combined into one output document. Multiple copies of the output document
  78  * will be produced with pages in collated order, i.e. pages 1, 2, 3, . . .,
  79  * 1, 2, 3, . . .
  80  *
  81  * <LI>
  82  * SheetCollate = COLLATED, {@link MultipleDocumentHandling
  83  * MultipleDocumentHandling} = SINGLE_DOCUMENT_NEW_SHEET -- All the input docs
  84  * will be combined into one output document, and the first impression of each
  85  * input doc will always start on a new media sheet. Multiple copies of the
  86  * output document will be produced with pages in collated order, i.e. pages
  87  * 1, 2, 3, . . ., 1, 2, 3, . . .
  88  *
  89  * <LI>
  90  * SheetCollate = COLLATED, {@link MultipleDocumentHandling
  91  * MultipleDocumentHandling} = SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each
  92  * input doc will remain a separate output document. Multiple copies of each
  93  * output document (call them A, B, . . .) will be produced with each document's
  94  * pages in collated order, but the documents themselves in uncollated order,
  95  * i.e. pages A1, A2, A3, . . ., A1, A2, A3, . . ., B1, B2, B3, . . ., B1, B2,
  96  * B3, . . .
  97  *
  98  * <LI>
  99  * SheetCollate = COLLATED, {@link MultipleDocumentHandling
 100  * MultipleDocumentHandling} = SEPARATE_DOCUMENTS_COLLATED_COPIES -- Each input
 101  * doc will remain a separate output document. Multiple copies of each output
 102  * document (call them A, B, . . .) will be produced with each document's pages
 103  * in collated order, with the documents themselves also in collated order, i.e.
 104  * pages A1, A2, A3, . . ., B1, B2, B3, . . ., A1, A2, A3, . . ., B1, B2, B3,
 105  * . . .
 106  *
 107  * <LI>
 108  * SheetCollate = UNCOLLATED, {@link MultipleDocumentHandling
 109  * MultipleDocumentHandling} = SINGLE_DOCUMENT -- All the input docs will be
 110  * combined into one output document. Multiple copies of the output document
 111  * will be produced with pages in uncollated order, i.e. pages 1, 1, . . .,
 112  * 2, 2, . . ., 3, 3, . . .
 113  *
 114  * <LI>
 115  * SheetCollate = UNCOLLATED, {@link MultipleDocumentHandling
 116  * MultipleDocumentHandling} = SINGLE_DOCUMENT_NEW_SHEET -- All the input docs
 117  * will be combined into one output document, and the first impression of each
 118  * input doc will always start on a new media sheet. Multiple copies of the
 119  * output document will be produced with pages in uncollated order, i.e. pages
 120  * 1, 1, . . ., 2, 2, . . ., 3, 3, . . .
 121  *
 122  * <LI>
 123  * SheetCollate = UNCOLLATED, {@link MultipleDocumentHandling
 124  * MultipleDocumentHandling} = SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each
 125  * input doc will remain a separate output document. Multiple copies of each
 126  * output document (call them A, B, . . .) will be produced with each document's
 127  * pages in uncollated order, with the documents themselves also in uncollated
 128  * order, i.e. pages A1, A1, . . ., A2, A2, . . ., A3, A3, . . ., B1, B1, . . .,
 129  * B2, B2, . . ., B3, B3, . . .
 130  * </UL>
 131  *
 132  * <LI>
 133  * If different docs have different sheet collations specified, then only one
 134  * value of {@link MultipleDocumentHandling MultipleDocumentHandling} is
 135  * permitted, and the printer reports an error when the job is submitted if any
 136  * other value is specified:
 137  * <UL>
 138  * <LI>
 139  * {@link MultipleDocumentHandling MultipleDocumentHandling} =
 140  * SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each input doc will remain a separate
 141  * output document. Multiple copies of each output document (call them A, B,
 142  * . . .) will be produced with each document's pages in collated or uncollated
 143  * order as the corresponding input doc's SheetCollate attribute specifies, and
 144  * with the documents themselves in uncollated order. If document A had
 145  * SheetCollate = UNCOLLATED and document B had SheetCollate = COLLATED, the
 146  * following pages would be produced: A1, A1, . . ., A2, A2, . . ., A3, A3,
 147  * . . ., B1, B2, B3, . . ., B1, B2, B3, . . .
 148  * </UL>
 149  * </UL>
 150  * <P>
 151  * <B>IPP Compatibility:</B> SheetCollate is not an IPP attribute at present.