001 /*
002 * Copyright 2000-2004 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 package javax.print.attribute.standard;
026
027 import javax.print.attribute.Attribute;
028 import javax.print.attribute.EnumSyntax;
029 import javax.print.attribute.DocAttribute;
030 import javax.print.attribute.PrintRequestAttribute;
031 import javax.print.attribute.PrintJobAttribute;
032
033 /**
034 * Class Chromaticity is a printing attribute class, an enumeration, that
035 * specifies monochrome or color printing. This is used by a print client
036 * to specify how the print data should be generated or processed. It is not
037 * descriptive of the color capabilities of the device. Query the service's
038 * {@link ColorSupported ColorSupported} attribute to determine if the device
039 * can be verified to support color printing.
040 * <P>
041 * The table below shows the effects of specifying a Chromaticity attribute of
042 * {@link #MONOCHROME <CODE>MONOCHROME</CODE>} or {@link #COLOR
043 * <CODE>COLOR</CODE>} for a monochrome or color document.
044 * <P>
045 * <TABLE BORDER=1 CELLPADDING=2 CELLSPACING=1 SUMMARY="Shows effects of specifying MONOCHROME or COLOR Chromaticity attributes">
046 * <TR BGCOLOR="#E5E5E5">
047 * <TH>
048 * Chromaticity<BR>Attribute
049 * </TH>
050 * <TH>
051 * Effect on<BR>Monochrome Document
052 * </TH>
053 * <TH>
054 * Effect on<BR>Color Document
055 * </TH>
056 * </TR>
057 * <TR>
058 * <TD>
059 * {@link #MONOCHROME <CODE>MONOCHROME</CODE>}
060 * </TD>
061 * <TD>
062 * Printed as is, in monochrome
063 * </TD>
064 * <TD>
065 * Printed in monochrome, with colors converted to shades of gray
066 * </TD>
067 * </TR>
068 * <TR>
069 * <TD>
070 * {@link #COLOR <CODE>COLOR</CODE>}
071 * </TD>
072 * <TD>
073 * Printed as is, in monochrome
074 * </TD>
075 * <TD>
076 * Printed as is, in color
077 * </TD>
078 * </TR>
079 * </TABLE>
080 * <P>
081 * <P>
082 * <B>IPP Compatibility:</B> Chromaticity is not an IPP attribute at present.
083 * <P>
084 *
085 * @author Alan Kaminsky
086 */
087 public final class Chromaticity extends EnumSyntax implements
088 DocAttribute, PrintRequestAttribute, PrintJobAttribute {
089
090 private static final long serialVersionUID = 4660543931355214012L;
091
092 /**
093 * Monochrome printing.
094 */
095 public static final Chromaticity MONOCHROME = new Chromaticity(0);
096
097 /**
098 * Color printing.
099 */
100 public static final Chromaticity COLOR = new Chromaticity(1);
101
102 /**
103 * Construct a new chromaticity enumeration value with the given integer
104 * value.
105 *
106 * @param value Integer value.
107 */
108 protected Chromaticity(int value) {
109 super (value);
110 }
111
112 private static final String[] myStringTable = { "monochrome",
113 "color" };
114
115 private static final Chromaticity[] myEnumValueTable = {
116 MONOCHROME, COLOR };
117
118 /**
119 * Returns the string table for class Chromaticity.
120 */
121 protected String[] getStringTable() {
122 return myStringTable;
123 }
124
125 /**
126 * Returns the enumeration value table for class Chromaticity.
127 */
128 protected EnumSyntax[] getEnumValueTable() {
129 return myEnumValueTable;
130 }
131
132 /**
133 * Get the printing attribute class which is to be used as the "category"
134 * for this printing attribute value.
135 * <P>
136 * For class Chromaticity, the category is the class Chromaticity itself.
137 *
138 * @return Printing attribute class (category), an instance of class
139 * {@link java.lang.Class java.lang.Class}.
140 */
141 public final Class<? extends Attribute> getCategory() {
142 return Chromaticity.class;
143 }
144
145 /**
146 * Get the name of the category of which this attribute value is an
147 * instance.
148 * <P>
149 * For class Chromaticity, the category name is <CODE>"chromaticity"</CODE>.
150 *
151 * @return Attribute category name.
152 */
153 public final String getName() {
154 return "chromaticity";
155 }
156
157 }
|