APIdia Launch Partner
Top Description Fields Constructors Methods
javax.print.attribute.standard

public Class Finishings

extends EnumSyntax
implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
Class Inheritance
All Implemented Interfaces
javax.print.attribute.PrintJobAttribute, javax.print.attribute.Attribute, java.io.Serializable, javax.print.attribute.PrintRequestAttribute, javax.print.attribute.DocAttribute
Known Direct Subclasses
sun.print.IPPPrintService.ExtFinishing
Imports
java.io.Serial, javax.print.attribute.Attribute, .DocAttribute, .EnumSyntax, .PrintJobAttribute, .PrintRequestAttribute

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:

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

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.

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

Field Summary

Modifier and TypeField 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 Finishings.

private static final String[]
myStringTable

The string table for class Finishings.

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

Hides javax.print.attribute.EnumSyntax.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.

Constructor Summary

AccessConstructor and Description
protected
Finishings(int
Integer value
value
)

Construct a new finishings binding enumeration value with the given integer value.

Method Summary

Modifier and TypeMethod and Description
public final Class<? extends Attribute>

Returns:

printing attribute class (category), an instance of class java.lang.Class
getCategory
()

Implements javax.print.attribute.Attribute.getCategory.

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

protected EnumSyntax[]
getEnumValueTable()

Overrides javax.print.attribute.EnumSyntax.getEnumValueTable.

Returns the enumeration value table for class Finishings.

public final String

Returns:

attribute category name
getName
()

Implements javax.print.attribute.Attribute.getName.

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

protected int
getOffset()

Overrides javax.print.attribute.EnumSyntax.getOffset.

Returns the lowest integer value used by class Finishings.

protected String[]
getStringTable()

Overrides javax.print.attribute.EnumSyntax.getStringTable.

Returns the string table for class Finishings.

Inherited from javax.print.attribute.EnumSyntax:
clonegetValuehashCodereadResolvetoString

Field Detail

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

COVERback 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_STITCHback 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_BOTTOMback 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_LEFTback 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_RIGHTback 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_TOPback 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.

myEnumValueTableback to summary
private static final Finishings[] myEnumValueTable

The enumeration value table for class Finishings.

myStringTableback to summary
private static final String[] myStringTable

The string table for class Finishings.

NONEback to summary
public static final Finishings NONE

Perform no binding.

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

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.print.attribute.EnumSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations
@Serial
STAPLEback 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_LEFTback 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_RIGHTback 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_BOTTOMback 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_LEFTback 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_RIGHTback 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_TOPback 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_LEFTback 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_RIGHTback to summary
public static final Finishings STAPLE_TOP_RIGHT

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

Constructor Detail

Finishingsback to summary
protected Finishings(int value)

Construct a new finishings binding enumeration value with the given integer value.

Parameters
value:int

Integer value

Method Detail

getCategoryback to summary
public final Class<? extends Attribute> getCategory()

Implements javax.print.attribute.Attribute.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.

Returns:Class<? extends Attribute>

printing attribute class (category), an instance of class java.lang.Class

Annotations
@Override
getEnumValueTableback to summary
protected EnumSyntax[] getEnumValueTable()

Overrides javax.print.attribute.EnumSyntax.getEnumValueTable.

Returns the enumeration value table for class Finishings.

Annotations
@Override
getNameback to summary
public final String getName()

Implements javax.print.attribute.Attribute.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".

Returns:String

attribute category name

Annotations
@Override
getOffsetback to summary
protected int getOffset()

Overrides javax.print.attribute.EnumSyntax.getOffset.

Returns the lowest integer value used by class Finishings.

Annotations
@Override
getStringTableback to summary
protected String[] getStringTable()

Overrides javax.print.attribute.EnumSyntax.getStringTable.

Returns the string table for class Finishings.

Annotations
@Override