Finishings is a printing attribute class, an enumeration, that
identifies whether the printer applies a finishing operation of some kind of
binding to each copy of each printed document in the job. For multidoc print
jobs (jobs with multiple documents), the
MultipleDocumentHandling attribute
determines what constitutes a "copy" for purposes of finishing.
Standard Finishings values are:
The following Finishings values are more specific; they indicate a
corner or an edge as if the document were a portrait document:
STAPLE_TOP_LEFT
EDGE_STITCH_LEFT
STAPLE_DUAL_LEFT
STAPLE_BOTTOM_LEFT
EDGE_STITCH_TOP
STAPLE_DUAL_TOP
STAPLE_TOP_RIGHT
EDGE_STITCH_RIGHT
STAPLE_DUAL_RIGHT
STAPLE_BOTTOM_RIGHT
EDGE_STITCH_BOTTOM
STAPLE_DUAL_BOTTOM
The STAPLE_XXX values are specified with respect to the document as if
the document were a portrait document. If the document is actually a
landscape or a reverse-landscape document, the client supplies the
appropriate transformed value. For example, to position a staple in the upper
left hand corner of a landscape document when held for reading, the client
supplies the STAPLE_BOTTOM_LEFT value (since landscape is defined as
a +90 degree rotation from portrait, i.e., anti-clockwise). On the other
hand, to position a staple in the upper left hand corner of a
reverse-landscape document when held for reading, the client supplies the
STAPLE_TOP_RIGHT value (since reverse-landscape is defined as a -90
degree rotation from portrait, i.e., clockwise).
The angle (vertical, horizontal, angled) of each staple with respect to the document depends on the implementation which may in turn depend on the value of the attribute.
The effect of a Finishings attribute on a multidoc print job (a job
with multiple documents) depends on whether all the docs have the same
binding specified or whether different docs have different bindings
specified, and on the (perhaps defaulted) value of the
MultipleDocumentHandling attribute.
MultipleDocumentHandling makes sense, and
the printer's processing depends on the
MultipleDocumentHandling value:
SINGLE_DOCUMENT -- All the input docs will be bound together
as one output document with the specified binding.
SINGLE_DOCUMENT_NEW_SHEET -- All the input docs will be bound
together as one output document with the specified binding, and the first
impression of each input doc will always start on a new media sheet.
SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each input doc will
be bound separately with the specified binding.
SEPARATE_DOCUMENTS_COLLATED_COPIES -- Each input doc will be
bound separately with the specified binding.
MultipleDocumentHandling make
sense, and the printer reports an error when the job is submitted if any
other value is specified:
SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each input doc will
be bound separately with its own specified binding.
SEPARATE_DOCUMENTS_COLLATED_COPIES -- Each input doc will be
bound separately with its own specified binding.
IPP Compatibility: Class Finishings encapsulates some of the IPP enum
values that can be included in an IPP "finishings" attribute, which is a set
of enums. The category name returned by getName() is the IPP
attribute name. The enumeration's integer value is the IPP enum value. The
toString() method returns the IPP string representation of the
attribute value. In IPP Finishings is a multi-value attribute, this API
currently allows only one binding to be specified.
| Modifier and Type | Field and Description |
|---|---|
| public static final Finishings | BIND
This value indicates that a binding is to be applied to the document; the type and placement of the binding is site-defined. |
| public static final Finishings | COVER
This value is specified when it is desired to select a non-printed (or pre-printed) cover for the document. |
| public static final Finishings | EDGE_STITCH
Bind the document(s) with one or more staples (wire stitches) along one edge. |
| public static final Finishings | EDGE_STITCH_BOTTOM
Bind the document(s) with one or more staples (wire stitches) along the bottom edge. |
| public static final Finishings | EDGE_STITCH_LEFT
Bind the document(s) with one or more staples (wire stitches) along the left edge. |
| public static final Finishings | EDGE_STITCH_RIGHT
Bind the document(s) with one or more staples (wire stitches) along the right edge. |
| public static final Finishings | EDGE_STITCH_TOP
Bind the document(s) with one or more staples (wire stitches) along the top edge. |
| private static final Finishings[] | myEnumValueTable
The enumeration value table for class |
| private static final String[] | myStringTable
The string table for class |
| public static final Finishings | NONE
Perform no binding. |
| public static final Finishings | SADDLE_STITCH
Bind the document(s) with one or more staples (wire stitches) along the middle fold. |
| private static final long | serialVersionUID
Use serialVersionUID from JDK 1.4 for interoperability.
|
| public static final Finishings | STAPLE
Bind the document(s) with one or more staples. |
| public static final Finishings | STAPLE_BOTTOM_LEFT
Bind the document(s) with one or more staples in the bottom left corner. |
| public static final Finishings | STAPLE_BOTTOM_RIGHT
Bind the document(s) with one or more staples in the bottom right corner. |
| public static final Finishings | STAPLE_DUAL_BOTTOM
Bind the document(s) with two staples (wire stitches) along the bottom edge assuming a portrait document (see above). |
| public static final Finishings | STAPLE_DUAL_LEFT
Bind the document(s) with two staples (wire stitches) along the left edge assuming a portrait document (see above). |
| public static final Finishings | STAPLE_DUAL_RIGHT
Bind the document(s) with two staples (wire stitches) along the right edge assuming a portrait document (see above). |
| public static final Finishings | STAPLE_DUAL_TOP
Bind the document(s) with two staples (wire stitches) along the top edge assuming a portrait document (see above). |
| public static final Finishings | STAPLE_TOP_LEFT
Bind the document(s) with one or more staples in the top left corner. |
| public static final Finishings | STAPLE_TOP_RIGHT
Bind the document(s) with one or more staples in the top right corner. |
| Access | Constructor and Description |
|---|---|
| protected | Finishings(int
Integer value value)Construct a new finishings binding enumeration value with the given integer value. |
| Modifier and Type | Method and Description |
|---|---|
| public final Class | Returns: printing attribute class (category), an instance of classjava.Implements javax. Get the printing attribute class which is to be used as the "category" for this printing attribute value. |
| protected EnumSyntax[] | getEnumValueTable()
Overrides javax. Returns the enumeration value table for class |
| public final String | Returns: attribute category nameImplements javax. Get the name of the category of which this attribute value is an instance. |
| protected int | getOffset()
Overrides javax. Returns the lowest integer value used by class |
| protected String[] | getStringTable()
Overrides javax. Returns the string table for class |
| BIND | back to summary |
|---|---|
| public static final Finishings BIND This value indicates that a binding is to be applied to the document; the type and placement of the binding is site-defined. | |
| COVER | back to summary |
|---|---|
| public static final Finishings COVER This value is specified when it is desired to select a non-printed (or pre-printed) cover for the document. This does not supplant the specification of a printed cover (on cover stock medium) by the document itself. | |
| EDGE_STITCH | back to summary |
|---|---|
| public static final Finishings EDGE_STITCH Bind the document(s) with one or more staples (wire stitches) along one edge. The exact number and placement of the staples is implementation- and/or site- defined. | |
| EDGE_STITCH_BOTTOM | back to summary |
|---|---|
| public static final Finishings EDGE_STITCH_BOTTOM Bind the document(s) with one or more staples (wire stitches) along the bottom edge. The exact number and placement of the staples is implementation- and/or site-defined. | |
| EDGE_STITCH_LEFT | back to summary |
|---|---|
| public static final Finishings EDGE_STITCH_LEFT Bind the document(s) with one or more staples (wire stitches) along the left edge. The exact number and placement of the staples is implementation- and/or site-defined. | |
| EDGE_STITCH_RIGHT | back to summary |
|---|---|
| public static final Finishings EDGE_STITCH_RIGHT Bind the document(s) with one or more staples (wire stitches) along the right edge. The exact number and placement of the staples is implementation- and/or site-defined. | |
| EDGE_STITCH_TOP | back to summary |
|---|---|
| public static final Finishings EDGE_STITCH_TOP Bind the document(s) with one or more staples (wire stitches) along the top edge. The exact number and placement of the staples is implementation- and/or site-defined. | |
| myEnumValueTable | back to summary |
|---|---|
| private static final Finishings[] myEnumValueTable The enumeration value table for class | |
| myStringTable | back to summary |
|---|---|
| private static final String[] myStringTable The string table for class | |
| NONE | back to summary |
|---|---|
| public static final Finishings NONE Perform no binding. | |
| SADDLE_STITCH | back to summary |
|---|---|
| public static final Finishings SADDLE_STITCH Bind the document(s) with one or more staples (wire stitches) along the middle fold. The exact number and placement of the staples and the middle fold is implementation- and/or site-defined. | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID Hides javax. Use serialVersionUID from JDK 1.4 for interoperability. | |
| STAPLE | back to summary |
|---|---|
| public static final Finishings STAPLE Bind the document(s) with one or more staples. The exact number and placement of the staples is site-defined. | |
| STAPLE_BOTTOM_LEFT | back to summary |
|---|---|
| public static final Finishings STAPLE_BOTTOM_LEFT Bind the document(s) with one or more staples in the bottom left corner. | |
| STAPLE_BOTTOM_RIGHT | back to summary |
|---|---|
| public static final Finishings STAPLE_BOTTOM_RIGHT Bind the document(s) with one or more staples in the bottom right corner. | |
| STAPLE_DUAL_BOTTOM | back to summary |
|---|---|
| public static final Finishings STAPLE_DUAL_BOTTOM Bind the document(s) with two staples (wire stitches) along the bottom edge assuming a portrait document (see above). | |
| STAPLE_DUAL_LEFT | back to summary |
|---|---|
| public static final Finishings STAPLE_DUAL_LEFT Bind the document(s) with two staples (wire stitches) along the left edge assuming a portrait document (see above). | |
| STAPLE_DUAL_RIGHT | back to summary |
|---|---|
| public static final Finishings STAPLE_DUAL_RIGHT Bind the document(s) with two staples (wire stitches) along the right edge assuming a portrait document (see above). | |
| STAPLE_DUAL_TOP | back to summary |
|---|---|
| public static final Finishings STAPLE_DUAL_TOP Bind the document(s) with two staples (wire stitches) along the top edge assuming a portrait document (see above). | |
| STAPLE_TOP_LEFT | back to summary |
|---|---|
| public static final Finishings STAPLE_TOP_LEFT Bind the document(s) with one or more staples in the top left corner. | |
| STAPLE_TOP_RIGHT | back to summary |
|---|---|
| public static final Finishings STAPLE_TOP_RIGHT Bind the document(s) with one or more staples in the top right corner. | |
| Finishings | back to summary |
|---|---|
| protected Finishings(int value) Construct a new finishings binding enumeration value with the given integer value.
| |
| getCategory | back to summary |
|---|---|
| public final Class Implements javax. Get the printing attribute class which is to be used as the "category" for this printing attribute value.
For class
| |
| getEnumValueTable | back to summary |
|---|---|
| protected EnumSyntax[] getEnumValueTable() Overrides javax. Returns the enumeration value table for class
| |
| getName | back to summary |
|---|---|
| public final String getName() Implements javax. Get the name of the category of which this attribute value is an instance.
For class | |
| getOffset | back to summary |
|---|---|
| protected int getOffset() Overrides javax. Returns the lowest integer value used by class
| |
| getStringTable | back to summary |
|---|---|
| protected String[] getStringTable() Overrides javax. Returns the string table for class
| |