javax.print.attribute.standard

Class Finishings

public class Finishings extends EnumSyntax implements DocAttribute, PrintJobAttribute, PrintRequestAttribute

The Finishings attribute specifies the finishing operations that the Printer applies to every copy of each printed document in the Job.

Standard enum values are: NONE, STAPLE, COVER, BIND, SADDLE_STITCH, EDGE_STITCH.

The following values are more specific: STAPLE_TOP_LEFT, STAPLE_BOTTOM_LEFT, STAPLE_TOP_RIGHT, STAPLE_BOTTOM_RIGHT, EDGE_STITCH_LEFT, EDGE_STITCH_TOP, EDGE_STITCH_RIGHT, EDGE_STITCH_BOTTOM, STAPLE_DUAL_LEFT, STAPLE_DUAL_TOP, STAPLE_DUAL_RIGHT, STAPLE_DUAL_BOTTOM.

Note: The effect of this attribute on jobs with multiple documents is controlled by the job attribute {@link javax.print.attribute.standard.MultipleDocumentHandling}.

IPP Compatibility: Finishings is an IPP 1.1 attribute. Differences to the IPP specification are that in the Java Print Service API only one enum value is supported (in IPP a set of enums). Further the enum punch is not supported.

Field Summary
static FinishingsBIND
Selects that a binding is to be applied to the document.
static FinishingsCOVER
Selects the use of a non-printed (or pre-printed) cover for the document.
static FinishingsEDGE_STITCH
Selects binding of the documents with one or more staples along one edge.
static FinishingsEDGE_STITCH_BOTTOM
Selects binding of the documents with one or more staples along the bottom edge.
static FinishingsEDGE_STITCH_LEFT
Selects binding of the documents with one or more staples along the left edge.
static FinishingsEDGE_STITCH_RIGHT
Selects binding of the documents with one or more staples along the right edge.
static FinishingsEDGE_STITCH_TOP
Selects binding of the documents with one or more staples along the top edge.
static FinishingsNONE
Perform no finishings of the documents.
static FinishingsSADDLE_STITCH
Selects binding of the documents with one or more staples along the middle fold.
static FinishingsSTAPLE
Selects binding of the documents with one or more staples.
static FinishingsSTAPLE_BOTTOM_LEFT
Selects binding of the documents with one or more staples in the bottom left corner.
static FinishingsSTAPLE_BOTTOM_RIGHT
Selects binding of the documents with one or more staples in the bottom right corner.
static FinishingsSTAPLE_DUAL_BOTTOM
Selects binding of the documents with two staples along the bottom edge assuming a portrait document.
static FinishingsSTAPLE_DUAL_LEFT
Selects binding of the documents with two staples along the left edge assuming a portrait document.
static FinishingsSTAPLE_DUAL_RIGHT
Selects binding of the documents with two staples along the right edge assuming a portrait document.
static FinishingsSTAPLE_DUAL_TOP
Selects binding of the documents with two staples along the top edge assuming a portrait document.
static FinishingsSTAPLE_TOP_LEFT
Selects binding of the documents with one or more staples in the top left corner.
static FinishingsSTAPLE_TOP_RIGHT
Selects binding of the documents with one or more staples in the top right corner.
Constructor Summary
protected Finishings(int value)
Constructs a Finishings object.
Method Summary
Class<? extends Attribute>getCategory()
Returns category of this class.
protected EnumSyntax[]getEnumValueTable()
Returns a table with the enumeration values for this object.
StringgetName()
Returns the name of this attribute.
protected intgetOffset()
Returns the lowest used value by the enumerations of this class.
protected String[]getStringTable()
Returns a table with the enumeration values represented as strings for this object.

Field Detail

BIND

public static final Finishings BIND
Selects that a binding is to be applied to the document. The type and placement of the binding is site-defined.

COVER

public static final Finishings COVER
Selects the use of a non-printed (or pre-printed) cover for the document.

EDGE_STITCH

public static final Finishings EDGE_STITCH
Selects binding of the documents with one or more staples along one edge.

EDGE_STITCH_BOTTOM

public static final Finishings EDGE_STITCH_BOTTOM
Selects binding of the documents with one or more staples along the bottom edge.

EDGE_STITCH_LEFT

public static final Finishings EDGE_STITCH_LEFT
Selects binding of the documents with one or more staples along the left edge.

EDGE_STITCH_RIGHT

public static final Finishings EDGE_STITCH_RIGHT
Selects binding of the documents with one or more staples along the right edge.

EDGE_STITCH_TOP

public static final Finishings EDGE_STITCH_TOP
Selects binding of the documents with one or more staples along the top edge.

NONE

public static final Finishings NONE
Perform no finishings of the documents.

SADDLE_STITCH

public static final Finishings SADDLE_STITCH
Selects binding of the documents with one or more staples along the middle fold.

STAPLE

public static final Finishings STAPLE
Selects binding of the documents with one or more staples.

STAPLE_BOTTOM_LEFT

public static final Finishings STAPLE_BOTTOM_LEFT
Selects binding of the documents with one or more staples in the bottom left corner.

STAPLE_BOTTOM_RIGHT

public static final Finishings STAPLE_BOTTOM_RIGHT
Selects binding of the documents with one or more staples in the bottom right corner.

STAPLE_DUAL_BOTTOM

public static final Finishings STAPLE_DUAL_BOTTOM
Selects binding of the documents with two staples along the bottom edge assuming a portrait document.

STAPLE_DUAL_LEFT

public static final Finishings STAPLE_DUAL_LEFT
Selects binding of the documents with two staples along the left edge assuming a portrait document.

STAPLE_DUAL_RIGHT

public static final Finishings STAPLE_DUAL_RIGHT
Selects binding of the documents with two staples along the right edge assuming a portrait document.

STAPLE_DUAL_TOP

public static final Finishings STAPLE_DUAL_TOP
Selects binding of the documents with two staples along the top edge assuming a portrait document.

STAPLE_TOP_LEFT

public static final Finishings STAPLE_TOP_LEFT
Selects binding of the documents with one or more staples in the top left corner.

STAPLE_TOP_RIGHT

public static final Finishings STAPLE_TOP_RIGHT
Selects binding of the documents with one or more staples in the top right corner.

Constructor Detail

Finishings

protected Finishings(int value)
Constructs a Finishings object.

Parameters: value the value

Method Detail

getCategory

public Class<? extends Attribute> getCategory()
Returns category of this class.

Returns: the class Finishings itself

getEnumValueTable

protected EnumSyntax[] getEnumValueTable()
Returns a table with the enumeration values for this object.

Returns: The enumeration values.

getName

public final String getName()
Returns the name of this attribute.

Returns: The name "finishings".

getOffset

protected int getOffset()
Returns the lowest used value by the enumerations of this class. .

Returns: The lowest value used.

getStringTable

protected String[] getStringTable()
Returns a table with the enumeration values represented as strings for this object.

Returns: The enumeration values as strings.