001/* MediaTray.java --
002   Copyright (C) 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.EnumSyntax;
041
042/**
043 * <code>MediaTray</code> is a subclass of the <code>Media</code> printing
044 * attribute and provides selection of media to be used by the means of the
045 * input tray of the printer. The class pre-defines commonly available types
046 * of input trays in printers. This media type enumeration may be used in
047 * alternative to MediaSizeName/MediaName.
048 * <p>
049 * <b>IPP Compatibility:</b> MediaTray is not an IPP 1.1 attribute on its own.
050 * It provides parts of the <code>media</code> attribute type values.
051 * </p>
052 *
053 * @author Sven de Marothy
054 * @author Wolfgang Baer (WBaer@gmx.de)
055 */
056public class MediaTray extends Media
057{
058
059  private static final long serialVersionUID = -982503611095214703L;
060
061  /**
062   * Top tray
063   */
064  public static final MediaTray TOP = new MediaTray(0);
065
066  /**
067   * Middle tray
068   */
069  public static final MediaTray MIDDLE = new MediaTray(1);
070
071  /**
072   * Bottom tray
073   */
074  public static final MediaTray BOTTOM = new MediaTray(2);
075
076  /**
077   * Envelope tray
078   */
079  public static final MediaTray ENVELOPE = new MediaTray(3);
080
081  /**
082   * Manual-feed tray
083   */
084  public static final MediaTray MANUAL = new MediaTray(4);
085
086  /**
087   * Large capacity tray
088   */
089  public static final MediaTray LARGE_CAPACITY = new MediaTray(5);
090
091  /**
092   * Main tray
093   */
094  public static final MediaTray MAIN = new MediaTray(6);
095
096  /**
097   * Side tray
098   */
099  public static final MediaTray SIDE = new MediaTray(7);
100
101  private static final String[] stringTable = { "top", "middle", "bottom",
102                                                "envelope", "manual",
103                                                "large-capacity", "main",
104                                                "side" };
105
106  private static final MediaTray[] enumValueTable = { TOP, MIDDLE, BOTTOM,
107                                                      ENVELOPE, MANUAL,
108                                                      LARGE_CAPACITY, MAIN,
109                                                      SIDE };
110
111  /**
112   * Creates a <code>MediaTray</code> object.
113   *
114   * @param i the enum value.
115   */
116  protected MediaTray(int i)
117  {
118    super( i );
119  }
120
121  /**
122   * Returns a table with the enumeration values represented as strings
123   * for this object.
124   *
125   * @return The enumeration values as strings.
126   */
127  protected String[] getStringTable()
128  {
129    return stringTable;
130  }
131
132  /**
133   * Returns a table with the enumeration values for this object.
134   *
135   * @return The enumeration values.
136   */
137  protected EnumSyntax[] getEnumValueTable()
138  {
139    return enumValueTable;
140  }
141}