javax.print.attribute.standard
Class Finishings

java.lang.Object
  extended by javax.print.attribute.EnumSyntax
      extended by javax.print.attribute.standard.Finishings
All Implemented Interfaces:
Serializable, Cloneable, Attribute, DocAttribute, PrintJobAttribute, PrintRequestAttribute

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

See Also:
Serialized Form

Field Summary
static Finishings BIND
          Selects that a binding is to be applied to the document.
static Finishings COVER
          Selects the use of a non-printed (or pre-printed) cover for the document.
static Finishings EDGE_STITCH
          Selects binding of the documents with one or more staples along one edge.
static Finishings EDGE_STITCH_BOTTOM
          Selects binding of the documents with one or more staples along the bottom edge.
static Finishings EDGE_STITCH_LEFT
          Selects binding of the documents with one or more staples along the left edge.
static Finishings EDGE_STITCH_RIGHT
          Selects binding of the documents with one or more staples along the right edge.
static Finishings EDGE_STITCH_TOP
          Selects binding of the documents with one or more staples along the top edge.
static Finishings NONE
          Perform no finishings of the documents.
static Finishings SADDLE_STITCH
          Selects binding of the documents with one or more staples along the middle fold.
static Finishings STAPLE
          Selects binding of the documents with one or more staples.
static Finishings STAPLE_BOTTOM_LEFT
          Selects binding of the documents with one or more staples in the bottom left corner.
static Finishings STAPLE_BOTTOM_RIGHT
          Selects binding of the documents with one or more staples in the bottom right corner.
static Finishings STAPLE_DUAL_BOTTOM
          Selects binding of the documents with two staples along the bottom edge assuming a portrait document.
static Finishings STAPLE_DUAL_LEFT
          Selects binding of the documents with two staples along the left edge assuming a portrait document.
static Finishings STAPLE_DUAL_RIGHT
          Selects binding of the documents with two staples along the right edge assuming a portrait document.
static Finishings STAPLE_DUAL_TOP
          Selects binding of the documents with two staples along the top edge assuming a portrait document.
static Finishings STAPLE_TOP_LEFT
          Selects binding of the documents with one or more staples in the top left corner.
static Finishings STAPLE_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.
 String getName()
          Returns the name of this attribute.
protected  int getOffset()
          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.
 
Methods inherited from class javax.print.attribute.EnumSyntax
clone, getValue, hashCode, readResolve, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

NONE

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


STAPLE

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


COVER

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


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.


SADDLE_STITCH

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


EDGE_STITCH

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


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_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_TOP_RIGHT

public static final Finishings STAPLE_TOP_RIGHT
Selects binding of the documents with one or more staples in the top right 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.


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_TOP

public static final Finishings EDGE_STITCH_TOP
Selects binding of the documents with one or more staples along the top 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_BOTTOM

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


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_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_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_BOTTOM

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

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.

Specified by:
getCategory in interface Attribute
Returns:
the class Finishings itself

getName

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

Specified by:
getName in interface Attribute
Returns:
The name "finishings".

getStringTable

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

Overrides:
getStringTable in class EnumSyntax
Returns:
The enumeration values as strings.

getEnumValueTable

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

Overrides:
getEnumValueTable in class EnumSyntax
Returns:
The enumeration values.

getOffset

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

Overrides:
getOffset in class EnumSyntax
Returns:
The lowest value used.