Java™ Platform
Standard Ed. 6

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, PrintRequestAttribute, PrintJobAttribute

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.

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:
Serialized Form

Field Summary
static 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.
static Finishings COVER
          This value is specified when it is desired to select a non-printed (or pre-printed) cover for the document.
static Finishings EDGE_STITCH
          Bind the document(s) with one or more staples (wire stitches) along one edge.
static Finishings EDGE_STITCH_BOTTOM
          Bind the document(s) with one or more staples (wire stitches) along the bottom edge.
static Finishings EDGE_STITCH_LEFT
          Bind the document(s) with one or more staples (wire stitches) along the left edge.
static Finishings EDGE_STITCH_RIGHT
          Bind the document(s) with one or more staples (wire stitches) along the right edge.
static Finishings EDGE_STITCH_TOP
          Bind the document(s) with one or more staples (wire stitches) along the top edge.
static Finishings NONE
          Perform no binding.
static Finishings SADDLE_STITCH
          Bind the document(s) with one or more staples (wire stitches) along the middle fold.
static Finishings STAPLE
          Bind the document(s) with one or more staples.
static Finishings STAPLE_BOTTOM_LEFT
          Bind the document(s) with one or more staples in the bottom left corner.
static Finishings STAPLE_BOTTOM_RIGHT
          Bind the document(s) with one or more staples in the bottom right corner.
static Finishings STAPLE_DUAL_BOTTOM
          Bind the document(s) with two staples (wire stitches) along the bottom edge assuming a portrait document (see above).
static Finishings STAPLE_DUAL_LEFT
          Bind the document(s) with two staples (wire stitches) along the left edge assuming a portrait document (see above).
static Finishings STAPLE_DUAL_RIGHT
          Bind the document(s) with two staples (wire stitches) along the right edge assuming a portrait document (see above).
static Finishings STAPLE_DUAL_TOP
          Bind the document(s) with two staples (wire stitches) along the top edge assuming a portrait document (see above).
static Finishings STAPLE_TOP_LEFT
          Bind the document(s) with one or more staples in the top left corner.
static Finishings STAPLE_TOP_RIGHT
          Bind the document(s) with one or more staples in the top right corner.
 
Constructor Summary
protected Finishings(int value)
          Construct a new finishings binding enumeration value with the given integer value.
 
Method Summary
 Class<? extends Attribute> getCategory()
          Get the printing attribute class which is to be used as the "category" for this printing attribute value.
protected  EnumSyntax[] getEnumValueTable()
          Returns the enumeration value table for class Finishings.
 String getName()
          Get the name of the category of which this attribute value is an instance.
protected  int getOffset()
          Returns the lowest integer value used by class Finishings.
protected  String[] getStringTable()
          Returns the string table for class Finishings.
 
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 binding.


STAPLE

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.


COVER

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.


BIND

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.


SADDLE_STITCH

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.


EDGE_STITCH

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.


STAPLE_TOP_LEFT

public static final Finishings STAPLE_TOP_LEFT
Bind the document(s) with one or more staples in the top left corner.


STAPLE_BOTTOM_LEFT

public static final Finishings STAPLE_BOTTOM_LEFT
Bind the document(s) with one or more staples in the bottom left corner.


STAPLE_TOP_RIGHT

public static final Finishings STAPLE_TOP_RIGHT
Bind the document(s) with one or more staples in the top right corner.


STAPLE_BOTTOM_RIGHT

public static final Finishings STAPLE_BOTTOM_RIGHT
Bind the document(s) with one or more staples in the bottom right corner.


EDGE_STITCH_LEFT

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_TOP

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.


EDGE_STITCH_RIGHT

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_BOTTOM

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.


STAPLE_DUAL_LEFT

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_TOP

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_DUAL_RIGHT

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_BOTTOM

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

Constructor Detail

Finishings

protected Finishings(int value)
Construct a new finishings binding enumeration value with the given integer value.

Parameters:
value - Integer value.
Method Detail

getStringTable

protected String[] getStringTable()
Returns the string table for class Finishings.

Overrides:
getStringTable in class EnumSyntax
Returns:
the string table

getEnumValueTable

protected EnumSyntax[] getEnumValueTable()
Returns the enumeration value table for class Finishings.

Overrides:
getEnumValueTable in class EnumSyntax
Returns:
the value table

getOffset

protected int getOffset()
Returns the lowest integer value used by class Finishings.

Overrides:
getOffset in class EnumSyntax
Returns:
the offset of the lowest enumeration value.

getCategory

public final Class<? extends 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.

Specified by:
getCategory in interface Attribute
Returns:
Printing attribute class (category), an instance of class java.lang.Class.

getName

public final 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".

Specified by:
getName in interface Attribute
Returns:
Attribute category name.

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.

Scripting on this page tracks web page traffic, but does not change the content in any way.