Java Doc for Finishings.java in  » 6.0-JDK-Core » print » javax » print » attribute » standard » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » print » javax.print.attribute.standard 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   javax.print.attribute.EnumSyntax
      javax.print.attribute.standard.Finishings

Finishings
public class Finishings extends EnumSyntax implements DocAttribute,PrintRequestAttribute,PrintJobAttribute(Code)
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 MultipleDocumentHandling attribute determines what constitutes a "copy" for purposes of finishing.

Standard Finishings values are:
  Finishings.NONE NONE Finishings.STAPLE STAPLE Finishings.EDGE_STITCH EDGE_STITCH
  Finishings.BIND BIND Finishings.SADDLE_STITCH SADDLE_STITCH Finishings.COVER COVER  

The following Finishings values are more specific; they indicate a corner or an edge as if the document were a portrait document:
  Finishings.STAPLE_TOP_LEFT STAPLE_TOP_LEFT Finishings.EDGE_STITCH_LEFT EDGE_STITCH_LEFT Finishings.STAPLE_DUAL_LEFT STAPLE_DUAL_LEFT  
  Finishings.STAPLE_BOTTOM_LEFT STAPLE_BOTTOM_LEFT Finishings.EDGE_STITCH_TOP EDGE_STITCH_TOP Finishings.STAPLE_DUAL_TOP STAPLE_DUAL_TOP  
  Finishings.STAPLE_TOP_RIGHT STAPLE_TOP_RIGHT Finishings.EDGE_STITCH_RIGHT EDGE_STITCH_RIGHT Finishings.STAPLE_DUAL_RIGHT STAPLE_DUAL_RIGHT  
  Finishings.STAPLE_BOTTOM_RIGHT STAPLE_BOTTOM_RIGHT Finishings.EDGE_STITCH_BOTTOM EDGE_STITCH_BOTTOM Finishings.STAPLE_DUAL_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 MultipleDocumentHandling attribute.

  • If all the docs have the same binding specified, then any value of MultipleDocumentHandling MultipleDocumentHandling makes sense, and the printer's processing depends on the MultipleDocumentHandling MultipleDocumentHandling value:
    • SINGLE_DOCUMENT -- All the input docs will be bound together as one output document with the specified binding.

    • SINGLE_DOCUMENT_NEW_SHEET -- All the input docs will be bound together as one output document with the specified binding, and the first impression of each input doc will always start on a new media sheet.

    • SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each input doc will be bound separately with the specified binding.

    • SEPARATE_DOCUMENTS_COLLATED_COPIES -- Each input doc will be bound separately with the specified binding.

  • If different docs have different bindings specified, then only two values of MultipleDocumentHandling MultipleDocumentHandling make sense, and the printer reports an error when the job is submitted if any other value is specified:
    • SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each input doc will be bound separately with its own specified binding.

    • SEPARATE_DOCUMENTS_COLLATED_COPIES -- Each input doc will be bound separately with its own specified binding.

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.
author:
   Alan Kaminsky



Field Summary
final public static  FinishingsBIND
     This value indicates that a binding is to be applied to the document; the type and placement of the binding is site-defined.
final public static  FinishingsCOVER
     This value is specified when it is desired to select a non-printed (or pre-printed) cover for the document.
final public static  FinishingsEDGE_STITCH
     Bind the document(s) with one or more staples (wire stitches) along one edge.
final public static  FinishingsEDGE_STITCH_BOTTOM
     Bind the document(s) with one or more staples (wire stitches) along the bottom edge.
final public static  FinishingsEDGE_STITCH_LEFT
     Bind the document(s) with one or more staples (wire stitches) along the left edge.
final public static  FinishingsEDGE_STITCH_RIGHT
     Bind the document(s) with one or more staples (wire stitches) along the right edge.
final public static  FinishingsEDGE_STITCH_TOP
     Bind the document(s) with one or more staples (wire stitches) along the top edge.
final public static  FinishingsNONE
     Perform no binding.
final public static  FinishingsSADDLE_STITCH
     Bind the document(s) with one or more staples (wire stitches) along the middle fold.
final public static  FinishingsSTAPLE
     Bind the document(s) with one or more staples.
final public static  FinishingsSTAPLE_BOTTOM_LEFT
     Bind the document(s) with one or more staples in the bottom left corner.
final public static  FinishingsSTAPLE_BOTTOM_RIGHT
     Bind the document(s) with one or more staples in the bottom right corner.
final public static  FinishingsSTAPLE_DUAL_BOTTOM
     Bind the document(s) with two staples (wire stitches) along the bottom edge assuming a portrait document (see above).
final public static  FinishingsSTAPLE_DUAL_LEFT
     Bind the document(s) with two staples (wire stitches) along the left edge assuming a portrait document (see above).
final public static  FinishingsSTAPLE_DUAL_RIGHT
     Bind the document(s) with two staples (wire stitches) along the right edge assuming a portrait document (see above).
final public static  FinishingsSTAPLE_DUAL_TOP
     Bind the document(s) with two staples (wire stitches) along the top edge assuming a portrait document (see above).
final public static  FinishingsSTAPLE_TOP_LEFT
     Bind the document(s) with one or more staples in the top left corner.
final public static  FinishingsSTAPLE_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
final public  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.

protected  EnumSyntax[]getEnumValueTable()
     Returns the enumeration value table for class Finishings.
final public  StringgetName()
     Get the name of the category of which this attribute value is an instance.
protected  intgetOffset()
     Returns the lowest integer value used by class Finishings.
protected  String[]getStringTable()
     Returns the string table for class Finishings.

Field Detail
BIND
final public static Finishings BIND(Code)
This value indicates that a binding is to be applied to the document; the type and placement of the binding is site-defined.



COVER
final public static Finishings COVER(Code)
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.



EDGE_STITCH
final public static Finishings EDGE_STITCH(Code)
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.



EDGE_STITCH_BOTTOM
final public static Finishings EDGE_STITCH_BOTTOM(Code)
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.



EDGE_STITCH_LEFT
final public static Finishings EDGE_STITCH_LEFT(Code)
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_RIGHT
final public static Finishings EDGE_STITCH_RIGHT(Code)
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_TOP
final public static Finishings EDGE_STITCH_TOP(Code)
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.



NONE
final public static Finishings NONE(Code)
Perform no binding.



SADDLE_STITCH
final public static Finishings SADDLE_STITCH(Code)
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.



STAPLE
final public static Finishings STAPLE(Code)
Bind the document(s) with one or more staples. The exact number and placement of the staples is site-defined.



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



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



STAPLE_DUAL_BOTTOM
final public static Finishings STAPLE_DUAL_BOTTOM(Code)
Bind the document(s) with two staples (wire stitches) along the bottom edge assuming a portrait document (see above).



STAPLE_DUAL_LEFT
final public static Finishings STAPLE_DUAL_LEFT(Code)
Bind the document(s) with two staples (wire stitches) along the left edge assuming a portrait document (see above).



STAPLE_DUAL_RIGHT
final public static Finishings STAPLE_DUAL_RIGHT(Code)
Bind the document(s) with two staples (wire stitches) along the right edge assuming a portrait document (see above).



STAPLE_DUAL_TOP
final public static Finishings STAPLE_DUAL_TOP(Code)
Bind the document(s) with two staples (wire stitches) along the top edge assuming a portrait document (see above).



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



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




Constructor Detail
Finishings
protected Finishings(int value)(Code)
Construct a new finishings binding enumeration value with the given integer value.
Parameters:
  value - Integer value.




Method Detail
getCategory
final public Class<? extends Attribute> getCategory()(Code)
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. Printing attribute class (category), an instance of classjava.lang.Class java.lang.Class.




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



getName
final public String getName()(Code)
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". Attribute category name.




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



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



Methods inherited from javax.print.attribute.EnumSyntax
public Object clone()(Code)(Java Doc)
protected EnumSyntax[] getEnumValueTable()(Code)(Java Doc)
protected int getOffset()(Code)(Java Doc)
protected String[] getStringTable()(Code)(Java Doc)
public int getValue()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
protected Object readResolve() throws ObjectStreamException(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.