1. /*

  2.  * @(#)Finishings.java	1.7 03/01/23

  3.  *

  4.  * Copyright 2003 Sun Microsystems, Inc. All rights reserved.

  5.  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

  6.  */

  7. package javax.print.attribute.standard;

  8. 

  9. import javax.print.attribute.EnumSyntax;

  10. import javax.print.attribute.DocAttribute;

  11. import javax.print.attribute.PrintRequestAttribute;

  12. import javax.print.attribute.PrintJobAttribute;

  13. 

  14. /**

  15.  * Class Finishings is a printing attribute class, an enumeration, that 

  16.  * identifies whether the printer applies a finishing operation of some kind  

  17.  * of binding to each copy of each printed document in the job. For multidoc  

  18.  * print jobs (jobs with multiple documents), the

  19.  * {@link MultipleDocumentHandling 

  20.  * MultipleDocumentHandling} attribute determines what constitutes a "copy"  

  21.  * for purposes of finishing. 

  22.  * <P>

  23.  * Standard Finishings values are:

  24.  * <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100% SUMMARY="layout">

  25.  * <TR>

  26.  * <TD WIDTH=10%>

  27.  *  

  28.  * </TD>

  29.  * <TD WIDTH=27%>

  30.  * {@link #NONE <CODE>NONE</CODE>}

  31.  * </TD>

  32.  * <TD WIDTH=27%>

  33.  * {@link #STAPLE <CODE>STAPLE</CODE>}

  34.  * </TD>

  35.  * <TD WIDTH=36%>

  36.  * {@link #EDGE_STITCH <CODE>EDGE_STITCH</CODE>}

  37.  * </TD>

  38.  * </TR>

  39.  * <TR>

  40.  * <TD>

  41.  *  

  42.  * </TD>

  43.  * <TD>

  44.  * {@link #BIND <CODE>BIND</CODE>}

  45.  * </TD>

  46.  * <TD>

  47.  * {@link #SADDLE_STITCH <CODE>SADDLE_STITCH</CODE>}

  48.  * </TD>

  49.  * <TD>

  50.  * {@link #COVER <CODE>COVER</CODE>}

  51.  * </TD>

  52.  * <TD>

  53.  *  

  54.  * </TD>

  55.  * </TR>

  56.  * </TABLE>

  57.  * <P>

  58.  * The following Finishings values are more specific; they indicate a 

  59.  * corner or an edge as if the document were a portrait document: 

  60.  * <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100% SUMMARY="layout">

  61.  * <TR>

  62.  * <TD WIDTH=10%>

  63.  *  

  64.  * </TD>

  65.  * <TD WIDTH=27%>

  66.  * {@link #STAPLE_TOP_LEFT <CODE>STAPLE_TOP_LEFT</CODE>}

  67.  * </TD>

  68.  * <TD WIDTH=27%>

  69.  * {@link #EDGE_STITCH_LEFT <CODE>EDGE_STITCH_LEFT</CODE>}

  70.  * </TD>

  71.  * <TD WIDTH=27%>

  72.  * {@link #STAPLE_DUAL_LEFT <CODE>STAPLE_DUAL_LEFT</CODE>}

  73.  * </TD>

  74.  * <TD WIDTH=9%>

  75.  *  

  76.  * </TD>

  77.  * </TR>

  78.  * <TR>

  79.  * <TD WIDTH=10%>

  80.  *  

  81.  * </TD>

  82.  * <TD WIDTH=27%>

  83.  * {@link #STAPLE_BOTTOM_LEFT <CODE>STAPLE_BOTTOM_LEFT</CODE>}

  84.  * </TD>

  85.  * <TD WIDTH=27%>

  86.  * {@link #EDGE_STITCH_TOP <CODE>EDGE_STITCH_TOP</CODE>}

  87.  * </TD>

  88.  * <TD WIDTH=27%>

  89.  * {@link #STAPLE_DUAL_TOP <CODE>STAPLE_DUAL_TOP</CODE>}

  90.  * </TD>

  91.  * <TD WIDTH=9%>

  92.  *  

  93.  * </TD>

  94.  * </TR>

  95.  * <TR>

  96.  * <TD WIDTH=10%>

  97.  *  

  98.  * </TD>

  99.  * <TD WIDTH=27%>

  100.  * {@link #STAPLE_TOP_RIGHT <CODE>STAPLE_TOP_RIGHT</CODE>}

  101.  * </TD>

  102.  * <TD WIDTH=27%>

  103.  * {@link #EDGE_STITCH_RIGHT <CODE>EDGE_STITCH_RIGHT</CODE>}

  104.  * </TD>

  105.  * <TD WIDTH=27%>

  106.  * {@link #STAPLE_DUAL_RIGHT <CODE>STAPLE_DUAL_RIGHT</CODE>}

  107.  * </TD>

  108.  * <TD WIDTH=9%>

  109.  *  

  110.  * </TD>

  111.  * </TR>

  112.  * <TR>

  113.  * <TD WIDTH=10%>

  114.  *  

  115.  * </TD>

  116.  * <TD WIDTH=27%>

  117.  * {@link #STAPLE_BOTTOM_RIGHT <CODE>STAPLE_BOTTOM_RIGHT</CODE>}

  118.  * </TD>

  119.  * <TD WIDTH=27%>

  120.  * {@link #EDGE_STITCH_BOTTOM <CODE>EDGE_STITCH_BOTTOM</CODE>}

  121.  * </TD>

  122.  * <TD WIDTH=27%>

  123.  * {@link #STAPLE_DUAL_BOTTOM <CODE>STAPLE_DUAL_BOTTOM</CODE>}

  124.  * </TD>

  125.  * <TD WIDTH=9%>

  126.  *  

  127.  * </TD>

  128.  * </TR>

  129.  * </TABLE>

  130.  * <P>

  131.  * The <CODE>STAPLE_<I>XXX</I></CODE> values are specified with respect to the 

  132.  * document as if the document were a portrait document. If the document is 

  133.  * actually a landscape or a reverse-landscape document, the client supplies the 

  134.  * appropriate transformed value. For example, to position a staple in the upper 

  135.  * left hand corner of a landscape document when held for reading, the client 

  136.  * supplies the <CODE>STAPLE_BOTTOM_LEFT</CODE> value (since landscape is 

  137.  * defined as a +90 degree rotation from portrait, i.e., anti-clockwise). On the 

  138.  * other hand, to position a staple in the upper left hand corner of a 

  139.  * reverse-landscape document when held for reading, the client supplies the 

  140.  * <CODE>STAPLE_TOP_RIGHT</CODE> value (since reverse-landscape is defined as a 

  141.  * -90 degree rotation from portrait, i.e., clockwise). 

  142.  * <P>

  143.  * The angle (vertical, horizontal, angled) of each staple with respect to the 

  144.  * document depends on the implementation which may in turn depend on the value 

  145.  * of the attribute.

  146.  * <P>

  147.  * The effect of a Finishings attribute on a multidoc print job (a job 

  148.  * with multiple documents) depends on whether all the docs have the same 

  149.  * binding specified or whether different docs have different bindings 

  150.  * specified, and on the (perhaps defaulted) value of the {@link 

  151.  * MultipleDocumentHandling MultipleDocumentHandling} attribute. 

  152.  * <UL>

  153.  * <LI>

  154.  * If all the docs have the same binding specified, then any value of {@link 

  155.  * MultipleDocumentHandling MultipleDocumentHandling} makes sense, and the 

  156.  * printer's processing depends on the {@link MultipleDocumentHandling 

  157.  * MultipleDocumentHandling} value: 

  158.  * <UL>

  159.  * <LI>

  160.  * SINGLE_DOCUMENT -- All the input docs will be bound together as one output 

  161.  * document with the specified binding. 

  162.  * <P>

  163.  * <LI>

  164.  * SINGLE_DOCUMENT_NEW_SHEET -- All the input docs will be bound together as one 

  165.  * output document with the specified binding, and the first impression of each 

  166.  * input doc will always start on a new media sheet. 

  167.  * <P>

  168.  * <LI>

  169.  * SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each input doc will be bound 

  170.  * separately with the specified binding. 

  171.  * <P>

  172.  * <LI>

  173.  * SEPARATE_DOCUMENTS_COLLATED_COPIES -- Each input doc will be bound separately 

  174.  * with the specified binding. 

  175.  * </UL> 

  176.  * <P>

  177.  * <LI>

  178.  * If different docs have different bindings specified, then only two values of 

  179.  * {@link MultipleDocumentHandling MultipleDocumentHandling} make sense, and the 

  180.  * printer reports an error when the job is submitted if any other value is 

  181.  * specified: 

  182.  * <UL>

  183.  * <LI>

  184.  * SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each input doc will be bound 

  185.  * separately with its own specified binding. 

  186.  * <P>

  187.  * <LI>

  188.  * SEPARATE_DOCUMENTS_COLLATED_COPIES -- Each input doc will be bound separately 

  189.  * with its own specified binding. 

  190.  * </UL>

  191.  * </UL>

  192.  * <P>

  193.  * <B>IPP Compatibility:</B> Class Finishings encapsulates some of the 

  194.  * IPP enum values that can be included in an IPP "finishings" attribute, which 

  195.  * is a set of enums. The category name returned by 

  196.  * <CODE>getName()</CODE> is the IPP attribute name.  The enumeration's 

  197.  * integer value is the IPP enum value.  The <code>toString()</code> method 

  198.  * returns the IPP string representation of the attribute value.

  199.  * In IPP Finishings is a multi-value attribute, this API currently allows

  200.  * only one binding to be specified.

  201.  *  

  202.  * @author  Alan Kaminsky

  203.  */

  204. public class Finishings extends EnumSyntax

  205.     implements DocAttribute, PrintRequestAttribute, PrintJobAttribute {

  206. 

  207.     /**

  208.      * Perform no binding.

  209.      */

  210.     public static final Finishings NONE = new Finishings(3);

  211. 

  212.     /**

  213.      * Bind the document(s) with one or more staples. The exact number and 

  214.      * placement of the staples is site-defined. 

  215.      */

  216.     public static final Finishings STAPLE = new Finishings(4);

  217. 

  218.     /**

  219.      * This value is specified when it is desired to select a non-printed (or 

  220.      * pre-printed) cover for the document. This does not supplant the 

  221.      * specification of a printed cover (on cover stock medium) by the  

  222.      * document  itself. 

  223.      */

  224.     public static final Finishings COVER = new Finishings(6);

  225. 

  226.     /**

  227.      * This value indicates that a binding is to be applied to the document;

  228.      * the type and placement of the binding is site-defined. 

  229.      */

  230.     public static final Finishings BIND = new Finishings(7);

  231. 

  232.     /**

  233.      * Bind the document(s) with one or more staples (wire stitches) along the 

  234.      * middle fold. The exact number and placement of the staples and the  

  235.      * middle fold is implementation- and/or site-defined. 

  236.      */

  237.     public static final Finishings SADDLE_STITCH = 

  238. 	new Finishings(8);

  239. 

  240.     /**

  241.      * Bind the document(s) with one or more staples (wire stitches) along one 

  242.      * edge. The exact number and placement of the staples is implementation- 

  243.      * and/or site- defined. 

  244.      */

  245.     public static final Finishings EDGE_STITCH = 

  246. 	new Finishings(9);

  247. 

  248.     /**

  249.      * Bind the document(s) with one or more staples in the top left corner. 

  250.      */

  251.     public static final Finishings STAPLE_TOP_LEFT = 

  252. 	new Finishings(20);

  253. 

  254.     /**

  255.      * Bind the document(s) with one or more staples in the bottom left

  256.      * corner. 

  257.      */

  258.     public static final Finishings STAPLE_BOTTOM_LEFT =

  259. 	new Finishings(21);

  260. 

  261.     /**

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

  263.      */

  264.     public static final Finishings STAPLE_TOP_RIGHT =

  265. 	new Finishings(22);

  266. 

  267.     /**

  268.      * Bind the document(s) with one or more staples in the bottom right

  269.      * corner. 

  270.      */

  271.     public static final Finishings STAPLE_BOTTOM_RIGHT =

  272. 	new Finishings(23);

  273. 

  274.     /**

  275.      * Bind the document(s) with one or more staples (wire stitches) along the 

  276.      * left edge. The exact number and placement of the staples is 

  277.      * implementation- and/or site-defined. 

  278.      */

  279.     public static final Finishings EDGE_STITCH_LEFT =

  280. 	new Finishings(24);

  281.     

  282.     /**

  283.      * Bind the document(s) with one or more staples (wire stitches) along the 

  284.      * top edge. The exact number and placement of the staples is 

  285.      * implementation- and/or site-defined. 

  286.      */

  287.     public static final Finishings EDGE_STITCH_TOP =

  288. 	new Finishings(25);

  289. 

  290.     /**

  291.      * Bind the document(s) with one or more staples (wire stitches) along the 

  292.      * right edge. The exact number and placement of the staples is 

  293.      * implementation- and/or site-defined. 

  294.      */

  295.     public static final Finishings EDGE_STITCH_RIGHT =

  296. 	new Finishings(26);

  297.     

  298.     /**

  299.      * Bind the document(s) with one or more staples (wire stitches) along the 

  300.      * bottom edge. The exact number and placement of the staples is 

  301.      * implementation- and/or site-defined. 

  302.      */

  303.     public static final Finishings EDGE_STITCH_BOTTOM =

  304. 	new Finishings(27);

  305.     

  306.     /**

  307.      * Bind the document(s) with two staples (wire stitches) along the left  

  308.      * edge assuming a portrait document (see above). 

  309.      */

  310.     public static final Finishings STAPLE_DUAL_LEFT =

  311. 	new Finishings(28);

  312. 

  313.     /**

  314.      * Bind the document(s) with two staples (wire stitches) along the top 

  315.      * edge assuming a portrait document (see above). 

  316.      */

  317.     public static final Finishings STAPLE_DUAL_TOP =

  318. 	new Finishings(29);

  319. 

  320.     /**

  321.      * Bind the document(s) with two staples (wire stitches) along the right 

  322.      * edge assuming a portrait document (see above). 

  323.      */

  324.     public static final Finishings STAPLE_DUAL_RIGHT =

  325. 	new Finishings(30);

  326. 

  327.     /**

  328.      * Bind the document(s) with two staples (wire stitches) along the bottom 

  329.      * edge assuming a portrait document (see above). 

  330.      */

  331.     public static final Finishings STAPLE_DUAL_BOTTOM = 

  332. 	new Finishings(31);

  333. 

  334.     /**

  335.      * Construct a new finishings binding enumeration value with the given 

  336.      * integer value. 

  337.      *

  338.      * @param  value  Integer value.

  339.      */

  340.     protected Finishings(int value) {

  341. 	super(value);

  342.     }

  343. 

  344.     private static final String[] myStringTable =

  345. 		{"none",

  346. 		 "staple",

  347. 		 null,

  348. 		 "cover",

  349. 		 "bind",

  350. 		 "saddle-stitch",

  351. 		 "edge-stitch",

  352. 		 null, // The next ten enum values are reserved.

  353. 		 null,

  354. 		 null,

  355. 		 null,

  356. 		 null,

  357. 		 null,

  358. 		 null,

  359. 		 null,

  360. 		 null,

  361. 		 null,

  362. 		 "staple-top-left",

  363. 		 "staple-bottom-left",

  364. 		 "staple-top-right",

  365. 		 "staple-bottom-right",

  366. 		 "edge-stitch-left",

  367. 		 "edge-stitch-top",

  368. 		 "edge-stitch-right",

  369. 		 "edge-stitch-bottom",

  370. 		 "staple-dual-left",

  371. 		 "staple-dual-top",

  372. 		 "staple-dual-right",

  373. 		 "staple-dual-bottom"

  374. 		};

  375. 

  376.     private static final Finishings[] myEnumValueTable =

  377. 		{NONE,

  378. 		 STAPLE,

  379. 		 null,

  380. 		 COVER,

  381. 		 BIND,

  382. 		 SADDLE_STITCH,

  383. 		 EDGE_STITCH,

  384. 		 null, // The next ten enum values are reserved.

  385. 		 null,

  386. 		 null,

  387. 		 null,

  388. 		 null,

  389. 		 null,

  390. 		 null,

  391. 		 null,

  392. 		 null,

  393. 		 null,

  394. 		 STAPLE_TOP_LEFT,

  395. 		 STAPLE_BOTTOM_LEFT,

  396. 		 STAPLE_TOP_RIGHT,

  397. 		 STAPLE_BOTTOM_RIGHT,

  398. 		 EDGE_STITCH_LEFT,

  399. 		 EDGE_STITCH_TOP,

  400. 		 EDGE_STITCH_RIGHT,

  401. 		 EDGE_STITCH_BOTTOM,

  402. 		 STAPLE_DUAL_LEFT,

  403. 		 STAPLE_DUAL_TOP,

  404. 		 STAPLE_DUAL_RIGHT,

  405. 		 STAPLE_DUAL_BOTTOM 

  406. 		};

  407. 

  408.     /**

  409.      * Returns the string table for class Finishings.

  410.      */

  411.     protected String[] getStringTable() {

  412. 	return (String[])myStringTable.clone();

  413.     }

  414. 

  415.     /**

  416.      * Returns the enumeration value table for class Finishings.

  417.      */

  418.     protected EnumSyntax[] getEnumValueTable() {

  419. 	return (EnumSyntax[])myEnumValueTable.clone();

  420.     }

  421.     

  422.     /**

  423.      * Returns the lowest integer value used by class Finishings.

  424.      */

  425.     protected int getOffset() {

  426. 	return 3;

  427.     } 

  428. 

  429.     /**

  430.      * Get the printing attribute class which is to be used as the "category" 

  431.      * for this printing attribute value.

  432.      * <P>

  433.      * For class Finishings and any vendor-defined subclasses, the 

  434.      * category is class Finishings itself. 

  435.      *

  436.      * @return  Printing attribute class (category), an instance of class

  437.      *          {@link java.lang.Class java.lang.Class}.

  438.      */

  439.     public final Class getCategory() {

  440. 	return Finishings.class;

  441.     }

  442. 

  443.     /**

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

  445.      * instance. 

  446.      * <P>

  447.      * For class Finishings and any vendor-defined subclasses, the 

  448.      * category name is <CODE>"finishings"</CODE>. 

  449.      *

  450.      * @return  Attribute category name.

  451.      */

  452.     public final String getName() {

  453. 	return "finishings";

  454.     }

  455.     

  456. }