- java.lang.Object
-
- javax.print.attribute.EnumSyntax
-
- javax.print.attribute.standard.MultipleDocumentHandling
-
- All Implemented Interfaces:
Serializable,Cloneable,Attribute,PrintJobAttribute,PrintRequestAttribute
public class MultipleDocumentHandling extends EnumSyntax implements PrintRequestAttribute, PrintJobAttribute
ClassMultipleDocumentHandlingis a printing attribute class, an enumeration, that controls finishing operations and the placement of one or more print-stream pages into impressions and onto media sheets. When the value of theCopiesattribute exceeds 1,MultipleDocumentHandlingalso controls the order in which the copies that result from processing the documents are produced. This attribute is relevant only for a multidoc print job consisting of two or more individual docs.Briefly,
MultipleDocumentHandlingdetermines the relationship between the multiple input (electronic) documents fed into a multidoc print job and the output (physical) document or documents produced by the multidoc print job. There are two possibilities:- The multiple input documents are combined into a single output
document. Finishing operations (
Finishings), are performed on this single output document. TheCopiesattribute tells how many copies of this single output document to produce. TheMultipleDocumentHandlingvaluesSINGLE_DOCUMENTandSINGLE_DOCUMENT_NEW_SHEETspecify two variations of this possibility. - The multiple input documents remain separate output documents.
Finishing operations (
Finishings), are performed on each output document separately. TheCopiesattribute tells how many copies of each separate output document to produce. TheMultipleDocumentHandlingvaluesSEPARATE_DOCUMENTS_UNCOLLATED_COPIESandSEPARATE_DOCUMENTS_COLLATED_COPIESspecify two variations of this possibility.
a" represents an instance of document data, then the result of processing the data in document "a" is a sequence of media sheets represented by "a(*)".The standard
MultipleDocumentHandlingvalues are:SINGLE_DOCUMENT. If a print job has multiple documents -- say, the document data is calledaandb-- then the result of processing all the document data (aand thenb) must be treated as a single sequence of media sheets for finishing operations; that is, finishing would be performed on the concatenation of the sequencesa(*),b(*). The printer must not force the data in each document instance to be formatted onto a new print-stream page, nor to start a new impression on a new media sheet. If more than one copy is made, the ordering of the sets of media sheets resulting from processing the document data must bea(*),b(*),a(*),b(*),..., and the printer object must force each copy (a(*),b(*)) to start on a new media sheet.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES. If a print job has multiple documents -- say, the document data is calledaandb-- then the result of processing the data in each document instance must be treated as a single sequence of media sheets for finishing operations; that is, the setsa(*)andb(*)would each be finished separately. The printer must force each copy of the result of processing the data in a single document to start on a new media sheet. If more than one copy is made, the ordering of the sets of media sheets resulting from processing the document data must bea(*),a(*),...,b(*),b(*)....SEPARATE_DOCUMENTS_COLLATED_COPIES. If a print job has multiple documents -- say, the document data is calledaandb-- then the result of processing the data in each document instance must be treated as a single sequence of media sheets for finishing operations; that is, the setsa(*)andb(*)would each be finished separately. The printer must force each copy of the result of processing the data in a single document to start on a new media sheet. If more than one copy is made, the ordering of the sets of media sheets resulting from processing the document data must bea(*),b(*),a(*),b(*),....SINGLE_DOCUMENT_NEW_SHEET. Same as SINGLE_DOCUMENT, except that the printer must ensure that the first impression of each document instance in the job is placed on a new media sheet. This value allows multiple documents to be stapled together with a single staple where each document starts on a new sheet.
SINGLE_DOCUMENTis the same asSEPARATE_DOCUMENTS_COLLATED_COPIESwith respect to ordering of print-stream pages, but not media sheet generation, sinceSINGLE_DOCUMENTwill put the first page of the next document on the back side of a sheet if an odd number of pages have been produced so far for the job, whileSEPARATE_DOCUMENTS_COLLATED_COPIESalways forces the next document or document copy on to a new sheet.In addition, if a
Finishingsattribute ofSTAPLEis specified, then:- With
SINGLE_DOCUMENT, documentsaandbare stapled together as a single document with no regard to new sheets. - With
SINGLE_DOCUMENT_NEW_SHEET, documentsaandbare stapled together as a single document, but documentbstarts on a new sheet. - With
SEPARATE_DOCUMENTS_UNCOLLATED_COPIESandSEPARATE_DOCUMENTS_COLLATED_COPIES, documentsaandbare stapled separately.
SheetCollateattribute.IPP Compatibility: The category name returned by
getName()is the IPP attribute name. The enumeration's integer value is the IPP enum value. ThetoString()method returns the IPP string representation of the attribute value.- See Also:
Copies,Finishings,NumberUp,PageRanges,SheetCollate,Sides, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static MultipleDocumentHandlingSEPARATE_DOCUMENTS_COLLATED_COPIESSeparate documents collated copies -- see above for further information.static MultipleDocumentHandlingSEPARATE_DOCUMENTS_UNCOLLATED_COPIESSeparate documents uncollated copies -- see above for further information.static MultipleDocumentHandlingSINGLE_DOCUMENTSingle document -- see above for further information.static MultipleDocumentHandlingSINGLE_DOCUMENT_NEW_SHEETSingle document new sheet -- see above for further information.
-
Constructor Summary
Constructors Modifier Constructor Description protectedMultipleDocumentHandling(int value)Construct a new multiple document handling enumeration value with the given integer value.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Class<? extends Attribute>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 classMultipleDocumentHandling.StringgetName()Get the name of the category of which this attribute value is an instance.protected String[]getStringTable()Returns the string table for classMultipleDocumentHandling.-
Methods declared in class javax.print.attribute.EnumSyntax
clone, getOffset, getValue, hashCode, readResolve, toString
-
-
-
-
Field Detail
-
SINGLE_DOCUMENT
public static final MultipleDocumentHandling SINGLE_DOCUMENT
Single document -- see above for further information.
-
SEPARATE_DOCUMENTS_UNCOLLATED_COPIES
public static final MultipleDocumentHandling SEPARATE_DOCUMENTS_UNCOLLATED_COPIES
Separate documents uncollated copies -- see above for further information.
-
SEPARATE_DOCUMENTS_COLLATED_COPIES
public static final MultipleDocumentHandling SEPARATE_DOCUMENTS_COLLATED_COPIES
Separate documents collated copies -- see above for further information.
-
SINGLE_DOCUMENT_NEW_SHEET
public static final MultipleDocumentHandling SINGLE_DOCUMENT_NEW_SHEET
Single document new sheet -- see above for further information.
-
-
Method Detail
-
getStringTable
protected String[] getStringTable()
Returns the string table for classMultipleDocumentHandling.- Overrides:
getStringTablein classEnumSyntax- Returns:
- the string table
-
getEnumValueTable
protected EnumSyntax[] getEnumValueTable()
Returns the enumeration value table for classMultipleDocumentHandling.- Overrides:
getEnumValueTablein classEnumSyntax- Returns:
- the value table
-
getCategory
public final Class<? extends Attribute> getCategory()
Get the printing attribute class which is to be used as the "category" for this printing attribute value.For class
MultipleDocumentHandlingand any vendor-defined subclasses, the category is classMultipleDocumentHandlingitself.- Specified by:
getCategoryin interfaceAttribute- 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
MultipleDocumentHandlingand any vendor-defined subclasses, the category name is"multiple-document-handling".
-
-