javax.print.attribute.standard

Class Finishings

Implemented Interfaces:
Attribute, Cloneable, DocAttribute, PrintJobAttribute, PrintRequestAttribute, Serializable

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

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, getEnumValueTable, getOffset, getStringTable, getValue, hashCode, readResolve, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

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 Details

Finishings

protected Finishings(int value)
Constructs a Finishings object.
Parameters:
value - the value

Method Details

? extends Attribute> getCategory

public Class< ? extends Attribute> getCategory()
Returns category of this class.
Specified by:
? extends Attribute> getCategory in interface Attribute
Returns:
the class Finishings itself

getEnumValueTable

protected EnumSyntax[] getEnumValueTable()
Returns a table with the enumeration values for this object.
Overrides:
getEnumValueTable in interface EnumSyntax
Returns:
The enumeration values.

getName

public final String getName()
Returns the name of this attribute.
Specified by:
getName in interface Attribute
Returns:
The name "finishings".

getOffset

protected int getOffset()
Returns the lowest used value by the enumerations of this class. .
Overrides:
getOffset in interface EnumSyntax
Returns:
The lowest value used.

getStringTable

protected String[] getStringTable()
Returns a table with the enumeration values represented as strings for this object.
Overrides:
getStringTable in interface EnumSyntax
Returns:
The enumeration values as strings.

Finishings.java -- Copyright (C) 2004, 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.