001/* OrientationRequested.java --
002   Copyright (C) 2004, 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.print.attribute.standard;
039
040import javax.print.attribute.Attribute;
041import javax.print.attribute.DocAttribute;
042import javax.print.attribute.EnumSyntax;
043import javax.print.attribute.PrintJobAttribute;
044import javax.print.attribute.PrintRequestAttribute;
045
046
047/**
048 * The <code>OrientationRequested</code> printing attribute specifies
049 * the desired orientation of the print data on the media sheet.
050 * <p>
051 * The effect of this attribute may depend on the document format as
052 * some document formats (e.g. postscript) contains the orientation
053 * inside the print data. However for other formats like e.g. plain
054 * text this attribute will have an effect on the orientation.
055 * </p>
056 * <p>
057 * <b>IPP Compatibility:</b> OrientationRequested is an IPP 1.1 attribute.
058 * </p>
059 *
060 * @author Michael Koch (konqueror@gmx.de)
061 * @author Wolfgang Baer (WBaer@gmx.de)
062 */
063public final class OrientationRequested extends EnumSyntax
064  implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
065{
066  private static final long serialVersionUID = -4447437289862822276L;
067
068  /**
069   * Orientation as portrait.
070   */
071  public static final OrientationRequested PORTRAIT =
072    new OrientationRequested(3);
073
074  /**
075   * Orientation as landscape.
076   */
077  public static final OrientationRequested LANDSCAPE =
078    new OrientationRequested(4);
079
080  /**
081   * Orientation as reversed landscape.
082   */
083  public static final OrientationRequested REVERSE_LANDSCAPE =
084    new OrientationRequested(5);
085
086  /**
087   * Orientation as reversed portrait.
088   */
089  public static final OrientationRequested REVERSE_PORTRAIT =
090    new OrientationRequested(6);
091
092
093  private static final String[] stringTable = { "portrait", "landscape",
094                                                "reverse-landscape",
095                                                "reverse-portrait" };
096
097  private static final OrientationRequested[]
098      enumValueTable = { PORTRAIT, LANDSCAPE,
099                         REVERSE_LANDSCAPE, REVERSE_PORTRAIT };
100
101  /**
102   * Constructs a <code>OrientationRequested</code> object.
103   *
104   * @param value the value
105   */
106  protected OrientationRequested(int value)
107  {
108    super(value);
109  }
110
111  /**
112   * Returns category of this class.
113   *
114   * @return The class <code>OrientationRequested</code> itself.
115   */
116  public Class< ? extends Attribute> getCategory()
117  {
118    return OrientationRequested.class;
119  }
120
121  /**
122   * Returns the name of this attribute.
123   *
124   * @return The name "orientation-requested".
125   */
126  public String getName()
127  {
128    return "orientation-requested";
129  }
130
131  /**
132   * Returns a table with the enumeration values represented as strings
133   * for this object.
134   *
135   * @return The enumeration values as strings.
136   */
137  protected String[] getStringTable()
138  {
139    return stringTable;
140  }
141
142  /**
143   * Returns a table with the enumeration values for this object.
144   *
145   * @return The enumeration values.
146   */
147  protected EnumSyntax[] getEnumValueTable()
148  {
149    return enumValueTable;
150  }
151
152  /**
153   * Returns the lowest used value by the enumerations of this class.
154   * .
155   * @return The lowest value used.
156   */
157  protected int getOffset()
158  {
159    return 3;
160  }
161}