1 /*
   2  * Copyright (c) 2000, 2003, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package javax.print.attribute.standard;
  26 
  27 import java.util.Locale;
  28 
  29 import javax.print.attribute.Attribute;
  30 import javax.print.attribute.EnumSyntax;
  31 
  32 
  33 /**
  34  * Class MediaTray is a subclass of Media.
  35  * Class MediaTray is a printing attribute class, an enumeration, that
  36  * specifies the media tray or bin for the job.
  37  * This attribute can be used instead of specifying MediaSize or MediaName.
  38  * <p>
  39  * Class MediaTray declares keywords for standard media kind values.
  40  * Implementation- or site-defined names for a media kind attribute may also
  41  * be created by defining a subclass of class MediaTray.
  42  * <P>
  43  * <B>IPP Compatibility:</B> MediaTray is a representation class for
  44  * values of the IPP "media" attribute which name paper trays.
  45  * <P>
  46  *
  47  */
  48 public class MediaTray extends Media implements Attribute {
  49 
  50     private static final long serialVersionUID = -982503611095214703L;
  51 
  52     /**
  53      * The top input tray in the printer.
  54      */
  55     public static final MediaTray TOP = new MediaTray(0);
  56 
  57     /**
  58      * The middle input tray in the printe.
  59      */
  60     public static final MediaTray MIDDLE = new MediaTray(1);
  61 
  62     /**
  63      * The bottom input tray in the printer.
  64      */
  65     public static final MediaTray BOTTOM = new MediaTray(2);
  66 
  67     /**
  68      * The envelope input tray in the printer.
  69      */
  70     public static final MediaTray ENVELOPE = new MediaTray(3);
  71 
  72     /**
  73      * The manual feed input tray in the printer.
  74      */
  75     public static final MediaTray MANUAL = new MediaTray(4);
  76 
  77     /**
  78      * The large capacity input tray in the printer.
  79      */
  80     public static final MediaTray LARGE_CAPACITY = new MediaTray(5);
  81 
  82     /**
  83      * The main input tray in the printer.
  84      */
  85     public static final MediaTray MAIN = new MediaTray(6);
  86 
  87     /**
  88      * The side input tray.
  89      */
  90     public static final MediaTray SIDE = new MediaTray(7);
  91 
  92     /**
  93      * Construct a new media tray enumeration value with the given integer
  94      * value.
  95      *
  96      * @param  value  Integer value.
  97      */
  98     protected MediaTray(int value) {
  99         super (value);
 100     }
 101 
 102     private static final String[] myStringTable ={
 103         "top",
 104         "middle",
 105         "bottom",
 106         "envelope",
 107         "manual",
 108         "large-capacity",
 109         "main",
 110         "side"
 111     };
 112 
 113     private static final MediaTray[] myEnumValueTable = {
 114         TOP,
 115         MIDDLE,
 116         BOTTOM,
 117         ENVELOPE,
 118         MANUAL,
 119         LARGE_CAPACITY,
 120         MAIN,
 121         SIDE
 122     };
 123 
 124     /**
 125      * Returns the string table for class MediaTray.
 126      */
 127     protected String[] getStringTable()
 128     {
 129         return (String[])myStringTable.clone();
 130     }
 131 
 132     /**
 133      * Returns the enumeration value table for class MediaTray.
 134      */
 135     protected EnumSyntax[] getEnumValueTable() {
 136         return (EnumSyntax[])myEnumValueTable.clone();
 137     }
 138 
 139 
 140 }