Finishings JDK 1.6)

Description

public class Finishings

Class 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:

NONE STAPLE EDGE_STITCH

BIND SADDLE_STITCH COVER

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.

If all the docs have the same binding specified, then any value of 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.
If different docs have different bindings specified, then only two values of 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.

See also:

Methods

Hide/Show inherited methods

public Object clone () [Inherited From EnumSyntax]

Returns a clone of this enumeration value, which to preserve the semantics of enumeration values is the same object as this enumeration value.

publicfinal Class<Attribute> getCategory ()

Get the printing attribute class which is to be used as the "category" for this printing attribute value.

protected EnumSyntax getEnumValueTable () [Overrides EnumSyntax]

Returns the enumeration value table for class Finishings.

publicfinal String getName ()

Get the name of the category of which this attribute value is an instance.

protected int getOffset () [Overrides EnumSyntax]

Returns the lowest integer value used by class Finishings.

protected String getStringTable () [Overrides EnumSyntax]

Returns the string table for class Finishings.

public int getValue () [Inherited From EnumSyntax]

Returns this enumeration value's integer value.

public int hashCode () [Inherited From EnumSyntax]

Returns a hash code value for this enumeration value.

protected Object readResolve () throws ObjectStreamException [Inherited From EnumSyntax]

During object input, convert this deserialized enumeration instance to the proper enumeration value defined in the enumeration attribute class.

During object input, convert this deserialized enumeration instance to
the proper enumeration value defined in the enumeration attribute class.
Returns: The enumeration singleton value stored at index i-L in the enumeration value table returned by {@link #getEnumValueTable() getEnumValueTable()}, where i is this enumeration value's integer value and L is the value returned by {@link #getOffset() getOffset()}.
Throws:
- ObjectStreamException - if the stream can't be deserialised
- InvalidObjectException - Thrown if the enumeration value table is null, this enumeration value's integer value does not correspond to an element in the enumeration value table, or the corresponding element in the enumeration value table is null. (Note: {@link java.io.InvalidObjectException InvalidObjectException} is a subclass of {@link java.io.ObjectStreamException ObjectStreamException}, which readResolve() is declared to throw.)

public String toString () [Inherited From EnumSyntax]

Returns a string value corresponding to this enumeration value.

Fields

Hide/Show inherited fields

publicfinalstatic 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.

publicfinalstatic Finishings COVER

This value is specified when it is desired to select a non-printed (or pre-printed) cover for the document.

publicfinalstatic Finishings EDGE_STITCH

Bind the document(s) with one or more staples (wire stitches) along one edge.

publicfinalstatic Finishings EDGE_STITCH_BOTTOM

Bind the document(s) with one or more staples (wire stitches) along the bottom edge.

publicfinalstatic Finishings EDGE_STITCH_LEFT

Bind the document(s) with one or more staples (wire stitches) along the left edge.

publicfinalstatic Finishings EDGE_STITCH_RIGHT

Bind the document(s) with one or more staples (wire stitches) along the right edge.

publicfinalstatic Finishings EDGE_STITCH_TOP

Bind the document(s) with one or more staples (wire stitches) along the top edge.

publicfinalstatic Finishings NONE

Perform no binding.

publicfinalstatic Finishings SADDLE_STITCH

Bind the document(s) with one or more staples (wire stitches) along the middle fold.

publicfinalstatic Finishings STAPLE

Bind the document(s) with one or more staples.

publicfinalstatic Finishings STAPLE_BOTTOM_LEFT

Bind the document(s) with one or more staples in the bottom left corner.

publicfinalstatic Finishings STAPLE_BOTTOM_RIGHT

Bind the document(s) with one or more staples in the bottom right corner.

publicfinalstatic Finishings STAPLE_DUAL_BOTTOM

Bind the document(s) with two staples (wire stitches) along the bottom edge assuming a portrait document (see above).

publicfinalstatic Finishings STAPLE_DUAL_LEFT

Bind the document(s) with two staples (wire stitches) along the left edge assuming a portrait document (see above).

publicfinalstatic Finishings STAPLE_DUAL_RIGHT

Bind the document(s) with two staples (wire stitches) along the right edge assuming a portrait document (see above).

publicfinalstatic Finishings STAPLE_DUAL_TOP

Bind the document(s) with two staples (wire stitches) along the top edge assuming a portrait document (see above).

publicfinalstatic Finishings STAPLE_TOP_LEFT

Bind the document(s) with one or more staples in the top left corner.

publicfinalstatic Finishings STAPLE_TOP_RIGHT

Bind the document(s) with one or more staples in the top right corner.

`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`