File Doc Category Size Date Package
Finishings.java API Doc Java SE 5 API 13639 Fri Aug 26 14:57:44 BST 2005 javax.print.attribute.standard

Finishings

java.lang.Object
- javax.print.attribute.EnumSyntax

public class Finishings extends EnumSyntax implements PrintJobAttribute, PrintRequestAttribute, DocAttribute

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 {@link MultipleDocumentHandling MultipleDocumentHandling} attribute determines what constitutes a "copy" for purposes of finishing.

Standard Finishings values are:

{@link #NONE NONE} {@link #STAPLE STAPLE} {@link #EDGE_STITCH EDGE_STITCH}

{@link #BIND BIND} {@link #SADDLE_STITCH SADDLE_STITCH} {@link #COVER COVER}

The following Finishings values are more specific; they indicate a corner or an edge as if the document were a portrait document:

{@link #STAPLE_TOP_LEFT STAPLE_TOP_LEFT} {@link #EDGE_STITCH_LEFT EDGE_STITCH_LEFT} {@link #STAPLE_DUAL_LEFT STAPLE_DUAL_LEFT}

{@link #STAPLE_BOTTOM_LEFT STAPLE_BOTTOM_LEFT} {@link #EDGE_STITCH_TOP EDGE_STITCH_TOP} {@link #STAPLE_DUAL_TOP STAPLE_DUAL_TOP}

{@link #STAPLE_TOP_RIGHT STAPLE_TOP_RIGHT} {@link #EDGE_STITCH_RIGHT EDGE_STITCH_RIGHT} {@link #STAPLE_DUAL_RIGHT STAPLE_DUAL_RIGHT}

{@link #STAPLE_BOTTOM_RIGHT STAPLE_BOTTOM_RIGHT} {@link #EDGE_STITCH_BOTTOM EDGE_STITCH_BOTTOM} {@link #STAPLE_DUAL_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 {@link MultipleDocumentHandling MultipleDocumentHandling} attribute.

If all the docs have the same binding specified, then any value of {@link MultipleDocumentHandling MultipleDocumentHandling} makes sense, and the printer's processing depends on the {@link MultipleDocumentHandling 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 {@link MultipleDocumentHandling 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.

author: Alan Kaminsky

Fields Summary
private static final long
serialVersionUID
public static final Finishings
NONE
Perform no binding.
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.
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.
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
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.
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.
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_BOTTOM_LEFT
Bind the document(s) with one or more staples in the bottom left corner.
public static final Finishings
STAPLE_TOP_RIGHT
Bind the document(s) with one or more staples in the top right 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
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.
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.
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.
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.
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_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_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_BOTTOM
Bind the document(s) with two staples (wire stitches) along the bottom edge assuming a portrait document (see above).
private static final String[]
myStringTable
private static final Finishings[]
myEnumValueTable
Constructors Summary
protected Finishings(int value)
Construct a new finishings binding enumeration value with the given integer value.
param
value Integer value.
super(value);
Methods Summary
public final java.lang.Class getCategory()
Get the printing attribute class which is to be used as the "category" for this printing attribute value.
For class Finishings and any vendor-defined subclasses, the category is class Finishings itself.
return
Printing attribute class (category), an instance of class {@link java.lang.Class java.lang.Class}.
return Finishings.class;
protected javax.print.attribute.EnumSyntax[] getEnumValueTable()
Returns the enumeration value table for class Finishings.
return (EnumSyntax[])myEnumValueTable.clone();
public final java.lang.String getName()
Get the name of the category of which this attribute value is an instance.
For class Finishings and any vendor-defined subclasses, the category name is "finishings".
return
Attribute category name.
return "finishings";
protected int getOffset()
Returns the lowest integer value used by class Finishings.
return 3;
protected java.lang.String[] getStringTable()
Returns the string table for class Finishings.
return (String[])myStringTable.clone();