diff options
Diffstat (limited to 'libjava/classpath/javax/print/attribute/standard/Finishings.java')
| -rw-r--r-- | libjava/classpath/javax/print/attribute/standard/Finishings.java | 226 |
1 files changed, 205 insertions, 21 deletions
diff --git a/libjava/classpath/javax/print/attribute/standard/Finishings.java b/libjava/classpath/javax/print/attribute/standard/Finishings.java index 1224c1da163..6d474a6ead1 100644 --- a/libjava/classpath/javax/print/attribute/standard/Finishings.java +++ b/libjava/classpath/javax/print/attribute/standard/Finishings.java @@ -1,5 +1,5 @@ /* Finishings.java -- - Copyright (C) 2004 Free Software Foundation, Inc. + Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -33,7 +33,8 @@ 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. */ +exception statement from your version. */ + package javax.print.attribute.standard; @@ -44,32 +45,184 @@ import javax.print.attribute.PrintRequestAttribute; /** + * The <code>Finishings</code> attribute specifies the finishing operations + * that the Printer applies to every copy of each printed document in the Job. + * <p> + * Standard enum values are: <code>NONE</code>, <code>STAPLE</code>, + * <code>COVER</code>, <code>BIND</code>, <code>SADDLE_STITCH</code>, + * <code>EDGE_STITCH</code>. + * <br><br> + * The following values are more specific: + * <code>STAPLE_TOP_LEFT</code>, <code>STAPLE_BOTTOM_LEFT</code>, + * <code>STAPLE_TOP_RIGHT</code>, <code>STAPLE_BOTTOM_RIGHT</code>, + * <code>EDGE_STITCH_LEFT</code>, <code>EDGE_STITCH_TOP</code>, + * <code>EDGE_STITCH_RIGHT</code>, <code>EDGE_STITCH_BOTTOM</code>, + * <code>STAPLE_DUAL_LEFT</code>, <code>STAPLE_DUAL_TOP</code>, + * <code>STAPLE_DUAL_RIGHT</code>, <code>STAPLE_DUAL_BOTTOM</code>. + * </p> + * <p> + * <b>Note:</b> The effect of this attribute on jobs with multiple documents + * is controlled by the job attribute + * {@link javax.print.attribute.standard.MultipleDocumentHandling}. + * </p> + * <p> + * <b>IPP Compatibility:</b> 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 + * <code>punch</code> is not supported. + * </p> + * * @author Michael Koch (konqueror@gmx.de) + * @author Wolfgang Baer (WBaer@gmx.de) */ public class Finishings extends EnumSyntax implements DocAttribute, PrintJobAttribute, PrintRequestAttribute { private static final long serialVersionUID = -627840419548391754L; - public static final Finishings NONE = new Finishings(0); - public static final Finishings STAPLE = new Finishings(1); - public static final Finishings COVER = new Finishings(2); - public static final Finishings BIND = new Finishings(3); - public static final Finishings SADDLE_STITCH = new Finishings(4); - public static final Finishings EDGE_STITCH = new Finishings(5); - public static final Finishings STAPLE_TOP_LEFT = new Finishings(6); - public static final Finishings STAPLE_BOTTOM_LEFT = new Finishings(7); - public static final Finishings STAPLE_TOP_RIGHT = new Finishings(8); - public static final Finishings STAPLE_BOTTOM_RIGHT = new Finishings(9); - public static final Finishings EDGE_STITCH_LEFT = new Finishings(10); - public static final Finishings EDGE_STITCH_TOP = new Finishings(11); - public static final Finishings EDGE_STITCH_RIGHT = new Finishings(12); - public static final Finishings EDGE_STITCH_BOTTOM = new Finishings(13); - public static final Finishings STAPLE_DUAL_LEFT = new Finishings(14); - public static final Finishings STAPLE_DUAL_TOP = new Finishings(15); - public static final Finishings STAPLE_DUAL_RIGHT = new Finishings(16); - public static final Finishings STAPLE_DUAL_BOTTOM = new Finishings(17); + /** + * Perform no finishings of the documents. + */ + public static final Finishings NONE = new Finishings(3); + + /** + * Selects binding of the documents with one or more staples. + */ + public static final Finishings STAPLE = new Finishings(4); + + /** + * Selects the use of a non-printed (or pre-printed) cover for + * the document. + */ + public static final Finishings COVER = new Finishings(6); + + /** + * Selects that a binding is to be applied to the document. + * The type and placement of the binding is site-defined. + */ + public static final Finishings BIND = new Finishings(7); + + /** + * Selects binding of the documents with one or more staples + * along the middle fold. + */ + public static final Finishings SADDLE_STITCH = new Finishings(8); + + /** + * Selects binding of the documents with one or more staples + * along one edge. + */ + public static final Finishings EDGE_STITCH = new Finishings(9); + + /** + * Selects binding of the documents with one or more staples + * in the top left corner. + */ + public static final Finishings STAPLE_TOP_LEFT = new Finishings(20); + + /** + * Selects binding of the documents with one or more staples in the bottom + * left corner. + */ + public static final Finishings STAPLE_BOTTOM_LEFT = new Finishings(21); + + /** + * Selects binding of the documents with one or more staples in + * the top right corner. + */ + public static final Finishings STAPLE_TOP_RIGHT = new Finishings(22); + + /** + * Selects binding of the documents with one or more staples in + * the bottom right corner. + */ + public static final Finishings STAPLE_BOTTOM_RIGHT = new Finishings(23); + + /** + * Selects binding of the documents with one or more staples + * along the left edge. + */ + public static final Finishings EDGE_STITCH_LEFT = new Finishings(24); + + /** + * Selects binding of the documents with one or more staples along + * the top edge. + */ + public static final Finishings EDGE_STITCH_TOP = new Finishings(25); + + /** + * Selects binding of the documents with one or more staples along + * the right edge. + */ + public static final Finishings EDGE_STITCH_RIGHT = new Finishings(26); + + /** + * Selects binding of the documents with one or more staples along + * the bottom edge. + */ + public static final Finishings EDGE_STITCH_BOTTOM = new Finishings(27); + + /** + * Selects binding of the documents with two staples along the + * left edge assuming a portrait document. + */ + public static final Finishings STAPLE_DUAL_LEFT = new Finishings(28); + + /** + * Selects binding of the documents with two staples along the + * top edge assuming a portrait document. + */ + public static final Finishings STAPLE_DUAL_TOP = new Finishings(29); + + /** + * Selects binding of the documents with two staples along the + * right edge assuming a portrait document. + */ + public static final Finishings STAPLE_DUAL_RIGHT = new Finishings(30); + + /** + * Selects binding of the documents with two staples along the + * bottom edge assuming a portrait document. + */ + public static final Finishings STAPLE_DUAL_BOTTOM = new Finishings(31); + private static final String[] stringTable = { "none", "staple", null, + "cover", "bind", "saddle-stitch", + "edge-stitch", null, null, null, + null, null, null, null, null, + null, null, "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" }; + + private static final Finishings[] enumValueTable = { NONE, STAPLE, null, + COVER, BIND, + SADDLE_STITCH, + EDGE_STITCH, null, + null, null, null, + null, null, null, + null, null, null, + 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 }; + /** * Constructs a <code>Finishings</code> object. * @@ -93,10 +246,41 @@ public class Finishings extends EnumSyntax /** * Returns the name of this attribute. * - * @return the name + * @return The name "finishings". */ public String getName() { return "finishings"; } + + /** + * Returns a table with the enumeration values represented as strings + * for this object. + * + * @return The enumeration values as strings. + */ + protected String[] getStringTable() + { + return stringTable; + } + + /** + * Returns a table with the enumeration values for this object. + * + * @return The enumeration values. + */ + protected EnumSyntax[] getEnumValueTable() + { + return enumValueTable; + } + + /** + * Returns the lowest used value by the enumerations of this class. + * . + * @return The lowest value used. + */ + protected int getOffset() + { + return 3; + } } |
