< prev index next >

src/java.desktop/share/classes/javax/print/attribute/standard/Finishings.java

Print this page




 195  *
 196  * <LI>
 197  * If different docs have different bindings specified, then only two values of
 198  * {@link MultipleDocumentHandling MultipleDocumentHandling} make sense, and the
 199  * printer reports an error when the job is submitted if any other value is
 200  * specified:
 201  * <UL>
 202  * <LI>
 203  * SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each input doc will be bound
 204  * separately with its own specified binding.
 205  *
 206  * <LI>
 207  * SEPARATE_DOCUMENTS_COLLATED_COPIES -- Each input doc will be bound separately
 208  * with its own specified binding.
 209  * </UL>
 210  * </UL>
 211  * <P>
 212  * <B>IPP Compatibility:</B> Class Finishings encapsulates some of the
 213  * IPP enum values that can be included in an IPP "finishings" attribute, which
 214  * is a set of enums. The category name returned by
 215  * <CODE>getName()</CODE> is the IPP attribute name.  The enumeration's
 216  * integer value is the IPP enum value.  The <code>toString()</code> method
 217  * returns the IPP string representation of the attribute value.
 218  * In IPP Finishings is a multi-value attribute, this API currently allows
 219  * only one binding to be specified.
 220  *
 221  * @author  Alan Kaminsky
 222  */
 223 public class Finishings extends EnumSyntax
 224     implements DocAttribute, PrintRequestAttribute, PrintJobAttribute {
 225 
 226     private static final long serialVersionUID = -627840419548391754L;
 227 
 228     /**
 229      * Perform no binding.
 230      */
 231     public static final Finishings NONE = new Finishings(3);
 232 
 233     /**
 234      * Bind the document(s) with one or more staples. The exact number and
 235      * placement of the staples is site-defined.
 236      */


 449 
 450     /**
 451      * Get the printing attribute class which is to be used as the "category"
 452      * for this printing attribute value.
 453      * <P>
 454      * For class Finishings and any vendor-defined subclasses, the
 455      * category is class Finishings itself.
 456      *
 457      * @return  Printing attribute class (category), an instance of class
 458      *          {@link java.lang.Class java.lang.Class}.
 459      */
 460     public final Class<? extends Attribute> getCategory() {
 461         return Finishings.class;
 462     }
 463 
 464     /**
 465      * Get the name of the category of which this attribute value is an
 466      * instance.
 467      * <P>
 468      * For class Finishings and any vendor-defined subclasses, the
 469      * category name is <CODE>"finishings"</CODE>.
 470      *
 471      * @return  Attribute category name.
 472      */
 473     public final String getName() {
 474         return "finishings";
 475     }
 476 
 477 }


 195  *
 196  * <LI>
 197  * If different docs have different bindings specified, then only two values of
 198  * {@link MultipleDocumentHandling MultipleDocumentHandling} make sense, and the
 199  * printer reports an error when the job is submitted if any other value is
 200  * specified:
 201  * <UL>
 202  * <LI>
 203  * SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each input doc will be bound
 204  * separately with its own specified binding.
 205  *
 206  * <LI>
 207  * SEPARATE_DOCUMENTS_COLLATED_COPIES -- Each input doc will be bound separately
 208  * with its own specified binding.
 209  * </UL>
 210  * </UL>
 211  * <P>
 212  * <B>IPP Compatibility:</B> Class Finishings encapsulates some of the
 213  * IPP enum values that can be included in an IPP "finishings" attribute, which
 214  * is a set of enums. The category name returned by
 215  * {@code getName()} is the IPP attribute name.  The enumeration's
 216  * integer value is the IPP enum value.  The {@code toString()} method
 217  * returns the IPP string representation of the attribute value.
 218  * In IPP Finishings is a multi-value attribute, this API currently allows
 219  * only one binding to be specified.
 220  *
 221  * @author  Alan Kaminsky
 222  */
 223 public class Finishings extends EnumSyntax
 224     implements DocAttribute, PrintRequestAttribute, PrintJobAttribute {
 225 
 226     private static final long serialVersionUID = -627840419548391754L;
 227 
 228     /**
 229      * Perform no binding.
 230      */
 231     public static final Finishings NONE = new Finishings(3);
 232 
 233     /**
 234      * Bind the document(s) with one or more staples. The exact number and
 235      * placement of the staples is site-defined.
 236      */


 449 
 450     /**
 451      * Get the printing attribute class which is to be used as the "category"
 452      * for this printing attribute value.
 453      * <P>
 454      * For class Finishings and any vendor-defined subclasses, the
 455      * category is class Finishings itself.
 456      *
 457      * @return  Printing attribute class (category), an instance of class
 458      *          {@link java.lang.Class java.lang.Class}.
 459      */
 460     public final Class<? extends Attribute> getCategory() {
 461         return Finishings.class;
 462     }
 463 
 464     /**
 465      * Get the name of the category of which this attribute value is an
 466      * instance.
 467      * <P>
 468      * For class Finishings and any vendor-defined subclasses, the
 469      * category name is {@code "finishings"}.
 470      *
 471      * @return  Attribute category name.
 472      */
 473     public final String getName() {
 474         return "finishings";
 475     }
 476 
 477 }
< prev index next >